Light
Dark
System

Configuration

There are two different types of configuration that can be made: clientside config, and session state. Clientside configuration is strictly related on how EdgeDB.Net operates; while session state is configuration for a particular connection with EdgeDB.

Clientside configuration happens at client instansiation and cannot be mutated.

The EdgeDB.EdgeDBClientPoolConfig is used to configurate the EdgeDB.EdgeDBClient instance by passing it as a parameter to the clients constructor:

C#
F#
Copy
var config = new EdgeDBClientPoolConfig()
{
    ConnectionTimeout = 5000u
};

var client = new EdgeDBClient(config);
Copy
let config = new EdgeDBClientPoolConfig()
config.ConnectionTimeout <- 5000u

let client = new EdgeDBClient(config)

Property

Type

Description

DefaultPoolSize

int

The default client pool size.

Logger

ILogger

The logger used for logging messages from the driver.

RetryMode

ConnectionRetryMode

The retry mode for connecting new clients.

MaxConnectionRetries

uint

The maximum number of times to retry to connect.

ConnectionTimeout

uint

The number of miliseconds a client will wait for a connection to be established with the server.

MessageTimeout

uint

The max amount of miliseconds a client will wait for an expected message.

ExplicitObjectIds

bool

Whether or not to always return object ids.

ImplicitLimit

ulong

The implicit object limit for all queries. By default there is not limit.

SchemaNamingStrategy

INamingStrategy

The default naming strategy used within the schema.

All state configuration methods begin with With and return a new client instance with the applied changes. The client instance returned from a state change shares the same underlying connection pool as the client it was derived from.

See EdgeDB.EdgeDBClient.WithConfig(Config), EdgeDB.EdgeDBClient.WithGlobals(IDictionary<string,object>), EdgeDB.EdgeDBClient.WithModule(string), and EdgeDB.EdgeDBClient.WithAliases(IDictionary<string,string>)

Light
Dark
System