Class: ResultSetMetaData

$.db. ResultSetMetaData

$.db.ResultSetMetaData represents the metadata of a result set

new ResultSetMetaData()

Represents the metadata of a result set

Methods

getCatalogName(columnIndex) → {string}

Returns the catalog name for the specified column
Parameters:
Name Type Description
columnIndex integer The index of the column in the result set starting from 1
Throws:
  • Throws an error on invalid parameters or if the object the method is being called on is not valid.
Returns:
The catalog name for the specified column
Type
string

getColumnCount() → {integer}

Returns the number of the columns in the result set
Throws:
  • Throws an error if the object the method is being called on is not valid.
Returns:
The number of the columns in the result set
Type
integer

getColumnDisplaySize(columnIndex) → {integer}

Returns the column display size of the specified column
Parameters:
Name Type Description
columnIndex integer The index of the column in the result set starting from 1
Throws:
  • Throws an error on invalid parameters or if the object the method is being called on is not valid.
Returns:
The column display size of the specified column
Type
integer

getColumnLabel(columnIndex) → {string}

Returns the alias or name of the specified column
Parameters:
Name Type Description
columnIndex integer The index of the column in the result set starting from 1
Throws:
  • Throws an error on invalid parameters or if the object the method is being called on is not valid.
Returns:
The alias or name of the specified column
Type
string

getColumnName(columnIndex) → {string}

Returns the name of the specified column
Parameters:
Name Type Description
columnIndex integer The index of the column in the result set starting from 1
Throws:
  • Throws an error on invalid parameters or if the object the method is being called on is not valid.
Returns:
The name of the specified column
Type
string

getColumnType(columnIndex) → {$.db.types}

Returns the type of the specified column
Parameters:
Name Type Description
columnIndex integer The index of the column in the result set starting from 1
Throws:
  • Throws an error on invalid parameters or if the object the method is being called on is not valid.
Returns:
The type of the column
Type
$.db.types

getColumnTypeName(columnIndex) → {string}

Returns the name of the specified column type
Parameters:
Name Type Description
columnIndex integer The index of the column in the result set starting from 1
Throws:
  • Throws an error on invalid parameters or if the object the method is being called on is not valid.
Returns:
The name of the column type
Type
string

getPrecision(columnIndex) → {integer}

Returns the precision of the specified column
Parameters:
Name Type Description
columnIndex integer The index of the column in the result set starting from 1
Throws:
  • Throws an error on invalid parameters or if the object the method is being called on is not valid.
Returns:
The precision of the specified column
Type
integer

getScale(columnIndex) → {integer}

Returns the scale of the specified column
Parameters:
Name Type Description
columnIndex integer The index of the column in the result set starting from 1
Throws:
  • Throws an error on invalid parameters or if the object the method is being called on is not valid.
Returns:
The scale of the specified column
Type
integer

getTableName(columnIndex) → {string}

Returns the table name for the specified column
Parameters:
Name Type Description
columnIndex integer The index of the column in the result set starting from 1
Throws:
  • Throws an error on invalid parameters or if the object the method is being called on is not valid.
Returns:
The table name for the specified column
Type
string