Data.DBXMetaDataNames.TDBXColumnsIndex

From RAD Studio API Documentation
Jump to: navigation, search

System.TObjectTDBXColumnsIndex

Delphi

TDBXColumnsIndex = class

C++

class PASCALIMPLEMENTATION TDBXColumnsIndex : public System::TObject

Properties

Type Visibility Source Unit Parent
class public
Data.DBXMetaDataNames.pas
Data.DBXMetaDataNames.hpp
Data.DBXMetaDataNames Data.DBXMetaDataNames

Description

Accesses columns by ordinal in the Columns metadata.

TDBXColumnsIndex is used to access columns by ordinal in the Columns metadata collection. These columns are returned when TDBXCommand.Text is TDBXMetaDataCommands.GetColumns when reading metadata. To retrieve metadata columns, use these constants to index the TDBXReader instance returned by TDBXCommand.ExecuteQuery.

This table describes the columns.



Column Ordinal Name Data Type of Column Data Description

CatalogName

String

Catalog name.

SchemaName

String

Schema name.

TableName

String

Table name.

ColumnName

String

Column name.

TypeName

String

Database specific data type name.

Precision

Int32

Precision of this type.

For a string data type, this is the maximum number of characters.

For a decimal types, this is the maximum number digits including digits from the scale.

Scale

Int32

Scale of a decimal type.

Ordinal

Int32

Position in the rows of the table starting with 1.

DefaultValue

String

Default value.

IsNullable

Boolean

True if accepts NULL values; false otherwise.

IsAutoIncrement

Boolean

Is an autoincrement value.

MaxInline

Int32

The maximal number of bytes to write into row. The rest of the data is handled as a BLOB.

DbxDataType

Int32

dbExpress data type.

IsFixedLength

Boolean

True if holds fixed length data; false otherwise.

IsUnicode

Boolean

Can hold Unicode characters.

IsLong

Boolean

Is a BLOB data type.

IsUnsigned

Boolean

Is an unsigned numeric type.



See Also