IFdbDatabaseOptions

Namespace: FoundationDB.Client · interface

Properties

ApiVersion

int ApiVersion { get; }

API version selected for this database

ClusterFile

string ClusterFile { get; }

Full path to the '.cluster' file that contains the connection string to the cluster

This should be a valid path, accessible with read and write permissions by the process.

This property and ConnectionString are mutually exclusive.

ConnectionString

string ConnectionString { get; }

Connection string to the cluster

The format of this string is the same as the content of a .cluster file.

This property and ClusterFile are mutually exclusive.

DefaultMaxRetryDelay

int DefaultMaxRetryDelay { get; set; }

Default Maximum Retry Delay value (in milliseconds) for all transactions created from this database instance.

If changed, will only be effective for future transactions

DefaultRetryLimit

int DefaultRetryLimit { get; set; }

Default Retry Limit value for all transactions created from this database instance.

If changed, will only be effective for future transactions

DefaultTimeout

int DefaultTimeout { get; set; }

Default Timeout value (in milliseconds) for all transactions created from this database instance.

If changed, will only be effective for future transactions

DefaultTracing

FdbTracingOptions DefaultTracing { get; set; }

Default tracing options for all transactions created from this database instance.

If changed, will only be effective for future transactions

Methods

SetOption

IFdbDatabaseOptions SetOption(FdbDatabaseOption option)

Set an option on this database that does not take any parameter

  • option — Option to set

IFdbDatabaseOptions SetOption(FdbDatabaseOption option, long value)

Set an option on this database that takes an integer value

  • option — Option to set
  • value — Value of the parameter

IFdbDatabaseOptions SetOption(FdbDatabaseOption option, ReadOnlySpan<char> value)

Set an option on this database that takes a string value

  • option — Option to set
  • value — Value of the parameter (can be empty)

IFdbDatabaseOptions SetOption(FdbDatabaseOption option, ReadOnlySpan<byte> value)

Set an option on this database that takes a byte array value

  • option — Option to set
  • value — Value of the parameter (can be empty)