FdbClientSettings

Namespace: Aspire.FoundationDb.Client · class

Provides the client configuration settings for connecting to a FoundationDB cluster.

Constructors

FdbClientSettings

FdbClientSettings()

Properties

ApiVersion

int? ApiVersion { get; set; }

Overrides the API version that should be used by this instance

ClusterContents

string ClusterContents { get; set; }

Overrides the content of the cluster file that should be used by this instance

ClusterFile

string ClusterFile { get; set; }

Overrides the path to the cluster file that should be used by this instance

ClusterVersion

string ClusterVersion { get; set; }

Overrides the cluster version that should be used by this instance

ConnectionString

string ConnectionString { get; set; }

The connection string of the FoundationDB server to connect to.

DefaultRetryLimit

int? DefaultRetryLimit { get; set; }

Overrides the default transaction retry limit that should be used by this instance

See for more information.

DefaultTimeout

TimeSpan? DefaultTimeout { get; set; }

Overrides the default transaction timeout that should be used by this instance

See for more information.

DefaultTracing

int? DefaultTracing { get; set; }

Overrides the default tracing options that should be used by this instance

See Tracing for more information.

The default tracing options are RecordTransactions and RecordOperations

DisableHealthChecks

bool DisableHealthChecks { get; set; }

Gets or sets a boolean value that indicates whether the FoundationDB health check is disabled or not.

Enabled by default.

DisableMetrics

bool DisableMetrics { get; set; }

Gets or sets a boolean value that indicates whether the OpenTelemetry metrics are disabled or not.

Metrics are enabled by default.

DisableTracing

bool DisableTracing { get; set; }

Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.

Tracing is enabled by default.

NativeLibraryPath

string NativeLibraryPath { get; set; }

Overrides the path to the native library that should be used by this instance

If empty, pre-loading of the native C API library will be enabled, and the operating system will handle the binding of the library.

If not empty, the native C API library will be pre-loaded using the specified path. If the file does not exist, is not readable, or is corrupted, the startup will fail.

ReadOnly

bool? ReadOnly { get; set; }

Overrides the read-only flag that should be used by this instance

Root

string Root { get; set; }

Overrides the root subspace location that should be used by this instance