Class AdbColumnSchema

Information about a database column. Note that several members are optional and might not be populated for a particular database provider and connection. Created by GetTableColumnsAsync(IAdbTableIdentifier) and associated overloads.

Inheritance
Object
AdbColumnSchema
Namespace: actionETL.Adb
Assembly: actionETL.dll
Syntax
public sealed class AdbColumnSchema

Properties

DataTypeFullName

Gets the name of the column data type, including nullability, length, size, precision and scale if applicable.

Declaration
public string DataTypeFullName { get; }
Property Value
Type Description
String

DataTypeName

Gets the name of the column data type. Also see DataTypeFullName.

Declaration
public string DataTypeName { get; }
Property Value
Type Description
String

IsNullable

Gets a value indicating whether the column is nullable.

Declaration
public bool IsNullable { get; }
Property Value
Type Description
Boolean

true if nullable; otherwise, false.

LengthInBytes

Gets the column length in bytes, or null if not applicable or available.

Note that for variable length columns, this returns the maximum length.

Also note that for the few database types that report more than MaxValue (e.g. MySql longblob reporting 4GB), or report an 'infinite' number (e.g. SqlClient using -1 for varbinary(max)), this property will be set to MaxValue since ADO.NET database parameters uses Int32 sizes.

Declaration
public int? LengthInBytes { get; }
Property Value
Type Description
Nullable<Int32>

LengthInCharacters

Gets the column length in characters, or null if not applicable or available.

Note that for variable length columns, this returns the maximum length.

Also note that for the few database types that report more than MaxValue (e.g. MySql longblob reporting 4GB), or report an 'infinite' number (e.g. SqlClient using -1 for varbinary(max)), this property will be set to MaxValue since ADO.NET database parameters uses Int32 sizes.

Declaration
public int? LengthInCharacters { get; }
Property Value
Type Description
Nullable<Int32>

Ordinal

Gets the (1-based) column ordinal, or null if not available.

Declaration
public int? Ordinal { get; }
Property Value
Type Description
Nullable<Int32>

Precision

Gets the column precision, or null if not applicable or available.

Declaration
public int? Precision { get; }
Property Value
Type Description
Nullable<Int32>

Scale

Gets the column scale, or null if not applicable or available.

Declaration
public int? Scale { get; }
Property Value
Type Description
Nullable<Int32>

UnquotedCatalogName

Gets the unquoted name of the catalog (or database) the column resides in. null if not supported.

Declaration
public string UnquotedCatalogName { get; }
Property Value
Type Description
String

UnquotedColumnName

Gets the unquoted name of the column.

Declaration
public string UnquotedColumnName { get; }
Property Value
Type Description
String

UnquotedSchemaName

Gets the unquoted name of the schema (or owner) the column resides in. null if not supported.

Declaration
public string UnquotedSchemaName { get; }
Property Value
Type Description
String

UnquotedTableName

Gets the unquoted name of the table the column resides in.

Declaration
public string UnquotedTableName { get; }
Property Value
Type Description
String

Methods

Equals(Object)

Determines whether the specified Object, is equal to this instance.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The Object to compare with this instance.
Returns
Type Description
Boolean

true if the specified Object is equal to this instance; otherwise, false.
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

ToString()

Returns a String that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

See Also