Class AdbTableInformation
An optional service that manipulates table identifiers and provides information about table-like objects, such as which ones exists and what their type is (table, view, etc), and which columns are present. This assists with writing provider-independent database code, and is available as TableInformation, if the provider supports it. Also see HasTableInformationService, AdbTableCommand, AdbDataSourceInformation and AdbConnection.
Namespace: actionETL.Adb
Assembly: actionETL.dll
Syntax
public class AdbTableInformationMethods
ComposeTableIdentifierParts(String, String, String)
Composes the table identifier parts into a composite table identifier string.
Each specified part must follow the quoting requirements of the provider, e.g. use quoting due to potential spaces in the part name (i.e. parts won't be automatically quoted). Use QuoteIdentifierPart(String) to automatically quote a part.
Declaration
public string ComposeTableIdentifierParts(string quotedTableName, string quotedSchemaName, string quotedCatalogName)Parameters
| Type | Name | Description |
|---|---|---|
| String | quotedTableName | Name of the table, with quoting if required. Cannot be |
| String | quotedSchemaName | Name of the schema, with quoting if required, or |
| String | quotedCatalogName | Name of the catalog, with quoting if required, or |
Returns
| Type | Description |
|---|---|
| String | The combined table identifier string. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException |
|
CreateTableIdentifier(String)
Creates an identifier for a table-like database object from a composite name, i.e. it splits a potentially delimited table name into its constituent parts, i.e. database or catalog name, schema or owner name, and table name. Depending on the provider, the identifier can be either system or user regular tables, temporary tables, views, table-valued functions, etc.
Note that some providers do not support all identifier parts;
unsupported parts will be set to null, but unused parts will be set to
an empty string. While the SqlClient provider puts the database and schema in the
CatalogName and SchemaName properties respectively,
the MySqlClient provider puts the database in the SchemaName property.
Declaration
public IAdbTableIdentifier CreateTableIdentifier(string compositeTableName)Parameters
| Type | Name | Description |
|---|---|---|
| String | compositeTableName | Name of the table, potentially including database or catalog name, and schema or owner name. The string must be formatted according to the requirements of the data source, i.e. use the appropriate quoting characters and delimiters, in the appropriate order. |
Returns
| Type | Description |
|---|---|
| IAdbTableIdentifier | A table identifier. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException |
|
GetTableColumnsAsync(IAdbTableIdentifier)
Gets information (name, data type etc.) about all columns in a table-like database object. Depending on the provider, this can include both system and user regular tables, temporary tables, views, table-valued functions, etc.
Note that it does not include objects that do not themselves have columns, e.g. stored procedures.
Note that this method does not log errors. Instead the caller should normally log any returned failure status.
Declaration
public Task<OutcomeStatusResult<IList<AdbColumnSchema>>> GetTableColumnsAsync(IAdbTableIdentifier tableIdentifier)Parameters
| Type | Name | Description |
|---|---|---|
| IAdbTableIdentifier | tableIdentifier | The identifier for a table-like object to check. It must specify table name,
but schema and/or catalog names can be |
Returns
| Type | Description |
|---|---|
| Task<OutcomeStatusResult<IList<AdbColumnSchema>>> | On success, Status will be
On failure, Status will have a
failure status, and Result will be
An incorrect parameter will throw immediately. Any other exceptions or failures
will be caught and contained in the returned See the provider documentation for specific Open() exceptions. Some providers may throw if the connection is associated with a transaction. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException |
|
| ArgumentNullException |
|
GetTableColumnsAsync(String)
Gets information (name, data type etc.) about all columns in a table-like database object. Depending on the provider, this can include both system and user regular tables, temporary tables, views, table-valued functions, etc.
Note that it does not include objects that do not themselves have columns, e.g. stored procedures.
Note that this method does not log errors. Instead the caller should normally log any returned failure status.
Declaration
public Task<OutcomeStatusResult<IList<AdbColumnSchema>>> GetTableColumnsAsync(string compositeTableName)Parameters
| Type | Name | Description |
|---|---|---|
| String | compositeTableName | The composite name of the table (or view, ...) to return column information from. It must specify table name, but schema/owner and/or database/catalog names can be omitted, in which case the current schema and database for the connection is used. |
Returns
| Type | Description |
|---|---|
| Task<OutcomeStatusResult<IList<AdbColumnSchema>>> | On success, Status will be
On failure, Status will have a
failure status, and Result will be
An incorrect parameter will throw immediately. Any other exceptions or failures
will be caught and contained in the returned See the provider documentation for specific Open() exceptions. Some providers may throw if the connection is associated with a transaction. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException |
|
GetTableTypeAsync(IAdbTableIdentifier)
Check if a table-like object exists, and what type it is. Depending on provider, this can e.g. be a regular table, temporary table, view, table-valued function etc. It does not include stored procedures etc. that do not themselves have columns.
Note that this method does not log errors. Instead the caller should normally log any returned failure status.
Declaration
public Task<OutcomeStatusResult<AdbTableType>> GetTableTypeAsync(IAdbTableIdentifier tableIdentifier)Parameters
| Type | Name | Description |
|---|---|---|
| IAdbTableIdentifier | tableIdentifier | The identifier for a table-like object to check. It must specify table name,
but schema and/or catalog names can be |
Returns
| Type | Description |
|---|---|
| Task<OutcomeStatusResult<AdbTableType>> | On success, Status will be
On failure, Status will have a failure status, and Result will be undefined.
An incorrect parameter will throw immediately. Any other exceptions or failures
will be caught and contained in the returned See the provider documentation for specific Open() exceptions. Some providers may throw if the connection is associated with a transaction. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException |
|
| ArgumentNullException |
|
GetTableTypeAsync(String)
Check if a table-like object exists, and what type it is. Depending on provider, this can e.g. be a regular table, temporary table, view, table-valued function etc. It does not include stored procedures etc. that do not themselves have columns.
Note that this method does not log errors. Instead the caller should normally log any returned failure status.
Declaration
public Task<OutcomeStatusResult<AdbTableType>> GetTableTypeAsync(string compositeTableName)Parameters
| Type | Name | Description |
|---|---|---|
| String | compositeTableName | The name of a table-like object to check. It must specify table name,
but schema and/or database names can be |
Returns
| Type | Description |
|---|---|
| Task<OutcomeStatusResult<AdbTableType>> | On success, Status will be
On failure, Status will have a failure status, and Result will be undefined.
An incorrect parameter will throw immediately. Any other exceptions or failures
will be caught and contained in the returned See the provider documentation for specific Open() exceptions. Some providers may throw if the connection is associated with a transaction. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException |
|