Public API

Detailed Description

Public API Routines.

Stability

Internal:

This covers the functions and structures of the library which are public interfaces. These consist of functions decorated with LIBCOUCHBASE_API and which are defined in the libcouchbase header directory.

Modules
	Full Text Search
	Search for strings in documents and more.
	N1QL Queries
	Execute N1QL queries.
	Views (Map-Reduce)
	Higher level API which splits view results into rows.
	Encryption
	Register crypto-providers and working with encrypted fields of the documents.
	Operation Metrics
	Output per-operation latencies.
	vBucket
	Initialization
	Key/Value
	Preview APIs for performing commands.
	PING
	Broadcast NOOP-like commands to each service in the cluster.
	User Cookies
	Associate user-defined data with operations.
	Waiting
	Functions for synchronous I/O execution.
	Advanced Scheduling
	Additional functions for scheduling operations.
	Settings
	Get/Set Library Options.
	Build Information
	Get library version and supported features.
	Logging
	Various logging functions.
	Analytics Queries
	Execute Analytics N1QL Queries.
	End to end tracing
	End to end tracing.
	Authentication
	Error Codes
	Status codes returned by the library.
	Network I/O
	Raw packet forwarding and dispatch routines
	These functions perform packet forwarding functions to send and receive raw packets.
	Flush
	Clear the contents of a bucket.
	Timings
	Determine how long operations are taking to be completed.
	Cluster Information
	These functions return status information about the handle, the current connection, and the number of nodes found within the cluster.