Constants

The following constants are available globally.

  • Value of type property for blob object

    Declaration

    Objective-C

    extern NSString *const _Nonnull kCBLBlobType

  • Blob dict property containing a blobType of the data.

    Declaration

    Objective-C

    extern NSString *const _Nonnull kCBLTypeProperty

  • Blob dict property containing a digest of the data.

    Declaration

    Objective-C

    extern NSString *const _Nonnull kCBLBlobDigestProperty

  • Blob dict property containing a length of the data.

    Declaration

    Objective-C

    extern NSString *const _Nonnull kCBLBlobLengthProperty

  • Blob dict property containing a content type of the data.

    Declaration

    Objective-C

    extern NSString *const _Nonnull kCBLBlobContentTypeProperty

  • The default collection name constant

    Declaration

    Objective-C

    extern NSString *const _Nonnull kCBLDefaultCollectionName

CBLDatabaseConfiguration

  • [NO] Full sync is off by default because the performance hit is seldom worth the benefit

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultDatabaseFullSync

  • [NO] Memory mapped database files are disabled by default. Always disabled for macOS.

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultDatabaseMmapEnabled

CBLLogFileConfiguration

  • [NO] Plaintext is not used, and instead binary encoding is used in log files

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultLogFileUsePlaintext

  • Deprecated

    Use kCBLDefaultLogFileUsePlaintext instead.

    [NO] Plaintext is not used, and instead binary encoding is used in log files

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultLogFileUsePlainText

  • [524288] 512 KiB for the size of a log file

    Declaration

    Objective-C

    extern const uint64_t kCBLDefaultLogFileMaxSize

  • [1] 1 rotated file present (2 total, including the currently active log file)

    Declaration

    Objective-C

    extern const NSInteger kCBLDefaultLogFileMaxRotateCount

CBLFileLogSink

  • [NO] Plaintext is not used, and instead binary encoding is used in log files

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultFileLogSinkUsePlaintext

  • [524288] 512 KiB for the size of a log file

    Declaration

    Objective-C

    extern const long long kCBLDefaultFileLogSinkMaxSize

  • [2] 2 files preserved during each log rotation

    Declaration

    Objective-C

    extern const NSInteger kCBLDefaultFileLogSinkMaxKeptFiles

CBLFullTextIndexConfiguration

  • [NO] Accents and ligatures are not ignored when indexing via full text search

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultFullTextIndexIgnoreAccents

CBLReplicatorConfiguration

  • [kCBLReplicatorTypePushAndPull] Perform bidirectional replication

    Declaration

    Objective-C

    extern const CBLReplicatorType kCBLDefaultReplicatorType

  • [NO] One-shot replication is used, and will stop once all initial changes are processed

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultReplicatorContinuous

  • [NO] Replication stops when an application enters background mode

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultReplicatorAllowReplicatingInBackground

  • [300] A heartbeat messages is sent every 300 seconds to keep the connection alive

    Declaration

    Objective-C

    extern const NSTimeInterval kCBLDefaultReplicatorHeartbeat

  • [10] When replicator is not continuous, after 10 failed attempts give up on the replication

    Declaration

    Objective-C

    extern const NSUInteger kCBLDefaultReplicatorMaxAttemptsSingleShot

  • [NSUIntegerMax] When replicator is continuous, never give up unless explicitly stopped

    Declaration

    Objective-C

    extern const NSUInteger kCBLDefaultReplicatorMaxAttemptsContinuous

  • [300] Max wait time between retry attempts in seconds

    Declaration

    Objective-C

    extern const NSTimeInterval kCBLDefaultReplicatorMaxAttemptsWaitTime

  • Deprecated

    Use kCBLDefaultReplicatorMaxAttemptsWaitTime instead.

    [300] Max wait time between retry attempts in seconds

    Declaration

    Objective-C

    extern const NSTimeInterval kCBLDefaultReplicatorMaxAttemptWaitTime

  • [YES] Purge documents when a user loses access

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultReplicatorEnableAutoPurge

  • [NO] Whether or not a replicator only accepts self-signed certificates from the remote

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultReplicatorSelfSignedCertificateOnly

  • [NO] Whether or not a replicator only accepts cookies for the sender’s parent domains

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultReplicatorAcceptParentCookies

CBLVectorIndexConfiguration

  • [NO] Vectors are not lazily indexed, by default

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultVectorIndexIsLazy

  • [kCBLSQ8] Vectors are encoded by using 8-bit Scalar Quantizer encoding, by default

    Declaration

    Objective-C

    extern const CBLScalarQuantizerType kCBLDefaultVectorIndexEncoding

  • [kCBLDistanceMetricEuclideanSquared] By default, vectors are compared using Squared Euclidean metrics

    Declaration

    Objective-C

    extern const CBLDistanceMetric kCBLDefaultVectorIndexDistanceMetric

  • [0] By default, the value will be determined based on the number of centroids, encoding types, and the encoding parameters.

    Declaration

    Objective-C

    extern const unsigned int kCBLDefaultVectorIndexMinTrainingSize

  • [0] By default, the value will be determined based on the number of centroids, encoding types, and the encoding parameters

    Declaration

    Objective-C

    extern const unsigned int kCBLDefaultVectorIndexMaxTrainingSize

  • [0] By default, the value will be determined based on the number of centroids.

    Declaration

    Objective-C

    extern const unsigned int kCBLDefaultVectorIndexNumProbes

CBLURLEndpointListenerConfiguration

  • [0] No port specified, the OS will assign one

    Declaration

    Objective-C

    extern const unsigned short kCBLDefaultListenerPort

  • [NO] TLS is enabled on the connection

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultListenerDisableTls

  • [NO] The listener will allow database writes

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultListenerReadOnly

  • [NO] Delta sync is disabled for the listener

    Declaration

    Objective-C

    extern const BOOL kCBLDefaultListenerEnableDeltaSync

  • NSError domain for Couchbase Lite errors.

    Declaration

    Objective-C

    extern const NSErrorDomain CBLErrorDomain

  • The default scope name constant

    Declaration

    Objective-C

    extern NSString *const _Nonnull kCBLDefaultScopeName

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrCommonName

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrPseudonym

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrGivenName

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrSurname

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrOrganization

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrOrganizationUnit

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrPostalAddress

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrLocality

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrPostalCode

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrStateOrProvince

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrCountry

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrEmailAddress

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrHostname

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrURL

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrIPAddress

  • Undocumented

    Declaration

    Objective-C

    extern NSString* const kCBLCertAttrRegisteredID

  • Undocumented

    Declaration

    Objective-C

    extern double CouchbaseLiteVersionNumber

  • Undocumented

    Declaration

    Objective-C

    extern const unsigned char CouchbaseLiteVersionString[]