Class DatabaseConfiguration

A struct containing configuration for creating or opening database data

Inheritance

System.Object

DatabaseConfiguration

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

Assembly: Couchbase.Lite.dll

Syntax

public sealed class DatabaseConfiguration

Constructors

DatabaseConfiguration()

Default constructor

Declaration

public DatabaseConfiguration()

Properties

Directory

Gets or sets the directory to use when creating or opening the data

Declaration

public string Directory { get; set; }

Property Value

Type	Description
System.String

EncryptionKey

Gets or sets the encryption key to use on the database

Declaration

public EncryptionKey EncryptionKey { get; set; }

Property Value

Type	Description
EncryptionKey

FullSync

There is a very small (though non-zero) chance that a power failure at just the wrong time could cause the most recently committed transaction's changes to be lost. This would cause the database to appear as it did immediately before that transaction. Setting this mode true ensures that an operating system crash or power failure will not cause the loss of any data. FULL synchronous is very safe but it is also dramatically slower.

Declaration

public bool FullSync { get; set; }

Property Value

Type	Description
System.Boolean	A boolean representing whether or not full sync is enabled

MmapEnabled

Hint for enabling or disabling memory-mapped I/O. Disabling it may affect database performance. Typically, there is no need to modify this setting.

Declaration

public bool MmapEnabled { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

[!NOTE] Memory-mapped I/O is always disabled to prevent database corruption on macOS. As a result, this configuration is not supported on the macOS platform.