Class JdbcResultSetMetaData

JdbcResultSetMetaData

A JDBC ResultSetMetaData. For documentation of this class, see java.sql.ResultSetMetaData.

Methods

MethodReturn typeBrief description
getCatalogName(column)StringFor documentation of this method, see java.sql.ResultSetMetaData#getCatalogName(int).
getColumnClassName(column)StringFor documentation of this method, see java.sql.ResultSetMetaData#getColumnClassName(int).
getColumnCount()IntegerFor documentation of this method, see java.sql.ResultSetMetaData#getColumnCount().
getColumnDisplaySize(column)IntegerFor documentation of this method, see java.sql.ResultSetMetaData#getColumnDisplaySize(int).
getColumnLabel(column)StringFor documentation of this method, see java.sql.ResultSetMetaData#getColumnLabel(int).
getColumnName(column)StringFor documentation of this method, see java.sql.ResultSetMetaData#getColumnName(int).
getColumnType(column)IntegerFor documentation of this method, see java.sql.ResultSetMetaData#getColumnType(int).
getColumnTypeName(column)StringFor documentation of this method, see java.sql.ResultSetMetaData#getColumnTypeName(int).
getPrecision(column)IntegerFor documentation of this method, see java.sql.ResultSetMetaData#getPrecision(int).
getScale(column)IntegerFor documentation of this method, see java.sql.ResultSetMetaData#getScale(int).
getSchemaName(column)StringFor documentation of this method, see java.sql.ResultSetMetaData#getSchemaName(int).
getTableName(column)StringFor documentation of this method, see java.sql.ResultSetMetaData#getTableName(int).
isAutoIncrement(column)BooleanFor documentation of this method, see java.sql.ResultSetMetaData#isAutoIncrement(int).
isCaseSensitive(column)BooleanFor documentation of this method, see java.sql.ResultSetMetaData#isCaseSensitive(int).
isCurrency(column)BooleanFor documentation of this method, see java.sql.ResultSetMetaData#isCurrency(int).
isDefinitelyWritable(column)BooleanFor documentation of this method, see java.sql.ResultSetMetaData#isDefinitelyWritable(int).
isNullable(column)IntegerFor documentation of this method, see java.sql.ResultSetMetaData#isNullable(int).
isReadOnly(column)BooleanFor documentation of this method, see java.sql.ResultSetMetaData#isReadOnly(int).
isSearchable(column)BooleanFor documentation of this method, see java.sql.ResultSetMetaData#isSearchable(int).
isSigned(column)BooleanFor documentation of this method, see java.sql.ResultSetMetaData#isSigned(int).
isWritable(column)BooleanFor 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

NameTypeDescription
columnIntegerThe 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.

Authorization

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

  • https://www.googleapis.com/auth/script.external_request

getColumnClassName(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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:

  • https://www.googleapis.com/auth/script.external_request

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:

  • https://www.googleapis.com/auth/script.external_request

getColumnDisplaySize(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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:

  • https://www.googleapis.com/auth/script.external_request

getColumnLabel(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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) if an AS is not specified.

Authorization

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

  • https://www.googleapis.com/auth/script.external_request

getColumnName(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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:

  • https://www.googleapis.com/auth/script.external_request

getColumnType(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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:

  • https://www.googleapis.com/auth/script.external_request

getColumnTypeName(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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:

  • https://www.googleapis.com/auth/script.external_request

getPrecision(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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:

  • https://www.googleapis.com/auth/script.external_request

getScale(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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:

  • https://www.googleapis.com/auth/script.external_request

getSchemaName(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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:

  • https://www.googleapis.com/auth/script.external_request

getTableName(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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:

  • https://www.googleapis.com/auth/script.external_request

isAutoIncrement(column)

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

Parameters

NameTypeDescription
columnIntegerThe index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Booleantrue 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:

  • https://www.googleapis.com/auth/script.external_request

isCaseSensitive(column)

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

Parameters

NameTypeDescription
columnIntegerThe index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Booleantrue 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:

  • https://www.googleapis.com/auth/script.external_request

isCurrency(column)

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

Parameters

NameTypeDescription
columnIntegerThe index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Booleantrue 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:

  • https://www.googleapis.com/auth/script.external_request

isDefinitelyWritable(column)

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

Parameters

NameTypeDescription
columnIntegerThe index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Booleantrue 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:

  • https://www.googleapis.com/auth/script.external_request

isNullable(column)

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

Parameters

NameTypeDescription
columnIntegerThe 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, or Jdbc.ResultSetMetaData.columnNullableUnknown.

Authorization

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

  • https://www.googleapis.com/auth/script.external_request

isReadOnly(column)

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

Parameters

NameTypeDescription
columnIntegerThe index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Booleantrue 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:

  • https://www.googleapis.com/auth/script.external_request

isSearchable(column)

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

Parameters

NameTypeDescription
columnIntegerThe index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Booleantrue 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:

  • https://www.googleapis.com/auth/script.external_request

isSigned(column)

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

Parameters

NameTypeDescription
columnIntegerThe index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Booleantrue 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:

  • https://www.googleapis.com/auth/script.external_request

isWritable(column)

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

Parameters

NameTypeDescription
columnIntegerThe index of the column to examine (the first column is 1, the second is 2, and so on).

Return

Booleantrue 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:

  • https://www.googleapis.com/auth/script.external_request