Flush

Detailed Description

Clear the contents of a bucket.

Flush is useful for development environments (for example clearing a bucket before running tests).

Function Documentation

lcb_cbflush3()

lcb_STATUS lcb_cbflush3	(	lcb_INSTANCE *	instance,
		void *	cookie,
		const lcb_CMDCBFLUSH *	cmd
	)

Stability

Uncommitted:

Flush a bucket This function will properly flush any type of bucket using the REST API via HTTP.

The callback invoked under LCB_CALLBACK_CBFLUSH will be invoked with either a success or failure status depending on the outcome of the operation. Note that in order for lcb_cbflush3() to succeed, flush must already be enabled on the bucket via the administrative interface.

Parameters

instance	the library handle
cookie	the cookie passed in the callback
cmd	empty command structure. Currently there are no options for this command.

Returns

status code for scheduling.

Attention

Because this command is built using HTTP, this is not subject to operation pipeline calls such as lcb_sched_enter()/lcb_sched_leave()