Struct SqlCreateDatabaseOptions

Namespace

LfrlAnvil.Sql

Assembly

LfrlAnvil.Sql.Core.dll

Specifies available ISqlDatabase creation options.

public readonly record struct SqlCreateDatabaseOptions : IEquatable<SqlCreateDatabaseOptions>

Implements

IEquatable<SqlCreateDatabaseOptions>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Fields

CommandTimeout

Specifies IDbCommand timeout for statements ran by the database factory.

public readonly TimeSpan? CommandTimeout

Field Value

TimeSpan?

Default

Represents default options.

public static readonly SqlCreateDatabaseOptions Default

Field Value

SqlCreateDatabaseOptions

Mode

SqlDatabaseCreateMode value that specifies the mode.

public readonly SqlDatabaseCreateMode Mode

Field Value

SqlDatabaseCreateMode

VersionHistoryName

Specifies the name of the table that stores information about applied versions.

public readonly SqlSchemaObjectName? VersionHistoryName

Field Value

SqlSchemaObjectName?

VersionHistoryPersistenceMode

SqlDatabaseVersionHistoryMode value that specifies which versions should be inserted into the version history table.

public readonly SqlDatabaseVersionHistoryMode VersionHistoryPersistenceMode

Field Value

SqlDatabaseVersionHistoryMode

VersionHistoryQueryMode

SqlDatabaseVersionHistoryMode value that specifies which version history records should be read in order to verify and find the next version to be applied.

public readonly SqlDatabaseVersionHistoryMode VersionHistoryQueryMode

Field Value

SqlDatabaseVersionHistoryMode

Methods

AddStatementListener(ISqlDatabaseFactoryStatementListener)

Creates a new SqlCreateDatabaseOptions instance with added ISqlDatabaseFactoryStatementListener instance.

[Pure]
public SqlCreateDatabaseOptions AddStatementListener(ISqlDatabaseFactoryStatementListener listener)

Parameters

listener ISqlDatabaseFactoryStatementListener

Listener to add.

Returns

SqlCreateDatabaseOptions

New SqlCreateDatabaseOptions instance.

GetStatementListeners()

Returns a collection of registered ISqlDatabaseFactoryStatementListener instances.

[Pure]
public ReadOnlySpan<ISqlDatabaseFactoryStatementListener> GetStatementListeners()

Returns

ReadOnlySpan<ISqlDatabaseFactoryStatementListener>

Collection of registered ISqlDatabaseFactoryStatementListener instances.

SetCommandTimeout(TimeSpan?)

Creates a new SqlCreateDatabaseOptions instance with changed CommandTimeout.

[Pure]
public SqlCreateDatabaseOptions SetCommandTimeout(TimeSpan? timeout)

Parameters

timeout TimeSpan?

Value to set.

Returns

SqlCreateDatabaseOptions

New SqlCreateDatabaseOptions instance.

SetMode(SqlDatabaseCreateMode)

Creates a new SqlCreateDatabaseOptions instance with changed Mode.

[Pure]
public SqlCreateDatabaseOptions SetMode(SqlDatabaseCreateMode mode)

Parameters

mode SqlDatabaseCreateMode

Value to set.

Returns

SqlCreateDatabaseOptions

New SqlCreateDatabaseOptions instance.

SetVersionHistoryName(SqlSchemaObjectName?)

Creates a new SqlCreateDatabaseOptions instance with changed VersionHistoryName.

[Pure]
public SqlCreateDatabaseOptions SetVersionHistoryName(SqlSchemaObjectName? name)

Parameters

name SqlSchemaObjectName?

Value to set.

Returns

SqlCreateDatabaseOptions

New SqlCreateDatabaseOptions instance.

SetVersionHistoryPersistenceMode(SqlDatabaseVersionHistoryMode)

Creates a new SqlCreateDatabaseOptions instance with changed VersionHistoryPersistenceMode.

[Pure]
public SqlCreateDatabaseOptions SetVersionHistoryPersistenceMode(SqlDatabaseVersionHistoryMode mode)

Parameters

mode SqlDatabaseVersionHistoryMode

Value to set.

Returns

SqlCreateDatabaseOptions

New SqlCreateDatabaseOptions instance.

SetVersionHistoryQueryMode(SqlDatabaseVersionHistoryMode)

Creates a new SqlCreateDatabaseOptions instance with changed VersionHistoryQueryMode.

[Pure]
public SqlCreateDatabaseOptions SetVersionHistoryQueryMode(SqlDatabaseVersionHistoryMode mode)

Parameters

mode SqlDatabaseVersionHistoryMode

Value to set.

Returns

SqlCreateDatabaseOptions

New SqlCreateDatabaseOptions instance.