Class JdbcResultSetMetaData  |  Apps Script  |  Google for Developers (original) (raw)

Skip to main content

Class JdbcResultSetMetaData

Stay organized with collections Save and categorize content based on your preferences.

Methods

Method Return type Brief description
getCatalogName(column) String For documentation of this method, see java.sql.ResultSetMetaData#getCatalogName(int).
getColumnClassName(column) String For documentation of this method, see java.sql.ResultSetMetaData#getColumnClassName(int).
getColumnCount() Integer For documentation of this method, see java.sql.ResultSetMetaData#getColumnCount().
getColumnDisplaySize(column) Integer For documentation of this method, see java.sql.ResultSetMetaData#getColumnDisplaySize(int).
getColumnLabel(column) String For documentation of this method, see java.sql.ResultSetMetaData#getColumnLabel(int).
getColumnName(column) String For documentation of this method, see java.sql.ResultSetMetaData#getColumnName(int).
getColumnType(column) Integer For documentation of this method, see java.sql.ResultSetMetaData#getColumnType(int).
getColumnTypeName(column) String For documentation of this method, see java.sql.ResultSetMetaData#getColumnTypeName(int).
getPrecision(column) Integer For documentation of this method, see java.sql.ResultSetMetaData#getPrecision(int).
getScale(column) Integer For documentation of this method, see java.sql.ResultSetMetaData#getScale(int).
getSchemaName(column) String For documentation of this method, see java.sql.ResultSetMetaData#getSchemaName(int).
getTableName(column) String For documentation of this method, see java.sql.ResultSetMetaData#getTableName(int).
isAutoIncrement(column) Boolean For documentation of this method, see java.sql.ResultSetMetaData#isAutoIncrement(int).
isCaseSensitive(column) Boolean For documentation of this method, see java.sql.ResultSetMetaData#isCaseSensitive(int).
isCurrency(column) Boolean For documentation of this method, see java.sql.ResultSetMetaData#isCurrency(int).
isDefinitelyWritable(column) Boolean For documentation of this method, see java.sql.ResultSetMetaData#isDefinitelyWritable(int).
isNullable(column) Integer For documentation of this method, see java.sql.ResultSetMetaData#isNullable(int).
isReadOnly(column) Boolean For documentation of this method, see java.sql.ResultSetMetaData#isReadOnly(int).
isSearchable(column) Boolean For documentation of this method, see java.sql.ResultSetMetaData#isSearchable(int).
isSigned(column) Boolean For documentation of this method, see java.sql.ResultSetMetaData#isSigned(int).
isWritable(column) Boolean For documentation of this method, see java.sql.ResultSetMetaData#isWritable(int).

Detailed documentation

getCatalogName(column)

For documentation of this method, see java.sql.ResultSetMetaData#getCatalogName(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

String — The catalog name for the table in the designated column, or an empty string if not applicable.

Scripts that use this method require authorization with one or more of the following scopes:

getColumnClassName(column)

For documentation of this method, see java.sql.ResultSetMetaData#getColumnClassName(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

String — The fully-qualified name of the class of the designated column's values.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getColumnCount()

For documentation of this method, see java.sql.ResultSetMetaData#getColumnCount().

Return

Integer — The number of columns in this result set.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getColumnDisplaySize(column)

For documentation of this method, see java.sql.ResultSetMetaData#getColumnDisplaySize(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Integer — The maximum number of characters allowed as the width of the designated columns.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getColumnLabel(column)

For documentation of this method, see java.sql.ResultSetMetaData#getColumnLabel(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

String — The designated column's suggested title, usually specifed by a SQL AS clause. Returns the same as [getColumnName(column)](#getColumnName%28Integer%29) if an AS is not specified.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getColumnName(column)

For documentation of this method, see java.sql.ResultSetMetaData#getColumnName(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

String — The designated column's name.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getColumnType(column)

For documentation of this method, see java.sql.ResultSetMetaData#getColumnType(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Integer — The SQL type of the designated column.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getColumnTypeName(column)

For documentation of this method, see java.sql.ResultSetMetaData#getColumnTypeName(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

String — The designated column's database-specific type name. Returns the fully-qualifed type name if this is a user-defined type.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getPrecision(column)

For documentation of this method, see java.sql.ResultSetMetaData#getPrecision(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Integer — The maximum column size for the given column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime data, this is the length in characters of the string representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Returns 0 for types where the column size is not applicable.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getScale(column)

For documentation of this method, see java.sql.ResultSetMetaData#getScale(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Integer — The designated columns's number of digits to right of the decimal point. Returns 0 for data types where the scale is not applicable.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getSchemaName(column)

For documentation of this method, see java.sql.ResultSetMetaData#getSchemaName(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

String — The table schema of the designated column.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getTableName(column)

For documentation of this method, see java.sql.ResultSetMetaData#getTableName(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

String — The table name of the designated column, or an empty string if not applicable.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isAutoIncrement(column)

For documentation of this method, see java.sql.ResultSetMetaData#isAutoIncrement(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Boolean — true if the specified column is automatically numbered; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isCaseSensitive(column)

For documentation of this method, see java.sql.ResultSetMetaData#isCaseSensitive(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Boolean — true if the specified column is case-sensitive; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isCurrency(column)

For documentation of this method, see java.sql.ResultSetMetaData#isCurrency(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Boolean — true if the specified column is a cash value; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isDefinitelyWritable(column)

For documentation of this method, see java.sql.ResultSetMetaData#isDefinitelyWritable(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Boolean — true if writes to the designated column definitely succeed; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isNullable(column)

For documentation of this method, see java.sql.ResultSetMetaData#isNullable(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Integer — The nullability status of the specified column, which is Jdbc.ResultSetMetaData.columnNoNulls, Jdbc.ResultSetMetaData.columnNullable, orJdbc.ResultSetMetaData.columnNullableUnknown.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isReadOnly(column)

For documentation of this method, see java.sql.ResultSetMetaData#isReadOnly(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Boolean — true if the designated column is definitely non-writable; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isSearchable(column)

For documentation of this method, see java.sql.ResultSetMetaData#isSearchable(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Boolean — true if a where clause can use the specified column; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isSigned(column)

For documentation of this method, see java.sql.ResultSetMetaData#isSigned(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Boolean — true if the values in the specified column are signed numbers; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isWritable(column)

For documentation of this method, see java.sql.ResultSetMetaData#isWritable(int).

Parameters

Name Type Description
column Integer The index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Boolean — true if it is possible to write to the designated column; false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-03 UTC.