Class Constants

A class holding predefined constant default values for various classes

Note

This file was autogenerated by a Couchbase script

Inheritance

System.Object

Constants

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Couchbase.Lite.Info

Assembly: Couchbase.Lite.dll

Syntax

public static class Constants

Fields

DefaultDatabaseFullSync

Default value for FullSync (false) Full sync is off by default because the performance hit is seldom worth the benefit

Declaration

public static readonly bool DefaultDatabaseFullSync

Field Value

Type	Description
System.Boolean

DefaultDatabaseMmapEnabled

Default value for MmapEnabled (true) Memory mapped database files are enabled by default

Declaration

public static readonly bool DefaultDatabaseMmapEnabled

Field Value

Type	Description
System.Boolean

DefaultFileLogSinkMaxKeptFiles

Default value for (2) 2 files preserved during each log rotation

Declaration

public static readonly int DefaultFileLogSinkMaxKeptFiles

Field Value

Type	Description
System.Int32

DefaultFileLogSinkMaxSize

Default value for (524288) 512 KiB for the size of a log file

Declaration

public static readonly long DefaultFileLogSinkMaxSize

Field Value

Type	Description
System.Int64

DefaultFileLogSinkUsePlaintext

Default value for (false) Plaintext is not used, and instead binary encoding is used in log files

Declaration

public static readonly bool DefaultFileLogSinkUsePlaintext

Field Value

Type	Description
System.Boolean

DefaultFullTextIndexIgnoreAccents

Default value for IgnoreAccents (false) Accents and ligatures are not ignored when indexing via full text search

Declaration

public static readonly bool DefaultFullTextIndexIgnoreAccents

Field Value

Type	Description
System.Boolean

DefaultListenerDisableTls

Default value for DisableTLS (false) TLS is enabled on the connection

Declaration

public static readonly bool DefaultListenerDisableTls

Field Value

Type	Description
System.Boolean

DefaultListenerEnableDeltaSync

Default value for EnableDeltaSync (false) Delta sync is disabled for the listener

Declaration

public static readonly bool DefaultListenerEnableDeltaSync

Field Value

Type	Description
System.Boolean

DefaultListenerPort

Default value for Port (0) No port specified, the OS will assign one

Declaration

public static readonly ushort DefaultListenerPort

Field Value

Type	Description
System.UInt16

DefaultListenerReadOnly

Default value for ReadOnly (false) The listener will allow database writes

Declaration

public static readonly bool DefaultListenerReadOnly

Field Value

Type	Description
System.Boolean

DefaultLogFileMaxRotateCount

Default value for MaxRotateCount (1) 1 rotated file present (2 total, including the currently active log file)

Declaration

public static readonly int DefaultLogFileMaxRotateCount

Field Value

Type	Description
System.Int32

DefaultLogFileMaxSize

Default value for MaxSize (524288) 512 KiB for the size of a log file

Declaration

public static readonly long DefaultLogFileMaxSize

Field Value

Type	Description
System.Int64

DefaultLogFileUsePlaintext

Default value for UsePlaintext (false) Plaintext is not used, and instead binary encoding is used in log files

Declaration

public static readonly bool DefaultLogFileUsePlaintext

Field Value

Type	Description
System.Boolean

DefaultLogFileUsePlainText

Default value for UsePlaintext (false) Plaintext is not used, and instead binary encoding is used in log files

Declaration

[Obsolete("Use Constants.UsePlantext instead")]
public static readonly bool DefaultLogFileUsePlainText

Field Value

Type	Description
System.Boolean

DefaultReplicatorAcceptParentCookies

Default value for AcceptParentDomainCookies (false) Whether or not a replicator only accepts cookies for the sender's parent domains

Declaration

public static readonly bool DefaultReplicatorAcceptParentCookies

Field Value

Type	Description
System.Boolean

DefaultReplicatorContinuous

Default value for Continuous (false) One-shot replication is used, and will stop once all initial changes are processed

Declaration

public static readonly bool DefaultReplicatorContinuous

Field Value

Type	Description
System.Boolean

DefaultReplicatorEnableAutoPurge

Default value for EnableAutoPurge (true) Purge documents when a user loses access

Declaration

public static readonly bool DefaultReplicatorEnableAutoPurge

Field Value

Type	Description
System.Boolean

DefaultReplicatorHeartbeat

Default value for Heartbeat (TimeSpan.FromSeconds(300)) A heartbeat messages is sent every 300 seconds to keep the connection alive

Declaration

public static readonly TimeSpan DefaultReplicatorHeartbeat

Field Value

Type	Description
System.TimeSpan

DefaultReplicatorMaxAttemptsContinuous

Default value for MaxAttempts (Int32.MaxValue) When replicator is continuous, never give up unless explicitly stopped

Declaration

public static readonly int DefaultReplicatorMaxAttemptsContinuous

Field Value

Type	Description
System.Int32

DefaultReplicatorMaxAttemptsSingleShot

Default value for MaxAttempts (10) When replicator is not continuous, after 10 failed attempts give up on the replication

Declaration

public static readonly int DefaultReplicatorMaxAttemptsSingleShot

Field Value

Type	Description
System.Int32

DefaultReplicatorMaxAttemptsWaitTime

Default value for MaxAttemptsWaitTime (TimeSpan.FromSeconds(300)) Max wait time between retry attempts in seconds

Declaration

public static readonly TimeSpan DefaultReplicatorMaxAttemptsWaitTime

Field Value

Type	Description
System.TimeSpan

DefaultReplicatorMaxAttemptWaitTime

Default value for MaxAttemptsWaitTime (TimeSpan.FromSeconds(300)) Max wait time between retry attempts in seconds

Declaration

[Obsolete("Use Constants.DefaultReplicatorMaxAttemptsWaitTime (attempt -> attemps) instead")]
public static readonly TimeSpan DefaultReplicatorMaxAttemptWaitTime

Field Value

Type	Description
System.TimeSpan

DefaultReplicatorSelfSignedCertificateOnly

Default value for AcceptOnlySelfSignedServerCertificate (false) Whether or not a replicator only accepts self-signed certificates from the remote

Declaration

public static readonly bool DefaultReplicatorSelfSignedCertificateOnly

Field Value

Type	Description
System.Boolean

DefaultReplicatorType

Default value for ReplicatorType (ReplicatorType.PushAndPull) Perform bidirectional replication

Declaration

public static readonly ReplicatorType DefaultReplicatorType

Field Value

Type	Description
ReplicatorType

DefaultVectorIndexDistanceMetric

Default value for DistanceMetric (DistanceMetric.EuclideanSquared) By default, vectors are compared using squared Euclidean metrics

Declaration

public static readonly DistanceMetric DefaultVectorIndexDistanceMetric

Field Value

Type	Description
DistanceMetric

DefaultVectorIndexEncoding

Default value for Encoding (ScalarQuantizerType.SQ8) Vectors are encoded by using 8-bit Scalar Quantizer encoding, by default

Declaration

public static readonly ScalarQuantizerType DefaultVectorIndexEncoding

Field Value

Type	Description
ScalarQuantizerType

DefaultVectorIndexIsLazy

Default value for IsLazy (false) Vectors are not lazily indexed, by default

Declaration

public static readonly bool DefaultVectorIndexIsLazy

Field Value

Type	Description
System.Boolean

DefaultVectorIndexMaxTrainingSize

Default value for MaxTrainingSize (0) By default, the value will be determined based on the number of centroids, encoding types, and the encoding parameters

Declaration

public static readonly uint DefaultVectorIndexMaxTrainingSize

Field Value

Type	Description
System.UInt32

DefaultVectorIndexMinTrainingSize

Default value for MinTrainingSize (0) By default, the value will be determined based on the number of centroids, encoding types, and the encoding parameters.

Declaration

public static readonly uint DefaultVectorIndexMinTrainingSize

Field Value

Type	Description
System.UInt32

DefaultVectorIndexNumProbes

Default value for NumProbes (0) By default, the value will be determined based on the number of centroids.

Declaration

public static readonly uint DefaultVectorIndexNumProbes

Field Value

Type	Description
System.UInt32