DapperMatic

Appearance

DapperMaticService ​

Namespace: MJCZone.DapperMatic.AspNetCore.Services

Assembly: MJCZone.DapperMatic.AspNetCore

Summary ​

What one caller may use of a datasource: the shape every description of it is built from (the caller's OpenAPI document, their GraphQL schema).

Inheritance ​

Implemented Interfaces:

public

Contents ​

Constructors (2) | Methods (70)

Constructors ​

DapperMaticService ​

Initializes a new instance of the DapperMaticService class.

csharp
DapperMaticService(
    IDapperMaticDatasourceRepository datasourceRepository,
    IDbConnectionFactory connectionFactory,
    IDapperMaticPermissions permissions,
    IDapperMaticAuditLogger auditLogger)

Parameters ​

DapperMaticService ​

Initializes a new instance of the DapperMaticService class, with the options that declare the relations query requests may follow and the limits on what they may ask for.

csharp
DapperMaticService(
    IDapperMaticDatasourceRepository datasourceRepository,
    IDbConnectionFactory connectionFactory,
    IDapperMaticPermissions permissions,
    IDapperMaticAuditLogger auditLogger,
    DapperMaticOptions} options,
    DapperMaticSchemaCache schemaCache,
    DapperMaticPolicySet policies,
    DapperMaticResultCache resultCache,
    DapperMaticChangeLog changeLog,
    DapperMaticRealtimeHub hub,
    DapperMaticCallerModelCache callerModels)

Parameters ​

Methods ​

MethodSummary
GetCheckConstraintsAsyncGets all check constraints for a table.
GetCheckConstraintAsyncGets a specific check constraint from a table.
CreateCheckConstraintAsyncCreates a check constraint on a table.
DropCheckConstraintAsyncDrops a check constraint from a table.
GetColumnsAsyncGets all columns from the specified table.
GetColumnAsyncGets a specific column from the table.
AddColumnAsyncAdds a new column to an existing table.
RenameColumnAsyncUpdates an existing column in a table.
DropColumnAsyncDrops a column from an existing table.
GetDatasourcesAsyncGets all registered datasources.
GetDatasourceAsyncGets datasource information by name.
AddDatasourceAsyncAdds a new datasource.
UpdateDatasourceAsyncUpdates an existing datasource.
RemoveDatasourceAsyncRemoves a datasource.
DatasourceExistsAsyncChecks if a datasource exists.
TestDatasourceAsyncTests the connection to a datasource.
GetDatasourceDataTypesAsync
GetDefaultConstraintsAsyncGets all default constraints from the specified table.
GetDefaultConstraintAsyncGets a specific default constraint from the table.
GetDefaultConstraintOnColumnAsyncGets a specific default constraint from a table for a column.
CreateDefaultConstraintAsyncCreates a new default constraint on a table.
DropDefaultConstraintAsyncDrops a default constraint from a table.
DropDefaultConstraintOnColumnAsyncDrops a column default constraint from a table.
GetForeignKeyConstraintsAsyncGets all foreign key constraints from the specified table.
GetForeignKeyConstraintAsyncGets a specific foreign key constraint from the table.
CreateForeignKeyConstraintAsyncCreates a new foreign key constraint on a table.
DropForeignKeyConstraintAsyncDrops a foreign key constraint from a table.
ExecuteFunctionAsync
GetIndexesAsyncGets all indexes from the specified table.
GetIndexAsyncGets a specific index from the table.
CreateIndexAsyncCreates a new index on a table.
DropIndexAsyncDrops an index from a table.
GetOpenApiDocumentAsync
GetPrimaryKeyConstraintAsyncGets the primary key constraint for a table.
CreatePrimaryKeyConstraintAsyncCreates a new primary key constraint on a table.
DropPrimaryKeyConstraintAsyncDrops the primary key constraint from a table.
InsertTableRowsAsync
UpdateTableRowsAsync
DeleteTableRowsAsync
SaveTableRowsAsync
BatchAsync
GetSchemasAsync
GetSchemaAsync
CreateSchemaAsync
DropSchemaAsync
SchemaExistsAsync
GetTablesAsyncGets all tables from the specified datasource.
GetTableAsyncGets a specific table from the datasource.
CreateTableAsyncCreates a new table in the datasource.
UpdateTableAsyncUpdates an existing table in the datasource.
RenameTableAsyncRenames an existing table in the datasource.
DropTableAsyncDrops a table from the datasource.
TableExistsAsyncChecks if a table exists in the datasource.
QueryTableAsyncQueries a table with filtering, sorting, and pagination.
GetUniqueConstraintsAsyncGets all unique constraints from the specified table.
GetUniqueConstraintAsyncGets a specific unique constraint from the table.
CreateUniqueConstraintAsyncCreates a new unique constraint on a table.
DropUniqueConstraintAsyncDrops a unique constraint from a table.
GetViewsAsyncGets all views from the specified datasource.
GetViewAsyncGets a specific view from the datasource.
CreateViewAsyncCreates a new view in the datasource.
UpdateViewAsyncUpdates an existing view's properties in the datasource.
RenameViewAsyncRenames an existing view in the datasource.
DropViewAsyncDrops a view from the datasource.
ViewExistsAsyncChecks if a view exists in the datasource.
QueryViewAsyncQueries a view with filtering, sorting, and pagination.
GetType
ToString
Equals
GetHashCode

GetCheckConstraintsAsync ​

Gets all check constraints for a table.

csharp
Task<IEnumerable<CheckConstraintDto>> GetCheckConstraintsAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IEnumerable<CheckConstraintDto>>

List of check constraints for the table.

GetCheckConstraintAsync ​

Gets a specific check constraint from a table.

csharp
Task&lt;CheckConstraintDto&gt; GetCheckConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string constraintName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • constraintName (string) - The constraint name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<CheckConstraintDto>

The check constraint if found.

CreateCheckConstraintAsync ​

Creates a check constraint on a table.

csharp
Task&lt;CheckConstraintDto&gt; CreateCheckConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    CheckConstraintDto checkConstraint,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • checkConstraint (CheckConstraintDto) - The create check constraint request.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<CheckConstraintDto>

The created check constraint.

DropCheckConstraintAsync ​

Drops a check constraint from a table.

csharp
Task DropCheckConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string constraintName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • constraintName (string) - The constraint name to drop.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

Task representing the asynchronous operation.

GetColumnsAsync ​

Gets all columns from the specified table.

csharp
Task&lt;IEnumerable&lt;ColumnDto&gt;&gt; GetColumnsAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IEnumerable<ColumnDto>>

A collection of columns.

GetColumnAsync ​

Gets a specific column from the table.

csharp
Task&lt;ColumnDto&gt; GetColumnAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string columnName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • columnName (string) - The column name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<ColumnDto>

The column if found, otherwise null.

AddColumnAsync ​

Adds a new column to an existing table.

csharp
Task&lt;ColumnDto&gt; AddColumnAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    ColumnDto column,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • column (ColumnDto) - The add column request.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<ColumnDto>

The added column information if successful, otherwise null.

RenameColumnAsync ​

Updates an existing column in a table.

csharp
Task&lt;ColumnDto&gt; RenameColumnAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string columnName,
    string newColumnName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • columnName (string) - The column name to update.
  • newColumnName (string) - The new column name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<ColumnDto>

The updated column information if successful, otherwise null.

DropColumnAsync ​

Drops a column from an existing table.

csharp
Task DropColumnAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string columnName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • columnName (string) - The column name to drop.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

True if the column was dropped, false if it didn't exist.

GetDatasourcesAsync ​

Gets all registered datasources.

csharp
Task&lt;IEnumerable&lt;DatasourceDto&gt;&gt; GetDatasourcesAsync(
    DapperMaticOperation context,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • cancellationToken (CancellationToken) - Cancellation token.

Returns ​

Type: Task<IEnumerable<DatasourceDto>>

List of datasource information.

GetDatasourceAsync ​

Gets datasource information by name.

csharp
Task&lt;DatasourceDto&gt; GetDatasourceAsync(
    DapperMaticOperation context,
    string datasourceId,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The id of the datasource.
  • cancellationToken (CancellationToken) - Cancellation token.

Returns ​

Type: Task<DatasourceDto>

The datasource information.

AddDatasourceAsync ​

Adds a new datasource.

csharp
Task&lt;DatasourceDto&gt; AddDatasourceAsync(
    DapperMaticOperation context,
    DatasourceDto datasource,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasource (DatasourceDto) - The datasource to add.
  • cancellationToken (CancellationToken) - Cancellation token.

Returns ​

Type: Task<DatasourceDto>

The added datasource if successful.

UpdateDatasourceAsync ​

Updates an existing datasource.

csharp
Task&lt;DatasourceDto&gt; UpdateDatasourceAsync(
    DapperMaticOperation context,
    DatasourceDto datasource,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasource (DatasourceDto) - The updated datasource information.
  • cancellationToken (CancellationToken) - Cancellation token.

Returns ​

Type: Task<DatasourceDto>

The updated datasource.

RemoveDatasourceAsync ​

Removes a datasource.

csharp
Task RemoveDatasourceAsync(
    DapperMaticOperation context,
    string datasourceId,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The id of the datasource to remove.
  • cancellationToken (CancellationToken) - Cancellation token.

Returns ​

Type: Task

Task representing the asynchronous operation.

DatasourceExistsAsync ​

Checks if a datasource exists.

csharp
Task&lt;bool&gt; DatasourceExistsAsync(
    DapperMaticOperation context,
    string datasourceId,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The id of the datasource to check.
  • cancellationToken (CancellationToken) - Cancellation token.

Returns ​

Type: Task&lt;bool&gt;

True if the datasource exists, false otherwise.

TestDatasourceAsync ​

Tests the connection to a datasource.

csharp
Task&lt;DatasourceConnectivityTestDto&gt; TestDatasourceAsync(
    DapperMaticOperation context,
    string datasourceId,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The id of the datasource to test.
  • cancellationToken (CancellationToken) - Cancellation token.

Returns ​

Type: Task<DatasourceConnectivityTestDto>

Test result containing connection status and details.

GetDatasourceDataTypesAsync ​

csharp
Task&lt;(string, List&lt;DataTypeInfo&gt;)&gt; GetDatasourceDataTypesAsync()

Returns ​

Type: Task<(string, List<DataTypeInfo>)>

GetDefaultConstraintsAsync ​

Gets all default constraints from the specified table.

csharp
Task&lt;IEnumerable&lt;DefaultConstraintDto&gt;&gt; GetDefaultConstraintsAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IEnumerable<DefaultConstraintDto>>

A collection of default constraints.

GetDefaultConstraintAsync ​

Gets a specific default constraint from the table.

csharp
Task&lt;DefaultConstraintDto&gt; GetDefaultConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string constraintName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • constraintName (string) - The name of the constraint.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<DefaultConstraintDto>

The default constraint or null if not found.

GetDefaultConstraintOnColumnAsync ​

Gets a specific default constraint from a table for a column.

csharp
Task&lt;DefaultConstraintDto&gt; GetDefaultConstraintOnColumnAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string columnName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • columnName (string) - The column name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<DefaultConstraintDto>

The default constraint if found, otherwise null.

CreateDefaultConstraintAsync ​

Creates a new default constraint on a table.

csharp
Task&lt;DefaultConstraintDto&gt; CreateDefaultConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    DefaultConstraintDto defaultConstraint,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • defaultConstraint (DefaultConstraintDto) - The default constraint details.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<DefaultConstraintDto>

The created default constraint.

DropDefaultConstraintAsync ​

Drops a default constraint from a table.

csharp
Task DropDefaultConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string constraintName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • constraintName (string) - The name of the constraint.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

A task representing the asynchronous operation.

DropDefaultConstraintOnColumnAsync ​

Drops a column default constraint from a table.

csharp
Task DropDefaultConstraintOnColumnAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string columnName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • columnName (string) - The column name to drop the constraint from.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

Task representing the asynchronous operation.

GetForeignKeyConstraintsAsync ​

Gets all foreign key constraints from the specified table.

csharp
Task&lt;IEnumerable&lt;ForeignKeyConstraintDto&gt;&gt; GetForeignKeyConstraintsAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IEnumerable<ForeignKeyConstraintDto>>

A collection of foreign key constraints.

GetForeignKeyConstraintAsync ​

Gets a specific foreign key constraint from the table.

csharp
Task&lt;ForeignKeyConstraintDto&gt; GetForeignKeyConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string constraintName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • constraintName (string) - The name of the constraint.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<ForeignKeyConstraintDto>

The foreign key constraint or null if not found.

CreateForeignKeyConstraintAsync ​

Creates a new foreign key constraint on a table.

csharp
Task&lt;ForeignKeyConstraintDto&gt; CreateForeignKeyConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    ForeignKeyConstraintDto foreignKeyConstraint,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • foreignKeyConstraint (ForeignKeyConstraintDto) - The foreign key constraint details.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<ForeignKeyConstraintDto>

The created foreign key constraint.

DropForeignKeyConstraintAsync ​

Drops a foreign key constraint from a table.

csharp
Task DropForeignKeyConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string constraintName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • constraintName (string) - The name of the constraint.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

A task representing the asynchronous operation.

ExecuteFunctionAsync ​

csharp
Task&lt;FunctionResponse&gt; ExecuteFunctionAsync()

Returns ​

Type: Task<FunctionResponse>

GetIndexesAsync ​

Gets all indexes from the specified table.

csharp
Task&lt;IEnumerable&lt;IndexDto&gt;&gt; GetIndexesAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IEnumerable<IndexDto>>

A collection of indexes.

GetIndexAsync ​

Gets a specific index from the table.

csharp
Task&lt;IndexDto&gt; GetIndexAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string indexName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • indexName (string) - The index name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IndexDto>

The index if found, otherwise null.

CreateIndexAsync ​

Creates a new index on a table.

csharp
Task&lt;IndexDto&gt; CreateIndexAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    IndexDto index,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • index (IndexDto) - The index details.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IndexDto>

The created index.

DropIndexAsync ​

Drops an index from a table.

csharp
Task DropIndexAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string indexName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • indexName (string) - The index name to drop.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

A task representing the asynchronous operation.

GetOpenApiDocumentAsync ​

csharp
Task&lt;JsonObject&gt; GetOpenApiDocumentAsync()

Returns ​

Type: Task&lt;JsonObject&gt;

GetPrimaryKeyConstraintAsync ​

Gets the primary key constraint for a table.

csharp
Task&lt;PrimaryKeyConstraintDto?&gt; GetPrimaryKeyConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<PrimaryKeyConstraintDto?>

The primary key constraint or null if the table does not have a primary key.

CreatePrimaryKeyConstraintAsync ​

Creates a new primary key constraint on a table.

csharp
Task&lt;PrimaryKeyConstraintDto&gt; CreatePrimaryKeyConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    PrimaryKeyConstraintDto primaryKeyConstraint,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • primaryKeyConstraint (PrimaryKeyConstraintDto) - The primary key constraint details.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<PrimaryKeyConstraintDto>

The created primary key constraint.

DropPrimaryKeyConstraintAsync ​

Drops the primary key constraint from a table.

csharp
Task DropPrimaryKeyConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

A task representing the asynchronous operation.

InsertTableRowsAsync ​

csharp
Task&lt;int&gt; InsertTableRowsAsync()

Returns ​

Type: Task&lt;int&gt;

UpdateTableRowsAsync ​

csharp
Task&lt;int&gt; UpdateTableRowsAsync()

Returns ​

Type: Task&lt;int&gt;

DeleteTableRowsAsync ​

csharp
Task&lt;int&gt; DeleteTableRowsAsync()

Returns ​

Type: Task&lt;int&gt;

SaveTableRowsAsync ​

csharp
Task&lt;RowsResponse&gt; SaveTableRowsAsync()

Returns ​

Type: Task<RowsResponse>

BatchAsync ​

csharp
Task&lt;BatchResponse&gt; BatchAsync()

Returns ​

Type: Task<BatchResponse>

GetSchemasAsync ​

csharp
Task&lt;IEnumerable&lt;SchemaDto&gt;&gt; GetSchemasAsync()

Returns ​

Type: Task<IEnumerable<SchemaDto>>

GetSchemaAsync ​

csharp
Task&lt;SchemaDto&gt; GetSchemaAsync()

Returns ​

Type: Task<SchemaDto>

CreateSchemaAsync ​

csharp
Task&lt;SchemaDto&gt; CreateSchemaAsync()

Returns ​

Type: Task<SchemaDto>

DropSchemaAsync ​

csharp
Task DropSchemaAsync()

Returns ​

Type: Task

SchemaExistsAsync ​

csharp
Task&lt;bool&gt; SchemaExistsAsync()

Returns ​

Type: Task&lt;bool&gt;

GetTablesAsync ​

Gets all tables from the specified datasource.

csharp
Task&lt;IEnumerable&lt;TableDto&gt;&gt; GetTablesAsync(
    DapperMaticOperation context,
    string datasourceId,
    string schemaName,
    bool includeColumns,
    bool includeIndexes,
    bool includeConstraints,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • schemaName (string) - Optional schema name filter.
  • includeColumns (bool) - Whether to include column information.
  • includeIndexes (bool) - Whether to include index information.
  • includeConstraints (bool) - Whether to include constraint information.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IEnumerable<TableDto>>

A collection of tables.

GetTableAsync ​

Gets a specific table from the datasource.

csharp
Task&lt;TableDto&gt; GetTableAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    bool includeColumns,
    bool includeIndexes,
    bool includeConstraints,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • schemaName (string) - Optional schema name.
  • includeColumns (bool) - Whether to include column information.
  • includeIndexes (bool) - Whether to include index information.
  • includeConstraints (bool) - Whether to include constraint information.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<TableDto>

The table.

CreateTableAsync ​

Creates a new table in the datasource.

csharp
Task&lt;TableDto&gt; CreateTableAsync(
    DapperMaticOperation context,
    string datasourceId,
    TableDto table,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • table (TableDto) - The table information.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<TableDto>

The created table.

UpdateTableAsync ​

Updates an existing table in the datasource.

csharp
Task&lt;TableDto&gt; UpdateTableAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    TableDto updates,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The name of the table to update.
  • updates (TableDto) - The table updates.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<TableDto>

The updated table.

RenameTableAsync ​

Renames an existing table in the datasource.

csharp
Task&lt;TableDto&gt; RenameTableAsync(
    DapperMaticOperation context,
    string datasourceId,
    string currentTableName,
    string newTableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • currentTableName (string) - The current name of the table.
  • newTableName (string) - The new name for the table.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<TableDto>

The renamed table.

DropTableAsync ​

Drops a table from the datasource.

csharp
Task DropTableAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The name of the table to drop.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

A task representing the asynchronous operation.

TableExistsAsync ​

Checks if a table exists in the datasource.

csharp
Task&lt;bool&gt; TableExistsAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task&lt;bool&gt;

True if the table exists, otherwise false.

QueryTableAsync ​

Queries a table with filtering, sorting, and pagination.

csharp
Task&lt;QueryResultDto&gt; QueryTableAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    QueryDto request,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • tableName (string) - The table name to query.
  • request (QueryDto) - The query parameters.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<QueryResultDto>

The query results with pagination information.

GetUniqueConstraintsAsync ​

Gets all unique constraints from the specified table.

csharp
Task&lt;IEnumerable&lt;UniqueConstraintDto&gt;&gt; GetUniqueConstraintsAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IEnumerable<UniqueConstraintDto>>

A collection of unique constraints.

GetUniqueConstraintAsync ​

Gets a specific unique constraint from the table.

csharp
Task&lt;UniqueConstraintDto&gt; GetUniqueConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string constraintName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • constraintName (string) - The name of the constraint.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<UniqueConstraintDto>

The unique constraint or null if not found.

CreateUniqueConstraintAsync ​

Creates a new unique constraint on a table.

csharp
Task&lt;UniqueConstraintDto&gt; CreateUniqueConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    UniqueConstraintDto uniqueConstraint,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • uniqueConstraint (UniqueConstraintDto) - The request containing unique constraint details.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<UniqueConstraintDto>

The created unique constraint or null if creation failed.

DropUniqueConstraintAsync ​

Drops a unique constraint from a table.

csharp
Task DropUniqueConstraintAsync(
    DapperMaticOperation context,
    string datasourceId,
    string tableName,
    string constraintName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The ID of the datasource.
  • tableName (string) - The name of the table.
  • constraintName (string) - The name of the constraint.
  • schemaName (string) - The schema name (optional).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

True if the unique constraint was dropped successfully, false otherwise.

GetViewsAsync ​

Gets all views from the specified datasource.

csharp
Task&lt;IEnumerable&lt;ViewDto&gt;&gt; GetViewsAsync(
    DapperMaticOperation context,
    string datasourceId,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • schemaName (string) - Optional schema name filter.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<IEnumerable<ViewDto>>

A collection of views.

GetViewAsync ​

Gets a specific view from the datasource.

csharp
Task&lt;ViewDto&gt; GetViewAsync(
    DapperMaticOperation context,
    string datasourceId,
    string viewName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • viewName (string) - The view name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<ViewDto>

The view.

CreateViewAsync ​

Creates a new view in the datasource.

csharp
Task&lt;ViewDto&gt; CreateViewAsync(
    DapperMaticOperation context,
    string datasourceId,
    ViewDto view,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • view (ViewDto) - The view data transfer object containing the view information.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<ViewDto>

The created view.

UpdateViewAsync ​

Updates an existing view's properties in the datasource.

csharp
Task&lt;ViewDto&gt; UpdateViewAsync(
    DapperMaticOperation context,
    string datasourceId,
    string viewName,
    ViewDto updates,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • viewName (string) - The name of the view to update.
  • updates (ViewDto) - The view updates (only non-null properties will be updated).
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<ViewDto>

The updated view.

RenameViewAsync ​

Renames an existing view in the datasource.

csharp
Task&lt;ViewDto&gt; RenameViewAsync(
    DapperMaticOperation context,
    string datasourceId,
    string currentViewName,
    string newViewName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • currentViewName (string) - The current name of the view.
  • newViewName (string) - The new name for the view.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<ViewDto>

The renamed view.

DropViewAsync ​

Drops a view from the datasource.

csharp
Task DropViewAsync(
    DapperMaticOperation context,
    string datasourceId,
    string viewName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • viewName (string) - The name of the view to drop.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task

A task representing the asynchronous operation.

ViewExistsAsync ​

Checks if a view exists in the datasource.

csharp
Task&lt;bool&gt; ViewExistsAsync(
    DapperMaticOperation context,
    string datasourceId,
    string viewName,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • viewName (string) - The view name.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task&lt;bool&gt;

True if the view exists, otherwise false.

QueryViewAsync ​

Queries a view with filtering, sorting, and pagination.

csharp
Task&lt;QueryResultDto&gt; QueryViewAsync(
    DapperMaticOperation context,
    string datasourceId,
    string viewName,
    QueryDto request,
    string schemaName,
    CancellationToken cancellationToken)

Parameters ​

  • context (DapperMaticOperation) - The operation context.
  • datasourceId (string) - The datasource identifier.
  • viewName (string) - The view name to query.
  • request (QueryDto) - The query parameters.
  • schemaName (string) - Optional schema name.
  • cancellationToken (CancellationToken) - The cancellation token.

Returns ​

Type: Task<QueryResultDto>

The query results with pagination information.

GetType ​

csharp
GetType()

ToString ​

csharp
ToString()

Equals ​

csharp
Equals()

GetHashCode ​

csharp
GetHashCode()