com.pivotal.gemfirexd.callbacks

Interface TableMetaData

All Superinterfaces:

ResultSetMetaData, Wrapper

public interface TableMetaData
extends ResultSetMetaData

Used to represent the meta-data information of a table, or projection of some columns of a table.

Field Summary

Fields inherited from interface java.sql.ResultSetMetaData

columnNoNulls, columnNullable, columnNullableUnknown

Method Summary

Methods

Modifier and Type	Method and Description
int	getColumnPosition(String columnName) Get the position of a column (1-based) given its name.
int	getDeclaredColumnWidth(int column) Get the column width as declared in the DDL.
int	getSchemaVersion() Get the version of the schema of the table for which this metadata object was obtained.
int	getTableColumnPosition(int column) Get the actual position of a given column in the table.

Methods inherited from interface java.sql.ResultSetMetaData

getCatalogName, getColumnClassName, getColumnCount, getColumnDisplaySize, getColumnLabel, getColumnName, getColumnType, getColumnTypeName, getPrecision, getScale, getSchemaName, getTableName, isAutoIncrement, isCaseSensitive, isCurrency, isDefinitelyWritable, isNullable, isReadOnly, isSearchable, isSigned, isWritable

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Detail

getTableColumnPosition

int getTableColumnPosition(int column)
                           throws SQLException

Get the actual position of a given column in the table. For a full table meta-data this will always return the argument itself as the result.

Parameters:

column - position of the column (1-based); for a projection it is the position of column in the projection

Throws:

SQLException - if column could not be found, or there is no corresponding mapping to a column in table (SQLState: S0022)

getColumnPosition

int getColumnPosition(String columnName)
                      throws SQLException

Get the position of a column (1-based) given its name. For a full table meta-data this will return the position of the column in the table, while for a projection of some columns it will return the position in the projection.

Parameters:

columnName - name of the column

Throws:

SQLException - if column with given name could not be found (SQLState: 42X04)

getDeclaredColumnWidth

int getDeclaredColumnWidth(int column)
                           throws SQLException

Get the column width as declared in the DDL.

Throws:

SQLException

getSchemaVersion

int getSchemaVersion()

Get the version of the schema of the table for which this metadata object was obtained. This is a unique number for the schema of a table that changes after an ALTER TABLE has been executed.