MySqlMethods

Namespace: MJCZone.DapperMatic.Providers.MySql

Assembly: MJCZone.DapperMatic

Summary

Provides MySQL specific database methods.

Inheritance

Base Class: DatabaseMethodsBase

Implemented Interfaces:

• IMySqlMethods
• IDatabaseMethods
• IDatabaseTableMethods
• IDatabaseColumnMethods
• IDatabaseIndexMethods
• IDatabaseCheckConstraintMethods
• IDatabaseDefaultConstraintMethods
• IDatabasePrimaryKeyConstraintMethods
• IDatabaseUniqueConstraintMethods
• IDatabaseForeignKeyConstraintMethods
• IDatabaseSchemaMethods
• IDatabaseViewMethods

public

Contents

Methods (109) | Properties (4)

Methods

Method	Summary
RenameColumnIfExistsAsync	Renames a column if it exists in the specified table using version-appropriate MySQL syntax. MySQL 8...
AlterColumnIfExistsAsync	Changes the data type and nullability of a column if it exists, keeping the rest of its definition.
SupportsCheckConstraintsAsync	Checks if the database supports check constraints.
SupportsOrderedKeysInConstraintsAsync	Checks if the database supports ordered keys in constraints.
GetDatabaseVersionAsync	Gets the database version.
GetTablesAsync	Asynchronously retrieves a list of tables from the database.
DoesCheckConstraintExistAsync	Checks if a check constraint exists in the specified table.
DoesCheckConstraintExistOnColumnAsync	Checks if a check constraint exists on a specific column in the specified table.
CreateCheckConstraintIfNotExistsAsync	Creates a check constraint if it does not already exist.
CreateCheckConstraintIfNotExistsAsync	Creates a check constraint if it does not already exist.
GetCheckConstraintAsync	Gets the details of a check constraint.
GetCheckConstraintNameOnColumnAsync	Gets the name of a check constraint on a specific column.
GetCheckConstraintNamesAsync	Gets the names of all check constraints in the specified table.
GetCheckConstraintOnColumnAsync	Gets the details of a check constraint on a specific column.
GetCheckConstraintsAsync	Gets the details of all check constraints in the specified table.
DropCheckConstraintOnColumnIfExistsAsync	Drops a check constraint on a specific column if it exists.
DropCheckConstraintIfExistsAsync	Drops a check constraint if it exists.
RenameCheckConstraintIfExistsAsync	Renames a check constraint if it exists.
DoesColumnExistAsync	Checks if a column exists in the specified table.
CreateColumnIfNotExistsAsync	Creates a column if it does not already exist in the specified table.
CreateColumnIfNotExistsAsync
GetColumnAsync	Retrieves a column from the specified table.
GetColumnNamesAsync	Retrieves the names of columns from the specified table.
GetColumnsAsync	Retrieves columns from the specified table.
DropColumnIfExistsAsync	Drops a column if it exists in the specified table.
AlterColumnIfExistsAsync	Changes the data type and nullability of a column if it exists to match a column definition, with th...
SupportsDefaultConstraintsAsync	Determines whether the provider supports default constraints.
GetDotnetTypeFromSqlType	Gets the .NET type descriptor from the SQL type.
GetSqlTypeFromDotnetType	Gets the SQL type from the .NET type descriptor.
GetSchemaQualifiedIdentifierName	Gets the schema-qualified identifier name.
GetAvailableDataTypes	Gets the available data types for this database provider.
DiscoverCustomDataTypesAsync	Discovers custom data types from the database (e.g., user-defined types, domains, enums).
DoesDefaultConstraintExistAsync	Checks if a default constraint exists in the database.
DoesDefaultConstraintExistOnColumnAsync	Checks if a default constraint exists on a specific column in the database.
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 from the database.
GetDefaultConstraintNameOnColumnAsync	Gets the name of the default constraint on a specific column.
GetDefaultConstraintNamesAsync	Gets the names of all default constraints in the database.
GetDefaultConstraintOnColumnAsync	Gets the default constraint on a specific column.
GetDefaultConstraintsAsync	Gets all default constraints in the database.
DropDefaultConstraintOnColumnIfExistsAsync	Drops the default constraint on a specific column if it exists.
DropDefaultConstraintIfExistsAsync	Drops a default constraint if it exists.
DoesForeignKeyConstraintExistAsync	Checks if a foreign key constraint exists.
DoesForeignKeyConstraintExistOnColumnAsync	Checks if a foreign key constraint exists on a specific column.
CreateForeignKeyConstraintIfNotExistsAsync	Creates a foreign key constraint if it does not exist.
CreateForeignKeyConstraintIfNotExistsAsync	Creates a foreign key constraint if it does not exist.
GetForeignKeyConstraintAsync	Gets a foreign key constraint.
GetForeignKeyConstraintNameOnColumnAsync	Gets the name of the foreign key constraint on a specific column.
GetForeignKeyConstraintNamesAsync	Gets the names of the foreign key constraints.
GetForeignKeyConstraintOnColumnAsync	Gets the foreign key constraint on a specific column.
GetForeignKeyConstraintsAsync	Gets the foreign key constraints.
DropForeignKeyConstraintOnColumnIfExistsAsync	Drops the foreign key constraint on a specific column if it exists.
DropForeignKeyConstraintIfExistsAsync	Drops the foreign key constraint if it exists.
RenameForeignKeyConstraintIfExistsAsync	Renames a foreign key constraint if it exists.
DoesIndexExistAsync	Checks if an index exists in the database.
DoesIndexExistOnColumnAsync	Checks if an index exists on a specific column in the database.
CreateIndexIfNotExistsAsync	Creates an index if it does not already exist.
CreateIndexIfNotExistsAsync	Creates an index if it does not already exist.
GetIndexAsync	Retrieves an index from the database.
GetIndexesAsync	Retrieves a list of indexes from the database.
GetIndexNamesOnColumnAsync	Retrieves a list of index names on a specific column from the database.
GetIndexNamesAsync	Retrieves a list of index names from the database.
GetIndexesOnColumnAsync	Retrieves a list of indexes on a specific column from the database.
DropIndexIfExistsAsync	Drops an index if it exists in the database.
DropIndexesOnColumnIfExistsAsync	Drops indexes on a specific column if they exist in the database.
RenameIndexIfExistsAsync	Renames an index if it exists.
DoesPrimaryKeyConstraintExistAsync	Checks if a primary key constraint exists on the specified table.
CreatePrimaryKeyConstraintIfNotExistsAsync	Creates a primary key constraint if it does not already exist.
CreatePrimaryKeyConstraintIfNotExistsAsync	Creates a primary key constraint if it does not already exist.
GetPrimaryKeyConstraintAsync	Gets the primary key constraint for the specified table.
DropPrimaryKeyConstraintIfExistsAsync	Drops the primary key constraint if it exists.
DoesSchemaExistAsync	Checks if a schema exists in the database.
CreateSchemaIfNotExistsAsync	Creates a schema if it does not exist in the database.
GetSchemaNamesAsync	Retrieves the list of schema names from the database.
DropSchemaIfExistsAsync	Drops a schema if it exists in the database.
DoesTableExistAsync	Checks if a table exists in the database.
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.
GetTableAsync	Gets a table from the database.
GetTableNamesAsync	Gets the names of tables in the database.
DropTableIfExistsAsync	Drops a table if it exists.
RenameTableIfExistsAsync	Renames a table if it exists.
TruncateTableIfExistsAsync	Truncates a table if it exists.
DoesUniqueConstraintExistAsync	Checks if a unique constraint exists in the specified table.
DoesUniqueConstraintExistOnColumnAsync	Checks if a unique constraint exists on the specified column.
CreateUniqueConstraintIfNotExistsAsync	Creates a unique constraint if it does not already exist.
CreateUniqueConstraintIfNotExistsAsync	Creates a unique constraint if it does not already exist.
GetUniqueConstraintAsync	Gets a unique constraint by name.
GetUniqueConstraintNameOnColumnAsync	Gets the name of the unique constraint on the specified column.
GetUniqueConstraintNamesAsync	Gets the names of all unique constraints in the specified table.
GetUniqueConstraintOnColumnAsync	Gets the unique constraint on the specified column.
GetUniqueConstraintsAsync	Gets all unique constraints in the specified table.
DropUniqueConstraintIfExistsAsync	Drops a unique constraint if it exists.
DropUniqueConstraintOnColumnIfExistsAsync	Drops a unique constraint on the specified column if it exists.
RenameUniqueConstraintIfExistsAsync	Renames a 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.
GetViewAsync	Gets a view from the database.
GetViewNamesAsync	Gets the names of views from the database.
GetViewsAsync	Gets views from the database.
DropViewIfExistsAsync	Drops a view if it exists.
RenameViewIfExistsAsync	Renames a view if it exists.
GetType
ToString
Equals
GetHashCode

---

RenameColumnIfExistsAsync

Renames a column if it exists in the specified table using version-appropriate MySQL syntax. MySQL 8.0+ uses RENAME COLUMN, MySQL 5.7 and earlier uses CHANGE syntax.

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 current column name.
• newColumnName (string) - The new column name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column was renamed, otherwise false.

AlterColumnIfExistsAsync

Changes the data type and nullability of a column if it exists, keeping the rest of its definition.

Task<bool> AlterColumnIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string columnName,
    string sqlType,
    bool isNullable,
    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.
• sqlType (string) - The new SQL data type, including any length, precision and scale.
• isNullable (bool) - Whether the column allows nulls afterwards.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<bool>

True if the column exists and now has the given type and nullability, otherwise false.

SupportsCheckConstraintsAsync

Checks if the database supports check constraints.

Task<bool> SupportsCheckConstraintsAsync(
    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>

A task that represents the asynchronous operation. The task result contains a boolean indicating support for check constraints.

SupportsOrderedKeysInConstraintsAsync

Checks if the database supports ordered keys in constraints.

Task<bool> SupportsOrderedKeysInConstraintsAsync(
    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>

A task that represents the asynchronous operation. The task result contains a boolean indicating support for ordered keys in constraints.

GetDatabaseVersionAsync

Gets the database version.

Task<Version> GetDatabaseVersionAsync(
    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<Version>

A task that represents the asynchronous operation. The task result contains the database version.

GetTablesAsync

Asynchronously retrieves a list of tables from the database.

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 database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

Type: Task<List<DmTable>>

A list of tables.

DoesCheckConstraintExistAsync

Checks if a check constraint exists in the specified table.

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

True if the check constraint exists, otherwise false.

DoesCheckConstraintExistOnColumnAsync

Checks if a check constraint exists on a specific column in the specified table.

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

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

CreateCheckConstraintIfNotExistsAsync

Creates a check constraint if it does not already exist.

CreateCheckConstraintIfNotExistsAsync(
    IDbConnection db,
    DmCheckConstraint constraint,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the check constraint was created, otherwise false.

CreateCheckConstraintIfNotExistsAsync

Creates a check constraint if it does not already exist.

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 check constraint expression.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the check constraint was created, otherwise false.

GetCheckConstraintAsync

Gets the details of a check constraint.

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

The check constraint details, or null if not found.

GetCheckConstraintNameOnColumnAsync

Gets the name of a check constraint on a specific column.

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

The check constraint name, or null if not found.

GetCheckConstraintNamesAsync

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

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

A list of check constraint names.

GetCheckConstraintOnColumnAsync

Gets the details of a check constraint on a specific column.

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

The check constraint details, or null if not found.

GetCheckConstraintsAsync

Gets the details of all check constraints in the specified table.

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

A list of check constraint details.

DropCheckConstraintOnColumnIfExistsAsync

Drops a check constraint on a specific column if it exists.

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

True if the check constraint was dropped, otherwise false.

DropCheckConstraintIfExistsAsync

Drops a check constraint if it exists.

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

True if the check constraint was dropped, otherwise false.

RenameCheckConstraintIfExistsAsync

Renames a check constraint if it exists.

RenameCheckConstraintIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    string newConstraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if it was renamed; false if it does not exist, or the new name is already taken.

DoesColumnExistAsync

Checks if a column exists in the specified table.

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 database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the column exists, otherwise false.

CreateColumnIfNotExistsAsync

Creates a column if it does not already exist in the specified table.

CreateColumnIfNotExistsAsync(
    IDbConnection db,
    DmColumn column,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the column was created, otherwise false.

CreateColumnIfNotExistsAsync

CreateColumnIfNotExistsAsync()

GetColumnAsync

Retrieves a column from the specified table.

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 database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

The column definition if found, otherwise null.

GetColumnNamesAsync

Retrieves the names of columns from the specified table.

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) - The column name filter.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A list of column names.

GetColumnsAsync

Retrieves columns from the specified table.

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) - The column name filter.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A list of column definitions.

DropColumnIfExistsAsync

Drops a column if it exists in the specified table.

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 database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the column was dropped, otherwise false.

AlterColumnIfExistsAsync

Changes the data type and nullability of a column if it exists to match a column definition, with the type rendered the same way CREATE TABLE renders it.

AlterColumnIfExistsAsync(
    IDbConnection db,
    DmColumn column,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• column (DmColumn) - The column definition to match.
• tx (IDbTransaction) - The database transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the column exists and now has the definition's type and nullability, otherwise false.

SupportsDefaultConstraintsAsync

Determines whether the provider supports default constraints.

SupportsDefaultConstraintsAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

A task that represents the asynchronous operation. The task result contains a boolean value indicating whether the provider supports default constraints.

GetDotnetTypeFromSqlType

Gets the .NET type descriptor from the SQL type.

GetDotnetTypeFromSqlType(string sqlType)

Parameters

• sqlType (string) - The SQL type.

Returns

The .NET type descriptor.

GetSqlTypeFromDotnetType

Gets the SQL type from the .NET type descriptor.

GetSqlTypeFromDotnetType(DotnetTypeDescriptor descriptor)

Parameters

• descriptor (DotnetTypeDescriptor) - The .NET type descriptor.

Returns

The SQL type.

GetSchemaQualifiedIdentifierName

Gets the schema-qualified identifier name.

GetSchemaQualifiedIdentifierName(string schemaName, string tableName)

Parameters

• schemaName (string) - The schema name.
• tableName (string) - The table name.

Returns

The schema-qualified identifier name.

GetAvailableDataTypes

Gets the available data types for this database provider.

GetAvailableDataTypes(bool includeAdvanced)

Parameters

• includeAdvanced (bool) - If true, includes advanced/specialized types; otherwise, only common types.

Returns

A collection of available data types.

DiscoverCustomDataTypesAsync

Discovers custom data types from the database (e.g., user-defined types, domains, enums).

DiscoverCustomDataTypesAsync(
    IDbConnection db,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

A task that represents the asynchronous operation. The task result contains custom data types.

DoesDefaultConstraintExistAsync

Checks if a default constraint exists in the database.

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

True if the constraint exists, otherwise false.

DoesDefaultConstraintExistOnColumnAsync

Checks if a default constraint exists on a specific column in the database.

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

True if the constraint exists, otherwise false.

CreateDefaultConstraintIfNotExistsAsync

Creates a default constraint if it does not exist.

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

True if the constraint was created, otherwise false.

CreateDefaultConstraintIfNotExistsAsync

Creates a default constraint if it does not exist.

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

True if the constraint was created, otherwise false.

GetDefaultConstraintAsync

Gets a default constraint from the database.

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

The default constraint if found, otherwise null.

GetDefaultConstraintNameOnColumnAsync

Gets the name of the default constraint on a specific column.

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

The name of the default constraint if found, otherwise null.

GetDefaultConstraintNamesAsync

Gets the names of all default constraints in the database.

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

A list of default constraint names.

GetDefaultConstraintOnColumnAsync

Gets the default constraint on a specific column.

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

The default constraint if found, otherwise null.

GetDefaultConstraintsAsync

Gets all default constraints in the database.

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

A list of default constraints.

DropDefaultConstraintOnColumnIfExistsAsync

Drops the default constraint on a specific column if it exists.

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

True if the constraint was dropped, otherwise false.

DropDefaultConstraintIfExistsAsync

Drops a default constraint if it exists.

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

True if the constraint was dropped, otherwise false.

DoesForeignKeyConstraintExistAsync

Checks if a foreign key constraint exists.

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

True if the constraint exists, otherwise false.

DoesForeignKeyConstraintExistOnColumnAsync

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

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

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

CreateForeignKeyConstraintIfNotExistsAsync

Creates a foreign key constraint if it does not exist.

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

True if the constraint was created, otherwise false.

CreateForeignKeyConstraintIfNotExistsAsync

Creates a foreign key constraint if it does not exist.

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 delete action.
• onUpdate (DmForeignKeyAction) - The update action.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the constraint was created, otherwise false.

GetForeignKeyConstraintAsync

Gets a foreign key constraint.

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

The foreign key constraint if found, otherwise null.

GetForeignKeyConstraintNameOnColumnAsync

Gets the name of the foreign key constraint on a specific column.

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

The name of the foreign key constraint if found, otherwise null.

GetForeignKeyConstraintNamesAsync

Gets the names of the foreign key constraints.

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

A list of foreign key constraint names.

GetForeignKeyConstraintOnColumnAsync

Gets the foreign key constraint on a specific column.

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

The foreign key constraint if found, otherwise null.

GetForeignKeyConstraintsAsync

Gets the foreign key constraints.

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

A list of foreign key constraints.

DropForeignKeyConstraintOnColumnIfExistsAsync

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

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

True if the constraint was dropped, otherwise false.

DropForeignKeyConstraintIfExistsAsync

Drops the foreign key constraint if it exists.

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

True if the constraint was dropped, otherwise false.

RenameForeignKeyConstraintIfExistsAsync

Renames a foreign key constraint if it exists.

RenameForeignKeyConstraintIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    string newConstraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if it was renamed; false if it does not exist, or the new name is already taken.

DoesIndexExistAsync

Checks if an index exists in the database.

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

True if the index exists, otherwise false.

DoesIndexExistOnColumnAsync

Checks if an index exists on a specific column in the database.

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

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

CreateIndexIfNotExistsAsync

Creates an index if it does not already exist.

CreateIndexIfNotExistsAsync(
    IDbConnection db,
    DmIndex index,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the index was created, otherwise false.

CreateIndexIfNotExistsAsync

Creates an index if it does not already exist.

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 to include in the index.
• isUnique (bool) - Whether the index is unique.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the index was created, otherwise false.

GetIndexAsync

Retrieves an index from the database.

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

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

GetIndexesAsync

Retrieves a list of indexes from the database.

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) - An optional filter for the index name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A list of indexes.

GetIndexNamesOnColumnAsync

Retrieves a list of index names on a specific column from the database.

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

A list of index names.

GetIndexNamesAsync

Retrieves a list of index names from the database.

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) - An optional filter for the index name.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A list of index names.

GetIndexesOnColumnAsync

Retrieves a list of indexes on a specific column from the database.

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

A list of indexes.

DropIndexIfExistsAsync

Drops an index if it exists in the database.

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

True if the index was dropped, otherwise false.

DropIndexesOnColumnIfExistsAsync

Drops indexes on a specific column if they exist in the database.

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

True if any indexes were dropped, otherwise false.

RenameIndexIfExistsAsync

Renames an index if it exists.

RenameIndexIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string indexName,
    string newIndexName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if it was renamed; false if it does not exist, or the new name is already taken.

DoesPrimaryKeyConstraintExistAsync

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

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

True if the primary key constraint exists, otherwise false.

CreatePrimaryKeyConstraintIfNotExistsAsync

Creates a primary key constraint if it does not already exist.

CreatePrimaryKeyConstraintIfNotExistsAsync(
    IDbConnection db,
    DmPrimaryKeyConstraint constraint,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

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

CreatePrimaryKeyConstraintIfNotExistsAsync

Creates a primary key constraint if it does not already exist.

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

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

GetPrimaryKeyConstraintAsync

Gets the primary key constraint for the specified table.

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

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

DropPrimaryKeyConstraintIfExistsAsync

Drops the primary key constraint if it exists.

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

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

DoesSchemaExistAsync

Checks if a schema exists in the database.

DoesSchemaExistAsync(
    IDbConnection db,
    string schemaName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the schema exists, otherwise false.

CreateSchemaIfNotExistsAsync

Creates a schema if it does not exist in the database.

CreateSchemaIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the schema was created, otherwise false.

GetSchemaNamesAsync

Retrieves the list of schema names from the database.

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

A list of schema names.

DropSchemaIfExistsAsync

Drops a schema if it exists in the database.

DropSchemaIfExistsAsync(
    IDbConnection db,
    string schemaName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the schema was dropped, otherwise false.

DoesTableExistAsync

Checks if a table exists in the database.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the table exists, otherwise false.

CreateTablesIfNotExistsAsync

Creates tables if they do not exist.

CreateTablesIfNotExistsAsync(
    IDbConnection db,
    DmTable[] tables,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

• db (IDbConnection) - The database connection.
• tables (DmTable[]) - The tables to create.
• tx (IDbTransaction) - The transaction.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A task that represents the asynchronous operation.

CreateTableIfNotExistsAsync

Creates a table if it does not exist.

CreateTableIfNotExistsAsync(
    IDbConnection db,
    DmTable table,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the table was created, otherwise false.

CreateTableIfNotExistsAsync

Creates a table if it does not exist.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the table was created, otherwise false.

GetTableAsync

Gets a table from the database.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

The table if found, otherwise null.

GetTableNamesAsync

Gets the names of tables in the database.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A list of table names.

DropTableIfExistsAsync

Drops a table if it exists.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the table was dropped, otherwise false.

RenameTableIfExistsAsync

Renames a table if it exists.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the table was renamed, otherwise false.

TruncateTableIfExistsAsync

Truncates a table if it exists.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the table was truncated, otherwise false.

DoesUniqueConstraintExistAsync

Checks if a unique constraint exists in the specified table.

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 to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the unique constraint exists, otherwise false.

DoesUniqueConstraintExistOnColumnAsync

Checks if a unique constraint exists on the specified column.

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 to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

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

CreateUniqueConstraintIfNotExistsAsync

Creates a unique constraint if it does not already exist.

CreateUniqueConstraintIfNotExistsAsync(
    IDbConnection db,
    DmUniqueConstraint constraint,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the unique constraint was created, otherwise false.

CreateUniqueConstraintIfNotExistsAsync

Creates a unique constraint if it does not already exist.

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 to include in the constraint.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the unique constraint was created, otherwise false.

GetUniqueConstraintAsync

Gets a unique constraint by name.

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 to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

The unique constraint if found, otherwise null.

GetUniqueConstraintNameOnColumnAsync

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

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 to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

The name of the unique constraint if found, otherwise null.

GetUniqueConstraintNamesAsync

Gets the names of all unique constraints in the specified table.

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) - An optional filter for constraint names.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A list of unique constraint names.

GetUniqueConstraintOnColumnAsync

Gets the unique constraint on the specified column.

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 to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

The unique constraint if found, otherwise null.

GetUniqueConstraintsAsync

Gets all unique constraints in the specified table.

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) - An optional filter for constraint names.
• tx (IDbTransaction) - The transaction to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A list of unique constraints.

DropUniqueConstraintIfExistsAsync

Drops a unique constraint if it exists.

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 to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the unique constraint was dropped, otherwise false.

DropUniqueConstraintOnColumnIfExistsAsync

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

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 to use.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the unique constraint was dropped, otherwise false.

RenameUniqueConstraintIfExistsAsync

Renames a unique constraint if it exists.

RenameUniqueConstraintIfExistsAsync(
    IDbConnection db,
    string schemaName,
    string tableName,
    string constraintName,
    string newConstraintName,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if it was renamed; false if it does not exist, or the new name is already taken.

DoesViewExistAsync

Checks if a view exists in the database.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the view exists, otherwise false.

CreateViewIfNotExistsAsync

Creates a view if it does not exist.

CreateViewIfNotExistsAsync(
    IDbConnection db,
    DmView view,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the view was created, otherwise false.

CreateViewIfNotExistsAsync

Creates a view if it does not exist.

CreateViewIfNotExistsAsync(
    IDbConnection db,
    string schemaName,
    string viewName,
    string definition,
    IDbTransaction tx,
    CancellationToken cancellationToken)

Parameters

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

Returns

True if the view was created, otherwise false.

GetViewAsync

Gets a view from the database.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

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

GetViewNamesAsync

Gets the names of views from the database.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A list of view names.

GetViewsAsync

Gets views from the database.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

A list of views.

DropViewIfExistsAsync

Drops a view if it exists.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the view was dropped, otherwise false.

RenameViewIfExistsAsync

Renames a view if it exists.

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.
• cancellationToken (CancellationToken) - The cancellation token.

Returns

True if the view was renamed, otherwise false.

GetType

GetType()

ToString

ToString()

Equals

Equals()

GetHashCode

GetHashCode()

Properties

QuoteChars

Gets the characters used for quoting identifiers.

Type: char[]

ProviderType

Type: object

ProviderTypeMap

Type: object

SupportsSchemas

Gets a value indicating whether the provider supports schemas.

Type: object