DbConnectionExtensions

Namespace: MJCZone.DapperMatic

Assembly: MJCZone.DapperMatic

Summary

Extension methods for IDbConnection.

static public

Contents

Methods (195)

Methods

Method	Summary
DoesCheckConstraintExistAsync	Checks if a check constraint exists in the specified table.
DoesCheckConstraintExistAsync	Checks if a check constraint exists in the specified table.
DoesCheckConstraintExistOnColumnAsync	Checks if a check constraint exists on the specified column.
DoesCheckConstraintExistOnColumnAsync	Checks if a check constraint exists on the specified column.
CreateCheckConstraintIfNotExistsAsync	Creates a check constraint if it does not exist.
CreateCheckConstraintIfNotExistsAsync	Creates a check constraint if it does not exist.
CreateCheckConstraintIfNotExistsAsync	Creates a check constraint if it does not exist.
GetCheckConstraintAsync	Gets the check constraint with the specified name.
GetCheckConstraintAsync	Gets the check constraint with the specified name.
GetCheckConstraintNameOnColumnAsync	Gets the name of the check constraint on the specified column.
GetCheckConstraintNameOnColumnAsync	Gets the name of the check constraint on the specified column.
GetCheckConstraintNamesAsync	Gets the names of the check constraints in the specified table.
GetCheckConstraintNamesAsync	Gets the names of the check constraints in the specified table.
GetCheckConstraintOnColumnAsync	Gets the check constraint on the specified column.
GetCheckConstraintOnColumnAsync	Gets the check constraint on the specified column.
GetCheckConstraintsAsync	Gets the check constraints in the specified table.
GetCheckConstraintsAsync	Gets the check constraints in the specified table.
DropCheckConstraintIfExistsAsync	Drops the check constraint if it exists.
DropCheckConstraintIfExistsAsync	Drops the check constraint if it exists.
DropCheckConstraintOnColumnIfExistsAsync	Drops the check constraint on the specified column if it exists.
DropCheckConstraintOnColumnIfExistsAsync	Drops the check constraint on the specified column if it exists.
DoesColumnExistAsync	Checks if a column exists in the specified table.
DoesColumnExistAsync	Checks if a column exists in the specified table.
DoesColumnExistAsync	Checks if a column exists in the specified table.
GetColumnAsync	Gets the details of a column in the specified table.
GetColumnAsync	Gets the details of a column in the specified table.
GetColumnAsync	Gets the details of a column in the specified table.
GetColumnNamesAsync	Gets the names of columns in the specified table.
GetColumnNamesAsync	Gets the names of columns in the specified table.
GetColumnsAsync	Gets the details of columns in the specified table.
GetColumnsAsync	Gets the details of columns in the specified table.
CreateColumnIfNotExistsAsync	Creates a column if it does not exist.
CreateColumnIfNotExistsAsync	Creates a column if it does not exist.
CreateColumnIfNotExistsAsync	Creates a column if it does not exist.
CreateColumnIfNotExistsAsync	Creates a column if it does not exist.
CreateColumnIfNotExistsAsync	Creates a column if it does not exist.
CreateColumnIfNotExistsAsync	Creates a column if it does not exist.
DropColumnIfExistsAsync	Drops a column if it exists.
DropColumnIfExistsAsync	Drops a column if it exists.
RenameColumnIfExistsAsync	Renames a column if it exists.
RenameColumnIfExistsAsync	Renames a column if it exists.
RenameColumnIfExistsAsync	Renames a column if it exists.
GetDbProviderType	Gets the DbProviderType of the database connection.
GetDatabaseVersionAsync	Gets the version of the database.
GetProviderTypeMap	Gets the IDbProviderTypeMap of the database connection....
GetDotnetTypeFromSqlType	Gets the .NET type descriptor from the SQL type.
GetSqlTypeFromDotnetType	Gets the SQL type from the .NET type descriptor.
DoesDefaultConstraintExistAsync	Checks if a default constraint exists.
DoesDefaultConstraintExistAsync	Checks if a default constraint exists.
DoesDefaultConstraintExistOnColumnAsync	Checks if a default constraint exists on a column.
DoesDefaultConstraintExistOnColumnAsync	Checks if a default constraint exists on a column.
DoesDefaultConstraintExistOnColumnAsync	Checks if a default constraint exists on a column.
CreateDefaultConstraintIfNotExistsAsync	Creates a default constraint if it does not exist.
CreateDefaultConstraintIfNotExistsAsync	Creates a default constraint if it does not exist.
CreateDefaultConstraintIfNotExistsAsync	Creates a default constraint if it does not exist.
CreateDefaultConstraintIfNotExistsAsync	Creates a default constraint if it does not exist.
GetDefaultConstraintAsync	Gets a default constraint.
GetDefaultConstraintAsync	Gets a default constraint.
GetDefaultConstraintNameOnColumnAsync	Gets the name of the default constraint on a column.
GetDefaultConstraintNameOnColumnAsync	Gets the name of the default constraint on a column.
GetDefaultConstraintNameOnColumnAsync	Gets the name of the default constraint on a column.
GetDefaultConstraintNamesAsync	Gets the names of default constraints.
GetDefaultConstraintNamesAsync	Gets the names of default constraints.
GetDefaultConstraintOnColumnAsync	Gets the default constraint on a column.
GetDefaultConstraintOnColumnAsync	Gets the default constraint on a column.
GetDefaultConstraintOnColumnAsync	Gets the default constraint on a column.
GetDefaultConstraintsAsync	Gets the default constraints.
GetDefaultConstraintsAsync	Gets the default constraints.
DropDefaultConstraintIfExistsAsync	Drops a default constraint if it exists.
DropDefaultConstraintIfExistsAsync	Drops a default constraint if it exists.
DropDefaultConstraintOnColumnIfExistsAsync	Drops a default constraint on a column if it exists.
DropDefaultConstraintOnColumnIfExistsAsync	Drops a default constraint on a column if it exists.
DropDefaultConstraintOnColumnIfExistsAsync	Drops a default constraint on a column if it exists.
DoesForeignKeyConstraintExistOnColumnAsync	Checks if a foreign key constraint exists on a specific column.
DoesForeignKeyConstraintExistOnColumnAsync	Checks if a foreign key constraint exists on a specific column.
DoesForeignKeyConstraintExistOnColumnAsync	Checks if a foreign key constraint exists on a specific column.
DoesForeignKeyConstraintExistAsync	Checks if a foreign key constraint exists.
DoesForeignKeyConstraintExistAsync	Checks if a foreign key constraint exists.
CreateForeignKeyConstraintIfNotExistsAsync	Creates a foreign key constraint if it does not exist.
CreateForeignKeyConstraintIfNotExistsAsync	Creates a foreign key constraint if it does not exist.
CreateForeignKeyConstraintIfNotExistsAsync	Creates a foreign key constraint if it does not exist.
GetForeignKeyConstraintOnColumnAsync	Gets the foreign key constraint on a specific column.
GetForeignKeyConstraintOnColumnAsync	Gets the foreign key constraint on a specific column.
GetForeignKeyConstraintOnColumnAsync	Gets the foreign key constraint on a specific column.
GetForeignKeyConstraintAsync	Gets the foreign key constraint.
GetForeignKeyConstraintAsync	Gets the foreign key constraint.
GetForeignKeyConstraintsAsync	Gets the foreign key constraints.
GetForeignKeyConstraintsAsync	Gets the foreign key constraints.
GetForeignKeyConstraintNameOnColumnAsync	Gets the foreign key constraint name on a specific column.
GetForeignKeyConstraintNameOnColumnAsync	Gets the foreign key constraint name on a specific column.
GetForeignKeyConstraintNameOnColumnAsync	Gets the foreign key constraint name on a specific column.
GetForeignKeyConstraintNamesAsync	Gets the foreign key constraint names.
GetForeignKeyConstraintNamesAsync	Gets the foreign key constraint names.
DropForeignKeyConstraintOnColumnIfExistsAsync	Drops the foreign key constraint on a specific column if it exists.
DropForeignKeyConstraintOnColumnIfExistsAsync	Drops the foreign key constraint on a specific column if it exists.
DropForeignKeyConstraintOnColumnIfExistsAsync	Drops the foreign key constraint on a specific column if it exists.
DropForeignKeyConstraintIfExistsAsync	Drops the foreign key constraint if it exists.
DropForeignKeyConstraintIfExistsAsync	Drops the foreign key constraint if it exists.
DoesIndexExistOnColumnAsync	Checks if an index exists on a specified column.
DoesIndexExistOnColumnAsync	Checks if an index exists on a specified column.
DoesIndexExistOnColumnAsync	Checks if an index exists on a specified column.
DoesIndexExistAsync	Checks if an index exists.
DoesIndexExistAsync	Checks if an index exists.
CreateIndexIfNotExistsAsync	Creates an index if it does not exist.
CreateIndexIfNotExistsAsync	Creates an index if it does not exist.
CreateIndexIfNotExistsAsync	Creates an index if it does not exist.
GetIndexesOnColumnAsync	Gets the indexes on a specified column.
GetIndexesOnColumnAsync	Gets the indexes on a specified column.
GetIndexesOnColumnAsync	Gets the indexes on a specified column.
GetIndexAsync	Gets a specified index.
GetIndexAsync	Gets a specified index.
GetIndexesAsync	Gets the indexes on a specified table.
GetIndexesAsync	Gets the indexes on a specified table.
GetIndexNamesOnColumnAsync	Gets the names of indexes on a specified column.
GetIndexNamesOnColumnAsync	Gets the names of indexes on a specified column.
GetIndexNamesOnColumnAsync	Gets the names of indexes on a specified column.
GetIndexNamesAsync	Gets the names of indexes on a specified table.
GetIndexNamesAsync	Gets the names of indexes on a specified table.
DropIndexesOnColumnIfExistsAsync	Drops indexes on a specified column if they exist.
DropIndexesOnColumnIfExistsAsync	Drops indexes on a specified column if they exist.
DropIndexesOnColumnIfExistsAsync	Drops indexes on a specified column if they exist.
DropIndexIfExistsAsync	Drops a specified index if it exists.
DropIndexIfExistsAsync	Drops a specified index if it exists.
DoesPrimaryKeyConstraintExistAsync	Checks if a primary key constraint exists in the specified table.
DoesPrimaryKeyConstraintExistAsync	Checks if a primary key constraint exists in the specified table.
CreatePrimaryKeyConstraintIfNotExistsAsync	Creates a primary key constraint if it does not exist.
CreatePrimaryKeyConstraintIfNotExistsAsync	Creates a primary key constraint if it does not exist.
CreatePrimaryKeyConstraintIfNotExistsAsync	Creates a primary key constraint if it does not exist.
GetPrimaryKeyConstraintAsync	Gets the primary key constraint for the specified table.
GetPrimaryKeyConstraintAsync	Gets the primary key constraint for the specified table.
DropPrimaryKeyConstraintIfExistsAsync	Drops the primary key constraint if it exists.
DropPrimaryKeyConstraintIfExistsAsync	Drops the primary key constraint if it exists.
SupportsSchemas	Determines whether the database supports schemas.
GetSchemaQualifiedTableName	Gets the schema-qualified table name.
SupportsCheckConstraintsAsync	Determines whether the database supports check constraints asynchronously.
SupportsOrderedKeysInConstraintsAsync	Determines whether the database supports ordered keys in constraints asynchronously.
CreateSchemaIfNotExistsAsync	Creates the schema if it does not exist asynchronously.
DoesSchemaExistAsync	Determines whether the schema exists asynchronously.
GetSchemaNamesAsync	Gets the schema names asynchronously.
DropSchemaIfExistsAsync	Drops the schema if it exists asynchronously.
DoesTableExistAsync	Checks if a table exists in the database.
DoesTableExistAsync	Checks if a table exists in the database.
CreateTablesIfNotExistsAsync	Creates tables if they do not exist.
CreateTablesIfNotExistsAsync	Creates tables if they do not exist.
CreateTableIfNotExistsAsync	Creates a table if it does not exist.
CreateTableIfNotExistsAsync	Creates a table if it does not exist.
CreateTableIfNotExistsAsync	Creates a table if it does not exist.
GetTableAsync	Gets the table definition.
GetTableAsync	Gets the table definition.
GetTablesAsync	Gets the list of table definitions.
GetTableNamesAsync	Gets the list of table names.
DropTableIfExistsAsync	Drops a table if it exists.
DropTableIfExistsAsync	Drops a table if it exists.
RenameTableIfExistsAsync	Renames a table if it exists.
RenameTableIfExistsAsync	Renames a table if it exists.
TruncateTableIfExistsAsync	Truncates a table if it exists.
TruncateTableIfExistsAsync	Truncates a table if it exists.
DoesUniqueConstraintExistOnColumnAsync	Checks if a unique constraint exists on a specified column.
DoesUniqueConstraintExistOnColumnAsync	Checks if a unique constraint exists on a specified column.
DoesUniqueConstraintExistOnColumnAsync	Checks if a unique constraint exists on a specified column.
DoesUniqueConstraintExistAsync	Checks if a unique constraint exists.
DoesUniqueConstraintExistAsync	Checks if a unique constraint exists.
CreateUniqueConstraintIfNotExistsAsync	Creates a unique constraint if it does not exist.
CreateUniqueConstraintIfNotExistsAsync	Creates a unique constraint if it does not exist.
CreateUniqueConstraintIfNotExistsAsync	Creates a unique constraint if it does not exist.
GetUniqueConstraintOnColumnAsync	Gets the unique constraint on a specified column.
GetUniqueConstraintOnColumnAsync	Gets the unique constraint on a specified column.
GetUniqueConstraintOnColumnAsync	Gets the unique constraint on a specified column.
GetUniqueConstraintAsync	Gets the unique constraint.
GetUniqueConstraintAsync	Gets the unique constraint.
GetUniqueConstraintsAsync	Gets the unique constraints.
GetUniqueConstraintsAsync	Gets the unique constraints.
GetUniqueConstraintNameOnColumnAsync	Gets the unique constraint name on a specified column.
GetUniqueConstraintNameOnColumnAsync	Gets the unique constraint name on a specified column.
GetUniqueConstraintNameOnColumnAsync	Gets the unique constraint name on a specified column.
GetUniqueConstraintNamesAsync	Gets the unique constraint names.
GetUniqueConstraintNamesAsync	Gets the unique constraint names.
DropUniqueConstraintOnColumnIfExistsAsync	Drops the unique constraint on a specified column if it exists.
DropUniqueConstraintOnColumnIfExistsAsync	Drops the unique constraint on a specified column if it exists.
DropUniqueConstraintOnColumnIfExistsAsync	Drops the unique constraint on a specified column if it exists.
DropUniqueConstraintIfExistsAsync	Drops the unique constraint if it exists.
DropUniqueConstraintIfExistsAsync	Drops the unique constraint if it exists.
DoesViewExistAsync	Checks if a view exists in the database.
CreateViewIfNotExistsAsync	Creates a view if it does not exist.
CreateViewIfNotExistsAsync	Creates a view if it does not exist.
UpdateViewIfExistsAsync	Updates a view if it exists.
GetViewAsync	Gets a view from the database.
GetViewsAsync	Gets a list of views from the database.
GetViewNamesAsync	Gets a list of view names from the database.
DropViewIfExistsAsync	Drops a view if it exists.
RenameViewIfExistsAsync	Renames a view if it exists.
GetType
ToString
Equals
GetHashCode

---

DoesCheckConstraintExistAsync

Checks if a check constraint exists in the specified table.

Task<bool> DoesCheckConstraintExistAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint exists, otherwise false.

DoesCheckConstraintExistAsync

Checks if a check constraint exists in the specified table.

Task<bool> DoesCheckConstraintExistAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint exists, otherwise false.

DoesCheckConstraintExistOnColumnAsync

Checks if a check constraint exists on the specified column.

Task<bool> DoesCheckConstraintExistOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint exists, otherwise false.

DoesCheckConstraintExistOnColumnAsync

Checks if a check constraint exists on the specified column.

Task<bool> DoesCheckConstraintExistOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint exists, otherwise false.

CreateCheckConstraintIfNotExistsAsync

Creates a check constraint if it does not exist.

Task<bool> CreateCheckConstraintIfNotExistsAsync(
    IDbConnection db,
    DmCheckConstraint constraint,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraint (DmCheckConstraint) - The check constraint.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was created, otherwise false.

CreateCheckConstraintIfNotExistsAsync

Creates a check constraint if it does not exist.

Task<bool> CreateCheckConstraintIfNotExistsAsync(
    IDbConnection db,
    string columnName,
    string constraintName,
    string expression,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• constraintName (string) - The constraint name.
• expression (string) - The constraint expression.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was created, otherwise false.

CreateCheckConstraintIfNotExistsAsync

Creates a check constraint if it does not exist.

Task<bool> CreateCheckConstraintIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    string constraintName,
    string expression,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• constraintName (string) - The constraint name.
• expression (string) - The constraint expression.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was created, otherwise false.

GetCheckConstraintAsync

Gets the check constraint with the specified name.

Task<DmCheckConstraint?> GetCheckConstraintAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmCheckConstraint?>

The check constraint, or null if not found.

GetCheckConstraintAsync

Gets the check constraint with the specified name.

Task<DmCheckConstraint?> GetCheckConstraintAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmCheckConstraint?>

The check constraint, or null if not found.

GetCheckConstraintNameOnColumnAsync

Gets the name of the check constraint on the specified column.

Task<string?> GetCheckConstraintNameOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<string?>

The name of the check constraint, or null if not found.

GetCheckConstraintNameOnColumnAsync

Gets the name of the check constraint on the specified column.

Task<string?> GetCheckConstraintNameOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<string?>

The name of the check constraint, or null if not found.

GetCheckConstraintNamesAsync

Gets the names of the check constraints in the specified table.

Task<List<string>> GetCheckConstraintNamesAsync(
    IDbConnection db,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of check constraint names.

GetCheckConstraintNamesAsync

Gets the names of the check constraints in the specified table.

Task<List<string>> GetCheckConstraintNamesAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of check constraint names.

GetCheckConstraintOnColumnAsync

Gets the check constraint on the specified column.

Task<DmCheckConstraint?> GetCheckConstraintOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmCheckConstraint?>

The check constraint, or null if not found.

GetCheckConstraintOnColumnAsync

Gets the check constraint on the specified column.

Task<DmCheckConstraint?> GetCheckConstraintOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmCheckConstraint?>

The check constraint, or null if not found.

GetCheckConstraintsAsync

Gets the check constraints in the specified table.

Task<List<DmCheckConstraint>> GetCheckConstraintsAsync(
    IDbConnection db,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmCheckConstraint>>

A list of check constraints.

GetCheckConstraintsAsync

Gets the check constraints in the specified table.

Task<List<DmCheckConstraint>> GetCheckConstraintsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmCheckConstraint>>

A list of check constraints.

DropCheckConstraintIfExistsAsync

Drops the check constraint if it exists.

Task<bool> DropCheckConstraintIfExistsAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was dropped, otherwise false.

DropCheckConstraintIfExistsAsync

Drops the check constraint if it exists.

Task<bool> DropCheckConstraintIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was dropped, otherwise false.

DropCheckConstraintOnColumnIfExistsAsync

Drops the check constraint on the specified column if it exists.

Task<bool> DropCheckConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was dropped, otherwise false.

DropCheckConstraintOnColumnIfExistsAsync

Drops the check constraint on the specified column if it exists.

Task<bool> DropCheckConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was dropped, otherwise false.

DoesColumnExistAsync

Checks if a column exists in the specified table.

Task<bool> DoesColumnExistAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column exists, otherwise false.

DoesColumnExistAsync

Checks if a column exists in the specified table.

Task<bool> DoesColumnExistAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - The column expression.
• tx (Object}}) - The transaction to use, or null.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the column exists, otherwise false.

DoesColumnExistAsync

Checks if a column exists in the specified table.

Task<bool> DoesColumnExistAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column exists, otherwise false.

GetColumnAsync

Gets the details of a column in the specified table.

Task<DmColumn?> GetColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmColumn?>

The column details, or null if the column does not exist.

GetColumnAsync

Gets the details of a column in the specified table.

Task<DmColumn?> GetColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction to use, or null.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<DmColumn?>

The column details, or null if the column does not exist.

GetColumnAsync

Gets the details of a column in the specified table.

Task<DmColumn?> GetColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmColumn?>

The column details, or null if the column does not exist.

GetColumnNamesAsync

Gets the names of columns in the specified table.

Task<List<string>> GetColumnNamesAsync(
    IDbConnection db,
    string columnNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnNameFilter (string) - An optional filter for column names.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of column names.

GetColumnNamesAsync

Gets the names of columns in the specified table.

Task<List<string>> GetColumnNamesAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnNameFilter (string) - An optional filter for column names.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of column names.

GetColumnsAsync

Gets the details of columns in the specified table.

Task<List<DmColumn>> GetColumnsAsync(
    IDbConnection db,
    string columnNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnNameFilter (string) - An optional filter for column names.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmColumn>>

A list of column details.

GetColumnsAsync

Gets the details of columns in the specified table.

Task<List<DmColumn>> GetColumnsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnNameFilter (string) - An optional filter for column names.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmColumn>>

A list of column details.

CreateColumnIfNotExistsAsync

Creates a column if it does not exist.

Task<bool> CreateColumnIfNotExistsAsync(
    IDbConnection db,
    DmColumn column,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• column (DmColumn) - The column details.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was created, otherwise false.

CreateColumnIfNotExistsAsync

Creates a column if it does not exist.

Task<bool> CreateColumnIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    Type dotnetType,
    DmColumn} configureColumn,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• dotnetType (Type) - The .NET type of the column.
• configureColumn (DmColumn}) - An optional action to configure the column.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was created, otherwise false.

CreateColumnIfNotExistsAsync

Creates a column if it does not exist.

Task<bool> CreateColumnIfNotExistsAsync(
    IDbConnection db,
    string columnName,
    Type dotnetType,
    DmColumn} configureColumn,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• dotnetType (Type) - The .NET type of the column.
• configureColumn (DmColumn}) - An optional action to configure the column.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was created, otherwise false.

CreateColumnIfNotExistsAsync

Creates a column if it does not exist.

Task<bool> CreateColumnIfNotExistsAsync(
    IDbConnection db,
    string columnName,
    Type dotnetType,
    string providerDataType,
    Int32} length,
    Int32} precision,
    Int32} scale,
    string checkExpression,
    string defaultExpression,
    bool isNullable,
    bool isPrimaryKey,
    bool isAutoIncrement,
    bool isUnique,
    bool isUnicode,
    bool isIndexed,
    bool isForeignKey,
    string referencedTableName,
    string referencedColumnName,
    DmForeignKeyAction} onDelete,
    DmForeignKeyAction} onUpdate,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• dotnetType (Type) - The .NET type of the column.
• providerDataType (string) - The provider-specific data type of the column.
• length (Int32}) - The length of the column.
• precision (Int32}) - The precision of the column.
• scale (Int32}) - The scale of the column.
• checkExpression (string) - The check expression for the column.
• defaultExpression (string) - The default expression for the column.
• isNullable (bool) - Whether the column is nullable.
• isPrimaryKey (bool) - Whether the column is a primary key.
• isAutoIncrement (bool) - Whether the column is auto-incremented.
• isUnique (bool) - Whether the column is unique.
• isUnicode (bool) - Whether the column supports unicode characters.
• isIndexed (bool) - Whether the column is indexed.
• isForeignKey (bool) - Whether the column is a foreign key.
• referencedTableName (string) - The referenced table name for the foreign key.
• referencedColumnName (string) - The referenced column name for the foreign key.
• onDelete (DmForeignKeyAction}) - The action to take on delete.
• onUpdate (DmForeignKeyAction}) - The action to take on update.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was created, otherwise false.

CreateColumnIfNotExistsAsync

Creates a column if it does not exist.

Task<bool> CreateColumnIfNotExistsAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} configureColumn,
    DmColumn} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - The column expression.
• configureColumn (Object}}) - An optional action to configure the column.
• tx (DmColumn}) - The transaction to use, or null.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the column was created, otherwise false.

CreateColumnIfNotExistsAsync

Creates a column if it does not exist.

Task<bool> CreateColumnIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    Type dotnetType,
    string providerDataType,
    Int32} length,
    Int32} precision,
    Int32} scale,
    string checkExpression,
    string defaultExpression,
    bool isNullable,
    bool isPrimaryKey,
    bool isAutoIncrement,
    bool isUnique,
    bool isUnicode,
    bool isIndexed,
    bool isForeignKey,
    string referencedTableName,
    string referencedColumnName,
    DmForeignKeyAction} onDelete,
    DmForeignKeyAction} onUpdate,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• dotnetType (Type) - The .NET type of the column.
• providerDataType (string) - The provider-specific data type of the column.
• length (Int32}) - The length of the column.
• precision (Int32}) - The precision of the column.
• scale (Int32}) - The scale of the column.
• checkExpression (string) - The check expression for the column.
• defaultExpression (string) - The default expression for the column.
• isNullable (bool) - Whether the column is nullable.
• isPrimaryKey (bool) - Whether the column is a primary key.
• isAutoIncrement (bool) - Whether the column is auto-incremented.
• isUnique (bool) - Whether the column is unique.
• isUnicode (bool) - Whether the column supports unicode characters.
• isIndexed (bool) - Whether the column is indexed.
• isForeignKey (bool) - Whether the column is a foreign key.
• referencedTableName (string) - The referenced table name for the foreign key.
• referencedColumnName (string) - The referenced column name for the foreign key.
• onDelete (DmForeignKeyAction}) - The action to take on delete.
• onUpdate (DmForeignKeyAction}) - The action to take on update.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was created, otherwise false.

DropColumnIfExistsAsync

Drops a column if it exists.

Task<bool> DropColumnIfExistsAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was dropped, otherwise false.

DropColumnIfExistsAsync

Drops a column if it exists.

Task<bool> DropColumnIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was dropped, otherwise false.

RenameColumnIfExistsAsync

Renames a column if it exists.

Task<bool> RenameColumnIfExistsAsync(
    IDbConnection db,
    string columnName,
    string newColumnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• newColumnName (string) - The new column name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was renamed, otherwise false.

RenameColumnIfExistsAsync

Renames a column if it exists.

Task<bool> RenameColumnIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    string newColumnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• newColumnName (string) - The new column name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was renamed, otherwise false.

RenameColumnIfExistsAsync

Renames a column if it exists.

Task<bool> RenameColumnIfExistsAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} oldColumnName,
    string tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column that will be renamed.
• oldColumnName (Object}}) - The existing column name that will be renamed.
• tx (string) - The transaction to use, or null.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the column was renamed, otherwise false.

GetDbProviderType

Gets the DbProviderType of the database connection.

DbProviderType GetDbProviderType(IDbConnection db)

Parameters

• db (IDbConnection) - The database connection.

Returns

Type: DbProviderType

The of the database connection.

GetDatabaseVersionAsync

Gets the version of the database.

Task<Version> GetDatabaseVersionAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<Version>

The version of the database.

GetProviderTypeMap

Gets the IDbProviderTypeMap of the database connection.

IDbProviderTypeMap GetProviderTypeMap(IDbConnection db)

Parameters

• db (IDbConnection) - The database connection.

Returns

Type: IDbProviderTypeMap

The of the database connection.

GetDotnetTypeFromSqlType

Gets the .NET type descriptor from the SQL type.

DotnetTypeDescriptor GetDotnetTypeFromSqlType(IDbConnection db, string sqlType)

Parameters

• db (IDbConnection) - The database connection.
• sqlType (string) - The SQL type.

Returns

Type: DotnetTypeDescriptor

The corresponding to the SQL type.

GetSqlTypeFromDotnetType

Gets the SQL type from the .NET type descriptor.

string GetSqlTypeFromDotnetType(
    IDbConnection db,
    DotnetTypeDescriptor descriptor)

Parameters

• db (IDbConnection) - The database connection.
• descriptor (DotnetTypeDescriptor) - The .NET type descriptor.

Returns

Type: string

The SQL type corresponding to the .NET type descriptor.

DoesDefaultConstraintExistAsync

Checks if a default constraint exists.

Task<bool> DoesDefaultConstraintExistAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint exists, otherwise false.

DoesDefaultConstraintExistAsync

Checks if a default constraint exists.

Task<bool> DoesDefaultConstraintExistAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint exists, otherwise false.

DoesDefaultConstraintExistOnColumnAsync

Checks if a default constraint exists on a column.

Task<bool> DoesDefaultConstraintExistOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint exists on the column, otherwise false.

DoesDefaultConstraintExistOnColumnAsync

Checks if a default constraint exists on a column.

Task<bool> DoesDefaultConstraintExistOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint exists on the column, otherwise false.

DoesDefaultConstraintExistOnColumnAsync

Checks if a default constraint exists on a column.

Task<bool> DoesDefaultConstraintExistOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint exists on the column, otherwise false.

CreateDefaultConstraintIfNotExistsAsync

Creates a default constraint if it does not exist.

Task<bool> CreateDefaultConstraintIfNotExistsAsync(
    IDbConnection db,
    DmDefaultConstraint constraint,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraint (DmDefaultConstraint) - The default constraint.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was created, otherwise false.

CreateDefaultConstraintIfNotExistsAsync

Creates a default constraint if it does not exist.

Task<bool> CreateDefaultConstraintIfNotExistsAsync(
    IDbConnection db,
    string columnName,
    string constraintName,
    string expression,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• constraintName (string) - The constraint name.
• expression (string) - The expression.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was created, otherwise false.

CreateDefaultConstraintIfNotExistsAsync

Creates a default constraint if it does not exist.

Task<bool> CreateDefaultConstraintIfNotExistsAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} constraintName,
    string expression,
    string tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• constraintName (Object}}) - The constraint name.
• expression (string) - The expression.
• tx (string) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was created, otherwise false.

CreateDefaultConstraintIfNotExistsAsync

Creates a default constraint if it does not exist.

Task<bool> CreateDefaultConstraintIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    string constraintName,
    string expression,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• constraintName (string) - The constraint name.
• expression (string) - The expression.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was created, otherwise false.

GetDefaultConstraintAsync

Gets a default constraint.

Task<DmDefaultConstraint?> GetDefaultConstraintAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmDefaultConstraint?>

The default constraint.

GetDefaultConstraintAsync

Gets a default constraint.

Task<DmDefaultConstraint?> GetDefaultConstraintAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmDefaultConstraint?>

The default constraint.

GetDefaultConstraintNameOnColumnAsync

Gets the name of the default constraint on a column.

Task<string?> GetDefaultConstraintNameOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<string?>

The name of the default constraint on the column.

GetDefaultConstraintNameOnColumnAsync

Gets the name of the default constraint on a column.

Task<string?> GetDefaultConstraintNameOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<string?>

The name of the default constraint on the column.

GetDefaultConstraintNameOnColumnAsync

Gets the name of the default constraint on a column.

Task<string?> GetDefaultConstraintNameOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<string?>

The name of the default constraint on the column.

GetDefaultConstraintNamesAsync

Gets the names of default constraints.

Task<List<string>> GetDefaultConstraintNamesAsync(
    IDbConnection db,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of default constraint names.

GetDefaultConstraintNamesAsync

Gets the names of default constraints.

Task<List<string>> GetDefaultConstraintNamesAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of default constraint names.

GetDefaultConstraintOnColumnAsync

Gets the default constraint on a column.

Task<DmDefaultConstraint?> GetDefaultConstraintOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmDefaultConstraint?>

The default constraint on the column.

GetDefaultConstraintOnColumnAsync

Gets the default constraint on a column.

Task<DmDefaultConstraint?> GetDefaultConstraintOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<DmDefaultConstraint?>

The default constraint on the column.

GetDefaultConstraintOnColumnAsync

Gets the default constraint on a column.

Task<DmDefaultConstraint?> GetDefaultConstraintOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmDefaultConstraint?>

The default constraint on the column.

GetDefaultConstraintsAsync

Gets the default constraints.

Task<List<DmDefaultConstraint>> GetDefaultConstraintsAsync(
    IDbConnection db,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmDefaultConstraint>>

A list of default constraints.

GetDefaultConstraintsAsync

Gets the default constraints.

Task<List<DmDefaultConstraint>> GetDefaultConstraintsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmDefaultConstraint>>

A list of default constraints.

DropDefaultConstraintIfExistsAsync

Drops a default constraint if it exists.

Task<bool> DropDefaultConstraintIfExistsAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was dropped, otherwise false.

DropDefaultConstraintIfExistsAsync

Drops a default constraint if it exists.

Task<bool> DropDefaultConstraintIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was dropped, otherwise false.

DropDefaultConstraintOnColumnIfExistsAsync

Drops a default constraint on a column if it exists.

Task<bool> DropDefaultConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was dropped, otherwise false.

DropDefaultConstraintOnColumnIfExistsAsync

Drops a default constraint on a column if it exists.

Task<bool> DropDefaultConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was dropped, otherwise false.

DropDefaultConstraintOnColumnIfExistsAsync

Drops a default constraint on a column if it exists.

Task<bool> DropDefaultConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the constraint was dropped, otherwise false.

DoesForeignKeyConstraintExistOnColumnAsync

Checks if a foreign key constraint exists on a specific column.

Task<bool> DoesForeignKeyConstraintExistOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint exists, otherwise false.

DoesForeignKeyConstraintExistOnColumnAsync

Checks if a foreign key constraint exists on a specific column.

Task<bool> DoesForeignKeyConstraintExistOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint exists, otherwise false.

DoesForeignKeyConstraintExistOnColumnAsync

Checks if a foreign key constraint exists on a specific column.

Task<bool> DoesForeignKeyConstraintExistOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint exists, otherwise false.

DoesForeignKeyConstraintExistAsync

Checks if a foreign key constraint exists.

Task<bool> DoesForeignKeyConstraintExistAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint exists, otherwise false.

DoesForeignKeyConstraintExistAsync

Checks if a foreign key constraint exists.

Task<bool> DoesForeignKeyConstraintExistAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint exists, otherwise false.

CreateForeignKeyConstraintIfNotExistsAsync

Creates a foreign key constraint if it does not exist.

Task<bool> CreateForeignKeyConstraintIfNotExistsAsync(
    IDbConnection db,
    DmForeignKeyConstraint constraint,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraint (DmForeignKeyConstraint) - The foreign key constraint.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint was created, otherwise false.

CreateForeignKeyConstraintIfNotExistsAsync

Creates a foreign key constraint if it does not exist.

Task<bool> CreateForeignKeyConstraintIfNotExistsAsync(
    IDbConnection db,
    string constraintName,
    DmOrderedColumn[] sourceColumns,
    string referencedTableName,
    DmOrderedColumn[] referencedColumns,
    DmForeignKeyAction onDelete,
    DmForeignKeyAction onUpdate,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• sourceColumns (DmOrderedColumn[]) - The source columns.
• referencedTableName (string) - The referenced table name.
• referencedColumns (DmOrderedColumn[]) - The referenced columns.
• onDelete (DmForeignKeyAction) - The action on delete.
• onUpdate (DmForeignKeyAction) - The action on update.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint was created, otherwise false.

CreateForeignKeyConstraintIfNotExistsAsync

Creates a foreign key constraint if it does not exist.

Task<bool> CreateForeignKeyConstraintIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    DmOrderedColumn[] sourceColumns,
    string referencedTableName,
    DmOrderedColumn[] referencedColumns,
    DmForeignKeyAction onDelete,
    DmForeignKeyAction onUpdate,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• sourceColumns (DmOrderedColumn[]) - The source columns.
• referencedTableName (string) - The referenced table name.
• referencedColumns (DmOrderedColumn[]) - The referenced columns.
• onDelete (DmForeignKeyAction) - The action on delete.
• onUpdate (DmForeignKeyAction) - The action on update.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint was created, otherwise false.

GetForeignKeyConstraintOnColumnAsync

Gets the foreign key constraint on a specific column.

Task<DmForeignKeyConstraint?> GetForeignKeyConstraintOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmForeignKeyConstraint?>

The foreign key constraint if it exists, otherwise null.

GetForeignKeyConstraintOnColumnAsync

Gets the foreign key constraint on a specific column.

Task<DmForeignKeyConstraint?> GetForeignKeyConstraintOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<DmForeignKeyConstraint?>

The foreign key constraint if it exists, otherwise null.

GetForeignKeyConstraintOnColumnAsync

Gets the foreign key constraint on a specific column.

Task<DmForeignKeyConstraint?> GetForeignKeyConstraintOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmForeignKeyConstraint?>

The foreign key constraint if it exists, otherwise null.

GetForeignKeyConstraintAsync

Gets the foreign key constraint.

Task<DmForeignKeyConstraint?> GetForeignKeyConstraintAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmForeignKeyConstraint?>

The foreign key constraint if it exists, otherwise null.

GetForeignKeyConstraintAsync

Gets the foreign key constraint.

Task<DmForeignKeyConstraint?> GetForeignKeyConstraintAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmForeignKeyConstraint?>

The foreign key constraint if it exists, otherwise null.

GetForeignKeyConstraintsAsync

Gets the foreign key constraints.

Task<List<DmForeignKeyConstraint>> GetForeignKeyConstraintsAsync(
    IDbConnection db,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmForeignKeyConstraint>>

A list of foreign key constraints.

GetForeignKeyConstraintsAsync

Gets the foreign key constraints.

Task<List<DmForeignKeyConstraint>> GetForeignKeyConstraintsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmForeignKeyConstraint>>

A list of foreign key constraints.

GetForeignKeyConstraintNameOnColumnAsync

Gets the foreign key constraint name on a specific column.

Task<string?> GetForeignKeyConstraintNameOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<string?>

The foreign key constraint name if it exists, otherwise null.

GetForeignKeyConstraintNameOnColumnAsync

Gets the foreign key constraint name on a specific column.

Task<string?> GetForeignKeyConstraintNameOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<string?>

The foreign key constraint name if it exists, otherwise null.

GetForeignKeyConstraintNameOnColumnAsync

Gets the foreign key constraint name on a specific column.

Task<string?> GetForeignKeyConstraintNameOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<string?>

The foreign key constraint name if it exists, otherwise null.

GetForeignKeyConstraintNamesAsync

Gets the foreign key constraint names.

Task<List<string>> GetForeignKeyConstraintNamesAsync(
    IDbConnection db,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of foreign key constraint names.

GetForeignKeyConstraintNamesAsync

Gets the foreign key constraint names.

Task<List<string>> GetForeignKeyConstraintNamesAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of foreign key constraint names.

DropForeignKeyConstraintOnColumnIfExistsAsync

Drops the foreign key constraint on a specific column if it exists.

Task<bool> DropForeignKeyConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint was dropped, otherwise false.

DropForeignKeyConstraintOnColumnIfExistsAsync

Drops the foreign key constraint on a specific column if it exists.

Task<bool> DropForeignKeyConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint was dropped, otherwise false.

DropForeignKeyConstraintOnColumnIfExistsAsync

Drops the foreign key constraint on a specific column if it exists.

Task<bool> DropForeignKeyConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint was dropped, otherwise false.

DropForeignKeyConstraintIfExistsAsync

Drops the foreign key constraint if it exists.

Task<bool> DropForeignKeyConstraintIfExistsAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint was dropped, otherwise false.

DropForeignKeyConstraintIfExistsAsync

Drops the foreign key constraint if it exists.

Task<bool> DropForeignKeyConstraintIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the foreign key constraint was dropped, otherwise false.

DoesIndexExistOnColumnAsync

Checks if an index exists on a specified column.

Task<bool> DoesIndexExistOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the index exists, otherwise false.

DoesIndexExistOnColumnAsync

Checks if an index exists on a specified column.

Task<bool> DoesIndexExistOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the index exists, otherwise false.

DoesIndexExistOnColumnAsync

Checks if an index exists on a specified column.

Task<bool> DoesIndexExistOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the index exists, otherwise false.

DoesIndexExistAsync

Checks if an index exists.

Task<bool> DoesIndexExistAsync(
    IDbConnection db,
    string indexName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• indexName (string) - The index name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the index exists, otherwise false.

DoesIndexExistAsync

Checks if an index exists.

Task<bool> DoesIndexExistAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string indexName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• indexName (string) - The index name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the index exists, otherwise false.

CreateIndexIfNotExistsAsync

Creates an index if it does not exist.

Task<bool> CreateIndexIfNotExistsAsync(
    IDbConnection db,
    DmIndex index,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• index (DmIndex) - The index constraint.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the index was created, otherwise false.

CreateIndexIfNotExistsAsync

Creates an index if it does not exist.

Task<bool> CreateIndexIfNotExistsAsync(
    IDbConnection db,
    string indexName,
    DmOrderedColumn[] columns,
    bool isUnique,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• indexName (string) - The index name.
• columns (DmOrderedColumn[]) - The columns in the index.
• isUnique (bool) - Whether the index is unique.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the index was created, otherwise false.

CreateIndexIfNotExistsAsync

Creates an index if it does not exist.

Task<bool> CreateIndexIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string indexName,
    DmOrderedColumn[] columns,
    bool isUnique,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• indexName (string) - The index name.
• columns (DmOrderedColumn[]) - The columns in the index.
• isUnique (bool) - Whether the index is unique.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the index was created, otherwise false.

GetIndexesOnColumnAsync

Gets the indexes on a specified column.

Task<List<DmIndex>> GetIndexesOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmIndex>>

A list of indexes on the column.

GetIndexesOnColumnAsync

Gets the indexes on a specified column.

Task<List<DmIndex>> GetIndexesOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<List<DmIndex>>

A list of indexes on the column.

GetIndexesOnColumnAsync

Gets the indexes on a specified column.

Task<List<DmIndex>> GetIndexesOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmIndex>>

A list of indexes on the column.

GetIndexAsync

Gets a specified index.

Task<DmIndex?> GetIndexAsync(
    IDbConnection db,
    string indexName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• indexName (string) - The index name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmIndex?>

The index if found, otherwise null.

GetIndexAsync

Gets a specified index.

Task<DmIndex?> GetIndexAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string indexName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• indexName (string) - The index name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmIndex?>

The index if found, otherwise null.

GetIndexesAsync

Gets the indexes on a specified table.

Task<List<DmIndex>> GetIndexesAsync(
    IDbConnection db,
    string indexNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• indexNameFilter (string) - The index name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmIndex>>

A list of indexes on the table.

GetIndexesAsync

Gets the indexes on a specified table.

Task<List<DmIndex>> GetIndexesAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string indexNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• indexNameFilter (string) - The index name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmIndex>>

A list of indexes on the table.

GetIndexNamesOnColumnAsync

Gets the names of indexes on a specified column.

Task<List<string>> GetIndexNamesOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of index names on the column.

GetIndexNamesOnColumnAsync

Gets the names of indexes on a specified column.

Task<List<string>> GetIndexNamesOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<List<string>>

A list of index names on the column.

GetIndexNamesOnColumnAsync

Gets the names of indexes on a specified column.

Task<List<string>> GetIndexNamesOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of index names on the column.

GetIndexNamesAsync

Gets the names of indexes on a specified table.

Task<List<string>> GetIndexNamesAsync(
    IDbConnection db,
    string indexNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• indexNameFilter (string) - The index name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of index names on the table.

GetIndexNamesAsync

Gets the names of indexes on a specified table.

Task<List<string>> GetIndexNamesAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string indexNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• indexNameFilter (string) - The index name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of index names on the table.

DropIndexesOnColumnIfExistsAsync

Drops indexes on a specified column if they exist.

Task<bool> DropIndexesOnColumnIfExistsAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the indexes were dropped, otherwise false.

DropIndexesOnColumnIfExistsAsync

Drops indexes on a specified column if they exist.

Task<bool> DropIndexesOnColumnIfExistsAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - An expression representing the column.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

True if the indexes were dropped, otherwise false.

DropIndexesOnColumnIfExistsAsync

Drops indexes on a specified column if they exist.

Task<bool> DropIndexesOnColumnIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the indexes were dropped, otherwise false.

DropIndexIfExistsAsync

Drops a specified index if it exists.

Task<bool> DropIndexIfExistsAsync(
    IDbConnection db,
    string indexName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• indexName (string) - The index name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the index was dropped, otherwise false.

DropIndexIfExistsAsync

Drops a specified index if it exists.

Task<bool> DropIndexIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string indexName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• indexName (string) - The index name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the index was dropped, otherwise false.

DoesPrimaryKeyConstraintExistAsync

Checks if a primary key constraint exists in the specified table.

Task<bool> DoesPrimaryKeyConstraintExistAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the primary key constraint exists, otherwise false.

DoesPrimaryKeyConstraintExistAsync

Checks if a primary key constraint exists in the specified table.

Task<bool> DoesPrimaryKeyConstraintExistAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the primary key constraint exists, otherwise false.

CreatePrimaryKeyConstraintIfNotExistsAsync

Creates a primary key constraint if it does not exist.

Task<bool> CreatePrimaryKeyConstraintIfNotExistsAsync(
    IDbConnection db,
    DmPrimaryKeyConstraint constraint,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraint (DmPrimaryKeyConstraint) - The primary key constraint.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the primary key constraint was created, otherwise false.

CreatePrimaryKeyConstraintIfNotExistsAsync

Creates a primary key constraint if it does not exist.

Task<bool> CreatePrimaryKeyConstraintIfNotExistsAsync(
    IDbConnection db,
    string constraintName,
    DmOrderedColumn[] columns,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• columns (DmOrderedColumn[]) - The columns that make up the primary key.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the primary key constraint was created, otherwise false.

CreatePrimaryKeyConstraintIfNotExistsAsync

Creates a primary key constraint if it does not exist.

Task<bool> CreatePrimaryKeyConstraintIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    DmOrderedColumn[] columns,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• columns (DmOrderedColumn[]) - The columns that make up the primary key.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the primary key constraint was created, otherwise false.

GetPrimaryKeyConstraintAsync

Gets the primary key constraint for the specified table.

Task<DmPrimaryKeyConstraint?> GetPrimaryKeyConstraintAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmPrimaryKeyConstraint?>

The primary key constraint, or null if it does not exist.

GetPrimaryKeyConstraintAsync

Gets the primary key constraint for the specified table.

Task<DmPrimaryKeyConstraint?> GetPrimaryKeyConstraintAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmPrimaryKeyConstraint?>

The primary key constraint, or null if it does not exist.

DropPrimaryKeyConstraintIfExistsAsync

Drops the primary key constraint if it exists.

Task<bool> DropPrimaryKeyConstraintIfExistsAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the primary key constraint was dropped, otherwise false.

DropPrimaryKeyConstraintIfExistsAsync

Drops the primary key constraint if it exists.

Task<bool> DropPrimaryKeyConstraintIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• tx (IDbTransaction) - The transaction to use, or null.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the primary key constraint was dropped, otherwise false.

SupportsSchemas

Determines whether the database supports schemas.

bool SupportsSchemas(IDbConnection db)

Parameters

• db (IDbConnection) - The database connection.

Returns

Type: bool

True if the database supports schemas; otherwise, false.

GetSchemaQualifiedTableName

Gets the schema-qualified table name.

string GetSchemaQualifiedTableName(
    IDbConnection db,
    string schemaName,
    string tableName)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.

Returns

Type: string

The schema-qualified table name.

SupportsCheckConstraintsAsync

Determines whether the database supports check constraints asynchronously.

Task<bool> SupportsCheckConstraintsAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the database supports check constraints; otherwise, false.

SupportsOrderedKeysInConstraintsAsync

Determines whether the database supports ordered keys in constraints asynchronously.

Task<bool> SupportsOrderedKeysInConstraintsAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the database supports ordered keys in constraints; otherwise, false.

CreateSchemaIfNotExistsAsync

Creates the schema if it does not exist asynchronously.

Task<bool> CreateSchemaIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the schema was created; otherwise, false.

DoesSchemaExistAsync

Determines whether the schema exists asynchronously.

Task<bool> DoesSchemaExistAsync(
    IDbConnection db,
    string schemaName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the schema exists; otherwise, false.

GetSchemaNamesAsync

Gets the schema names asynchronously.

Task<List<string>> GetSchemaNamesAsync(
    IDbConnection db,
    string schemaNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaNameFilter (string) - The schema name filter.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of schema names.

DropSchemaIfExistsAsync

Drops the schema if it exists asynchronously.

Task<bool> DropSchemaIfExistsAsync(
    IDbConnection db,
    string schemaName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the schema was dropped; otherwise, false.

DoesTableExistAsync

Checks if a table exists in the database.

Task<bool> DoesTableExistAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table exists, otherwise false.

DoesTableExistAsync

Checks if a table exists in the database.

Task<bool> DoesTableExistAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table exists, otherwise false.

CreateTablesIfNotExistsAsync

Creates tables if they do not exist.

Task CreateTablesIfNotExistsAsync(
    IDbConnection db,
    Type} tables,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tables (Type}) - The table type definitions.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task

A task that represents the asynchronous operation.

CreateTablesIfNotExistsAsync

Creates tables if they do not exist.

Task CreateTablesIfNotExistsAsync(
    IDbConnection db,
    Type} tables,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tables (Type}) - The table type definitions.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task

A task that represents the asynchronous operation.

CreateTableIfNotExistsAsync

Creates a table if it does not exist.

Task<bool> CreateTableIfNotExistsAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table was created, otherwise false.

CreateTableIfNotExistsAsync

Creates a table if it does not exist.

Task<bool> CreateTableIfNotExistsAsync(
    IDbConnection db,
    DmTable table,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• table (DmTable) - The table definition.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table was created, otherwise false.

CreateTableIfNotExistsAsync

Creates a table if it does not exist.

Task<bool> CreateTableIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    DmColumn[] columns,
    DmPrimaryKeyConstraint primaryKey,
    DmCheckConstraint[] checkConstraints,
    DmDefaultConstraint[] defaultConstraints,
    DmUniqueConstraint[] uniqueConstraints,
    DmForeignKeyConstraint[] foreignKeyConstraints,
    DmIndex[] indexes,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columns (DmColumn[]) - The columns of the table.
• primaryKey (DmPrimaryKeyConstraint) - The primary key constraint.
• checkConstraints (DmCheckConstraint[]) - The check constraints.
• defaultConstraints (DmDefaultConstraint[]) - The default constraints.
• uniqueConstraints (DmUniqueConstraint[]) - The unique constraints.
• foreignKeyConstraints (DmForeignKeyConstraint[]) - The foreign key constraints.
• indexes (DmIndex[]) - The indexes.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table was created, otherwise false.

GetTableAsync

Gets the table definition.

Task<DmTable?> GetTableAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmTable?>

The table definition.

GetTableAsync

Gets the table definition.

Task<DmTable?> GetTableAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmTable?>

The table definition.

GetTablesAsync

Gets the list of table definitions.

Task<List<DmTable>> GetTablesAsync(
    IDbConnection db,
    string schemaName,
    string tableNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableNameFilter (string) - The table name filter.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmTable>>

The list of table definitions.

GetTableNamesAsync

Gets the list of table names.

Task<List<string>> GetTableNamesAsync(
    IDbConnection db,
    string schemaName,
    string tableNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableNameFilter (string) - The table name filter.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

The list of table names.

DropTableIfExistsAsync

Drops a table if it exists.

Task<bool> DropTableIfExistsAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table was dropped, otherwise false.

DropTableIfExistsAsync

Drops a table if it exists.

Task<bool> DropTableIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table was dropped, otherwise false.

RenameTableIfExistsAsync

Renames a table if it exists.

Task<bool> RenameTableIfExistsAsync(
    IDbConnection db,
    string oldTableName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• oldTableName (string) - The old table name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table was renamed, otherwise false.

RenameTableIfExistsAsync

Renames a table if it exists.

Task<bool> RenameTableIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string newTableName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• newTableName (string) - The new table name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table was renamed, otherwise false.

TruncateTableIfExistsAsync

Truncates a table if it exists.

Task<bool> TruncateTableIfExistsAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table was truncated, otherwise false.

TruncateTableIfExistsAsync

Truncates a table if it exists.

Task<bool> TruncateTableIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the table was truncated, otherwise false.

DoesUniqueConstraintExistOnColumnAsync

Checks if a unique constraint exists on a specified column.

Task<bool> DoesUniqueConstraintExistOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint exists.

DoesUniqueConstraintExistOnColumnAsync

Checks if a unique constraint exists on a specified column.

Task<bool> DoesUniqueConstraintExistOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - The column expression.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint exists.

DoesUniqueConstraintExistOnColumnAsync

Checks if a unique constraint exists on a specified column.

Task<bool> DoesUniqueConstraintExistOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint exists.

DoesUniqueConstraintExistAsync

Checks if a unique constraint exists.

Task<bool> DoesUniqueConstraintExistAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint exists.

DoesUniqueConstraintExistAsync

Checks if a unique constraint exists.

Task<bool> DoesUniqueConstraintExistAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint exists.

CreateUniqueConstraintIfNotExistsAsync

Creates a unique constraint if it does not exist.

Task<bool> CreateUniqueConstraintIfNotExistsAsync(
    IDbConnection db,
    DmUniqueConstraint constraint,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraint (DmUniqueConstraint) - The unique constraint.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint was created.

CreateUniqueConstraintIfNotExistsAsync

Creates a unique constraint if it does not exist.

Task<bool> CreateUniqueConstraintIfNotExistsAsync(
    IDbConnection db,
    string constraintName,
    DmOrderedColumn[] columns,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• columns (DmOrderedColumn[]) - The columns.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint was created.

CreateUniqueConstraintIfNotExistsAsync

Creates a unique constraint if it does not exist.

Task<bool> CreateUniqueConstraintIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    DmOrderedColumn[] columns,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• columns (DmOrderedColumn[]) - The columns.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint was created.

GetUniqueConstraintOnColumnAsync

Gets the unique constraint on a specified column.

Task<DmUniqueConstraint?> GetUniqueConstraintOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmUniqueConstraint?>

A task that represents the asynchronous operation. The task result contains the unique constraint.

GetUniqueConstraintOnColumnAsync

Gets the unique constraint on a specified column.

Task<DmUniqueConstraint?> GetUniqueConstraintOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - The column expression.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<DmUniqueConstraint?>

A task that represents the asynchronous operation. The task result contains the unique constraint.

GetUniqueConstraintOnColumnAsync

Gets the unique constraint on a specified column.

Task<DmUniqueConstraint?> GetUniqueConstraintOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmUniqueConstraint?>

A task that represents the asynchronous operation. The task result contains the unique constraint.

GetUniqueConstraintAsync

Gets the unique constraint.

Task<DmUniqueConstraint?> GetUniqueConstraintAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmUniqueConstraint?>

A task that represents the asynchronous operation. The task result contains the unique constraint.

GetUniqueConstraintAsync

Gets the unique constraint.

Task<DmUniqueConstraint?> GetUniqueConstraintAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmUniqueConstraint?>

A task that represents the asynchronous operation. The task result contains the unique constraint.

GetUniqueConstraintsAsync

Gets the unique constraints.

Task<List<DmUniqueConstraint>> GetUniqueConstraintsAsync(
    IDbConnection db,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmUniqueConstraint>>

A task that represents the asynchronous operation. The task result contains the list of unique constraints.

GetUniqueConstraintsAsync

Gets the unique constraints.

Task<List<DmUniqueConstraint>> GetUniqueConstraintsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmUniqueConstraint>>

A task that represents the asynchronous operation. The task result contains the list of unique constraints.

GetUniqueConstraintNameOnColumnAsync

Gets the unique constraint name on a specified column.

Task<string?> GetUniqueConstraintNameOnColumnAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<string?>

A task that represents the asynchronous operation. The task result contains the unique constraint name.

GetUniqueConstraintNameOnColumnAsync

Gets the unique constraint name on a specified column.

Task<string?> GetUniqueConstraintNameOnColumnAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - The column expression.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<string?>

A task that represents the asynchronous operation. The task result contains the unique constraint name.

GetUniqueConstraintNameOnColumnAsync

Gets the unique constraint name on a specified column.

Task<string?> GetUniqueConstraintNameOnColumnAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<string?>

A task that represents the asynchronous operation. The task result contains the unique constraint name.

GetUniqueConstraintNamesAsync

Gets the unique constraint names.

Task<List<string>> GetUniqueConstraintNamesAsync(
    IDbConnection db,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A task that represents the asynchronous operation. The task result contains the list of unique constraint names.

GetUniqueConstraintNamesAsync

Gets the unique constraint names.

Task<List<string>> GetUniqueConstraintNamesAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintNameFilter (string) - The constraint name filter.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A task that represents the asynchronous operation. The task result contains the list of unique constraint names.

DropUniqueConstraintOnColumnIfExistsAsync

Drops the unique constraint on a specified column if it exists.

Task<bool> DropUniqueConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint was dropped.

DropUniqueConstraintOnColumnIfExistsAsync

Drops the unique constraint on a specified column if it exists.

Task<bool> DropUniqueConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    Func{``0 columnExpression,
    Object}} tx,
    IDbTransaction cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• columnExpression (Func{``0) - The column expression.
• tx (Object}}) - The transaction.
• cancellationToken (IDbTransaction) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint was dropped.

DropUniqueConstraintOnColumnIfExistsAsync

Drops the unique constraint on a specified column if it exists.

Task<bool> DropUniqueConstraintOnColumnIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• columnName (string) - The column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint was dropped.

DropUniqueConstraintIfExistsAsync

Drops the unique constraint if it exists.

Task<bool> DropUniqueConstraintIfExistsAsync(
    IDbConnection db,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint was dropped.

DropUniqueConstraintIfExistsAsync

Drops the unique constraint if it exists.

Task<bool> DropUniqueConstraintIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• tableName (string) - The table name.
• constraintName (string) - The constraint name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the unique constraint was dropped.

DoesViewExistAsync

Checks if a view exists in the database.

Task<bool> DoesViewExistAsync(
    IDbConnection db,
    string schemaName,
    string viewName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• viewName (string) - The view name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the view exists, otherwise false.

CreateViewIfNotExistsAsync

Creates a view if it does not exist.

Task<bool> CreateViewIfNotExistsAsync(
    IDbConnection db,
    DmView view,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• view (DmView) - The view definition.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the view was created, otherwise false.

CreateViewIfNotExistsAsync

Creates a view if it does not exist.

Task<bool> CreateViewIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string viewName,
    string viewDefinition,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• viewName (string) - The view name.
• viewDefinition (string) - The view definition.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the view was created, otherwise false.

UpdateViewIfExistsAsync

Updates a view if it exists.

Task<bool> UpdateViewIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string viewName,
    string viewDefinition,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• viewName (string) - The view name.
• viewDefinition (string) - The view definition.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the view was updated, otherwise false.

GetViewAsync

Gets a view from the database.

Task<DmView?> GetViewAsync(
    IDbConnection db,
    string schemaName,
    string viewName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• viewName (string) - The view name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<DmView?>

The view if found, otherwise null.

GetViewsAsync

Gets a list of views from the database.

Task<List<DmView>> GetViewsAsync(
    IDbConnection db,
    string schemaName,
    string viewNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• viewNameFilter (string) - The view name filter.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmView>>

A list of views.

GetViewNamesAsync

Gets a list of view names from the database.

Task<List<string>> GetViewNamesAsync(
    IDbConnection db,
    string schemaName,
    string viewNameFilter,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• viewNameFilter (string) - The view name filter.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<string>>

A list of view names.

DropViewIfExistsAsync

Drops a view if it exists.

Task<bool> DropViewIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string viewName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• viewName (string) - The view name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the view was dropped, otherwise false.

RenameViewIfExistsAsync

Renames a view if it exists.

Task<bool> RenameViewIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string viewName,
    string newViewName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• schemaName (string) - The schema name.
• viewName (string) - The current view name.
• newViewName (string) - The new view name.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the view was renamed, otherwise false.

GetType

GetType()

ToString

ToString()

Equals

Equals()

GetHashCode

GetHashCode()