getColumns()

Previous Next

Gets a description of table columns available in the specified catalog.

Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION. Each column description has the following columns:

TABLE_CAT

String

table catalog (may be null)

TABLE_SCHEM

String

table schema (may be null)

TABLE_NAME

String

table name

COLUMN_NAME

String

column name

DATA_TYPE

Short

SQL type from java.sql.Types

TYPE_NAME

String

Data source dependent type name, for a UDT the type name is fully qualified

COLUMN_SIZE

Int

Column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.

BUFFER_LENGTH

 

is not used.

DECIMAL_DIGITS

int

the number of fractional digits

NUM_PREC_RADIX

int

Radix (typically either 10 or 2)

NULLABLE

int

is NULL allowed?

columnNoNulls - might not allow NULL values

columnNullable - definitely allows NULL values

columnNullableUnknown - nullability unknown

REMARKS

String

comment describing column (may be null)

COLUMN_DEF

String

default value (may be null)

SQL_DATA_TYPE

int

unused

SQL_DATETIME_SUB

int

unused

CHAR_OCTET_LENGTH

int

for char types the maximum number of bytes in the column

ORDINAL_POSITION

int

index of column in table (starting at 1)

IS_NULLABLE

String

"NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.

 

Syntax

getColumns(string catalog,string schemaPattern,string tableNamePattern, string columnNamePattern)

Parameters

catalog

A catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria

schemaPattern

A schema name pattern; "" retrieves those without a schema

tableNamePattern

A table name pattern

columnNamePattern

a column name pattern