ldbc.sql.ResultSetMetaData.scala Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ldbc-sql_3 Show documentation
Show all versions of ldbc-sql_3 Show documentation
JDBC API wrapped project with Effect System
/**
* Copyright (c) 2023-2024 by Takahiko Tominaga
* This software is licensed under the MIT License (MIT).
* For more information see LICENSE or https://opensource.org/licenses/MIT
*/
package ldbc.sql
/**
* An object that can be used to get information about the types
* and properties of the columns in a ResultSet object.
* The following code fragment creates the ResultSet object rs,
* creates the ResultSetMetaData object rsmd, and uses rsmd
* to find out how many columns rs has and whether the first column in rs
* can be used in a WHERE clause.
* {{{
* for
* rs <- stmt.executeQuery("SELECT a, b, c FROM TABLE2")
* rsmd <- rs.getMetaData()
* yield
* val rsmd = rs.getMetaData()
* val numberOfColumns = rsmd.getColumnCount()
* val b = rsmd.isSearchable(1)
* }}}
*/
trait ResultSetMetaData:
/**
* Returns the number of columns in this ResultSet object.
*
* @return the number of columns
*/
def getColumnCount(): Int
/**
* Indicates whether the designated column is automatically numbered.
*
* @param column the first column is 1, the second is 2, ...
* @return true if so; false otherwise
*/
def isAutoIncrement(column: Int): Boolean
/**
* Indicates whether the designated column can be used in a where clause.
*
* @param column the first column is 1, the second is 2, ...
* @return true if so; false otherwise
*/
def isCaseSensitive(column: Int): Boolean
/**
* Indicates whether the designated column can be used in a where clause.
*
* @param column the first column is 1, the second is 2, ...
* @return true if so; false otherwise
*/
def isSearchable(column: Int): Boolean
/**
* Indicates whether the designated column is a cash value.
*
* @param column the first column is 1, the second is 2, ...
* @return true if so; false otherwise
*/
def isCurrency(column: Int): Boolean
/**
* Indicates the nullability of values in the designated column.
*
* @param column the first column is 1, the second is 2, ...
* @return the nullability status of the given column; one of columnNoNulls,
* columnNullable or columnNullableUnknown
*/
def isNullable(column: Int): Int
/**
* Indicates whether values in the designated column are signed numbers.
*
* @param column the first column is 1, the second is 2, ...
* @return true if so; false otherwise
*/
def isSigned(column: Int): Boolean
/**
* Indicates the designated column's normal maximum width in characters.
*
* @param column the first column is 1, the second is 2, ...
* @return the normal maximum number of characters allowed as the width
* of the designated column
*/
def getColumnDisplaySize(column: Int): Int
/**
* Gets the designated column's suggested title for use in printouts and
* displays. The suggested title is usually specified by the SQL AS
* clause. If a SQL AS is not specified, the value returned from
* getColumnLabel will be the same as the value returned by the
* getColumnName method.
*
* @param column the first column is 1, the second is 2, ...
* @return the suggested column title
*/
def getColumnLabel(column: Int): String
/**
* Get the designated column's name.
*
* @param column the first column is 1, the second is 2, ...
* @return column name
*/
def getColumnName(column: Int): String
/**
* Get the designated column's table's schema.
*
* @param column the first column is 1, the second is 2, ...
* @return schema name or "" if not applicable
*/
def getSchemaName(column: Int): String
/**
* Get the designated column's specified column size.
* For numeric data, this is the maximum precision. For character data, this is the length in characters.
* For datetime datatypes, 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. 0 is returned for data types where the
* column size is not applicable.
*
* @param column the first column is 1, the second is 2, ...
* @return precision
*/
def getPrecision(column: Int): Int
/**
* Gets the designated column's number of digits to right of the decimal point.
* 0 is returned for data types where the scale is not applicable.
*
* @param column the first column is 1, the second is 2, ...
* @return scale
*/
def getScale(column: Int): Int
/**
* Gets the designated column's table name.
*
* @param column the first column is 1, the second is 2, ...
* @return table name or "" if not applicable
*/
def getTableName(column: Int): String
/**
* Gets the designated column's table's catalog name.
*
* @param column the first column is 1, the second is 2, ...
* @return the name of the catalog for the table in which the given column
* appears or "" if not applicable
*/
def getCatalogName(column: Int): String
/**
* Retrieves the designated column's SQL type.
*
* @param column the first column is 1, the second is 2, ...
* @return SQL type from java.sql.Types
*/
def getColumnType(column: Int): Int
/**
* Retrieves the designated column's database-specific type name.
*
* @param column the first column is 1, the second is 2, ...
* @return type name used by the database. If the column type is
* a user-defined type, then a fully-qualified type name is returned.
*/
def getColumnTypeName(column: Int): String
/**
* Indicates whether the designated column is definitely not writable.
*
* @param column the first column is 1, the second is 2, ...
* @return true if so; false otherwise
*/
def isReadOnly(column: Int): Boolean
/**
* Indicates whether it is possible for a write on the designated column to succeed.
*
* @param column the first column is 1, the second is 2, ...
* @return true if so; false otherwise
*/
def isWritable(column: Int): Boolean
/**
* Indicates whether a write on the designated column will definitely succeed.
*
* @param column the first column is 1, the second is 2, ...
* @return true if so; false otherwise
*/
def isDefinitelyWritable(column: Int): Boolean
object ResultSetMetaData:
/**
* The constant indicating that a
* column does not allow NULL values.
*/
val columnNoNulls = 0
/**
* The constant indicating that a
* column allows NULL values.
*/
val columnNullable = 1
/**
* The constant indicating that the
* nullability of a column's values is unknown.
*/
val columnNullableUnknown = 2