|
Couchbase Lite C
Couchbase Lite C API
|
| Errors | Types and constants for communicating errors from API calls |
| Other Types | |
| Reference Counting | Couchbase Lite "objects" are reference-counted; the functions below are the shared retain and release operations |
| Database | A CBLDatabase is both a filesystem object and a container for documents |
| Scope | A CBLScope represents a scope or namespace of the collections |
| Collection | A CBLCollection represent a collection which is a container for documents |
| Documents | A CBLDocument is essentially a JSON object with an ID string that's unique in its database |
| Blobs | A CBLBlob is a binary data blob associated with a document |
| Query | A CBLQuery represents a compiled database query |
| Index | Indexes are used to speed up queries by allowing fast – O(log n) – lookup of documents that have specific values or ranges of values |
| Replication | A replicator is a background task that synchronizes changes between a local database and another database on a remote server (or on a peer device, or even another local database.) |
| Encryptables | A CBLEncryptable is a value to be encrypted by the replicator when a document is pushed to the remote server |
| Listeners | Every API function that registers a listener callback returns an opaque token representing the registered callback |
| Constants | Constants for default configuration values |
| Logging | Managing messages that Couchbase Lite logs at runtime |
| LogSinks | Manages Couchbase Lite logging configuration, with three log sinks: |
| Queries | |
| TLSIdentity | TLSIdentity represents identity information, including an RSA key pair and certificates, used for server or client authentication as well as data encryption / decryption in TLS communication |
| Basic Fleece Data Types | |
| Fleece Arrays | FLArray is a "subclass" of FLValue, representing values that are arrays |
| Fleece Dictionaries | |
| Fleece Deep Iterator | A deep iterator traverses every value contained in a dictionary, in depth-first order |
| Reading Fleece Data | |
| Fleece CoreFoundation and Objective-C Helpers | |
| Fleece Encoders | An FLEncoder generates encoded Fleece or JSON data |
| Rarely-needed or advanced functions | |
| JSON Interoperability | |
| Fleece Paths | An FLKeyPath Describes a location in a Fleece object tree, as a path from the root that follows dictionary properties and array elements |
| Mutable Values | |
| Value Slots | An FLSlot is a temporary reference to an element of a mutable Array/Dict; its only purpose is to let you store a value into it, using the FLSlot_... functions |
| Fleece Formatted Value Builder | These functions use the printf idiom to make it convenient to create structured Fleece values in memory with one call |
| Slices | |
| Fleece Values | The core Fleece data type is FLValue: a reference to a value in Fleece-encoded data |