Couchbase Lite C
Couchbase Lite C API
Constants

Constants for default configuration values. More...

CBLLogFileConfiguration

CBL_PUBLIC const bool kCBLDefaultLogFileUsePlaintext
 [false] Plaintext is not used, and instead binary encoding is used in log files More...
 
CBL_PUBLIC const bool kCBLDefaultLogFileUsePlainText
 [false] Plaintext is not used, and instead binary encoding is used in log files More...
 
CBL_PUBLIC const size_t kCBLDefaultLogFileMaxSize
 [524288] 512 KiB for the size of a log file More...
 
CBL_PUBLIC const uint32_t kCBLDefaultLogFileMaxRotateCount
 [1] 1 rotated file present (2 total, including the currently active log file) More...
 

CBLFullTextIndexConfiguration

CBL_PUBLIC const bool kCBLDefaultFullTextIndexIgnoreAccents
 [false] Accents and ligatures are not ignored when indexing via full text search More...
 

CBLReplicatorConfiguration

CBL_PUBLIC const CBLReplicatorType kCBLDefaultReplicatorType
 [kCBLReplicatorTypePushAndPull] Perform bidirectional replication More...
 
CBL_PUBLIC const bool kCBLDefaultReplicatorContinuous
 [false] One-shot replication is used, and will stop once all initial changes are processed More...
 
CBL_PUBLIC const unsigned kCBLDefaultReplicatorHeartbeat
 [300] A heartbeat messages is sent every 300 seconds to keep the connection alive More...
 
CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptsSingleShot
 [10] When replicator is not continuous, after 10 failed attempts give up on the replication More...
 
CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptsContinuous
 [UINT_MAX] When replicator is continuous, never give up unless explicitly stopped More...
 
CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptsWaitTime
 [300] Max wait time between retry attempts in seconds More...
 
CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptWaitTime
 [300] Max wait time between retry attempts in seconds More...
 
CBL_PUBLIC const bool kCBLDefaultReplicatorDisableAutoPurge
 [false] Purge documents when a user loses access More...
 
CBL_PUBLIC const bool kCBLDefaultReplicatorAcceptParentCookies
 [false] Whether or not a replicator only accepts cookies for the sender's parent domains More...
 

CBLVectorIndexConfiguration

CBL_PUBLIC const bool kCBLDefaultVectorIndexLazy
 [false] Vectors are not lazily indexed, by default More...
 
CBL_PUBLIC const CBLDistanceMetric kCBLDefaultVectorIndexDistanceMetric
 [kCBLDistanceMetricEuclideanSquared] By default, vectors are compared using Squared Euclidean metric. More...
 
CBL_PUBLIC const unsigned kCBLDefaultVectorIndexMinTrainingSize
 [0] By default, the value will be determined based on the number of centroids, encoding types, and the encoding parameters. More...
 
CBL_PUBLIC const unsigned kCBLDefaultVectorIndexMaxTrainingSize
 [0] By default, the value will be determined based on the number of centroids, encoding types, and the encoding parameters More...
 
CBL_PUBLIC const unsigned kCBLDefaultVectorIndexNumProbes
 [0] By default, the value will be determined based on the number of centroids. More...
 

Detailed Description

Constants for default configuration values.

Variable Documentation

◆ kCBLDefaultFullTextIndexIgnoreAccents

CBL_PUBLIC const bool kCBLDefaultFullTextIndexIgnoreAccents
extern

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

◆ kCBLDefaultLogFileMaxRotateCount

CBL_PUBLIC const uint32_t kCBLDefaultLogFileMaxRotateCount
extern

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

◆ kCBLDefaultLogFileMaxSize

CBL_PUBLIC const size_t kCBLDefaultLogFileMaxSize
extern

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

◆ kCBLDefaultLogFileUsePlaintext

CBL_PUBLIC const bool kCBLDefaultLogFileUsePlaintext
extern

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

◆ kCBLDefaultLogFileUsePlainText

CBL_PUBLIC const bool kCBLDefaultLogFileUsePlainText
extern

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

Warning
Deprecated : Use kCBLDefaultLogFileUsePlaintext instead.

◆ kCBLDefaultReplicatorAcceptParentCookies

CBL_PUBLIC const bool kCBLDefaultReplicatorAcceptParentCookies
extern

[false] Whether or not a replicator only accepts cookies for the sender's parent domains

◆ kCBLDefaultReplicatorContinuous

CBL_PUBLIC const bool kCBLDefaultReplicatorContinuous
extern

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

◆ kCBLDefaultReplicatorDisableAutoPurge

CBL_PUBLIC const bool kCBLDefaultReplicatorDisableAutoPurge
extern

[false] Purge documents when a user loses access

◆ kCBLDefaultReplicatorHeartbeat

CBL_PUBLIC const unsigned kCBLDefaultReplicatorHeartbeat
extern

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

◆ kCBLDefaultReplicatorMaxAttemptsContinuous

CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptsContinuous
extern

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

◆ kCBLDefaultReplicatorMaxAttemptsSingleShot

CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptsSingleShot
extern

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

◆ kCBLDefaultReplicatorMaxAttemptsWaitTime

CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptsWaitTime
extern

[300] Max wait time between retry attempts in seconds

◆ kCBLDefaultReplicatorMaxAttemptWaitTime

CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptWaitTime
extern

[300] Max wait time between retry attempts in seconds

Warning
Deprecated : Use kCBLDefaultReplicatorMaxAttemptsWaitTime instead.

◆ kCBLDefaultReplicatorType

CBL_PUBLIC const CBLReplicatorType kCBLDefaultReplicatorType
extern

[kCBLReplicatorTypePushAndPull] Perform bidirectional replication

◆ kCBLDefaultVectorIndexDistanceMetric

CBL_PUBLIC const CBLDistanceMetric kCBLDefaultVectorIndexDistanceMetric
extern

[kCBLDistanceMetricEuclideanSquared] By default, vectors are compared using Squared Euclidean metric.

◆ kCBLDefaultVectorIndexLazy

CBL_PUBLIC const bool kCBLDefaultVectorIndexLazy
extern

[false] Vectors are not lazily indexed, by default

◆ kCBLDefaultVectorIndexMaxTrainingSize

CBL_PUBLIC const unsigned kCBLDefaultVectorIndexMaxTrainingSize
extern

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

◆ kCBLDefaultVectorIndexMinTrainingSize

CBL_PUBLIC const unsigned kCBLDefaultVectorIndexMinTrainingSize
extern

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

◆ kCBLDefaultVectorIndexNumProbes

CBL_PUBLIC const unsigned kCBLDefaultVectorIndexNumProbes
extern

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