class MetaData
extends anvil.lang.object

Abstract base class for types having SQL meta data description available.

Methods

string getCatalogName(string columnName)
string getCatalogName(int column)

Returns the catalog name of given column.

Parameters	`columnName -` `column -`
Returns	a column's table's catalog name
Throws	`SQLError -` if an error occured

int getColumnCount()

Returns the number of columns in this result set

Returns

the number of columns in this ResultSet

string getColumnLabel(string columnName)
string getColumnLabel(int column)

Returns the suggested column title.

Parameters	`columnName -` `column -`
Returns	the suggested column title for use in printouts and displays
Throws	`SQLError -` if an error occured

int getColumnLength(string columnName)
int getColumnLength(int column)

Returns the column's normal maximum length.

Parameters	`columnName -` `column -`
Returns	indicates the column's normal max width in chars
Throws	`SQLError -` if an error occured

string getColumnName(string columnName)
string getColumnName(int column)

Returns the name of column.

Parameters	`columnName -` `column -`
Returns	a column's name
Throws	`SQLError -` if an error occured

string getColumnType(string columnName)
string getColumnType(int column)

Returns the type of column.

Parameters	`columnName -` `column -`
Returns	Retrieves a column's SQL type
Throws	`SQLError -` if an error occured

int getPrecision(string columnName)
int getPrecision(int column)

Returns the column's precision.

Parameters	`columnName -` `column -`
Returns	a column's number of decimal digits
Throws	`SQLError -` if an error occured

int getScale(string columnName)
int getScale(int column)

Returns the column's scale.

Parameters	`columnName -` `column -`
Returns	a column's number of digits to right of the decimal point
Throws	`SQLError -` if an error occured

string getSchemaName(string columnName)
string getSchemaName(int column)

Returns the schema name of given column.

Parameters	`columnName -` `column -`
Returns	a column's table's schema
Throws	`SQLError -` if an error occured

string getTableName(string columnName)
string getTableName(int column)

Returns the table name of given column.

Parameters	`columnName -` `column -`
Returns	a column's table name
Throws	`SQLError -` if an error occured

boolean isAutoIncrement(string columnName)
boolean isAutoIncrement(int column)

Indicates whether the column is automatically numbered, thus read-only.

Parameters	`columnName -` `column -`
Returns	true if is automatically numbered
Throws	`SQLError -` if an error occured

boolean isCaseSensitive(string columnName)
boolean isCaseSensitive(int column)

Indicates whether a column's case matters.

Parameters	`columnName -` `column -`
Returns	true if is case sensitive
Throws	`SQLError -` if an error occured

boolean isCurrency(string columnName)
boolean isCurrency(int column)

Indicates whether the column is a cash value

Parameters	`columnName -` `column -`
Returns	true if is currency
Throws	`SQLError -` if an error occured

boolean isDefinitelyWritable(string columnName)
boolean isDefinitelyWritable(int column)

Indicates whether a write on the column will definitely succeed.

Parameters	`columnName -` `column -`
Returns	true / false
Throws	`SQLError -` if an error occured

boolean isNullable(string columnName)
boolean isNullable(int column)

Parameters	`columnName -` `column -`
Returns	`true` is nullable, `false` if not nullable and `null` is status in not known.
Throws	`SQLError -` if an error occured

boolean isReadOnly(string columnName)
boolean isReadOnly(int column)

Indicates whether a column is definitely not writable.

Parameters	`columnName -` `column -`
Returns	true / false
Throws	`SQLError -` if an error occured

boolean isSearchable(string columnName)
boolean isSearchable(int column)

Indicates whether the column can be used in a where clause.

Parameters	`columnName -` `column -`
Returns	true / false
Throws	`SQLError -` if an error occured

boolean isSigned(string columnName)
boolean isSigned(int column)

Indicates whether values in the column are signed numbers.

Parameters	`columnName -` `column -`
Returns	true if signed
Throws	`SQLError -` if an error occured

boolean isWritable(string columnName)
boolean isWritable(int column)

Indicates whether it is possible for a write on the column to succeed.

Parameters	`columnName -` `column -`
Returns	true if is possible
Throws	`SQLError -` if an error occured