Class ConnectionOptions

Inheritance

object

ConnectionOptions

Implements

IOptionSet

IConfigurationID

IEquatable<ConnectionOptions>

Namespace: LinqToDB.Data

Assembly: linq2db.dll

Syntax

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

Constructors

ConnectionOptions()

Declaration

public ConnectionOptions()

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

Declaration

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

Type	Name	Description
string	ConfigurationString	Gets configuration string name to use with DataConnection instance.
string	ConnectionString	The connection string, or null if a DbConnection was used instead of a connection string.
IDataProvider	DataProvider	Gets optional IDataProvider implementation to use with connection.
string	ProviderName	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.
bool	DisposeConnection	Gets DbConnection ownership status for DataConnection instance. If true, DataConnection will dispose provided connection on own dispose.
Func<DataOptions, DbConnection>	ConnectionFactory	Gets connection factory to use with DataConnection instance. Accepts current context DataOptions settings.
Func<ConnectionOptions, IDataProvider>	DataProviderFactory	Gets IDataProvider factory to use with DataConnection instance.
ConnectionOptionsConnectionInterceptor	ConnectionInterceptor	Connection interceptor to support connection configuration before or right after connection opened.
Action<MappingSchema, IEntityChangeDescriptor>	OnEntityDescriptorCreated	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.

Declaration

public string? ConfigurationString { get; init; }

Property Value

Type	Description
string

ConnectionFactory

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

Declaration

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

Property Value

Type	Description
Func<DataOptions, DbConnection>

ConnectionInterceptor

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

Declaration

public ConnectionOptionsConnectionInterceptor? ConnectionInterceptor { get; init; }

Property Value

Type	Description
ConnectionOptionsConnectionInterceptor

ConnectionString

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

Declaration

public string? ConnectionString { get; init; }

Property Value

Type	Description
string

DataProvider

Gets optional IDataProvider implementation to use with connection.

Declaration

public IDataProvider? DataProvider { get; init; }

Property Value

Type	Description
IDataProvider

DataProviderFactory

Gets IDataProvider factory to use with DataConnection instance.

Declaration

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

Property Value

Type	Description
Func<ConnectionOptions, IDataProvider>

DbConnection

Gets optional DbConnection instance to use with DataConnection instance.

Declaration

public DbConnection? DbConnection { get; init; }

Property Value

Type	Description
DbConnection

DbTransaction

Gets optional DbTransaction instance to use with DataConnection instance.

Declaration

public DbTransaction? DbTransaction { get; init; }

Property Value

Type	Description
DbTransaction

DisposeConnection

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

Declaration

public bool DisposeConnection { get; init; }

Property Value

Type	Description
bool

MappingSchema

Gets optional MappingSchema instance to use with DataConnection instance.

Declaration

public MappingSchema? MappingSchema { get; init; }

Property Value

Type	Description
MappingSchema

OnEntityDescriptorCreated

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

Declaration

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

Property Value

Type	Description
Action<MappingSchema, IEntityChangeDescriptor>

ProviderName

Gets optional provider name to use with DataConnection instance.

Declaration

public string? ProviderName { get; init; }

Property Value

Type	Description
string

Methods

Equals(ConnectionOptions?)

Declaration

public bool Equals(ConnectionOptions? other)

Parameters

Type	Name	Description
ConnectionOptions	other

Returns

Type	Description
bool

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

Object.GetHashCode()

Implements

IOptionSet

IConfigurationID

System.IEquatable<T>

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)

Map.DeepCopy<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>)