Class AdbTableIdentifier
An immutable class
that identifies a table-like database object by naming some
or all of its identifier parts, e.g. catalog or database name, schema or owner name, and table name.
Depending on the provider, this can include both system and user regular tables,
temporary tables, views, table-valued functions, etc.
It provides the identifier parts in three different forms: Original with whatever quoting the caller provided, Quoted with each part fully quoted, and Unquoted without any quoting. Use what's appropriate for the task, e.g. Quoted when adding and combining identifier parts into a new identifier.
It is created by CreateTableIdentifier(String), and is e.g. passed to workers to specify which database table to act on, or created by workers that need access to the individual parts of the table composite name.
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.
Furthermore, all possible identifier parts might not have been supplied when creating
the identifier. In both cases, these will be set to null
.
Implements
Namespace: actionETL.Adb
Assembly: actionETL.dll
Syntax
public sealed class AdbTableIdentifier : IAdbTableIdentifier
Properties
OriginalCatalogName
Name of the catalog, with any quoting as originally provided.
null
if not specified, and an empty string if it was specified as empty (e.g. .MySchema.MyTable
).
Catalog is normally the database if the provider uses it (e.g. SqlClient);
otherwise null
if unused (e.g. MySqlClient provider).
Declaration
public string OriginalCatalogName { get; }
Property Value
Type | Description |
---|---|
String |
OriginalCompositeName
Gets the composite table name, as originally supplied with or without quoting.
Declaration
public string OriginalCompositeName { get; }
Property Value
Type | Description |
---|---|
String |
OriginalSchemaName
Name of the schema, with any quoting as originally provided.
null
if not specified, and an empty string if it was specified as empty (e.g. .MyTable
).
Declaration
public string OriginalSchemaName { get; }
Property Value
Type | Description |
---|---|
String |
OriginalTableName
Name of table, without any schema or database, with any quoting as originally provided.
null
if not specified, and an empty string if it was specified as empty (e.g. MySchema.
).
Declaration
public string OriginalTableName { get; }
Property Value
Type | Description |
---|---|
String |
QuotedCatalogName
Name of the catalog, with quoting.
null
if not specified, and an empty string if it was specified as empty (e.g. .MySchema.MyTable
).
Catalog is normally the database if the provider uses it (e.g. SqlClient);
otherwise null
if unused (e.g. MySqlClient provider).
Declaration
public string QuotedCatalogName { get; }
Property Value
Type | Description |
---|---|
String |
QuotedCompositeName
Gets the composite name (with all specified parts), with quoting.
Declaration
public string QuotedCompositeName { get; }
Property Value
Type | Description |
---|---|
String |
QuotedSchemaName
Name of the schema (or owner), with quoting.
null
if not specified, and an empty string if it was specified as empty (e.g. .MyTable
).
Declaration
public string QuotedSchemaName { get; }
Property Value
Type | Description |
---|---|
String |
QuotedTableName
Name of table, without any schema or database, and with quoting.
null
if not specified, and an empty string if it was specified as empty (e.g. MySchema.
).
Declaration
public string QuotedTableName { get; }
Property Value
Type | Description |
---|---|
String |
UnquotedCatalogName
Name of the catalog, without any quoting.
null
if not specified, and an empty string if it was specified as empty (e.g. .MySchema.MyTable
).
Catalog is normally the database if the provider uses it (e.g. SqlClient);
otherwise null
if unused (e.g. MySqlClient provider).
Declaration
public string UnquotedCatalogName { get; }
Property Value
Type | Description |
---|---|
String |
UnquotedSchemaName
Name of the schema (or owner), without any quoting.
null
if not specified, and an empty string if it was specified as empty (e.g. .MyTable
).
Declaration
public string UnquotedSchemaName { get; }
Property Value
Type | Description |
---|---|
String |
UnquotedTableName
Name of table, without any schema or database, and without any quoting.
null
if not specified, and an empty string if it was specified as empty (e.g. MySchema.
).
Declaration
public string UnquotedTableName { get; }
Property Value
Type | Description |
---|---|
String |
Methods
Equals(Object)
Determines whether the specified Object, is equal to this instance using value equality.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj | The Object to compare with this instance. |
Returns
Type | Description |
---|---|
Boolean |
|
Overrides
GetHashCode()
Returns a hash code for this instance.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. |
Overrides
ToLongString()
Returns a string that shows all public properties.
Declaration
public string ToLongString()
Returns
Type | Description |
---|---|
String |
ToString()
Returns a string that represents this instance.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |