Couchbase Lite C
Couchbase Lite C API
CBLDefaults.h
Go to the documentation of this file.
1//
2// CBLDefaults.h
3// CouchbaseLite
4//
5// Copyright (c) 2024-present Couchbase, Inc All rights reserved.
6//
7// Licensed under the Apache License, Version 2.0 (the "License");
8// you may not use this file except in compliance with the License.
9// You may obtain a copy of the License at
10//
11// http://www.apache.org/licenses/LICENSE-2.0
12//
13// Unless required by applicable law or agreed to in writing, software
14// distributed under the License is distributed on an "AS IS" BASIS,
15// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16// See the License for the specific language governing permissions and
17// limitations under the License.
18//
19
20// THIS IS AN AUTOGENERATED FILE, MANUAL CHANGES SHOULD BE EXPECTED TO
21// BE OVERWRITTEN
22
23
24#pragma once
25#include "CBL_Compat.h"
26#include "CBLReplicator.h"
27#include "CBLQueryIndexTypes.h"
28
30
43
46
55
59
61CBL_PUBLIC extern const size_t kCBLDefaultLogFileMaxSize;
62
65
74
83
86
88CBL_PUBLIC extern const unsigned kCBLDefaultReplicatorHeartbeat;
89
92
95
98
102
105
108
111#ifdef COUCHBASE_ENTERPRISE
112
118CBL_PUBLIC extern const bool kCBLDefaultVectorIndexLazy;
119
122
125
128
130CBL_PUBLIC extern const unsigned kCBLDefaultVectorIndexNumProbes;
131
134#endif
135
#define CBL_CAPI_BEGIN
Definition: CBL_Compat.h:105
#define CBL_CAPI_END
Definition: CBL_Compat.h:106
#define CBL_PUBLIC
Definition: CBL_Compat.h:123
CBL_PUBLIC const bool kCBLDefaultDatabaseFullSync
[false] Full sync is off by default because the performance hit is seldom worth the benefit
CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptsContinuous
[UINT_MAX] When replicator is continuous, never give up unless explicitly stopped
CBL_PUBLIC const unsigned kCBLDefaultVectorIndexMaxTrainingSize
[0] By default, the value will be determined based on the number of centroids, encoding types,...
CBL_PUBLIC const unsigned kCBLDefaultVectorIndexNumProbes
[0] By default, the value will be determined based on the number of centroids.
CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptsWaitTime
[300] Max wait time between retry attempts in seconds
CBL_PUBLIC const unsigned kCBLDefaultReplicatorHeartbeat
[300] A heartbeat messages is sent every 300 seconds to keep the connection alive
CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptWaitTime
[300] Max wait time between retry attempts in seconds
CBL_PUBLIC const CBLDistanceMetric kCBLDefaultVectorIndexDistanceMetric
[kCBLDistanceMetricEuclideanSquared] By default, vectors are compared using Squared Euclidean metric.
CBL_PUBLIC const bool kCBLDefaultLogFileUsePlainText
[false] Plaintext is not used, and instead binary encoding is used in log files
CBL_PUBLIC const bool kCBLDefaultReplicatorDisableAutoPurge
[false] Purge documents when a user loses access
CBL_PUBLIC const uint32_t kCBLDefaultLogFileMaxRotateCount
[1] 1 rotated file present (2 total, including the currently active log file)
CBL_PUBLIC const bool kCBLDefaultDatabaseMmapDisabled
[false] Memory mapped database files are enabled by default
CBL_PUBLIC const unsigned kCBLDefaultReplicatorMaxAttemptsSingleShot
[10] When replicator is not continuous, after 10 failed attempts give up on the replication
CBL_PUBLIC const unsigned kCBLDefaultVectorIndexMinTrainingSize
[0] By default, the value will be determined based on the number of centroids, encoding types,...
CBL_PUBLIC const CBLReplicatorType kCBLDefaultReplicatorType
[kCBLReplicatorTypePushAndPull] Perform bidirectional replication
CBL_PUBLIC const size_t kCBLDefaultLogFileMaxSize
[524288] 512 KiB for the size of a log file
CBL_PUBLIC const bool kCBLDefaultVectorIndexLazy
[false] Vectors are not lazily indexed, by default
CBL_PUBLIC const bool kCBLDefaultFullTextIndexIgnoreAccents
[false] Accents and ligatures are not ignored when indexing via full text search
CBL_PUBLIC const bool kCBLDefaultReplicatorContinuous
[false] One-shot replication is used, and will stop once all initial changes are processed
CBL_PUBLIC const bool kCBLDefaultReplicatorAcceptParentCookies
[false] Whether or not a replicator only accepts cookies for the sender's parent domains
CBL_PUBLIC const bool kCBLDefaultLogFileUsePlaintext
[false] Plaintext is not used, and instead binary encoding is used in log files
CBLDistanceMetric
Distance metric to use in CBLVectorIndexConfiguration.
Definition: CBLQueryIndexTypes.h:122
CBLReplicatorType
Direction of replication: push, pull, or both.
Definition: CBLReplicator.h:78