cbl Namespace Reference

Classes
struct	ArrayIndexConfiguration
	Array Index Configuration for indexing property values within arrays in documents, intended for use with the UNNEST query. More...
class	Authenticator
	Authentication credentials for a remote server. More...
class	Blob
	A reference to a binary data blob associated with a document. More...
class	BlobReadStream
	A stream for reading a blob's content from the database. More...
class	BlobWriteStream
	A stream for writing a new blob to the database. More...
class	Collection
	A Collection is a container for documents within a database. More...
class	CollectionChange
	Collection change info notified to the collection change listener's callback. More...
class	CollectionConfiguration
	A collection to replicate, along with its collection-specific replication settings such as filters and a conflict resolver. More...
struct	ConsoleLogSink
	Console log sink configuration for logging to the console. More...
struct	CustomLogSink
	Custom log sink configuration for logging to a user-defined callback. More...
class	Database
	A Couchbase Lite database, which is a container for collections of documents. More...
class	DatabaseConfiguration
	Database configuration options. More...
struct	DecryptionResult
	Result returned by a PropertyDecryptor callback. More...
class	Document
	An immutable, in-memory copy of a document read from a collection. More...
class	DocumentChange
	Document change info notified to the document change listener's callback. More...
class	Encryptable
	A reference to an encryptable value associated with a document. More...
class	EncryptionKey
	A database encryption key, used in DatabaseConfiguration to open or create an encrypted database. More...
struct	EncryptionResult
	Result returned by a PropertyEncryptor callback. More...
class	Endpoint
	The replication endpoint representing the location of a database to replicate with. More...
struct	Error
	The exception thrown by the Couchbase Lite C++ API to report a Couchbase Lite failure. More...
class	Extension
	Manages Couchbase Lite extensions, such as the Vector Search extension. More...
struct	FileLogSink
	File log sink configuration for logging to files. More...
struct	FullTextIndexConfiguration
	Configuration for creating a full-text index, which enables full-text search in queries. More...
class	IndexUpdater
	Updates a lazy index by setting the computed vectors for the documents returned from QueryIndex::beginUpdate. More...
class	ListenerToken
	A token representing a registered listener; instances are returned from the various methods that register listeners, such as Collection::addChangeListener. More...
class	LogSinks
	Controls where Couchbase Lite writes its log messages. More...
class	MutableDocument
	A mutable document, whose properties can be modified and saved to a collection. More...
class	Prediction
	Registers/unregisters predictive models by name. More...
class	Query
	A database query. More...
class	QueryIndex
	Represents an existing index in a collection. More...
class	RefCounted
class	Replicator
	A replicator that syncs documents between a local database's collections and a target database. More...
class	ReplicatorConfiguration
	The configuration of a replicator. More...
class	Result
	A single query result; ResultSet::iterator iterates over these. More...
class	ResultSet
	The results of a query. More...
class	ResultSetIterator
	Single-pass iterator over a ResultSet, yielding each Result in turn. More...
class	Transaction
	A helper object for database transactions. More...
struct	ValueIndexConfiguration
	Configuration for creating a value index, which indexes the values of one or more document properties. More...
class	VectorEncoding
	Vector encoding type to use in a VectorIndexConfiguration, for reducing the size of the stored vectors. More...
class	VectorIndexConfiguration
	Configuration for creating a vector index, which enables searching documents by vector similarity. More...

Typedefs
using	slice = fleece::slice
	Convenience alias for fleece::slice, a non-owning view of a byte range.
using	alloc_slice = fleece::alloc_slice
	Convenience alias for fleece::alloc_slice, an owning byte buffer.
using	QueryLanguage = CBLQueryLanguage
using	CollectionConflictHandler
	Conflict handler used when saving a document.
using	ConflictHandler
	Conflict handler used when saving a document.
using	EncryptionAlgorithm = CBLEncryptionAlgorithm
	Alias for the C CBLEncryptionAlgorithm enum identifying an encryption algorithm.
using	EncryptionKeySize = CBLEncryptionKeySize
	Alias for the C CBLEncryptionKeySize enum giving the required key size for an algorithm.
using	LogDomainMask = CBLLogDomainMask
using	LogSinkCallback = CBLLogSinkCallback
using	LogLevel = CBLLogLevel
using	LogDomain = CBLLogDomain
using	PredictiveModel = std::function<fleece::MutableDict(fleece::Dict)>
	A predictive model callable that integrates a machine learning model into queries, invoked via the query's PREDICTION() function.
using	ReplicationFilter = std::function<bool(Document, CBLDocumentFlags flags)>
	Replication Filter Function Callback.
using	ConflictResolver
	Replication Conflict Resolver Function Callback.
using	PropertyEncryptor
	Property Encryptor Function Callback.
using	PropertyDecryptor
	Property Decryptor Function Callback.
using	ReplicationCollection = CollectionConfiguration
	Deprecated alias for backward compatibility.
using	DistanceMetric = CBLDistanceMetric
	The distance metric used by a vector index to measure the similarity of vectors.

Typedef Documentation

alloc_slice

using cbl::alloc_slice = fleece::alloc_slice

Convenience alias for fleece::alloc_slice, an owning byte buffer.

CollectionConflictHandler

using cbl::CollectionConflictHandler

Initial value:

 std::function<bool(MutableDocument documentBeingSaved,
                                                          Document conflictingDocument)>

Conflict handler used when saving a document.

ConflictHandler

using cbl::ConflictHandler

Initial value:

 std::function<bool(MutableDocument documentBeingSaved,
                                               Document conflictingDocument)>

Conflict handler used when saving a document.

ConflictResolver

using cbl::ConflictResolver

Initial value:

 std::function<Document(std::string_view docID,
                                                    const Document localDoc,
                                                    const Document remoteDoc)>

Replication Conflict Resolver Function Callback.

DistanceMetric

using cbl::DistanceMetric = CBLDistanceMetric

The distance metric used by a vector index to measure the similarity of vectors.

Note

ENTERPRISE EDITION ONLY

EncryptionAlgorithm

using cbl::EncryptionAlgorithm = CBLEncryptionAlgorithm

Alias for the C CBLEncryptionAlgorithm enum identifying an encryption algorithm.

EncryptionKeySize

using cbl::EncryptionKeySize = CBLEncryptionKeySize

Alias for the C CBLEncryptionKeySize enum giving the required key size for an algorithm.

LogDomain

using cbl::LogDomain = CBLLogDomain

LogDomainMask

using cbl::LogDomainMask = CBLLogDomainMask

LogLevel

using cbl::LogLevel = CBLLogLevel

LogSinkCallback

using cbl::LogSinkCallback = CBLLogSinkCallback

PredictiveModel

using cbl::PredictiveModel = std::function<fleece::MutableDict(fleece::Dict)>

A predictive model callable that integrates a machine learning model into queries, invoked via the query's PREDICTION() function.

Given an input dictionary, return the output dictionary.

Note

ENTERPRISE EDITION ONLY

The predictive index feature is not supported by Couchbase Lite for C. The Predictive Model is currently for creating vector indexes using the PREDICTION() function, which will call the specified predictive model for computing the vectors.

PropertyDecryptor

using cbl::PropertyDecryptor

Initial value:

 std::function<DecryptionResult(
        fleece::slice scope,
        fleece::slice collection,
        fleece::slice documentID,
        fleece::Dict properties,
        fleece::slice keyPath,
        fleece::slice input,
        std::optional<std::string_view> algorithm,
        std::optional<std::string_view> keyID)>

Property Decryptor Function Callback.

(Enterprise Edition only.) Called by the pull replicator for each encrypted property in a document.

PropertyEncryptor

using cbl::PropertyEncryptor

Initial value:

 std::function<EncryptionResult(
        fleece::slice scope,
        fleece::slice collection,
        fleece::slice documentID,
        fleece::Dict properties,
        fleece::slice keyPath,
        fleece::slice input)>

Property Encryptor Function Callback.

(Enterprise Edition only.) Called by the push replicator for each encryptable property in a document.

QueryLanguage

using cbl::QueryLanguage = CBLQueryLanguage

ReplicationCollection

using cbl::ReplicationCollection = CollectionConfiguration

Deprecated alias for backward compatibility.

Warning

Deprecated : Use CollectionConfiguration instead.

ReplicationFilter

using cbl::ReplicationFilter = std::function<bool(Document, CBLDocumentFlags flags)>

Replication Filter Function Callback.

slice

using cbl::slice = fleece::slice

Convenience alias for fleece::slice, a non-owning view of a byte range.