Remove items from the cluster

Detailed Description

Delete items from the cluster.

Functions
lcb_remove_callback	lcb_set_remove_callback (lcb_t, lcb_remove_callback)
lcb_error_t	lcb_remove (lcb_t instance, const void *command_cookie, lcb_SIZE num, const lcb_remove_cmd_t *const *commands)
	Remove a key from the cluster. More...

Typedefs
typedef void(*	lcb_remove_callback) (lcb_t instance, const void *cookie, lcb_error_t error, const lcb_remove_resp_t *resp)
	The callback function for a remove request. More...

Function Documentation

lcb_error_t lcb_remove	(	lcb_t	instance,
		const void *	command_cookie,
		lcb_SIZE	num,
		const lcb_remove_cmd_t *const *	commands
	)

Remove a key from the cluster.

lcb_remove_cmd_t *remove = calloc(1, sizeof(*remove));
remove->version = 0;
remove->v.v0.key = "my-key";
remove->v.v0.nkey = strlen(remove->v.v0.key);
remove->v.v0.cas = 0x666;
lcb_remove_cmd_t* commands[] = { remove };
lcb_remove(instance, NULL, 1, commands);

Parameters

instance	the instance used to batch the requests from
command_cookie	A cookie passed to all of the notifications from this command
num	the total number of elements in the commands array
commands	the array containing the items to remove

Returns

Status code indicating whether the operation was scheduled or not. See 'exceptions' section for errors received in callbacks

The following operation-specific error codes are returned in the callback

• LCB_KEY_ENOENT if the key does not exist
• LCB_KEY_EEXISTS if the CAS was specified and it does not match the CAS on the server
• LCB_KEY_EEXISTS if the item was locked and no CAS (or an incorrect CAS) was specified.

Stability

Committed:

Typedef Documentation

typedef void(* lcb_remove_callback) (lcb_t instance, const void *cookie, lcb_error_t error, const lcb_remove_resp_t *resp)

The callback function for a remove request.

Parameters

instance	the instance performing the operation
cookie	the cookie associated with with the command
error	The status of the operation
resp	More information about the operation