Class ConnectionOptions

Namespace

LinqToDB.Data

Assembly

linq2db.dll

public sealed record ConnectionOptions : IOptionSet, IConfigurationID, IEquatable<ConnectionOptions>

Inheritance

object

ConnectionOptions

Implements

IOptionSet

IConfigurationID

IEquatable<ConnectionOptions>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

DataOptionsExtensions.WithAfterConnectionOpened(ConnectionOptions, Action<DbConnection>, Func<DbConnection, CancellationToken, Task>?)

DataOptionsExtensions.WithBeforeConnectionOpened(ConnectionOptions, Action<DbConnection>, Func<DbConnection, CancellationToken, Task>?)

DataOptionsExtensions.WithConfigurationString(ConnectionOptions, string?)

DataOptionsExtensions.WithConnectionFactory(ConnectionOptions, Func<DataOptions, DbConnection>)

DataOptionsExtensions.WithConnectionString(ConnectionOptions, string?)

DataOptionsExtensions.WithDataProvider(ConnectionOptions, IDataProvider?)

DataOptionsExtensions.WithDataProviderFactory(ConnectionOptions, Func<ConnectionOptions, IDataProvider>)

DataOptionsExtensions.WithDbConnection(ConnectionOptions, DbConnection?)

DataOptionsExtensions.WithDbTransaction(ConnectionOptions, DbTransaction)

DataOptionsExtensions.WithDisposeConnection(ConnectionOptions, bool)

DataOptionsExtensions.WithMappingSchema(ConnectionOptions, MappingSchema)

DataOptionsExtensions.WithOnEntityDescriptorCreated(ConnectionOptions, Action<MappingSchema, IEntityChangeDescriptor>)

DataOptionsExtensions.WithProviderName(ConnectionOptions, string)

Sql.IsDistinctFrom<T>(T, T)

Sql.IsNotDistinctFrom<T>(T, T)

SqlExtensions.In<T>(T, T, T, T)

SqlExtensions.In<T>(T, T, T)

SqlExtensions.In<T>(T, params T[])

SqlExtensions.In<T>(T, IEnumerable<T>)

SqlExtensions.In<T>(T, IQueryable<T>)

SqlExtensions.NotIn<T>(T, T, T, T)

SqlExtensions.NotIn<T>(T, T, T)

SqlExtensions.NotIn<T>(T, params T[])

SqlExtensions.NotIn<T>(T, IEnumerable<T>)

SqlExtensions.NotIn<T>(T, IQueryable<T>)

Constructors

ConnectionOptions()

public ConnectionOptions()

ConnectionOptions(string?, string?, IDataProvider?, string?, MappingSchema?, DbConnection?, DbTransaction?, bool, Func<DataOptions, DbConnection>?, Func<ConnectionOptions, IDataProvider>?, ConnectionOptionsConnectionInterceptor?, Action<MappingSchema, IEntityChangeDescriptor>?)

public ConnectionOptions(string? ConfigurationString = null, string? ConnectionString = null, IDataProvider? DataProvider = null, string? ProviderName = null, MappingSchema? MappingSchema = null, DbConnection? DbConnection = null, DbTransaction? DbTransaction = null, bool DisposeConnection = false, Func<DataOptions, DbConnection>? ConnectionFactory = null, Func<ConnectionOptions, IDataProvider>? DataProviderFactory = null, ConnectionOptionsConnectionInterceptor? ConnectionInterceptor = null, Action<MappingSchema, IEntityChangeDescriptor>? OnEntityDescriptorCreated = null)

Parameters

ConfigurationString string

Gets configuration string name to use with DataConnection instance.

ConnectionString string

The connection string, or null if a DbConnection was used instead of a connection string.

DataProvider IDataProvider

Gets optional IDataProvider implementation to use with connection.

ProviderName string

Gets optional provider name to use with DataConnection instance.

MappingSchema MappingSchema

Gets optional MappingSchema instance to use with DataConnection instance.

DbConnection DbConnection

Gets optional DbConnection instance to use with DataConnection instance.

DbTransaction DbTransaction

Gets optional DbTransaction instance to use with DataConnection instance.

DisposeConnection bool

Gets DbConnection ownership status for DataConnection instance. If true, DataConnection will dispose provided connection on own dispose.

ConnectionFactory Func<DataOptions, DbConnection>

Gets connection factory to use with DataConnection instance. Accepts current context DataOptions settings.

DataProviderFactory Func<ConnectionOptions, IDataProvider>

Gets IDataProvider factory to use with DataConnection instance.

ConnectionInterceptor ConnectionOptionsConnectionInterceptor

Connection interceptor to support connection configuration before or right after connection opened.

OnEntityDescriptorCreated Action<MappingSchema, IEntityChangeDescriptor>

Action, called on entity descriptor creation. Allows descriptor modification. When not specified, application-wide callback EntityDescriptorCreatedCallback called.

Properties

ConfigurationString

Gets configuration string name to use with DataConnection instance.

public string? ConfigurationString { get; init; }

Property Value

string

ConnectionFactory

Gets connection factory to use with DataConnection instance. Accepts current context DataOptions settings.

public Func<DataOptions, DbConnection>? ConnectionFactory { get; init; }

Property Value

Func<DataOptions, DbConnection>

ConnectionInterceptor

Connection interceptor to support connection configuration before or right after connection opened.

public ConnectionOptionsConnectionInterceptor? ConnectionInterceptor { get; init; }

Property Value

ConnectionOptionsConnectionInterceptor

ConnectionString

The connection string, or null if a DbConnection was used instead of a connection string.

public string? ConnectionString { get; init; }

Property Value

string

DataProvider

Gets optional IDataProvider implementation to use with connection.

public IDataProvider? DataProvider { get; init; }

Property Value

IDataProvider

DataProviderFactory

Gets IDataProvider factory to use with DataConnection instance.

public Func<ConnectionOptions, IDataProvider>? DataProviderFactory { get; init; }

Property Value

Func<ConnectionOptions, IDataProvider>

DbConnection

Gets optional DbConnection instance to use with DataConnection instance.

public DbConnection? DbConnection { get; init; }

Property Value

DbConnection

DbTransaction

Gets optional DbTransaction instance to use with DataConnection instance.

public DbTransaction? DbTransaction { get; init; }

Property Value

DbTransaction

DisposeConnection

Gets DbConnection ownership status for DataConnection instance. If true, DataConnection will dispose provided connection on own dispose.

public bool DisposeConnection { get; init; }

Property Value

bool

MappingSchema

Gets optional MappingSchema instance to use with DataConnection instance.

public MappingSchema? MappingSchema { get; init; }

Property Value

MappingSchema

OnEntityDescriptorCreated

Action, called on entity descriptor creation. Allows descriptor modification. When not specified, application-wide callback EntityDescriptorCreatedCallback called.

public Action<MappingSchema, IEntityChangeDescriptor>? OnEntityDescriptorCreated { get; init; }

Property Value

Action<MappingSchema, IEntityChangeDescriptor>

ProviderName

Gets optional provider name to use with DataConnection instance.

public string? ProviderName { get; init; }

Property Value

string

Methods

Deconstruct(out string?, out string?, out IDataProvider?, out string?, out MappingSchema?, out DbConnection?, out DbTransaction?, out bool, out Func<DataOptions, DbConnection>?, out Func<ConnectionOptions, IDataProvider>?, out ConnectionOptionsConnectionInterceptor?, out Action<MappingSchema, IEntityChangeDescriptor>?)

public void Deconstruct(out string? ConfigurationString, out string? ConnectionString, out IDataProvider? DataProvider, out string? ProviderName, out MappingSchema? MappingSchema, out DbConnection? DbConnection, out DbTransaction? DbTransaction, out bool DisposeConnection, out Func<DataOptions, DbConnection>? ConnectionFactory, out Func<ConnectionOptions, IDataProvider>? DataProviderFactory, out ConnectionOptionsConnectionInterceptor? ConnectionInterceptor, out Action<MappingSchema, IEntityChangeDescriptor>? OnEntityDescriptorCreated)

Parameters

ConfigurationString string

ConnectionString string

DataProvider IDataProvider

ProviderName string

MappingSchema MappingSchema

DbConnection DbConnection

DbTransaction DbTransaction

DisposeConnection bool

ConnectionFactory Func<DataOptions, DbConnection>

DataProviderFactory Func<ConnectionOptions, IDataProvider>

ConnectionInterceptor ConnectionOptionsConnectionInterceptor

OnEntityDescriptorCreated Action<MappingSchema, IEntityChangeDescriptor>

Equals(ConnectionOptions?)

public bool Equals(ConnectionOptions? other)

Parameters

other ConnectionOptions

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

<Clone>$()

public ConnectionOptions <Clone>$()

Returns

ConnectionOptions

Operators

operator ==(ConnectionOptions?, ConnectionOptions?)

public static bool operator ==(ConnectionOptions? left, ConnectionOptions? right)

Parameters

left ConnectionOptions

right ConnectionOptions

Returns

bool

operator !=(ConnectionOptions?, ConnectionOptions?)

public static bool operator !=(ConnectionOptions? left, ConnectionOptions? right)

Parameters

left ConnectionOptions

right ConnectionOptions

Returns

bool