/** Module: Jdbc */
type Jdbc = typeof Jdbc;
declare namespace Jdbc {
/**
* Attempts to establish a connection to the given Google Cloud SQL URL.
*
* @param url - A database URL of the form jdbc:google:mysql://subname.
*
* @returns A JdbcConnection object.
*/
function getCloudSqlConnection(
url: string
): Jdbc.JdbcConnection
/**
* Attempts to establish a connection to the given Google Cloud SQL URL.
*
* @param url - A database URL of the form jdbc:google:mysql://subname.
* @param info - Optional JavaScript object specifying advanced parameters as defined below.
*
* @returns A JdbcConnection object.
*/
function getCloudSqlConnection(
url: string,
info: object
): Jdbc.JdbcConnection
/**
* Attempts to establish a connection to the given Google Cloud SQL URL.
*
* @param url - A database URL of the form jdbc:google:mysql://subname.
* @param userName - The username to pass to the database.
* @param password - The user's password.
*
* @returns A JdbcConnection object.
*/
function getCloudSqlConnection(
url: string,
userName: string,
password: string
): Jdbc.JdbcConnection
/**
* Attempts to establish a connection to the given database URL.
*
*
* var conn = Jdbc.getConnection('jdbc:mysql://yoursqlserver.example.com:3306/database_name');
*
*
* @param url - A database URL of the form jdbc:subprotocol:subname.
*
* @returns A JdbcConnection object.
*/
function getConnection(
url: string
): Jdbc.JdbcConnection
/**
* Attempts to establish a connection to the given database URL.
*
*
* var conn = Jdbc.getConnection('jdbc:mysql://yoursqlserver.example.com:3306/database_name',
* {user: 'username', password: 'password'});
*
*
* @param url - A database URL of the form jdbc:subprotocol:subname.
* @param info - Optional JavaScript object specifying advanced parameters as defined below.
*
* @returns A JdbcConnection object.
*/
function getConnection(
url: string,
info: object
): Jdbc.JdbcConnection
/**
* Attempts to establish a connection to the given database using a username and password.
*
*
* var conn = Jdbc.getConnection('jdbc:mysql://yoursqlserver.example.com:3306/database_name',
* 'username', 'password');
*
*
* @param url - A database URL of the form jdbc:subprotocol:subname.
* @param userName - The username to pass to the database.
* @param password - The user's password.
*
* @returns A JdbcConnection object.
*/
function getConnection(
url: string,
userName: string,
password: string
): Jdbc.JdbcConnection
/**
* Create a date from milliseconds since epoch.
*
* @param milliseconds - Milliseconds since epoch.
*
* @returns A JdbcDate object.
*/
function newDate(
milliseconds: number
): Jdbc.JdbcDate
/**
* Create a time from milliseconds since epoch.
*
* @param milliseconds - Milliseconds since epoch.
*
* @returns A JdbcTime object.
*/
function newTime(
milliseconds: number
): Jdbc.JdbcTime
/**
* Create a timestamp from milliseconds since epoch.
*
* @param milliseconds - Milliseconds since epoch.
*
* @returns A JdbcTimestamp object.
*/
function newTimestamp(
milliseconds: number
): Jdbc.JdbcTimestamp
/**
* Create a date by parsing the SQL date string.
*
* @param date - A string containing a SQL date string.
*
* @returns A JdbcDate object.
*/
function parseDate(
date: string
): Jdbc.JdbcDate
/**
* Create a time by parsing the SQL time string.
*
* @param time - A string containing a SQL time string.
*
* @returns A JdbcTime object.
*/
function parseTime(
time: string
): Jdbc.JdbcTime
/**
* Create a timestamp by parsing the SQL timestamp string.
*
* @param timestamp - A string containing a SQL timestamp string.
*
* @returns A JdbcTimestamp object.
*/
function parseTimestamp(
timestamp: string
): Jdbc.JdbcTimestamp
class JdbcArray {
private constructor();
/**
* For documentation of this method, see
* java.sql.Array#free().
*/
free(): void
/**
* For documentation of this method, see
* java.sql.Array#getArray()
*
* @returns An object containing the ordered elements of the SQL array value.
*/
getArray(): object
/**
* For documentation of this method, see
* java.sql.Array#getArray(long, int).
*
* @param index - The array index of the first element to retrieve, where the first element has an
* index of 1.
* @param count - The number of successive SQL array elements to retrieve.
*
* @returns An object containing up to the specified number of consecutive SQL array elements.
*/
getArray(
index: number,
count: number
): object
/**
* For documentation of this method, see
* java.sql.Array#getBaseType().
*
* @returns The type
* code for the elements in this array.
*/
getBaseType(): number
/**
* For documentation of this method, see
* java.sql.Array#getBaseTypeName().
*
* @returns The database-specific name for the built-in base type or else the fully-qualified SQL
* type name for a base type that is a UDT.
*/
getBaseTypeName(): string
/**
* For documentation of this method, see
* java.sql.Array#getResultSet().
*
* @returns The JdbcResultSet containing one row for each of the elements in the array
* designated by this Array object, with the rows in ascending order based on the indices.
*/
getResultSet(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.Array#getResultSet(long, int).
*
* @param index - The array index of the first element to retrieve, where the first element has an
* index of 1.
* @param count - The number of successive SQL array elements to retrieve.
*
* @returns A JdbcResultSet containing up to the specified number of consecutive SQL array
* elements.
*/
getResultSet(
index: number,
count: number
): Jdbc.JdbcResultSet
}
class JdbcBlob {
private constructor();
/**
* For documentation of this method, see
* java.sql.Blob#free().
*/
free(): void
/**
* Gets the content of this JdbcBlob as an Apps Script blob.
*
* @returns A Blob that can be used directly by other Apps Script APIs.
*/
getAppsScriptBlob(): Blob
/**
* Return the data inside this object as a blob converted to the specified content type. This
* method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it
* assumes that the part of the filename that follows the last period (if any) is an existing
* extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes
* "ShoppingList.12.25.pdf".
*
* To view the daily quotas for conversions, see Quotas for Google
* Services. Newly created G Suite domains might be temporarily subject to stricter quotas.
*
* @param contentType - The MIME type to convert to. For most blobs, 'application/pdf' is
* the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp', 'image/gif', 'image/jpeg', or 'image/png' are also
* valid.
*
* @returns The data as a blob.
*/
getAs(
contentType: string
): Blob
/**
* For documentation of this method, see
* java.sql.Blob#getBytes(long, int).
*
* @param position - The ordinal position of the first byte in the blob value to be extracted; the
* first byte is at position 1.
* @param length - The number of consecutive bytes to copy; the value for length must be zero or
* greater.
*
* @returns A byte array containing up to the specified number of consecutive bytes from the blob
* value.
*/
getBytes(
position: number,
length: number
): number[]
/**
* For documentation of this method, see
* java.sql.Blob#length().
*
* @returns The number of bytes in this blob.
*/
length(): number
/**
* For documentation of this method, see
* java.sql.Blob#position(byte[], long).
*
* @param pattern - The byte array to search for.
* @param start - The position in the blob value where to beging searching; the first position is 1.
*
* @returns The position at which the specified pattern begins, or else -1 if the pattern is not
* found.
*/
position(
pattern: number[],
start: number
): number
/**
* For documentation of this method, see
* java.sql.Blob#position(blob, long).
*
* @param pattern - The JdbcBlob indicating the value to search for.
* @param start - The position in the blob value where to beging searching; the first position is 1.
*
* @returns The position at which the specified pattern begins, or else -1 if the pattern is not
* found.
*/
position(
pattern: Jdbc.JdbcBlob,
start: number
): number
/**
* Convenience method for writing a JdbcBlob to this blob.
*
* @param position - The position in the blob at which to start writing; the first position is 1.
* @param blobSource - The source of data to write to this blob.
*
* @returns The number of bytes written.
*/
setBytes(
position: number,
blobSource: BlobSource
): number
/**
* Convenience method for writing a JdbcBlob to this blob.
*
* @param position - The position in the blob at which to start writing; the first position is 1.
* @param blobSource - The source of data to write to this blob.
* @param offset - The offset into the provided byte array at which to start reading bytes to set.
* @param length - The number of bytes to write to the blob.
*
* @returns The number of bytes written.
*/
setBytes(
position: number,
blobSource: BlobSource,
offset: number,
length: number
): number
/**
* For documentation of this method, see
* java.sql.Blob#setBytes(long, byte[]).
*
* @param position - The position in the blob at which to start writing; the first position is 1.
* @param bytes - The array of bytes to write to this blob.
*
* @returns The number of bytes written.
*/
setBytes(
position: number,
bytes: number[]
): number
/**
* For documentation of this method, see
* java.sql.Blob#setBytes(long, byte[], int, int).
*
* @param position - The position in the blob at which to start writing; the first position is 1.
* @param bytes - The array of bytes to write to this blob.
* @param offset - The offset into the provided byte array at which to start reading bytes to set.
* @param length - The number of bytes to write to the blob.
*
* @returns The number of bytes written.
*/
setBytes(
position: number,
bytes: number[],
offset: number,
length: number
): number
/**
* For documentation of this method, see
* java.sql.Blob#truncate(long).
*
* @param length - The size (in bytes) of this blob after truncation.
*/
truncate(
length: number
): void
}
class JdbcCallableStatement {
private constructor();
/**
* For documentation of this method, see
* java.sql.PreparedStatement#addBatch().
*/
addBatch(): void
/**
* For documentation of this method, see
* java.sql.Statement#addBatch(String).
*
* @param sql - The SQL command to add to this statement, typically an SQL INSERT or UPDATE.
*/
addBatch(
sql: string
): void
/**
* For documentation of this method, see
* java.sql.Statement#cancel().
*/
cancel(): void
/**
* For documentation of this method, see
* java.sql.Statement#clearBatch().
*/
clearBatch(): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#clearParameters().
*/
clearParameters(): void
/**
* For documentation of this method, see
* java.sql.Statement#clearWarnings().
*/
clearWarnings(): void
/**
* For documentation of this method, see
* java.sql.Statement#close().
*/
close(): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#execute().
*
* @returns true if the first result is a result set; false if the first result is
* an update count or there is no result.
*/
execute(): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String).
*
* @param sql - The SQL statement to execute.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String, int).
*
* @param sql - The SQL statement to execute.
* @param autoGeneratedKeys - A flag that indicates whether auto-generated keys are made available
* for future retrieval; either Jdbc.Statement.RETURN_GENERATED_KEYS or Jdbc.Statement.NO_GENERATED_KEYS.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string,
autoGeneratedKeys: number
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String, int[]).
*
* @param sql - The SQL statement to execute.
* @param columnIndexes - The column indices in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string,
columnIndexes: number[]
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String, String[]).
*
* @param sql - The SQL statement to execute.
* @param columnNames - The names of columns in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string,
columnNames: string[]
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#executeBatch().
*
* @returns The update counts for each command in the batch, using the same order in which commands
* were added to the batch.
*/
executeBatch(): number[]
/**
* For documentation of this method, see
* java.sql.PreparedStatement#executeQuery().
*
* @returns A result set that contains the data produced by the query.
*/
executeQuery(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.Statement#executeQuery(String).
*
* @param sql - The SQL statement to execute, typically a static SELECT.
*
* @returns A result set containing the results of the execution. This is never null.
*/
executeQuery(
sql: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.PreparedStatement#executeUpdate().
*
* @returns The row count ofr SQL Data Manipulation Language statements, or 0 for SQL statements
* that return nothing.
*/
executeUpdate(): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string
): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String, int).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
* @param autoGeneratedKeys - A flag that indicates whether auto-generated keys are made available
* for future retrieval; either Jdbc.Statement.RETURN_GENERATED_KEYS or Jdbc.Statement.NO_GENERATED_KEYS.
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string,
autoGeneratedKeys: number
): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String, int[]).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
* @param columnIndexes - The column indices in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string,
columnIndexes: number[]
): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String, String[]).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
* @param columnNames - The names of columns in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string,
columnNames: string[]
): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getArray(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a ARRAY parameter. Returns null if the value is null.
*/
getArray(
parameterIndex: number
): Jdbc.JdbcArray
/**
* For documentation of this method, see
* java.sql.CallableStatement#getArray(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a ARRAY parameter. Returns null if the value is null.
*/
getArray(
parameterName: string
): Jdbc.JdbcArray
/**
* For documentation of this method, see
* java.sql.CallableStatement#getBigDecimal(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a NUMERIC parameter in full precision. Returns null if the
* value is null.
*/
getBigDecimal(
parameterIndex: number
): BigNumber
/**
* For documentation of this method, see
* java.sql.CallableStatement#getBigDecimal(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a NUMERIC parameter. Returns null if the value is null.
*/
getBigDecimal(
parameterName: string
): BigNumber
/**
* For documentation of this method, see
* java.sql.CallableStatement#getBlob(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a BLOB parameter. Returns null if the value is null.
*/
getBlob(
parameterIndex: number
): Jdbc.JdbcBlob
/**
* For documentation of this method, see
* java.sql.CallableStatement#getBlob(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a BLOB parameter. Returns null if the value is null.
*/
getBlob(
parameterName: string
): Jdbc.JdbcBlob
/**
* For documentation of this method, see
* java.sql.CallableStatement#getBoolean(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a BIT or BOOLEAN parameter. Returns false if the
* value is null.
*/
getBoolean(
parameterIndex: number
): Boolean
/**
* For documentation of this method, see
* java.sql.CallableStatement#getBoolean(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a BIT or BOOLEAN parameter. Returns false if the
* value is null.
*/
getBoolean(
parameterName: string
): Boolean
/**
* For documentation of this method, see
* java.sql.CallableStatement#getByte(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a TINYINT parameter. Returns 0 if the value is null.
*/
getByte(
parameterIndex: number
): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getByte(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a TINYINT parameter. Returns 0 if the value is null.
*/
getByte(
parameterName: string
): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getBytes(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a BINARY or VARBINARY parameter. Returns null if
* the value is null.
*/
getBytes(
parameterIndex: number
): number[]
/**
* For documentation of this method, see
* java.sql.CallableStatement#getBytes(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a BINARY or VARBINARY parameter. Returns null if
* the value is null.
*/
getBytes(
parameterName: string
): number[]
/**
* For documentation of this method, see
* java.sql.CallableStatement#getClob(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a CLOB parameter. Returns null if the value is null.
*/
getClob(
parameterIndex: number
): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.CallableStatement#getClob(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a CLOB parameter. Returns null if the value is null.
*/
getClob(
parameterName: string
): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.Statement#getConnection().
*
* @returns The connection that produced this statement.
*/
getConnection(): Jdbc.JdbcConnection
/**
* For documentation of this method, see
* java.sql.CallableStatement#getDate(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a DATE parameter. Returns null if the value is null.
*/
getDate(
parameterIndex: number
): Jdbc.JdbcDate
/**
* For documentation of this method, see
* java.sql.CallableStatement#getDate(int, Calendar).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The value of a DATE parameter. Returns null if the value is null.
*/
getDate(
parameterIndex: number,
timeZone: string
): Jdbc.JdbcDate
/**
* For documentation of this method, see
* java.sql.CallableStatement#getDate(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a DATE parameter. Returns null if the value is null.
*/
getDate(
parameterName: string
): Jdbc.JdbcDate
/**
* For documentation of this method, see
* java.sql.CallableStatement#getDate(String, Calendar).
*
* @param parameterName - The name of the parameter.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The value of a DATE parameter. Returns null if the value is null.
*/
getDate(
parameterName: string,
timeZone: string
): Jdbc.JdbcDate
/**
* For documentation of this method, see
* java.sql.CallableStatement#getDouble(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a DOUBLE parameter. Returns 0 if the value is null.
*/
getDouble(
parameterIndex: number
): Number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getDouble(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a DOUBLE parameter. Returns 0 if the value is null.
*/
getDouble(
parameterName: string
): Number
/**
* For documentation of this method, see
* java.sql.Statement#getFetchDirection().
*
* @returns The default direction for result sets generated by this statement, which is either
* Jdbc.ResultSet.FETCH_FORWARD or Jdbc.ResultSet.FETCH_REVERSE.
*/
getFetchDirection(): number
/**
* For documentation of this method, see
* java.sql.Statement#getFetchSize().
*
* @returns The default row fetch size for result sets generated from this statement.
*/
getFetchSize(): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getFloat(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a FLOAT parameter. Returns 0 if the value is null.
*/
getFloat(
parameterIndex: number
): Number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getFloat(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a FLOAT parameter. Returns 0 if the value is null.
*/
getFloat(
parameterName: string
): Number
/**
* For documentation of this method, see
* java.sql.Statement#getGeneratedKeys().
*
* @returns A result set containing the auto-generated keys generated by the execution of this
* statement.
*/
getGeneratedKeys(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.CallableStatement#getInt(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a INTEGER parameter. Returns 0 if the value is null.
*/
getInt(
parameterIndex: number
): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getInt(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a INTEGER parameter. Returns 0 if the value is null.
*/
getInt(
parameterName: string
): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getLong(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a BIGINT parameter. Returns 0 if the value is null.
*/
getLong(
parameterIndex: number
): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getLong(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a BIGINT parameter. Returns 0 if the value is null.
*/
getLong(
parameterName: string
): number
/**
* For documentation of this method, see
* java.sql.Statement#getMaxFieldSize().
*
* @returns The current column byte size limit for columns storing character and binary values; a
* value of zero indictates no limit.
*/
getMaxFieldSize(): number
/**
* For documentation of this method, see
* java.sql.Statement#getMaxRows().
*
* @returns The current maximum number of rows for a result set produced by this statement; a value
* of 0 indicates no limit.
*/
getMaxRows(): number
/**
* For documentation of this method, see
* java.sql.PreparedStatement#getMetaData().
*
* @returns The description of a result set's columns, or NULL if this metadata is
* unavailable.
*/
getMetaData(): Jdbc.JdbcResultSetMetaData
/**
* For documentation of this method, see
* java.sql.Statement#getMoreResults().
*
* @returns true if the next result is a result set; false otherwise.
*/
getMoreResults(): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#getMoreResults(int).
*
* @param current - A flag that indicates what happens to current result sets when retrieved. This
* value is one of Jdbc.Statement.CLOSE_CURRENT_RESULT, Jdbc.Statement.KEEP_CURRENT_RESULT, or Jdbc.Statement.CLOSE_ALL_RESULTS.
*
* @returns true if the next result is a result set; false otherwise.
*/
getMoreResults(
current: number
): Boolean
/**
* For documentation of this method, see
* java.sql.CallableStatement#getNClob(int).
*
* @param parameterIndex - An index indicating which paramater to register (the first parameter is
* 1, the second is 2, and so on).
*
* @returns The value of a NCLOB parameter. Returns null if the value is null.
*/
getNClob(
parameterIndex: number
): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.CallableStatement#getNClob(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a NCLOB parameter. Returns null if the value is null.
*/
getNClob(
parameterName: string
): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.CallableStatement#getNString(int).
*
* @param parameterIndex - An index indicating which paramater to register (the first parameter is
* 1, the second is 2, and so on).
*
* @returns A string that maps a NCHAR, NVARCHAR, or LONGNVARCHAR value.
*/
getNString(
parameterIndex: number
): string
/**
* For documentation of this method, see
* java.sql.CallableStatement#getNString(String).
*
* @param parameterName - The name of the parameter.
*
* @returns A string that maps a NCHAR, NVARCHAR, or LONGNVARCHAR value.
*/
getNString(
parameterName: string
): string
/**
* For documentation of this method, see
* java.sql.CallableStatement#getObject(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns An object holding the parameter value.
*/
getObject(
parameterIndex: number
): object
/**
* For documentation of this method, see
* java.sql.CallableStatement#getObject(String).
*
* @param parameterName - The name of the parameter.
*
* @returns An object holding the parameter value.
*/
getObject(
parameterName: string
): object
/**
* For documentation of this method, see
* java.sql.PreparedStatement#getParameterMetaData().
*
* @returns The parameter metadata, including the number, types, and properties for each parameter.
*/
getParameterMetaData(): Jdbc.JdbcParameterMetaData
/**
* For documentation of this method, see
* java.sql.Statement#getQueryTimeout().
*
* @returns The current query timeout in seconds; a value of zero indicates no timeout.
*/
getQueryTimeout(): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getRef(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a REF parameter. Returns null if the value is null.
*/
getRef(
parameterIndex: number
): Jdbc.JdbcRef
/**
* For documentation of this method, see
* java.sql.CallableStatement#getRef(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a REF parameter. Returns null if the value is null.
*/
getRef(
parameterName: string
): Jdbc.JdbcRef
/**
* For documentation of this method, see
* java.sql.Statement#getResultSet().
*
* @returns The current result set, or null if the result is an update count or there are
* no more results.
*/
getResultSet(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.Statement#getResultSetConcurrency().
*
* @returns The result set concurrency for result sets generated from this statement, which is
* either Jdbc.ResultSet.CONCUR_READ_ONLY or Jdbc.ResultSet.CONCUR_UPDATABLE.
*/
getResultSetConcurrency(): number
/**
* For documentation of this method, see
* java.sql.Statement#getResultSetHoldability().
*
* @returns The result set holdability, which is either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*/
getResultSetHoldability(): number
/**
* For documentation of this method, see
* java.sql.Statement#getResultSetType().
*
* @returns The result set type for result sets generated from this statement, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or
* Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*/
getResultSetType(): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getRowId(int).
*
* @param parameterIndex - An index indicating which paramater to register (the first parameter is
* 1, the second is 2, and so on).
*
* @returns The ROWID value. Returns null if the parameter contains an SQL NULL.
*/
getRowId(
parameterIndex: number
): Jdbc.JdbcRowId
/**
* For documentation of this method, see
* java.sql.CallableStatement#getRowId(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The ROWID value. Returns null if the parameter contains an SQL NULL.
*/
getRowId(
parameterName: string
): Jdbc.JdbcRowId
/**
* For documentation of this method, see
* java.sql.CallableStatement#getSQLXML(int).
*
* @param parameterIndex - An index indicating which paramater to register (the first parameter is
* 1, the second is 2, and so on).
*
* @returns A SQLXML object that maps to an SQL XML value.
*/
getSQLXML(
parameterIndex: number
): Jdbc.JdbcSQLXML
/**
* For documentation of this method, see
* java.sql.CallableStatement#getSQLXML(String).
*
* @param parameterName - The name of the parameter.
*
* @returns A SQLXML object that maps to an SQL XML value.
*/
getSQLXML(
parameterName: string
): Jdbc.JdbcSQLXML
/**
* For documentation of this method, see
* java.sql.CallableStatement#getShort(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a SMALLINT parameter. Returns 0 if the value is null.
*/
getShort(
parameterIndex: number
): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getShort(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a SMALLINT parameter. Returns 0 if the value is null.
*/
getShort(
parameterName: string
): number
/**
* For documentation of this method, see
* java.sql.CallableStatement#getString(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a CHAR, VARCHAR, or LONGVARCHAR parameter.
*/
getString(
parameterIndex: number
): string
/**
* For documentation of this method, see
* java.sql.CallableStatement#getString(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a CHAR, VARCHAR, or LONGVARCHAR parameter. Returns
* null if the value is null.
*/
getString(
parameterName: string
): string
/**
* For documentation of this method, see
* java.sql.CallableStatement#getTime(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a TIME parameter. Returns null if the value is null.
*/
getTime(
parameterIndex: number
): Jdbc.JdbcTime
/**
* For documentation of this method, see
* java.sql.CallableStatement#getTime(int, Calendar).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The value of a TIME parameter. Returns null if the value is null.
*/
getTime(
parameterIndex: number,
timeZone: string
): Jdbc.JdbcTime
/**
* For documentation of this method, see
* java.sql.CallableStatement#getTime(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a TIME parameter. Returns null if the value is null.
*/
getTime(
parameterName: string
): Jdbc.JdbcTime
/**
* For documentation of this method, see
* java.sql.CallableStatement#getTime(String, Calendar).
*
* @param parameterName - The name of the parameter.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The value of a TIME parameter. Returns null if the value is null.
*/
getTime(
parameterName: string,
timeZone: string
): Jdbc.JdbcTime
/**
* For documentation of this method, see
* java.sql.CallableStatement#getTimestamp(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a TIMESTAMP parameter. Returns null if the value is null.
*/
getTimestamp(
parameterIndex: number
): Jdbc.JdbcTimestamp
/**
* For documentation of this method, see
* java.sql.CallableStatement#getTimestamp(int, Calendar).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The value of a TIMESTAMP parameter. Returns null if the value is null.
*/
getTimestamp(
parameterIndex: number,
timeZone: string
): Jdbc.JdbcTimestamp
/**
* For documentation of this method, see
* java.sql.CallableStatement#getTimestamp(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a TIMESTAMP parameter. Returns null if the value is null.
*/
getTimestamp(
parameterName: string
): Jdbc.JdbcTimestamp
/**
* For documentation of this method, see
* java.sql.CallableStatement#getTimestamp(String, Calendar).
*
* @param parameterName - The name of the parameter.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The value of a TIMESTAMP parameter. Returns null if the value is null.
*/
getTimestamp(
parameterName: string,
timeZone: string
): Jdbc.JdbcTimestamp
/**
* For documentation of this method, see
* java.sql.CallableStatement#getURL(int).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
*
* @returns The value of a DATALINK parameter as a string.
*/
getURL(
parameterIndex: number
): string
/**
* For documentation of this method, see
* java.sql.CallableStatement#getURL(String).
*
* @param parameterName - The name of the parameter.
*
* @returns The value of a DATALINK parameter. Returns null if the value is null.
*/
getURL(
parameterName: string
): string
/**
* For documentation of this method, see
* java.sql.Statement#getUpdateCount().
*
* @returns The current result as an update count, or -1 if the current result is a result set or
* if there are no more results.
*/
getUpdateCount(): number
/**
* For documentation of this method, see
* java.sql.Statement#getWarnings().
*
* @returns The current set of warnings, or null if there are no warnings.
*/
getWarnings(): string[]
/**
* For documentation of this method, see
* java.sql.Statement#isClosed().
*
* @returns true if this statement is closed; false otherwise.
*/
isClosed(): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#isPoolable().
*
* @returns true if this statement is poolable; false otherwise.
*/
isPoolable(): Boolean
/**
* For documentation of this method, see
* java.sql.CallableStatement#registerOutParameter(int, int).
*
* @param parameterIndex - An index indicating which paramater to register (the first parameter is
* 1, the second is 2, and so on).
* @param sqlType - The JDBC type code to
* register. If the parameter is of JDBC type NUMERIC or DECIMAL,
* use registerOutParameter(parameterIndex, sqlType, scale) instead.
*/
registerOutParameter(
parameterIndex: number,
sqlType: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#registerOutParameter(int, int, int).
*
* @param parameterIndex - An index indicating which paramater to register (the first parameter is
* 1, the second is 2, and so on).
* @param sqlType - The JDBC type code to
* register.
* @param scale - The desired number of digits to the right of the decimal point (must be zero or
* greater).
*/
registerOutParameter(
parameterIndex: number,
sqlType: number,
scale: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#registerOutParameter(int, int, String).
*
* @param parameterIndex - The index of the parameter to retrieve (the first parameter is 1, the
* second is 2, and so on).
* @param sqlType - A type
* code value.
* @param typeName - The fully-qualified name of an SQL structured type.
*/
registerOutParameter(
parameterIndex: number,
sqlType: number,
typeName: string
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#registerOutParameter(String, int).
*
* @param parameterName - The name of the parameter to be registered.
* @param sqlType - A type
* code value.
*/
registerOutParameter(
parameterName: string,
sqlType: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#registerOutParameter(String, int, int).
*
* @param parameterName - The name of the parameter to be registered.
* @param sqlType - A type
* code value.
* @param scale - The desired number of digits to the right of the decimal point, which must be zero
* or greater.
*/
registerOutParameter(
parameterName: string,
sqlType: number,
scale: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#registerOutParameter(String, int, String).
*
* @param parameterName - The name of the parameter to be registered.
* @param sqlType - A type
* code value.
* @param typeName - The fully-qualified name of an SQL structured type.
*/
registerOutParameter(
parameterName: string,
sqlType: number,
typeName: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setArray(int, Array).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setArray(
parameterIndex: number,
x: Jdbc.JdbcArray
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setBigDecimal(int, BigDecimal).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setBigDecimal(
parameterIndex: number,
x: BigNumber
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setBigDecimal(String, BigDecimal).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setBigDecimal(
parameterName: string,
x: BigNumber
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setBlob(int, Clob).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setBlob(
parameterIndex: number,
x: Jdbc.JdbcBlob
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setBlob(String, Blob).
*
* @param parameterName - The name of the parameter to set.
* @param x - A blob that maps to an SQL BLOB value.
*/
setBlob(
parameterName: string,
x: Jdbc.JdbcBlob
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setBoolean(int, boolean).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setBoolean(
parameterIndex: number,
x: Boolean
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setBoolean(String, boolean).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setBoolean(
parameterName: string,
x: Boolean
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setByte(int, byte).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setByte(
parameterIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setByte(String, byte).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setByte(
parameterName: string,
x: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setBytes(int, byte[]).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setBytes(
parameterIndex: number,
x: number[]
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setBytes(String, byte[]).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setBytes(
parameterName: string,
x: number[]
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setClob(int, Clob).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setClob(
parameterIndex: number,
x: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setBlob(String, Clob).
*
* @param parameterName - The name of the parameter to set.
* @param x - A clob that maps to an SQL CLOB value.
*/
setClob(
parameterName: string,
x: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.Statement#setCursorName(String).
*
* @param name - The new cursor name, which must be unique within a connection.
*/
setCursorName(
name: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setDate(int, Date).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setDate(
parameterIndex: number,
x: Jdbc.JdbcDate
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setDate(int, Date, Calendar).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*/
setDate(
parameterIndex: number,
x: Jdbc.JdbcDate,
timeZone: string
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setDate(String, Date).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setDate(
parameterName: string,
x: Jdbc.JdbcDate
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setDate(String, Date, Calendar).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*/
setDate(
parameterName: string,
x: Jdbc.JdbcDate,
timeZone: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setDouble(int, double).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setDouble(
parameterIndex: number,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setDouble(String, double).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setDouble(
parameterName: string,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setEscapeProcessing(boolean).
*
* @param enable - If true, escape processing is enabled; otherwise it is disabled.
*/
setEscapeProcessing(
enable: Boolean
): void
/**
* For documentation of this method, see
* java.sql.Statement#setFetchDirection(int).
*
* @param direction - The specified direction to set, which is either Jdbc.ResultSet.FETCH_FORWARD or Jdbc.ResultSet.FETCH_REVERSE.
*/
setFetchDirection(
direction: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setFetchSize(int).
*
* @param rows - The number of rows to fetch.
*/
setFetchSize(
rows: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setFloat(int, float).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setFloat(
parameterIndex: number,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setFloat(String, float).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setFloat(
parameterName: string,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setInt(int, int).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setInt(
parameterIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setInt(String, int).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setInt(
parameterName: string,
x: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setLong(int, long).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setLong(
parameterIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setLong(String, long).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setLong(
parameterName: string,
x: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setMaxFieldSize(int).
*
* @param max - The new column byte size limit; a value of zero indicates no limit.
*/
setMaxFieldSize(
max: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setMaxRows(int).
*
* @param max - The maximum number of rows a result set generated by this statement can have. A
* value of 0 indicates no limit.
*/
setMaxRows(
max: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setNClob(int, NClob).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setNClob(
parameterIndex: number,
x: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setNClob(String, NClob).
*
* @param parameterName - The name of the parameter to set.
* @param value - The parameter value to set.
*/
setNClob(
parameterName: string,
value: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setNString(int, String).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setNString(
parameterIndex: number,
x: string
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setNString(String, String).
*
* @param parameterName - The name of the parameter to set.
* @param value - The parameter value to set.
*/
setNString(
parameterName: string,
value: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setNull(int, int).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param sqlType - The SQL
* type of the specified parameter.
*/
setNull(
parameterIndex: number,
sqlType: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setNull(int, int, String).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param sqlType - The SQL
* type of the specified parameter.
* @param typeName - The fully-qualifed name of an SQL user-defined type. Ignored if the parameter
* isn't a user-defined type or REF.
*/
setNull(
parameterIndex: number,
sqlType: number,
typeName: string
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setNull(String, int).
*
* @param parameterName - The name of the parameter to set.
* @param sqlType - The SQL
* type code.
*/
setNull(
parameterName: string,
sqlType: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setNull(String, int, String).
*
* @param parameterName - The name of the parameter to set.
* @param sqlType - The SQL
* type.
* @param typeName - The fully-qualified name of an SQL user-defined type; ignored if the parameter
* is not a user-defined type or SQL REF value.
*/
setNull(
parameterName: string,
sqlType: number,
typeName: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setObject(int, Object).
*
* @param index - The index of the parameter to set (the first parameter is 1, the second is 2, and
* so on).
* @param x - The object containing the value to set the parameter to.
*/
setObject(
index: number,
x: object
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setObject(int, Object, int).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The object containing the value to set the parameter to.
* @param targetSqlType - The SQL type to send
* to the database.
*/
setObject(
parameterIndex: number,
x: object,
targetSqlType: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setObject(int, Object, int, int).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The object containing the value to set the parameter to.
* @param targetSqlType - The SQL type to send
* to the database. The scale argument may further qualify this type.
* @param scaleOrLength - The number of digits after the decimal for DECIMAL or NUMERIC types, or the length of data for InputStream or Reader types.
* Ignored for all other types.
*/
setObject(
parameterIndex: number,
x: object,
targetSqlType: number,
scaleOrLength: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setObject(String, Object).
*
* @param parameterName - The name of the parameter to set.
* @param x - The object containing the value to set.
*/
setObject(
parameterName: string,
x: object
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setObject(String, Object, int).
*
* @param parameterName - The name of the parameter to set.
* @param x - The object containing the value to set.
* @param targetSqlType - The SQL type sent to
* the database.
*/
setObject(
parameterName: string,
x: object,
targetSqlType: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setObject(String, Object, int, int).
*
* @param parameterName - The name of the parameter to set.
* @param x - The object containing the value to set.
* @param targetSqlType - The SQL type sent to
* the database. The scale parameter may further qualify this type.
* @param scale - The number of digits after the decimal point for DECIMAL and NUMERIC types. Ignored for all other types.
*/
setObject(
parameterName: string,
x: object,
targetSqlType: number,
scale: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setPoolable(boolean).
*
* @param poolable - If true, requests that this statement be pooled; otherwise requests it
* not be pooled.
*/
setPoolable(
poolable: Boolean
): void
/**
* For documentation of this method, see
* java.sql.Statement#setQueryTimeout(int).
*
* @param seconds - The new query timeout in seconds; a value of 0 indicates no timeout.
*/
setQueryTimeout(
seconds: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setRef(int, Ref).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The SQL REF value to set.
*/
setRef(
parameterIndex: number,
x: Jdbc.JdbcRef
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setRowId(int, RowId).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setRowId(
parameterIndex: number,
x: Jdbc.JdbcRowId
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setRowId(String, RowId).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setRowId(
parameterName: string,
x: Jdbc.JdbcRowId
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setSQLXML(int, SQLXML).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setSQLXML(
parameterIndex: number,
x: Jdbc.JdbcSQLXML
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setSQLXML(String, SQLXML).
*
* @param parameterName - The name of the parameter to set.
* @param xmlObject - A SQLXML object that maps to an SQL XML value.
*/
setSQLXML(
parameterName: string,
xmlObject: Jdbc.JdbcSQLXML
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setShort(int, short).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setShort(
parameterIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setShort(String, short).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setShort(
parameterName: string,
x: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setString(int, String).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setString(
parameterIndex: number,
x: string
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setString(String, String).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setString(
parameterName: string,
x: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setTime(int, Time).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setTime(
parameterIndex: number,
x: Jdbc.JdbcTime
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setTime(int, Time, Calendar).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*/
setTime(
parameterIndex: number,
x: Jdbc.JdbcTime,
timeZone: string
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setTime(String, Time).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setTime(
parameterName: string,
x: Jdbc.JdbcTime
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setTime(String, Time, Calendar).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*/
setTime(
parameterName: string,
x: Jdbc.JdbcTime,
timeZone: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setTimestamp(int, Timestamp).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setTimestamp(
parameterIndex: number,
x: Jdbc.JdbcTimestamp
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setTimestamp(int, Timestamp, Calendar).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*/
setTimestamp(
parameterIndex: number,
x: Jdbc.JdbcTimestamp,
timeZone: string
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setTimestamp(String, Timestamp).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
*/
setTimestamp(
parameterName: string,
x: Jdbc.JdbcTimestamp
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setTimestamp(String, Timestamp, Calendar).
*
* @param parameterName - The name of the parameter to set.
* @param x - The parameter value to set.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*/
setTimestamp(
parameterName: string,
x: Jdbc.JdbcTimestamp,
timeZone: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setURL(int, URL).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setURL(
parameterIndex: number,
x: string
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#setURL(String, URL).
*
* @param parameterName - The name of the parameter to set.
* @param val - The parameter value to set.
*/
setURL(
parameterName: string,
val: string
): void
/**
* For documentation of this method, see
* java.sql.CallableStatement#wasNull().
*
* @returns true if the last parameter read was null; returns false
* otherwise.
*/
wasNull(): Boolean
}
class JdbcClob {
private constructor();
/**
* For documentation of this method, see
* java.sql.Clob#truncate(long).
*/
free(): void
/**
* Gets the content of this JdbcClob as an Apps Script blob.
*
* @returns A Blob that can be used directly by other Apps Script APIs.
*/
getAppsScriptBlob(): Blob
/**
* Return the data inside this object as a blob converted to the specified content type. This
* method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it
* assumes that the part of the filename that follows the last period (if any) is an existing
* extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes
* "ShoppingList.12.25.pdf".
*
*
To view the daily quotas for conversions, see Quotas for Google
* Services. Newly created G Suite domains might be temporarily subject to stricter quotas.
*
* @param contentType - The MIME type to convert to. For most blobs, 'application/pdf' is
* the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp', 'image/gif', 'image/jpeg', or 'image/png' are also
* valid.
*
* @returns The data as a blob.
*/
getAs(
contentType: string
): Blob
/**
* For documentation of this method, see
* java.sql.Clob#getSubString(long, int).
*
* @param position - The index of the first character of the substring to extract. The first
* character is at index 1.
* @param length - The number of consecutive characters to copy (must be 0 or greater).
*
* @returns The retrieved substring.
*/
getSubString(
position: number,
length: number
): string
/**
* For documentation of this method, see
* java.sql.Clob#length().
*
* @returns The length (in characters) of this clob.
*/
length(): number
/**
* For documentation of this method, see
* java.sql.Clob#position(Clob, long).
*
* @param search - The clob object to search for.
* @param start - The position at which to begin searching; the first position is 1.
*
* @returns The position at which the specifed clob appears, or -1 if it is not present.
*/
position(
search: Jdbc.JdbcClob,
start: number
): number
/**
* For documentation of this method, see
* java.sql.Clob#position(String, long).
*
* @param search - The substring to search for.
* @param start - The position at which to begin searching; the first position is 1.
*
* @returns The position at which the specifed substring appears, or -1 if it is not present.
*/
position(
search: string,
start: number
): number
/**
* Convenience method for writing a JdbcClob to a clob.
*
* @param position - The position at which writing to the clob starts; the first position is 1.
* @param blobSource - The blob source to write.
*
* @returns The number of characters written.
*/
setString(
position: number,
blobSource: BlobSource
): number
/**
* Convenience method for writing a JdbcClob to a clob.
*
* @param position - The position at which writing to the clob starts; the first position is 1.
* @param blobSource - The blob source to write.
* @param offset - The offset into the provided string where reading characters to write starts.
* @param len - The number of characters to write.
*
* @returns The number of characters written.
*/
setString(
position: number,
blobSource: BlobSource,
offset: number,
len: number
): number
/**
* For documentation of this method, see
* java.sql.Clob#setString(long, String).
*
* @param position - The position at which writing to the clob starts; the first position is 1.
* @param value - The string to write.
*
* @returns The number of characters written.
*/
setString(
position: number,
value: string
): number
/**
* For documentation of this method, see
* java.sql.Clob#setString(long, String, int, int).
*
* @param position - The position at which writing to the clob starts; the first position is 1.
* @param value - The string to write.
* @param offset - The offset into the provided string where reading characters to write starts.
* @param len - The number of characters to write.
*
* @returns The number of characters written.
*/
setString(
position: number,
value: string,
offset: number,
len: number
): number
/**
* For documentation of this method, see
* java.sql.Clob#truncate(long).
*
* @param length - The size (in bytes) of this clob after truncation.
*/
truncate(
length: number
): void
}
class JdbcConnection {
private constructor();
/**
* For documentation of this method, see
* java.sql.Connection#clearWarnings().
*/
clearWarnings(): void
/**
* Release this connection's database and all associated resources.
*
*
* var conn = Jdbc.getConnection("jdbc:mysql://<host>:<port>/<instance>", "user", "password");
* conn.close();
*
*/
close(): void
/**
* Makes all pending changes permanent, releases database locks held by this JdbcConnection.
*
*
* var conn = Jdbc.getConnection("jdbc:mysql://<host>:<port>/<instance>", "user", "password");
* conn.setAutoCommit(false);
* var stmt = conn.prepareStatement("insert into person (lname,fname) values (?,?)");
* var start = new Date();
* for (var i = 0; i < 5000; i++) {
* // Objects are accessed using 1-based indexing
* stmt.setObject(1, 'firstName' + i);
* stmt.setObject(2, 'lastName' + i);
* stmt.addBatch();
* }
* var res = stmt.executeBatch();
* conn.commit(); // When this returns, this is when changes are actually committed
* conn.close();
*
*/
commit(): void
/**
* For documentation of this method, see
* java.sql.Connection#createArrayOf(String, Object[]).
*
* @param typeName - The database-specific SQL name of the array elemnents' type. Options include
* built-in types, user-defined types, or standard SQL types supported by the database.
* @param elements - The elements to populate in the returned object.
*
* @returns An array whose elements map to the specified SQL type.
*/
createArrayOf(
typeName: string,
elements: object[]
): Jdbc.JdbcArray
/**
* Constructs a JdbcBlob instance. See also
* java.sql.Connection#createBlob().
*
* The object returned initially contains no data. You can use the setBytes methods of
* JdbcBlob to set the data it should contain. The blob used here is not the same as the
* blob created with Utilities.newBlob(data). To convert
* between the two formats, use the defined getBytes() and setBytes() methods.
* Alternatively, both JdbcBlob and JdbcClob provide a getAppsScriptBlob()
* convenience method for converting to a format that can be used by Apps Script.
*
* @returns An empty blob object.
*/
createBlob(): Jdbc.JdbcBlob
/**
* For documentation of this method, see
* java.sql.Connection#createClob().
*
* @returns An empty clob object.
*/
createClob(): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.Connection#createNClob().
*
* @returns An empty nclob object.
*/
createNClob(): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.Connection#createSQLXML().
*
* @returns An empty SQLXML object.
*/
createSQLXML(): Jdbc.JdbcSQLXML
/**
* Creates a JdbcStatement object for sending SQL statements to the database. See also
* java.sql.Connection#createStatement().
*
*
* // This sample code assumes authentication is off
* var conn = Jdbc.getConnection("jdbc:mysql://<host>:3306/<instance>")
* var stmt = conn.createStatement();
*
* stmt.setMaxRows(100);
* var rs = stmt.execute("select * from person");
*
* while(rs.next()) {
* // Do something
* }
*
* rs.close();
* stmt.close();
* conn.close();
*
*
* @returns A statement instance to execute queries with.
*/
createStatement(): Jdbc.JdbcStatement
/**
* Creates a JdbcStatement object for sending SQL statements to the database. See also
* java.sql.Connection#createStatement(int, int).
*
* This version allows the result set type and concurrency to be overridden. * *
* // This sample code assumes authentication is off
* // For more information about this method, see documentation here:
* // http://docs.oracle.com/javase/6/docs/api/java/sql/Connection.html#createStatement(int, int)
* var conn = Jdbc.getConnection("jdbc:mysql://<host>:3306/<instance>")
* var stmt = conn.createStatement(Jdbc.ResultSet.TYPE_FORWARD_ONLY,
* Jdbc.ResultSet.CONCUR_READ_ONLY);
*
* stmt.setMaxRows(100);
* var rs = stmt.execute("select * from person");
*
* while(rs.next()) {
* // Do something
* }
*
* rs.close();
* stmt.close();
* conn.close();
*
*
* @param resultSetType - A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE.
* @param resultSetConcurrency - A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
* or Jdbc.ResultSet.CONCUR_UPDATABLE.
*
* @returns A statement instance to execute queries with.
*/
createStatement(
resultSetType: number,
resultSetConcurrency: number
): Jdbc.JdbcStatement
/**
* Creates a JdbcStatement object for sending SQL statements to the database. See also
* java.sql.Connection#createStatement(int, int, int).
*
* This version allows the result set type, concurrency and holdability to be overridden. * *
* // This sample code assumes authentication is off
* // For more information about this method, see documentation here:
* // http://docs.oracle.com/javase/6/docs/api/java/sql/Connection.html#createStatement(int, int)
* var conn = Jdbc.getConnection("jdbc:mysql://<host>:3306/<instance>")
* var stmt = conn.createStatement(Jdbc.ResultSet.TYPE_FORWARD_ONLY,
* Jdbc.ResultSet.CONCUR_READ_ONLY,
* Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT);
*
* stmt.setMaxRows(100);
* var rs = stmt.execute("select * from person");
*
* while(rs.next()) {
* // Do something
* }
*
* rs.close();
* stmt.close();
* conn.close();
*
*
* @param resultSetType - A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE.
* @param resultSetConcurrency - A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
* or Jdbc.ResultSet.CONCUR_UPDATABLE.
* @param resultSetHoldability - A holdability setting; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*
* @returns A statement instance to execute queries with.
*/
createStatement(
resultSetType: number,
resultSetConcurrency: number,
resultSetHoldability: number
): Jdbc.JdbcStatement
/**
* For documentation of this method, see
* java.sql.Connection#createStruct(String, Object[]).
*
* @param typeName - The database-specific SQL name of the array elemnents' type. Options include
* built-in types, user-defined types, or standard SQL types supported by the database.
* @param attributes - The attributes that populate the returned object.
*
* @returns A structure object that maps to the given SQL type and is populated with the given
* attributes.
*/
createStruct(
typeName: string,
attributes: object[]
): Jdbc.JdbcStruct
/**
* For documentation of this method, see
* java.sql.Connection#getAutoCommit().
*
* @returns true if the connection's auto-commit mode is enabled; false otherwise.
*/
getAutoCommit(): Boolean
/**
* or documentation of this method, see
* java.sql.Connection#getCatalog().
*
* @returns The current catalog name or null if no name has been set.
*/
getCatalog(): string
/**
* For documentation of this method, see
* java.sql.Connection#getHoldability().
*
* @returns The holdability setting of the connection; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*/
getHoldability(): number
/**
* For documentation of this method, see
* java.sql.Connection#getMetaData().
*
* @returns The metadata of the database this connection connects to.
*/
getMetaData(): Jdbc.JdbcDatabaseMetaData
/**
* For documentation of this method, see
* java.sql.Connection#getTransactionIsolation().
*
* @returns The current transaction level, which is one of: Jdbc.Connection.TRANSACTION_READ_UNCOMMITTED, Jdbc.Connection.TRANSACTION_READ_COMMITTED, Jdbc.Connection.TRANSACTION_REPEATABLE_READ, Jdbc.Connection.TRANSACTION_SERIALIZABLE, or Jdbc.Connection.TRANSACTION_NONE.
*/
getTransactionIsolation(): number
/**
* For documentation of this method, see
* java.sql.Connection#getWarnings().
*
* @returns An array of warning strings.
*/
getWarnings(): string[]
/**
* For documentation of this method, see
* java.sql.Connection#isClosed().
*
* @returns true if the connection is closed; false otherwise.
*/
isClosed(): Boolean
/**
* For documentation of this method, see
* java.sql.Connection#isReadOnly().
*
* @returns true if the connection is read-only; false otherwise.
*/
isReadOnly(): Boolean
/**
* For documentation of this method, see
* java.sql.Connection#isValid(int).
*
* @param timeout - The time in seconds to wait for the validation operation to complete. A value of
* 0 indicates no timeout is applied.
*
* @returns true if the connection is valid; false otherwise. Also returns false if the timeout period expires before the operation completes.
*/
isValid(
timeout: number
): Boolean
/**
* For documentation of this method, see
* java.sql.Connection#nativeSQL(String).
*
* @param sql - An SQL statement that may contain one more more '?' placeholders.
*
* @returns The native form of the provided statement.
*/
nativeSQL(
sql: string
): string
/**
* For documentation of this method, see
* java.sql.Connection#prepareCall(String).
*
* @param sql - An SQL statement that may contain one more more '?' placeholders, typically provided
* using JDBC call escape syntax.
*
* @returns A callable statement containing the pre-compiled SQL statement.
*/
prepareCall(
sql: string
): Jdbc.JdbcCallableStatement
/**
* For documentation of this method, see
* java.sql.Connection#prepareCall(String, int, int).
*
* @param sql - An SQL statement that may contain one more more '?' placeholders, typically provided
* using JDBC call escape syntax.
* @param resultSetType - A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE.
* @param resultSetConcurrency - A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
* or Jdbc.ResultSet.CONCUR_UPDATABLE.
*
* @returns A callable statement containing the pre-compiled SQL statement that produces result
* sets with the provided type and concurrency.
*/
prepareCall(
sql: string,
resultSetType: number,
resultSetConcurrency: number
): Jdbc.JdbcCallableStatement
/**
* For documentation of this method, see
* java.sql.Connection#prepareCall(String, int, int, int).
*
* @param sql - An SQL statement that may contain one more more '?' placeholders, typically provided
* using JDBC call escape syntax.
* @param resultSetType - A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE.
* @param resultSetConcurrency - A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
* or Jdbc.ResultSet.CONCUR_UPDATABLE.
* @param resultSetHoldability - A holdability setting; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*
* @returns A callable statement containing the pre-compiled SQL statement that produces result
* sets with the provided type, concurrency.
*/
prepareCall(
sql: string,
resultSetType: number,
resultSetConcurrency: number,
resultSetHoldability: number
): Jdbc.JdbcCallableStatement
/**
* For documentation of this method, see
* java.sql.Connection#prepareStatement(String).
*
* @param sql - An SQL statement that may contain one more more '?' IN parameter placeholders.
*
* @returns A prepared statement containing the pre-compiled SQL statement.
*/
prepareStatement(
sql: string
): Jdbc.JdbcPreparedStatement
/**
* For documentation of this method, see
* java.sql.Connection#prepareStatement(String, int).
*
* @param sql - An SQL statement that may contain one more more '?' IN parameter placeholders.
* @param autoGeneratedKeys - A flag that indicates whether auto-generated keys are returned; either
* Jdbc.Statement.RETURN_GENERATED_KEYS or Jdbc.Statement.NO_GENERATED_KEYS.
*
* @returns A prepared statement containing the pre-compiled SQL statement, possibly capable of
* returning auto-generated keys.
*/
prepareStatement(
sql: string,
autoGeneratedKeys: number
): Jdbc.JdbcPreparedStatement
/**
* For documentation of this method, see
* java.sql.Connection#prepareStatement(String, int, int).
*
* @param sql - An SQL statement that may contain one more more '?' IN parameter placeholders.
* @param resultSetType - A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE.
* @param resultSetConcurrency - A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
* or Jdbc.ResultSet.CONCUR_UPDATABLE.
*
* @returns A prepared statement containing the pre-compiled SQL statement that produces result
* sets with the provided type and concurrency.
*/
prepareStatement(
sql: string,
resultSetType: number,
resultSetConcurrency: number
): Jdbc.JdbcPreparedStatement
/**
* For documentation of this method, see
* java.sql.Connection#prepareStatement(String, int, int, int).
*
* @param sql - An SQL statement that may contain one more more '?' IN parameter placeholders.
* @param resultSetType - A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE.
* @param resultSetConcurrency - A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
* or Jdbc.ResultSet.CONCUR_UPDATABLE.
* @param resultSetHoldability - A holdability setting; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*
* @returns A prepared statement containing the pre-compiled SQL statement that produces result
* sets with the provided type, concurrency, and holdability.
*/
prepareStatement(
sql: string,
resultSetType: number,
resultSetConcurrency: number,
resultSetHoldability: number
): Jdbc.JdbcPreparedStatement
/**
* For documentation of this method, see
* java.sql.Connection#prepareStatement(String, int[]).
*
* @param sql - An SQL statement that may contain one more more '?' IN parameter placeholders.
* @param indices - The column indices of columns that are returned from the inserted row or rows.
*
* @returns A prepared statement containing the pre-compiled SQL statement, capable of returning
* auto-generated keys specified by the provided column indices.
*/
prepareStatementByIndex(
sql: string,
indices: number[]
): Jdbc.JdbcPreparedStatement
/**
* For documentation of this method, see
* java.sql.Connection#prepareStatement(String, String[]).
*
* @param sql - An SQL statement that may contain one more more '?' IN parameter placeholders.
* @param columnNames - The column names that specify which columns the method should return from
* the inserted row or rows.
*
* @returns A prepared statement containing the pre-compiled SQL statement, capable of returning
* auto-generated keys specified by the provided column names.
*/
prepareStatementByName(
sql: string,
columnNames: string[]
): Jdbc.JdbcPreparedStatement
/**
* For documentation of this method, see
* java.sql.Connection#releaseSavepoint(Savepoint).
*
* @param savepoint - The save point to remove.
*/
releaseSavepoint(
savepoint: Jdbc.JdbcSavepoint
): void
/**
* For documentation of this method, see
* java.sql.Connection#rollback().
*/
rollback(): void
/**
* For documentation of this method, see
* java.sql.Connection#rollback(Savepoint).
*
* @param savepoint - The save point to rollback to.
*/
rollback(
savepoint: Jdbc.JdbcSavepoint
): void
/**
* For documentation of this method, see
* java.sql.Connection#setAutoCommit(boolean).
*
* @param autoCommit - If true, auto-commit mode is enabled; false disables.
*/
setAutoCommit(
autoCommit: Boolean
): void
/**
* For documentation of this method, see
* java.sql.Connection#setCatalog(String).
*
* @param catalog - The name of a catalog (the subspace in the connection's database) in which to
* work.
*/
setCatalog(
catalog: string
): void
/**
* For documentation of this method, see
* java.sql.Connection#setHoldability(int).
*
* @param holdability - The default holdability of JdbcResultSet objects created with this
* connection; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*/
setHoldability(
holdability: number
): void
/**
* For documentation of this method, see
* java.sql.Connection#setReadOnly(boolean).
*
* @param readOnly - If true, read-only mode is enabled; false disables.
*/
setReadOnly(
readOnly: Boolean
): void
/**
* For documentation of this method, see
* java.sql.Connection#setSavepoint().
*
* @returns The new unnamed save point.
*/
setSavepoint(): Jdbc.JdbcSavepoint
/**
* For documentation of this method, see
* java.sql.Connection#setSavepoint(String).
*
* @param name - The name of the created save point.
*
* @returns The new named save point.
*/
setSavepoint(
name: string
): Jdbc.JdbcSavepoint
/**
* For documentation of this method, see
* java.sql.Connection#setTransactionIsolation(int).
*
* @param level - The transaction level to set, which is one of: Jdbc.Connection.TRANSACTION_READ_UNCOMMITTED, Jdbc.Connection.TRANSACTION_READ_COMMITTED, Jdbc.Connection.TRANSACTION_REPEATABLE_READ, Jdbc.Connection.TRANSACTION_SERIALIZABLE, or Jdbc.Connection.TRANSACTION_NONE.
*/
setTransactionIsolation(
level: number
): void
}
class JdbcDatabaseMetaData {
private constructor();
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#allProceduresAreCallable().
*
* @returns true if the user can call all of the procedures returned by getProcedures(catalog, schemaPattern, procedureNamePattern); false otherwise.
*/
allProceduresAreCallable(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#allTablesAreSelectable().
*
* @returns true if the user can call all of the tables returned by getTables(catalog, schemaPattern, tableNamePattern, types) in a SELECT
* statement; false otherwise.
*/
allTablesAreSelectable(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#autoCommitFailureClosesAllResultSets().
*
* @returns true if, when autoCommit is true, a SQL exception indicates
* that all open result sets are closed, even if holdable. Returns false otherwise.
*/
autoCommitFailureClosesAllResultSets(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#dataDefinitionCausesTransactionCommit().
*
* @returns true if a data definition statement within a transaction forces the transaction
* to commit; false otherwise.
*/
dataDefinitionCausesTransactionCommit(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#dataDefinitionIgnoredInTransactions().
*
* @returns true if the database ignores a data definition statement within a transaction;
* false otherwise.
*/
dataDefinitionIgnoredInTransactions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#deletesAreDetected(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if for the specified result set type a visible row delete is detected by
* calls to JdbcResultSet.rowDeleted(). If false, the deleted rows are removed
* from the result set.
*/
deletesAreDetected(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#doesMaxRowSizeIncludeBlobs().
*
* @returns true if SQL data types LONGVARCHAR and LONGVARBINARY are
* included in the size returned by getMaxRowSize(); false otherwise.
*/
doesMaxRowSizeIncludeBlobs(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getAttributes(String, String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
* @param typeNamePattern - The user-defined type name pattern; it must match the type name as it is
* stored in the database.
* @param attributeNamePattern - The attribute name pattern; it must match the attribute name as it
* is declared in the database.
*
* @returns A result set containing descriptions the attributes for a specified user-defined type
* available in the specified schema and catalog. Each row provides information about a
* specific attribute, ordered by TYPE_CAT, TYPE_SCHEM, TYPE_NAME, and
* ORDINAL_POSITION.
*/
getAttributes(
catalog: string,
schemaPattern: string,
typeNamePattern: string,
attributeNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getBestRowIdentifier(String, String, String, int, boolean)
* .
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schema - The schema name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a schema. Passing null incidates
* the schema name isn't used to narrow the search.
* @param table - The table name. It must match the table name as it is stored in the database.
* @param scope - The scope of interest, using the same values as present in the SCOPE
* column description column.
* @param nullable - If true, include columns that are nullable; otherwise do not.
*
* @returns A result set containing the column descriptions that uniquely identify a row (one
* column description per row in the result set, ordered by SCOPE).
*/
getBestRowIdentifier(
catalog: string,
schema: string,
table: string,
scope: number,
nullable: Boolean
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getCatalogSeparator().
*
* @returns The separator between a catalog and table name used by this database.
*/
getCatalogSeparator(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getCatalogTerm().
*
* @returns The database vendor's preferred term for 'catalog'.
*/
getCatalogTerm(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getCatalogs().
*
* @returns A result set containing the catalog names, one per row.
*/
getCatalogs(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getClientInfoProperties().
*
* @returns A result set containing client info properties the driver supports, ordered by NAME, one per row.
*/
getClientInfoProperties(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getColumnPrivileges(String, String, String, String)
* .
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schema - The name of the schema to filter the search by, as it appears in the database.
* Passing an empty string retrieves those procedures without a schema. Passing null
* incidates the schema name isn't used to narrow the search.
* @param table - The table name. It must match the table name as it is stored in the database.
* @param columnNamePattern - The column name pattern to filter the search by. It must match the
* column name as it is stored in the database.
*
* @returns A result set containing the column privilege descriptions, one per row, ordered by
* COLUMN_NAME and PRIVILEGE.
*/
getColumnPrivileges(
catalog: string,
schema: string,
table: string,
columnNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getColumns(String, String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
* @param tableNamePattern - The table name pattern to filter the search by. It must match the table
* name as it is stored in the database.
* @param columnNamePattern - The column name pattern to filter the search by. It must match the
* column name as it is stored in the database.
*
* @returns A result set containing the column descriptions, one per row, ordered according to
* TABLE_CAT, TABLE_SCHEM, TABLE_NAME, and ORDINAL_POSITION.
*/
getColumns(
catalog: string,
schemaPattern: string,
tableNamePattern: string,
columnNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getConnection().
*
* @returns The connection that produced this metadata.
*/
getConnection(): Jdbc.JdbcConnection
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getCrossReference(String, String, String,
* String, String, String).
*
* @param parentCatalog - A parent catalog name as it appears in the database. Passing an empty
* string retrieves those procedures without a catalog. Passing null incidates the
* catalog name isn't used in the selection criteria.
* @param parentSchema - A parent schema name as it appears in the database. Passing an empty string
* retrieves those procedures without a schema. Passing null incidates the schema name
* isn't used in the selection criteria.
* @param parentTable - The name of the parent table that exports the key. It must match the table
* name as it is stored in the database.
* @param foreignCatalog - A foreign catalog name as it appears in the database. Passing an empty
* string retrieves those procedures without a catalog. Passing null incidates the
* catalog name isn't used in the selection criteria.
* @param foreignSchema - A foreign schema name as it appears in the database. Passing an empty
* string retrieves those procedures without a schema. Passing null incidates the
* schema name isn't used in the selection criteria.
* @param foreignTable - The name of the foreign table that exports the key. It must match the table
* name as it is stored in the database.
*
* @returns An result set containing the foreign key column descriptions from the specified foreign
* key table that reference the primary key or the columns representing a unique constraint of
* the parent table. One column description is provided in each row of the result set, and
* they are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and
* KEY_SEQ.
*/
getCrossReference(
parentCatalog: string,
parentSchema: string,
parentTable: string,
foreignCatalog: string,
foreignSchema: string,
foreignTable: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getDatabaseMajorVersion().
*
* @returns The major version number of the underlying database.
*/
getDatabaseMajorVersion(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getDatabaseMinorVersion().
*
* @returns The minor version number of the underlying database.
*/
getDatabaseMinorVersion(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getDatabaseProductName().
*
* @returns The name of this database product.
*/
getDatabaseProductName(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getDatabaseProductVersion().
*
* @returns The version number of this database product.
*/
getDatabaseProductVersion(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getDefaultTransactionIsolation().
*
* @returns The database's default transaction isolation level, which is one of: Jdbc.Connection.TRANSACTION_READ_UNCOMMITTED, Jdbc.Connection.TRANSACTION_READ_COMMITTED, Jdbc.Connection.TRANSACTION_REPEATABLE_READ, Jdbc.Connection.TRANSACTION_SERIALIZABLE, or Jdbc.Connection.TRANSACTION_NONE.
*/
getDefaultTransactionIsolation(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getDriverMajorVersion().
*
* @returns The JDBC driver's major version number.
*/
getDriverMajorVersion(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getDriverMinorVersion().
*
* @returns The JDBC driver's minor version number.
*/
getDriverMinorVersion(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getDriverName().
*
* @returns The name of this JDBC driver.
*/
getDriverName(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getDriverVersion().
*
* @returns The version number of this JDBC driver.
*/
getDriverVersion(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getImportedKeys(String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schema - The schema name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a schema. Passing null incidates
* the schema name isn't used to narrow the search.
* @param table - The table name. It must match the table name as it is stored in the database.
*
* @returns An result set containing the foreign key column descriptions for the primary key
* columns exported by the table. One column description is provided in each row of the result
* set, and they are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.
*/
getExportedKeys(
catalog: string,
schema: string,
table: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getExtraNameCharacters().
*
* @returns The extra characters that are avaiable for use in unquoted identifier names in addition
* to a-z, A-Z, 0-9, and _.
*/
getExtraNameCharacters(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getFunctionColumns(String, String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
* @param functionNamePattern - The function pattern, which match the function name as it is stored
* in the database.
* @param columnNamePattern - The parameter name pattern, which must match the parameter or column
* name as it is stored in the database.
*
* @returns A result set containing the descriptions of system and user function parameters
* available in the given catalog. Each row contains one function description, ordered
* according to FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME, and
* SPECIFIC_ NAME.
*/
getFunctionColumns(
catalog: string,
schemaPattern: string,
functionNamePattern: string,
columnNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getFunctions(String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
* @param functionNamePattern - The function pattern, which must match the function name as it is
* stored in the database.
*
* @returns A result set containing descriptions of the system and user functions available in the
* given catalog. Each row contains one function description, ordered according to FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME, and SPECIFIC_ NAME.
*/
getFunctions(
catalog: string,
schemaPattern: string,
functionNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getIdentifierQuoteString().
*
* @returns The string used to quote SQL identifiers. Defaults to a space (" ") if identifier
* quoting isn't supported.
*/
getIdentifierQuoteString(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getImportedKeys(String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schema - The schema name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a schema. Passing null incidates
* the schema name isn't used to narrow the search.
* @param table - The table name. It must match the table name as it is stored in the database.
*
* @returns An result set containing the column descriptions for the primary key columns referenced
* by the given table's foreign key columns (those imported by a table). One column
* description is provided in each row of the result set, and they are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.
*/
getImportedKeys(
catalog: string,
schema: string,
table: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getIndexInfo(String, String, String, boolean, boolean)
* .
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schema - The schema name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a schema. Passing null incidates
* the schema name isn't used to narrow the search.
* @param table - The table name. It must match the table name as it is stored in the database.
* @param unique - If true, the method only return indices for unique values; otherwise it
* returns indices whether the values are unique or not.
* @param approximate - If true, the result is allowed to reflect approximate or out-of-data
* values; otherwise result accuracy is requested.
*
* @returns An result set containing the index and statistic column descriptions for the specified
* table. One column description is provided in each row of the result set, and they are
* ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.
*/
getIndexInfo(
catalog: string,
schema: string,
table: string,
unique: Boolean,
approximate: Boolean
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getJDBCMajorVersion().
*
* @returns The major JDBC version number for this driver.
*/
getJDBCMajorVersion(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getJDBCMinorVersion().
*
* @returns The minor JDBC version number for this driver.
*/
getJDBCMinorVersion(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxBinaryLiteralLength().
*
* @returns The maximum number of hex characters this database allows in an inline binary literal.
* A response of 0 indicates there is no known limit.
*/
getMaxBinaryLiteralLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxCatalogNameLength().
*
* @returns The maximum number of characters this database allows in a catalog name. A response of
* 0 indicates there is no known limit.
*/
getMaxCatalogNameLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxCharLiteralLength().
*
* @returns The maximum number of characters this database allows in a character literal. A
* response of 0 indicates there is no known limit.
*/
getMaxCharLiteralLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxColumnNameLength().
*
* @returns The maximum number of characters this database allows in a column name. A response of 0
* indicates there is no known limit.
*/
getMaxColumnNameLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxColumnsInGroupBy().
*
* @returns The maximum number of columns this database allows in a GROUP BY clause. A
* response of 0 indicates there is no known limit.
*/
getMaxColumnsInGroupBy(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxColumnsInIndex().
*
* @returns The maximum number of columns this database allows in an index. A response of 0
* indicates there is no known limit.
*/
getMaxColumnsInIndex(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxColumnsInOrderBy().
*
* @returns The maximum number of columns this database allows in an ORDER BY clause. A
* response of 0 indicates there is no known limit.
*/
getMaxColumnsInOrderBy(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxColumnsInSelect().
*
* @returns The maximum number of columns this database allows in an SELECT list. A
* response of 0 indicates there is no known limit.
*/
getMaxColumnsInSelect(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxColumnsInTable().
*
* @returns The maximum number of columns this database allows in a table. A response of 0
* indicates there is no known limit.
*/
getMaxColumnsInTable(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxConnections().
*
* @returns The maximum number of concurrent connections to this database. A response of 0
* indicates there is no known limit.
*/
getMaxConnections(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxCursorNameLength().
*
* @returns The maximum number of characters that this database allows in a cursor name. A response
* of 0 indicates there is no known limit.
*/
getMaxCursorNameLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxIndexLength().
*
* @returns The maximum number of bytes this database allows for an index, including all its parts.
* A response of 0 indicates there is no known limit.
*/
getMaxIndexLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxProcedureNameLength().
*
* @returns The maximum number of characters this database allows in a procedure name. A response
* of 0 indicates there is no known limit.
*/
getMaxProcedureNameLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxRowSize().
*
* @returns The maximum number of bytes this database allows in a single row. A response of 0
* indicates there is no known limit.
*/
getMaxRowSize(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxSchemaNameLength().
*
* @returns The maximum number of characters this database allows in a schema name. A response of 0
* indicates there is no known limit.
*/
getMaxSchemaNameLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxStatementLength().
*
* @returns The maximum number of characters this database allows in an SQL statement. A response
* of 0 indicates there is no known limit.
*/
getMaxStatementLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxStatements().
*
* @returns The maximum number of active statements to this database that can be open
* simultaneously. A response of 0 indicates there is no known limit.
*/
getMaxStatements(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxTableNameLength().
*
* @returns The maximum number of characters this database allows in a table name. A response of 0
* indicates there is no known limit.
*/
getMaxTableNameLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxTablesInSelect().
*
* @returns The maximum number of tables this database allows in a SELECT statement. A
* response of 0 indicates there is no known limit.
*/
getMaxTablesInSelect(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getMaxUserNameLength().
*
* @returns The maximum number of characters this database allows in a username. A response of 0
* indicates there is no known limit.
*/
getMaxUserNameLength(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getNumericFunctions().
*
* @returns The comma-separated list of math functions available with this database. These are the
* Open/Open CLI math function names used in the JDBC function escape clause.
*/
getNumericFunctions(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getPrimaryKeys(String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schema - The schema name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a schema. Passing null incidates
* the schema name isn't used to narrow the search.
* @param table - The table name. It must match the table name as it is stored in the database.
*
* @returns An result set containing the column descriptions for the primary key columns, one per
* row, ordered by COLUMN_NAME.
*/
getPrimaryKeys(
catalog: string,
schema: string,
table: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getProcedureColumns(String, String, String, String)
* .
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
* @param procedureNamePattern - The procedure name pattern to filter the search by. It must match
* the procedure name as it is stored in the database.
* @param columnNamePattern - The column name pattern to filter the search by. It must match the
* column name as it is stored in the database.
*
* @returns A result set containing the procedure and column descriptions, one per row.
*/
getProcedureColumns(
catalog: string,
schemaPattern: string,
procedureNamePattern: string,
columnNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getProcedureTerm().
*
* @returns The database vendor's preferred term for 'procedure'.
*/
getProcedureTerm(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getProcedures(String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
* @param procedureNamePattern - The procedure name pattern to filter the search by. It must match
* the procedure name as it is stored in the database.
*
* @returns A result set containing the procedure descriptions, one per row.
*/
getProcedures(
catalog: string,
schemaPattern: string,
procedureNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getResultSetHoldability().
*
* @returns The database default holdability; one of Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*/
getResultSetHoldability(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getRowIdLifetime().
*
* @returns The status indicatig the lifetime of a ROWID, which is one of Jdbc.RowIdLifetime.ROWID_UNSUPPORTED, Jdbc.RowIdLifetime.ROWID_VALID_OTHER, Jdbc.RowIdLifetime.ROWID_VALID_SESSION, Jdbc.RowIdLifetime.ROWID_VALID_TRANSACTION, or Jdbc.RowIdLifetime.ROWID_VALID_FOREVER.
*/
getRowIdLifetime(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getSQLKeywords().
*
* @returns The comma-separated list of all this database's SQL keywords that aren't also SQL:2003
* keywords.
*/
getSQLKeywords(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getSQLStateType().
*
* @returns The type of SQLSTATE, which is either sqlStateXOpen or sqlStateSQL.
*/
getSQLStateType(): number
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getSchemaTerm().
*
* @returns The database vendor's preferred term for 'schema'.
*/
getSchemaTerm(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getSchemas().
*
* @returns A result set containing the schema descriptions, one per row.
*/
getSchemas(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getSchemas().
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
*
* @returns A result set containing scheme descriptions available in this database, ordered by
* TABLE_CATALOG and TABLE_SCHEM.
*/
getSchemas(
catalog: string,
schemaPattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getSearchStringEscape().
*
* @returns The string that is used to escape wildcard characters such as '_' or '%'.
*/
getSearchStringEscape(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getStringFunctions().
*
* @returns The comma-separated list of string functions available with this database. These are
* the Open Group CLI string function names used in the JDBC function escape clause.
*/
getStringFunctions(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getSuperTables(String, String,String).
*
* @param catalog - The catalog name as it appears in the database. Passing an empty string
* retrieves those procedures without a catalog. Passing null incidates the catalog
* name isn't used in the selection criteria.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema.
* @param tableNamePattern - The table name pattern; may be a fully qualified name.
*
* @returns A result set containing descriptions of the table hierarchies defined in a particular
* schema in this database. Each row provides information about a specific table type. Tables
* without supers aren't listed.
*/
getSuperTables(
catalog: string,
schemaPattern: string,
tableNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getSuperTypes(String, String, String).
*
* @param catalog - The catalog name as it appears in the database. Passing an empty string
* retrieves those procedures without a catalog. Passing null incidates the catalog
* name isn't used in the selection criteria.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema.
* @param typeNamePattern - The user-defined type name pattern; may be a fully qualified name.
*
* @returns A result set containing descriptions of the user-defined type hierarchies defined in a
* particular schema in this database. Each row provides information about a specific
* user-defined type. Types without supers aren't listed.
*/
getSuperTypes(
catalog: string,
schemaPattern: string,
typeNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getSystemFunctions().
*
* @returns The comma-separated list of system functions available with this database. These are
* the Open Group CLI system function names used in the JDBC function escape clause.
*/
getSystemFunctions(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getTablePrivileges(String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
* @param tableNamePattern - The table name pattern to filter the search by. It must match the table
* name as it is stored in the database.
*
* @returns A result set containing the table privilege descriptions, one per row, ordered by
* TABLE_CAT, TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.
*/
getTablePrivileges(
catalog: string,
schemaPattern: string,
tableNamePattern: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getTableTypes().
*
* @returns A result set containing the table types, one per row.
*/
getTableTypes(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getTables(String, String, String, String[]).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
* @param tableNamePattern - The table name pattern to filter the search by. It must match the table
* name as it is stored in the database.
* @param types - A list of type types to return, each of which must be on the list that getTableTypes() returns. Passing null indictates that all table types are
* returned.
*
* @returns A result set containing the table descriptions, one per row, ordered according to
* TABLE_TYPE, TABLE_CAT, TABLE_SCHEM, and TABLE_NAME.
*/
getTables(
catalog: string,
schemaPattern: string,
tableNamePattern: string,
types: string[]
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getTimeDateFunctions().
*
* @returns The comma-separated list of time and date functions available with this database.
*/
getTimeDateFunctions(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getTypeInfo().
*
* @returns An result set containing the descriptions of data types supported by this database. One
* SQL type description is provided in each row of the result set, and they are ordered by
* DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL
* type.
*/
getTypeInfo(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getUDTs(String, String, String, int[]).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schemaPattern - The schema name pattern to filter the search by, as it appears in the
* database. Passing an empty string retrieves those procedures without a schema. Passing
* null incidates the schema name isn't used to narrow the search.
* @param typeNamePattern - The type name pattern to filter the search by; may be a fully qualified
* name.
* @param types - A list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include. Passing null indictates that all types are returned.
*
* @returns A result set containing the user-defined type (UDT) descriptions, one per row, ordered
* according to DATA_TYPE, TYPE_CAT, TYPE_SCHEM, and TYPE_NAME.
*/
getUDTs(
catalog: string,
schemaPattern: string,
typeNamePattern: string,
types: number[]
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getURL().
*
* @returns The URL for this database management system, or null if isn't generated.
*/
getURL(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getUserName().
*
* @returns The username as known to this database.
*/
getUserName(): string
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#getVersionColumns(String, String, String).
*
* @param catalog - The catalog name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a catalog. Passing null
* incidates the catalog name isn't used to narrow the search.
* @param schema - The schema name to filter the search by, as it appears in the database. Passing
* an empty string retrieves those procedures without a schema. Passing null incidates
* the schema name isn't used to narrow the search.
* @param table - The table name. It must match the table name as it is stored in the database.
*
* @returns An unordered result set containing the column descriptions that are updated when any
* value in a row is updated (one column description per row in the result set).
*/
getVersionColumns(
catalog: string,
schema: string,
table: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#insertsAreDetected(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if for the specified result set type a visible row insert is detected by
* calls to JdbcResultSet.rowInserted(); false otherwise.
*/
insertsAreDetected(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#isCatalogAtStart().
*
* @returns true if a catalog appears at the start of a fully-qualified table name; false otherwise.
*/
isCatalogAtStart(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#isReadOnly().
*
* @returns true if the database is read-only; false otherwise.
*/
isReadOnly(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#locatorsUpdateCopy().
*
* @returns true if updates made to a Large Object (LOB) are made to a copy of th LOB;
* false if updates are made directly to the LOB.
*/
locatorsUpdateCopy(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#nullPlusNonNullIsNull().
*
* @returns true if concatenations of NULL and non-NULL values result in a
* NULL; false otherwise.
*/
nullPlusNonNullIsNull(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#nullsAreSortedAtEnd().
*
* @returns true if NULL values are sorted to the end regardless of sort order
* (ascending or descending). Returns false otherwise.
*/
nullsAreSortedAtEnd(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#nullsAreSortedAtStart().
*
* @returns true if NULL values are sorted to the start regardless of sort order
* (ascending or descending). Returns false otherwise.
*/
nullsAreSortedAtStart(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#nullsAreSortedHigh().
*
* @returns true if the NULL values are sorted high, meaning they are considered to
* have a value higher than others in the domain when sorting. Returns false
* otherwise.
*/
nullsAreSortedHigh(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#nullsAreSortedLow().
*
* @returns true if the NULL values are sorted low, meaning they are considered to
* have a value lower than others in the domain when sorting. Returns false otherwise.
*/
nullsAreSortedLow(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#othersDeletesAreVisible(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if for the given result set type the deletes made by others are visible;
* false otherwise.
*/
othersDeletesAreVisible(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#othersInsertsAreVisible(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if for the given result set type the inserts made by others are visible;
* false otherwise.
*/
othersInsertsAreVisible(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#othersUpdatesAreVisible(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if for the given result set type the updates made by others are visible;
* false otherwise.
*/
othersUpdatesAreVisible(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#ownDeletesAreVisible(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if for the given result set type the set's own deletes are visible; false otherwise.
*/
ownDeletesAreVisible(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#ownInsertsAreVisible(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if for the given result set type the set's own inserts are visible; false otherwise.
*/
ownInsertsAreVisible(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#ownUpdatesAreVisible(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if for the given result set type the set's own updates are visible; false otherwise.
*/
ownUpdatesAreVisible(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#storesLowerCaseIdentifiers().
*
* @returns true if the database treats mixed case unquoted SQL identifiers as
* case-insensitive and stores them in lowercase; false otherwise.
*/
storesLowerCaseIdentifiers(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#storesLowerCaseQuotedIdentifiers().
*
* @returns true if the database treats mixed case quoted SQL identifiers as
* case-insensitive and stores them in lowercase; false otherwise.
*/
storesLowerCaseQuotedIdentifiers(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#storesMixedCaseIdentifiers().
*
* @returns true if the database treats mixed case unquoted SQL identifiers as
* case-insensitive and stores them in mixed case; false otherwise.
*/
storesMixedCaseIdentifiers(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#storesMixedCaseQuotedIdentifiers().
*
* @returns true if the database treats mixed case quoted SQL identifiers as
* case-insensitive and stores them in mixed case; false otherwise.
*/
storesMixedCaseQuotedIdentifiers(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#storesUpperCaseIdentifiers().
*
* @returns true if the database treats mixed case unquoted SQL identifiers as
* case-insensitive and stores them in uppercase; false otherwise.
*/
storesUpperCaseIdentifiers(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#storesUpperCaseQuotedIdentifiers().
*
* @returns true if the database treats mixed case quoted SQL identifiers as
* case-insensitive and stores them in uppercase; false otherwise.
*/
storesUpperCaseQuotedIdentifiers(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsANSI92EntryLevelSQL().
*
* @returns true if this database supports the ANSI92 entry level SQL grammar; false otherwise.
*/
supportsANSI92EntryLevelSQL(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsANSI92FullSQL().
*
* @returns true if this database supports the ANSI92 full level SQL grammar; false
* otherwise.
*/
supportsANSI92FullSQL(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsANSI92IntermediateSQL().
*
* @returns true if this database supports the ANSI92 intermediate level SQL grammar;
* false otherwise.
*/
supportsANSI92IntermediateSQL(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsAlterTableWithAddColumn().
*
* @returns true if the database supports ALTER TABLE with add column; false otherwise.
*/
supportsAlterTableWithAddColumn(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsAlterTableWithDropColumn().
*
* @returns true if the database supports ALTER TABLE with drop column; false otherwise.
*/
supportsAlterTableWithDropColumn(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsBatchUpdates().
*
* @returns true if the database supports batch updates; false otherwise.
*/
supportsBatchUpdates(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsCatalogsInDataManipulation().
*
* @returns true if a data manipulation statement can include a catalog name; false
* otherwise.
*/
supportsCatalogsInDataManipulation(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsCatalogsInIndexDefinitions().
*
* @returns true if an index definition statement can include a catalog name; false
* otherwise.
*/
supportsCatalogsInIndexDefinitions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsCatalogsInPrivilegeDefinitions().
*
* @returns true if a privilege definition statement can include a catalog name; false otherwise.
*/
supportsCatalogsInPrivilegeDefinitions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsCatalogsInProcedureCalls().
*
* @returns true if a procedure call statement can include a catalog name; false
* otherwise.
*/
supportsCatalogsInProcedureCalls(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsCatalogsInTableDefinitions().
*
* @returns true if a table definition statement can include a catalog name; false
* otherwise.
*/
supportsCatalogsInTableDefinitions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsColumnAliasing().
*
* @returns true if the database supports column aliasing; false otherwise.
*/
supportsColumnAliasing(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsConvert().
*
* @returns true if this database supports the JDBC scalar function CONVERT for the
* conversion of one JDBC type to
* another; false otherwise.
*/
supportsConvert(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsConvert(int, int).
*
* @param fromType - The
* type to convert from.
* @param toType - The
* type to convert to.
*
* @returns true if this database supports the JDBC scalar function CONVERT for the
* conversion of the specified JDBC types; false otherwise.
*/
supportsConvert(
fromType: number,
toType: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsCoreSQLGrammar().
*
* @returns true if this database supports the ODBC Core SQL grammar; false
* otherwise.
*/
supportsCoreSQLGrammar(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsCorrelatedSubqueries().
*
* @returns true if this database supports correlated subqueries; false otherwise.
*/
supportsCorrelatedSubqueries(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsDataDefinitionAndDataManipulationTransactions()
* .
*
* @returns true if this database supports both data definition and data manipulation
* statements within a transaction; false otherwise.
*/
supportsDataDefinitionAndDataManipulationTransactions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsDataManipulationTransactionsOnly().
*
* @returns true if this database supports data manipulation statements within a
* transaction; false otherwise.
*/
supportsDataManipulationTransactionsOnly(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsDifferentTableCorrelationNames().
*
* @returns true if table correlation names are supported and are restricted to be
* different frm the names of the tables in the database; false otherwise.
*/
supportsDifferentTableCorrelationNames(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsExpressionsInOrderBy().
*
* @returns true if this database supports expressions in ORDER BY lists; false otherwise.
*/
supportsExpressionsInOrderBy(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsExtendedSQLGrammar().
*
* @returns true if this database supports the ODBC Extended SQL grammar; false
* otherwise.
*/
supportsExtendedSQLGrammar(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsFullOuterJoins().
*
* @returns true if this database supports full nested outer joins; false
* otherwise.
*/
supportsFullOuterJoins(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsGetGeneratedKeys().
*
* @returns true if auto-generated keys can be retrieved after a statement is executed;
* false otherwise.
*/
supportsGetGeneratedKeys(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsGroupBy().
*
* @returns true if this database supports some form of GROUP BY clause; false otherwise.
*/
supportsGroupBy(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsGroupByBeyondSelect().
*
* @returns true if this database supports using columns that aren't in the SELECT
* statement in a GROUP BY clause, provided that all the columns in the SELECT
* statement are included in the GROUP BY clause. Returns false otherwise.
*/
supportsGroupByBeyondSelect(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsGroupByUnrelated().
*
* @returns true if this database supports using a column that isn't in the SELECT
* statement in a GROUP BY clause; false otherwise.
*/
supportsGroupByUnrelated(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsIntegrityEnhancementFacility().
*
* @returns true if this database supports the SQL Integrity Enhancement Facility; false otherwise.
*/
supportsIntegrityEnhancementFacility(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsLikeEscapeClause().
*
* @returns true if this database supports specifying a LIKE escape clause; false otherwise.
*/
supportsLikeEscapeClause(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsLimitedOuterJoins().
*
* @returns true if this database provides limited support for outer joins; false
* otherwise.
*/
supportsLimitedOuterJoins(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsMinimumSQLGrammar().
*
* @returns true if this database supports the ODBC Minimum SQL grammar; false
* otherwise.
*/
supportsMinimumSQLGrammar(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsMixedCaseIdentifiers().
*
* @returns true if the database treats mixed case unquoted SQL identifiers as
* case-sensitive and as a result stores them in mixed case; false otherwise.
*/
supportsMixedCaseIdentifiers(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsMixedCaseQuotedIdentifiers().
*
* @returns true if the database treats mixed case quoted SQL identifiers as case-sensitive
* and as a result stores them in mixed case; false otherwise.
*/
supportsMixedCaseQuotedIdentifiers(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsMultipleOpenResults().
*
* @returns true if a callable statement can return multiple result sets simultenously;
* false otherwise.
*/
supportsMultipleOpenResults(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsMultipleResultSets().
*
* @returns true if this database supports getting multiple result sets from a single
* execution call; false otherwise.
*/
supportsMultipleResultSets(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsMultipleTransactions().
*
* @returns true if this database supports having multiple transactions on different
* connections open at once; false otherwise.
*/
supportsMultipleTransactions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsNamedParameters().
*
* @returns true if the database supports named parameters to callable statements; false otherwise.
*/
supportsNamedParameters(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsNonNullableColumns().
*
* @returns true if columns in this database may be defined as non-nullable; false
* otherwise.
*/
supportsNonNullableColumns(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsOpenCursorsAcrossCommit().
*
* @returns true if this database supports keeping cursors always open across commits;
* false otherwise.
*/
supportsOpenCursorsAcrossCommit(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsOpenCursorsAcrossRollback().
*
* @returns true if this database supports keeping cursors always open across rollbacks;
* false otherwise.
*/
supportsOpenCursorsAcrossRollback(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsOpenStatementsAcrossCommit().
*
* @returns true if this database supports keeping statements always open across commits;
* false otherwise.
*/
supportsOpenStatementsAcrossCommit(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsOpenStatementsAcrossRollback().
*
* @returns true if this database supports keeping statements always open across rollbacks;
* false otherwise.
*/
supportsOpenStatementsAcrossRollback(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsOrderByUnrelated().
*
* @returns true if this database supports using a column that isn't in the SELECT
* statement in an ORDER BY clause; false otherwise.
*/
supportsOrderByUnrelated(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsOuterJoins().
*
* @returns true if this database supports some form of outer join; false
* otherwise.
*/
supportsOuterJoins(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsPositionedDelete().
*
* @returns true if this database supports positioned DELETE statements; false otherwise.
*/
supportsPositionedDelete(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsPositionedUpdate().
*
* @returns true if this database supports positioned UPDATE statements; false otherwise.
*/
supportsPositionedUpdate(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsResultSetConcurrency(int, int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
* @param concurrency - The concurrency type, which is either Jdbc.ResultSet.CONCUR_READ_ONLY or Jdbc.ResultSet.CONCUR_UPDATABLE.
*
* @returns true if this database supports the specified result set and concurrency type
* combination; false otherwise.
*/
supportsResultSetConcurrency(
type: number,
concurrency: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsResultSetHoldability(int).
*
* @param holdability - A holdability constant to check; one of Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*
* @returns true if the database the specified holdability; false otherwise.
*/
supportsResultSetHoldability(
holdability: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsResultSetType(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if this database supports the specified result set type; false
* otherwise.
*/
supportsResultSetType(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSavepoints().
*
* @returns true if the database supports savepoints; false otherwise.
*/
supportsSavepoints(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSchemasInDataManipulation().
*
* @returns true if a data manipulation statement can include a schema name; false
* otherwise.
*/
supportsSchemasInDataManipulation(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSchemasInIndexDefinitions().
*
* @returns true if an index definition statement can include a schema name; false
* otherwise.
*/
supportsSchemasInIndexDefinitions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSchemasInPrivilegeDefinitions().
*
* @returns true if an privilege definition statement can include a schema name; false otherwise.
*/
supportsSchemasInPrivilegeDefinitions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSchemasInProcedureCalls().
*
* @returns true if a procedure call statement can include a schema name; false
* otherwise.
*/
supportsSchemasInProcedureCalls(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSchemasInTableDefinitions().
*
* @returns true if a table definition statement can include a schema name; false
* otherwise.
*/
supportsSchemasInTableDefinitions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSelectForUpdate().
*
* @returns true if this database supports SELECT FOR UPDATE statements; false otherwise.
*/
supportsSelectForUpdate(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsStatementPooling().
*
* @returns true if the database supports statement pooling; false otherwise.
*/
supportsStatementPooling(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsStoredFunctionsUsingCallSyntax().
*
* @returns true if the database supports invoking user-defined or vendor functions using
* the stored procedure escape syntax; false otherwise.
*/
supportsStoredFunctionsUsingCallSyntax(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsStoredProcedures().
*
* @returns true if this database supports stored procedure calls that used the stored
* procedure escape syntax; false otherwise.
*/
supportsStoredProcedures(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSubqueriesInComparisons().
*
* @returns true if this database supports subqueries in comparison expressions; false otherwise.
*/
supportsSubqueriesInComparisons(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSubqueriesInExists().
*
* @returns true if this database supports subqueries in EXISTS expressions; false otherwise.
*/
supportsSubqueriesInExists(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSubqueriesInIns().
*
* @returns true if this database supports subqueries in IN expressions; false otherwise.
*/
supportsSubqueriesInIns(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsSubqueriesInQuantifieds().
*
* @returns true if this database supports subqueries in quantified expressions; false otherwise.
*/
supportsSubqueriesInQuantifieds(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsTableCorrelationNames().
*
* @returns true if this database supports table corelation names; false otherwise.
*/
supportsTableCorrelationNames(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsTransactionIsolationLevel(int).
*
* @param level - The transaction isolation level to determine the support of. This must be one of
* Jdbc.Connection.TRANSACTION_READ_UNCOMMITTED, Jdbc.Connection.TRANSACTION_READ_COMMITTED, Jdbc.Connection.TRANSACTION_REPEATABLE_READ, Jdbc.Connection.TRANSACTION_SERIALIZABLE, or Jdbc.Connection.TRANSACTION_NONE.
*
* @returns true if this database supports the given transaction isolation level; false otherwise.
*/
supportsTransactionIsolationLevel(
level: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsTransactions().
*
* @returns true if this database supports transactions; false otherwise.
*/
supportsTransactions(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsUnion().
*
* @returns true if this database supports SQL UNION; false otherwise.
*/
supportsUnion(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#supportsUnionAll().
*
* @returns true if this database supports SQL UNION ALL; false otherwise.
*/
supportsUnionAll(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#updatesAreDetected(int).
*
* @param type - The result set type, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*
* @returns true if for the specified result set type a visible row update is detected by
* calls to JdbcResultSet.rowUpdated(); false otherwise.
*/
updatesAreDetected(
type: number
): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#usesLocalFilePerTable().
*
* @returns true if the database stores each table in a separate local file; false
* otherwise.
*/
usesLocalFilePerTable(): Boolean
/**
* For documentation of this method, see
* java.sql.DatabaseMetaData#usesLocalFiles().
*
* @returns true if the database stores tables in a local file; false otherwise.
*/
usesLocalFiles(): Boolean
}
class JdbcDate {
private constructor();
/**
* For documentation of this method, see
* java.sql.Date#after(date).
*
* @param when - A date to compare to.
*
* @returns true if and only if this date is strictly later than the provided date; false otherwise.
*/
after(
when: Jdbc.JdbcDate
): Boolean
/**
* For documentation of this method, see
* java.sql.Date#before(date).
*
* @param when - A date to compare to.
*
* @returns true if and only if this date is strictly earlier than the provided date;
* false otherwise.
*/
before(
when: Jdbc.JdbcDate
): Boolean
/**
* For documentation of this method, see
* java.sql.Date#getDate().
*
* @returns The day of the month represented by this date. The value is between 1 and 31.
*/
getDate(): number
/**
* For documentation of this method, see
* java.sql.Date#getMonth().
*
* @returns The number representing the month that contains or begins with the instant in time
* represented by this date. The value returned is between 0 and 11, with the value 0
* representing January.
*/
getMonth(): number
/**
* For documentation of this method, see
* java.sql.Date#getTime().
*
* @returns The number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this
* date.
*/
getTime(): number
/**
* For documentation of this method, see
* java.sql.Date#getYear().
*
* @returns The result of subtracting 1900 from the year that contains or begins with the instant
* in time represented by this date, as interpreted in the local time zone.
*/
getYear(): number
/**
* For documentation of this method, see
* java.sql.Date#setDate(int).
*
* @param date - The day of the month to set. The value is between 1 and 31, modified as needed. For
* example, if the date was April 30, for example, and the date is set to 31, then it is
* treated as if it were on May 1, because April has only 30 days.
*/
setDate(
date: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setMonth(int).
*
* @param month - The month value to set. The value returned is between 0 and 11, with the value 0
* representing January.
*/
setMonth(
month: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setTime(int).
*
* @param milliseconds - The number of milliseconds since January 1, 1970, 00:00:00 GMT, not to
* exceed the milliseconds representation for the year 8099. A negative number indicates the
* number of milliseconds before January 1, 1970, 00:00:00 GMT.
*/
setTime(
milliseconds: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setYear(int).
*
* @param year - The value to set the year with. This value plus 1900 is the resulting year the date
* has after this method executes.
*/
setYear(
year: number
): void
}
class JdbcParameterMetaData {
private constructor();
/**
* For documentation of this method, see
* java.sql.ParameterMetaData#getParameterClassName(int).
*
* @param param - The index of the parameter to examine. The first parameter has an index of 1.
*
* @returns The fully-qualified Java class name that is used by the JdbcPreparedStatement.setObject(index, x) methods.
*/
getParameterClassName(
param: number
): string
/**
* For documentation of this method, see
* java.sql.ParameterMetaData#getParameterCount().
*
* @returns The number of parameters for which this metadata contains information.
*/
getParameterCount(): number
/**
* For documentation of this method, see
* java.sql.ParameterMetaData#getParameterMode(int).
*
* @param param - The index of the parameter to examine. The first parameter has an index of 1.
*
* @returns The designated parameter's mode, which is one of Jdbc.ParameterMetaData.parameterModeIn, Jdbc.ParameterMetaData.parameterModeOut,
* Jdbc.ParameterMetaData.parameterModeInOut, or Jdbc.ParameterMetaData.parameterModeUnknown.
*/
getParameterMode(
param: number
): number
/**
* For documentation of this method, see
* java.sql.ParameterMetaData#getParameterType(int).
*
* @param param - The index of the parameter to examine. The first parameter has an index of 1.
*
* @returns The designated parameter's SQL type.
*/
getParameterType(
param: number
): number
/**
* For documentation of this method, see
* java.sql.ParameterMetaData#getParameterTypeName(int).
*
* @param param - The index of the parameter to examine. The first parameter has an index of 1.
*
* @returns The designated parameter's database-specific type name. This is a fully-qualified type
* name if the parameter is a user-defined type.
*/
getParameterTypeName(
param: number
): string
/**
* For documentation of this method, see
* java.sql.ParameterMetaData#getPrecision(int).
*
* @param param - The index of the parameter to examine. The first parameter has an index of 1.
*
* @returns The maximum column size for the given parameter. 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.
*/
getPrecision(
param: number
): number
/**
* For documentation of this method, see
* java.sql.ParameterMetaData#getScale(int).
*
* @param param - The index of the parameter to examine. The first parameter has an index of 1.
*
* @returns The designated parameter's number of digits to right of the decimal point. Returns 0
* for data types where the scale is not applicable.
*/
getScale(
param: number
): number
/**
* For documentation of this method, see
* java.sql.ParameterMetaData#isNullable(int).
*
* @param param - The index of the parameter to examine. The first parameter has an index of 1.
*
* @returns The nullability status of the given parameter; one of Jdbc.ParameterMetaData.parameterNoNulls, Jdbc.ParameterMetaData.parameterNullable,
* or Jdbc.ParameterMetaData.parameterNullableUnknown.
*/
isNullable(
param: number
): number
/**
* For documentation of this method, see
* java.sql.ParameterMetaData#isSigned(int).
*
* @param param - The index of the parameter to examine. The first parameter has an index of 1.
*
* @returns true if the specified parameter can accept signed number values; false
* otherwise.
*/
isSigned(
param: number
): Boolean
}
class JdbcPreparedStatement {
private constructor();
/**
* For documentation of this method, see
* java.sql.PreparedStatement#addBatch().
*/
addBatch(): void
/**
* For documentation of this method, see
* java.sql.Statement#addBatch(String).
*
* @param sql - The SQL command to add to this statement, typically an SQL INSERT or UPDATE.
*/
addBatch(
sql: string
): void
/**
* For documentation of this method, see
* java.sql.Statement#cancel().
*/
cancel(): void
/**
* For documentation of this method, see
* java.sql.Statement#clearBatch().
*/
clearBatch(): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#clearParameters().
*/
clearParameters(): void
/**
* For documentation of this method, see
* java.sql.Statement#clearWarnings().
*/
clearWarnings(): void
/**
* For documentation of this method, see
* java.sql.Statement#close().
*/
close(): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#execute().
*
* @returns true if the first result is a result set; false if the first result is
* an update count or there is no result.
*/
execute(): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String).
*
* @param sql - The SQL statement to execute.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String, int).
*
* @param sql - The SQL statement to execute.
* @param autoGeneratedKeys - A flag that indicates whether auto-generated keys are made available
* for future retrieval; either Jdbc.Statement.RETURN_GENERATED_KEYS or Jdbc.Statement.NO_GENERATED_KEYS.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string,
autoGeneratedKeys: number
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String, int[]).
*
* @param sql - The SQL statement to execute.
* @param columnIndexes - The column indices in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string,
columnIndexes: number[]
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String, String[]).
*
* @param sql - The SQL statement to execute.
* @param columnNames - The names of columns in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string,
columnNames: string[]
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#executeBatch().
*
* @returns The update counts for each command in the batch, using the same order in which commands
* were added to the batch.
*/
executeBatch(): number[]
/**
* For documentation of this method, see
* java.sql.PreparedStatement#executeQuery().
*
* @returns A result set that contains the data produced by the query.
*/
executeQuery(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.Statement#executeQuery(String).
*
* @param sql - The SQL statement to execute, typically a static SELECT.
*
* @returns A result set containing the results of the execution. This is never null.
*/
executeQuery(
sql: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.PreparedStatement#executeUpdate().
*
* @returns The row count ofr SQL Data Manipulation Language statements, or 0 for SQL statements
* that return nothing.
*/
executeUpdate(): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string
): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String, int).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
* @param autoGeneratedKeys - A flag that indicates whether auto-generated keys are made available
* for future retrieval; either Jdbc.Statement.RETURN_GENERATED_KEYS or Jdbc.Statement.NO_GENERATED_KEYS.
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string,
autoGeneratedKeys: number
): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String, int[]).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
* @param columnIndexes - The column indices in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string,
columnIndexes: number[]
): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String, String[]).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
* @param columnNames - The names of columns in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string,
columnNames: string[]
): number
/**
* For documentation of this method, see
* java.sql.Statement#getConnection().
*
* @returns The connection that produced this statement.
*/
getConnection(): Jdbc.JdbcConnection
/**
* For documentation of this method, see
* java.sql.Statement#getFetchDirection().
*
* @returns The default direction for result sets generated by this statement, which is either
* Jdbc.ResultSet.FETCH_FORWARD or Jdbc.ResultSet.FETCH_REVERSE.
*/
getFetchDirection(): number
/**
* For documentation of this method, see
* java.sql.Statement#getFetchSize().
*
* @returns The default row fetch size for result sets generated from this statement.
*/
getFetchSize(): number
/**
* For documentation of this method, see
* java.sql.Statement#getGeneratedKeys().
*
* @returns A result set containing the auto-generated keys generated by the execution of this
* statement.
*/
getGeneratedKeys(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.Statement#getMaxFieldSize().
*
* @returns The current column byte size limit for columns storing character and binary values; a
* value of zero indictates no limit.
*/
getMaxFieldSize(): number
/**
* For documentation of this method, see
* java.sql.Statement#getMaxRows().
*
* @returns The current maximum number of rows for a result set produced by this statement; a value
* of 0 indicates no limit.
*/
getMaxRows(): number
/**
* For documentation of this method, see
* java.sql.PreparedStatement#getMetaData().
*
* @returns The description of a result set's columns, or NULL if this metadata is
* unavailable.
*/
getMetaData(): Jdbc.JdbcResultSetMetaData
/**
* For documentation of this method, see
* java.sql.Statement#getMoreResults().
*
* @returns true if the next result is a result set; false otherwise.
*/
getMoreResults(): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#getMoreResults(int).
*
* @param current - A flag that indicates what happens to current result sets when retrieved. This
* value is one of Jdbc.Statement.CLOSE_CURRENT_RESULT, Jdbc.Statement.KEEP_CURRENT_RESULT, or Jdbc.Statement.CLOSE_ALL_RESULTS.
*
* @returns true if the next result is a result set; false otherwise.
*/
getMoreResults(
current: number
): Boolean
/**
* For documentation of this method, see
* java.sql.PreparedStatement#getParameterMetaData().
*
* @returns The parameter metadata, including the number, types, and properties for each parameter.
*/
getParameterMetaData(): Jdbc.JdbcParameterMetaData
/**
* For documentation of this method, see
* java.sql.Statement#getQueryTimeout().
*
* @returns The current query timeout in seconds; a value of zero indicates no timeout.
*/
getQueryTimeout(): number
/**
* For documentation of this method, see
* java.sql.Statement#getResultSet().
*
* @returns The current result set, or null if the result is an update count or there are
* no more results.
*/
getResultSet(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.Statement#getResultSetConcurrency().
*
* @returns The result set concurrency for result sets generated from this statement, which is
* either Jdbc.ResultSet.CONCUR_READ_ONLY or Jdbc.ResultSet.CONCUR_UPDATABLE.
*/
getResultSetConcurrency(): number
/**
* For documentation of this method, see
* java.sql.Statement#getResultSetHoldability().
*
* @returns The result set holdability, which is either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*/
getResultSetHoldability(): number
/**
* For documentation of this method, see
* java.sql.Statement#getResultSetType().
*
* @returns The result set type for result sets generated from this statement, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or
* Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*/
getResultSetType(): number
/**
* For documentation of this method, see
* java.sql.Statement#getUpdateCount().
*
* @returns The current result as an update count, or -1 if the current result is a result set or
* if there are no more results.
*/
getUpdateCount(): number
/**
* For documentation of this method, see
* java.sql.Statement#getWarnings().
*
* @returns The current set of warnings, or null if there are no warnings.
*/
getWarnings(): string[]
/**
* For documentation of this method, see
* java.sql.Statement#isClosed().
*
* @returns true if this statement is closed; false otherwise.
*/
isClosed(): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#isPoolable().
*
* @returns true if this statement is poolable; false otherwise.
*/
isPoolable(): Boolean
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setArray(int, Array).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setArray(
parameterIndex: number,
x: Jdbc.JdbcArray
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setBigDecimal(int, BigDecimal).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setBigDecimal(
parameterIndex: number,
x: BigNumber
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setBlob(int, Clob).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setBlob(
parameterIndex: number,
x: Jdbc.JdbcBlob
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setBoolean(int, boolean).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setBoolean(
parameterIndex: number,
x: Boolean
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setByte(int, byte).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setByte(
parameterIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setBytes(int, byte[]).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setBytes(
parameterIndex: number,
x: number[]
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setClob(int, Clob).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setClob(
parameterIndex: number,
x: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.Statement#setCursorName(String).
*
* @param name - The new cursor name, which must be unique within a connection.
*/
setCursorName(
name: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setDate(int, Date).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setDate(
parameterIndex: number,
x: Jdbc.JdbcDate
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setDate(int, Date, Calendar).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*/
setDate(
parameterIndex: number,
x: Jdbc.JdbcDate,
timeZone: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setDouble(int, double).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setDouble(
parameterIndex: number,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setEscapeProcessing(boolean).
*
* @param enable - If true, escape processing is enabled; otherwise it is disabled.
*/
setEscapeProcessing(
enable: Boolean
): void
/**
* For documentation of this method, see
* java.sql.Statement#setFetchDirection(int).
*
* @param direction - The specified direction to set, which is either Jdbc.ResultSet.FETCH_FORWARD or Jdbc.ResultSet.FETCH_REVERSE.
*/
setFetchDirection(
direction: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setFetchSize(int).
*
* @param rows - The number of rows to fetch.
*/
setFetchSize(
rows: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setFloat(int, float).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setFloat(
parameterIndex: number,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setInt(int, int).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setInt(
parameterIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setLong(int, long).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setLong(
parameterIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setMaxFieldSize(int).
*
* @param max - The new column byte size limit; a value of zero indicates no limit.
*/
setMaxFieldSize(
max: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setMaxRows(int).
*
* @param max - The maximum number of rows a result set generated by this statement can have. A
* value of 0 indicates no limit.
*/
setMaxRows(
max: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setNClob(int, NClob).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setNClob(
parameterIndex: number,
x: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setNString(int, String).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setNString(
parameterIndex: number,
x: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setNull(int, int).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param sqlType - The SQL
* type of the specified parameter.
*/
setNull(
parameterIndex: number,
sqlType: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setNull(int, int, String).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param sqlType - The SQL
* type of the specified parameter.
* @param typeName - The fully-qualifed name of an SQL user-defined type. Ignored if the parameter
* isn't a user-defined type or REF.
*/
setNull(
parameterIndex: number,
sqlType: number,
typeName: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setObject(int, Object).
*
* @param index - The index of the parameter to set (the first parameter is 1, the second is 2, and
* so on).
* @param x - The object containing the value to set the parameter to.
*/
setObject(
index: number,
x: object
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setObject(int, Object, int).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The object containing the value to set the parameter to.
* @param targetSqlType - The SQL type to send
* to the database.
*/
setObject(
parameterIndex: number,
x: object,
targetSqlType: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setObject(int, Object, int, int).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The object containing the value to set the parameter to.
* @param targetSqlType - The SQL type to send
* to the database. The scale argument may further qualify this type.
* @param scaleOrLength - The number of digits after the decimal for DECIMAL or NUMERIC types, or the length of data for InputStream or Reader types.
* Ignored for all other types.
*/
setObject(
parameterIndex: number,
x: object,
targetSqlType: number,
scaleOrLength: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setPoolable(boolean).
*
* @param poolable - If true, requests that this statement be pooled; otherwise requests it
* not be pooled.
*/
setPoolable(
poolable: Boolean
): void
/**
* For documentation of this method, see
* java.sql.Statement#setQueryTimeout(int).
*
* @param seconds - The new query timeout in seconds; a value of 0 indicates no timeout.
*/
setQueryTimeout(
seconds: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setRef(int, Ref).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The SQL REF value to set.
*/
setRef(
parameterIndex: number,
x: Jdbc.JdbcRef
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setRowId(int, RowId).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setRowId(
parameterIndex: number,
x: Jdbc.JdbcRowId
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setSQLXML(int, SQLXML).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setSQLXML(
parameterIndex: number,
x: Jdbc.JdbcSQLXML
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setShort(int, short).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setShort(
parameterIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setString(int, String).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setString(
parameterIndex: number,
x: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setTime(int, Time).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setTime(
parameterIndex: number,
x: Jdbc.JdbcTime
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setTime(int, Time, Calendar).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*/
setTime(
parameterIndex: number,
x: Jdbc.JdbcTime,
timeZone: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setTimestamp(int, Timestamp).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setTimestamp(
parameterIndex: number,
x: Jdbc.JdbcTimestamp
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setTimestamp(int, Timestamp, Calendar).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*/
setTimestamp(
parameterIndex: number,
x: Jdbc.JdbcTimestamp,
timeZone: string
): void
/**
* For documentation of this method, see
* java.sql.PreparedStatement#setURL(int, URL).
*
* @param parameterIndex - The index of the parameter to set (the first parameter is 1, the second
* is 2, and so on).
* @param x - The parameter value to set.
*/
setURL(
parameterIndex: number,
x: string
): void
}
class JdbcRef {
private constructor();
/**
* For documentation of this method, see
* java.sql.Ref#getBaseTypeName().
*
* @returns The fully-qualified SQL name of the SQL structured type this JdbcRef
* references.
*/
getBaseTypeName(): string
/**
* For documentation of this method, see
* java.sql.Ref#getObject().
*
* @returns The object that this JdbcRef references.
*/
getObject(): object
/**
* For documentation of this method, see
* java.sql.Ref#setObject(Object).
*
* @param object - The object to set as the refernence target.
*/
setObject(
object: object
): void
}
class JdbcResultSet {
private constructor();
/**
* For documentation of this method, see
* java.sql.ResultSet#absolute(int).
*
* @param row - The number of the row to which the cursor moves to. A positive number indicates the
* row number counting from the start of the result set, while a negative number indicates the
* counting from the end of the result set.
*
* @returns true if the cursor is moved to a position in this result set; false if
* the cursor is before the first row or after the last row.
*/
absolute(
row: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#afterLast().
*/
afterLast(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#beforeFirst().
*/
beforeFirst(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#cancelRowUpdates().
*/
cancelRowUpdates(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#clearWarnings().
*/
clearWarnings(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#close().
*/
close(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#deleteRow().
*/
deleteRow(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#findColumn(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column index of the specified column.
*/
findColumn(
columnLabel: string
): number
/**
* For documentation of this method, see
* java.sql.ResultSet#first().
*
* @returns true if the cursor is on a valid row; false if there are no rows in the
* result set.
*/
first(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#getArray(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The value of the designated column in the current row of this result set as an array.
*/
getArray(
columnIndex: number
): Jdbc.JdbcArray
/**
* For documentation of this method, see
* java.sql.ResultSet#getArray(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The value of the designated column in the current row of this result set as an array.
*/
getArray(
columnLabel: string
): Jdbc.JdbcArray
/**
* For documentation of this method, see
* java.sql.ResultSet#getBigDecimal(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The column value; null if the value was SQL NULL.
*/
getBigDecimal(
columnIndex: number
): BigNumber
/**
* For documentation of this method, see
* java.sql.ResultSet#getBigDecimal(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; null if the value was SQL NULL.
*/
getBigDecimal(
columnLabel: string
): BigNumber
/**
* For documentation of this method, see
* java.sql.ResultSet#getBlob(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The value of the designated column in the current row of this result set as a blob.
*/
getBlob(
columnIndex: number
): Jdbc.JdbcBlob
/**
* For documentation of this method, see
* java.sql.ResultSet#getBlob(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The value of the designated column in the current row of this result set as a blob.
*/
getBlob(
columnLabel: string
): Jdbc.JdbcBlob
/**
* For documentation of this method, see
* java.sql.ResultSet#getBoolean(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; false if the value was SQL NULL.
*/
getBoolean(
columnIndex: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#getBoolean(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; false if the value was SQL NULL.
*/
getBoolean(
columnLabel: string
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#getByte(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getByte(
columnIndex: number
): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getByte(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getByte(
columnLabel: string
): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getBytes(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; null if the value was SQL NULL.
*/
getBytes(
columnIndex: number
): number[]
/**
* For documentation of this method, see
* java.sql.ResultSet#getBytes(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; null if the value was SQL NULL.
*/
getBytes(
columnLabel: string
): number[]
/**
* For documentation of this method, see
* java.sql.ResultSet#getClob(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The value of the designated column in the current row of this result set as a clob.
*/
getClob(
columnIndex: number
): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.ResultSet#getClob(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The value of the designated column in the current row of this result set as a clob.
*/
getClob(
columnLabel: string
): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.ResultSet#getConcurrency().
*
* @returns The concurrency type, which is either Jdbc.ResultSet.CONCUR_READ_ONLY or Jdbc.ResultSet.CONCUR_UPDATABLE.
*/
getConcurrency(): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getCursorName().
*
* @returns The SQL name for this result set's cursor.
*/
getCursorName(): string
/**
* For documentation of this method, see
* java.sql.ResultSet#getDate(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; null if the value was SQL NULL.
*/
getDate(
columnIndex: number
): Jdbc.JdbcDate
/**
* For documentation of this method, see
* java.sql.ResultSet#getDate(int, Calendar).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The column value; null if the value was SQL NULL.
*/
getDate(
columnIndex: number,
timeZone: string
): Jdbc.JdbcDate
/**
* For documentation of this method, see
* java.sql.ResultSet#getDate(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; null if the value was SQL NULL.
*/
getDate(
columnLabel: string
): Jdbc.JdbcDate
/**
* For documentation of this method, see
* java.sql.ResultSet#getDate(String, Calendar).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The column value; null if the value was SQL NULL.
*/
getDate(
columnLabel: string,
timeZone: string
): Jdbc.JdbcDate
/**
* For documentation of this method, see
* java.sql.ResultSet#getDouble(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getDouble(
columnIndex: number
): Number
/**
* For documentation of this method, see
* java.sql.ResultSet#getDouble(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getDouble(
columnLabel: string
): Number
/**
* For documentation of this method, see
* java.sql.ResultSet#getFetchDirection().
*
* @returns The specified direction to set, which is either Jdbc.ResultSet.FETCH_FORWARD or
* Jdbc.ResultSet.FETCH_REVERSE.
*/
getFetchDirection(): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getFetchSize().
*
* @returns The current fetch size for this result set.
*/
getFetchSize(): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getFloat(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getFloat(
columnIndex: number
): Number
/**
* For documentation of this method, see
* java.sql.ResultSet#getFloat(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getFloat(
columnLabel: string
): Number
/**
* For documentation of this method, see
* java.sql.ResultSet#getHoldability().
*
* @returns The holdability of this result set, which is either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*/
getHoldability(): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getInt(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getInt(
columnIndex: number
): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getInt(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getInt(
columnLabel: string
): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getLong(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getLong(
columnIndex: number
): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getLong(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getLong(
columnLabel: string
): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getMetaData().
*
* @returns The number, types, and properties of this result set's columns.
*/
getMetaData(): Jdbc.JdbcResultSetMetaData
/**
* For documentation of this method, see
* java.sql.ResultSet#getNClob(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The column value of the current row.
*/
getNClob(
columnIndex: number
): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.ResultSet#getNClob(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value of the current row.
*/
getNClob(
columnLabel: string
): Jdbc.JdbcClob
/**
* For documentation of this method, see
* java.sql.ResultSet#getNString(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The column value of the current row; null if the value is SQL NULL.
*/
getNString(
columnIndex: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSet#getNString(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value of the current row; null if the value is SQL NULL.
*/
getNString(
columnLabel: string
): string
/**
* For documentation of this method, see
* java.sql.ResultSet#getObject(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The value of the designated column in the current row of this result set.
*/
getObject(
columnIndex: number
): object
/**
* For documentation of this method, see
* java.sql.ResultSet#getObject(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The value of the designated column in the current row of this result set.
*/
getObject(
columnLabel: string
): object
/**
* For documentation of this method, see
* java.sql.ResultSet#getRef(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The value of the designated column in the current row of this result set as a
* reference.
*/
getRef(
columnIndex: number
): Jdbc.JdbcRef
/**
* For documentation of this method, see
* java.sql.ResultSet#getRef(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The value of the designated column in the current row of this result set as a
* reference.
*/
getRef(
columnLabel: string
): Jdbc.JdbcRef
/**
* For documentation of this method, see
* java.sql.ResultSet#getRow().
*
* @returns The current row number, or 0 if there is no current row.
*/
getRow(): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getRowId(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The column row ID value; null if the value is SQL NULL.
*/
getRowId(
columnIndex: number
): Jdbc.JdbcRowId
/**
* For documentation of this method, see
* java.sql.ResultSet#getRowId(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column row ID value; null if the value is SQL NULL.
*/
getRowId(
columnLabel: string
): Jdbc.JdbcRowId
/**
* For documentation of this method, see
* java.sql.ResultSet#getSQLXML(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The column value of the current row.
*/
getSQLXML(
columnIndex: number
): Jdbc.JdbcSQLXML
/**
* For documentation of this method, see
* java.sql.ResultSet#getSQLXML(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value of the current row.
*/
getSQLXML(
columnLabel: string
): Jdbc.JdbcSQLXML
/**
* For documentation of this method, see
* java.sql.ResultSet#getShort(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getShort(
columnIndex: number
): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getShort(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; 0 if the value was SQL NULL.
*/
getShort(
columnLabel: string
): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getStatement().
*
* @returns The statement that produced this result set, or null if the result set was
* produced some other way.
*/
getStatement(): Jdbc.JdbcStatement
/**
* For documentation of this method, see
* java.sql.ResultSet#getString(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; null if the value was SQL NULL.
*/
getString(
columnIndex: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSet#getString(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; null if the value was SQL NULL.
*/
getString(
columnLabel: string
): string
/**
* For documentation of this method, see
* java.sql.ResultSet#getTime(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; null if the value was SQL NULL.
*/
getTime(
columnIndex: number
): Jdbc.JdbcTime
/**
* For documentation of this method, see
* java.sql.ResultSet#getTime(int, Calendar).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The column value; null if the value was SQL NULL.
*/
getTime(
columnIndex: number,
timeZone: string
): Jdbc.JdbcTime
/**
* For documentation of this method, see
* java.sql.ResultSet#getTime(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; null if the value was SQL NULL.
*/
getTime(
columnLabel: string
): Jdbc.JdbcTime
/**
* For documentation of this method, see
* java.sql.ResultSet#getTime(String, Calendar).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The column value; null if the value was SQL NULL.
*/
getTime(
columnLabel: string,
timeZone: string
): Jdbc.JdbcTime
/**
* For documentation of this method, see
* java.sql.ResultSet#getTimestamp(int).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
*
* @returns The column value; null if the value was SQL NULL.
*/
getTimestamp(
columnIndex: number
): Jdbc.JdbcTimestamp
/**
* For documentation of this method, see
* java.sql.ResultSet#getTimestamp(int, Calendar).
*
* @param columnIndex - The index of the column to retrieve (the first column is 1, the second is 2,
* and so on).
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The column value; null if the value was SQL NULL.
*/
getTimestamp(
columnIndex: number,
timeZone: string
): Jdbc.JdbcTimestamp
/**
* For documentation of this method, see
* java.sql.ResultSet#getTimestamp(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The column value; null if the value was SQL NULL.
*/
getTimestamp(
columnLabel: string
): Jdbc.JdbcTimestamp
/**
* For documentation of this method, see
* java.sql.ResultSet#getTimestamp(String, Calendar).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param timeZone - A time zone string used to construct
* java.lang.Calendar instance, which in turn is used to build the date. Several formats
* of time zone strings are recognized: short IDs (such as PST, EST, and
* GMT), long IDs (such as US/Pacific and America/Los_Angeles), and
* offsets (such as GMT+6:30).
*
* @returns The column value; null if the value was SQL NULL.
*/
getTimestamp(
columnLabel: string,
timeZone: string
): Jdbc.JdbcTimestamp
/**
* For documentation of this method, see
* java.sql.ResultSet#getType().
*
* @returns The type of this result set, which is one of Jdbc.ResultSet.TYPE_FORWARD_ONLY,
* Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*/
getType(): number
/**
* For documentation of this method, see
* java.sql.ResultSet#getURL(int).
*
* @param columnIndex - The index of the column to retrieve the data from (the first column is 1,
* the second is 2, and so on).
*
* @returns The URL value of the designated column in the current row of this result set.
*/
getURL(
columnIndex: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSet#getURL(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*
* @returns The URL value of the designated column in the current row of this result set.
*/
getURL(
columnLabel: string
): string
/**
* Returns the current set of warnings reported by the driver.
*
* @returns The current set of warnings.
*/
getWarnings(): string[]
/**
* For documentation of this method, see
* java.sql.ResultSet#insertRow().
*/
insertRow(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#isAfterLast().
*
* @returns true if the cursor is after the last row; false if it is in any other
* position or if the result set contains no rows.
*/
isAfterLast(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#isBeforeFirst().
*
* @returns true if the cursor is before the first row; false if it is in any other
* position or if the result set contains no rows.
*/
isBeforeFirst(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#isClosed().
*
* @returns true if this result set is closed; false otherwise.
*/
isClosed(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#isFirst().
*
* @returns true if the cursor is on the first row; false otherwise.
*/
isFirst(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#isLast().
*
* @returns true if the cursor is on the last row; false otherwise.
*/
isLast(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#first().
*
* @returns true if the cursor is on a valid row; false if there are no rows in the
* result set.
*/
last(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#moveToCurrentRow().
*/
moveToCurrentRow(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#moveToInsertRow().
*/
moveToInsertRow(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#next().
*
* @returns true if the new current row is valid; false otherwise.
*/
next(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#previous().
*
* @returns true if the cursor is on a valid row; false if the cursor is positioned
* before the first row.
*/
previous(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#refreshRow().
*/
refreshRow(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#relative(int).
*
* @param rows - The number row steps to move the cursor. A positive number moves the cursor
* forward, while a negative number moves the cursor backward.
*
* @returns true if the cursor is on a row; false otherwise.
*/
relative(
rows: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#rowDeleted().
*
* @returns true if the current row was visibly deleted; false otherwise.
*/
rowDeleted(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#rowInserted().
*
* @returns true if the current row was visibly inserted; false otherwise.
*/
rowInserted(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#rowUpdated().
*
* @returns true if the current row was visibly updated; false otherwise.
*/
rowUpdated(): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSet#setFetchDirection(int).
*
* @param direction - The specified direction to set, which is either Jdbc.ResultSet.FETCH_FORWARD or Jdbc.ResultSet.FETCH_REVERSE.
*/
setFetchDirection(
direction: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#setFetchSize(int).
*
* @param rows - The number of rows to fetch.
*/
setFetchSize(
rows: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateArray(int, Array).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateArray(
columnIndex: number,
x: Jdbc.JdbcArray
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateArray(String, Array).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateArray(
columnLabel: string,
x: Jdbc.JdbcArray
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateBigDecimal(int, BigDecimal).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateBigDecimal(
columnIndex: number,
x: BigNumber
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateBigDecimal(String, BigDecimal).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateBigDecimal(
columnLabel: string,
x: BigNumber
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateBlob(int, Blob).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateBlob(
columnIndex: number,
x: Jdbc.JdbcBlob
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateRef(String, Blob).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateBlob(
columnLabel: string,
x: Jdbc.JdbcBlob
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateBoolean(int, boolean).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateBoolean(
columnIndex: number,
x: Boolean
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateBoolean(String, boolean).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateBoolean(
columnLabel: string,
x: Boolean
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateByte(int, byte).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateByte(
columnIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateByte(String, byte).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateByte(
columnLabel: string,
x: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateBytes(int, byte[]).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateBytes(
columnIndex: number,
x: number[]
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateBytes(String, byte[]).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateBytes(
columnLabel: string,
x: number[]
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateClob(int, Clob).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateClob(
columnIndex: number,
x: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateClob(String, Clob).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateClob(
columnLabel: string,
x: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateDate(int, Date).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateDate(
columnIndex: number,
x: Jdbc.JdbcDate
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateDate(String, Date).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateDate(
columnLabel: string,
x: Jdbc.JdbcDate
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateDouble(int, double).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateDouble(
columnIndex: number,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateDouble(String, double).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateDouble(
columnLabel: string,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateFloat(int, float).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateFloat(
columnIndex: number,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateFloat(String, float).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateFloat(
columnLabel: string,
x: Number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateInt(int, int).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateInt(
columnIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateInt(String, int).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateInt(
columnLabel: string,
x: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateLong(int, long).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateLong(
columnIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateLong(String, long).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateLong(
columnLabel: string,
x: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateNClob(int, NClob).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateNClob(
columnIndex: number,
x: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateNClob(String, NClob).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateNClob(
columnLabel: string,
x: Jdbc.JdbcClob
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateNString(int, String).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateNString(
columnIndex: number,
x: string
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateNString(String, String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateNString(
columnLabel: string,
x: string
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateNull(int).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
*/
updateNull(
columnIndex: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateNull(String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
*/
updateNull(
columnLabel: string
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateObject(int, Object).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateObject(
columnIndex: number,
x: object
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateObject(int, Object, int).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
* @param scaleOrLength - The number of digits after the decimal for BigDecimal types, or
* the length of data for InputStream or Reader types. Ignored for all other
* types.
*/
updateObject(
columnIndex: number,
x: object,
scaleOrLength: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateObject(String, Object).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateObject(
columnLabel: string,
x: object
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateObject(String, Object, int).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
* @param scaleOrLength - The number of digits after the decimal for BigDecimal types, or
* the length of data for InputStream or Reader types. Ignored for all other
* types.
*/
updateObject(
columnLabel: string,
x: object,
scaleOrLength: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateRef(int, Ref).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateRef(
columnIndex: number,
x: Jdbc.JdbcRef
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateRef(String, Ref).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateRef(
columnLabel: string,
x: Jdbc.JdbcRef
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateRow().
*/
updateRow(): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateRowId(int, RowId).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateRowId(
columnIndex: number,
x: Jdbc.JdbcRowId
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateRowId(String, RowId).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateRowId(
columnLabel: string,
x: Jdbc.JdbcRowId
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateSQLXML(int, SQLXML).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateSQLXML(
columnIndex: number,
x: Jdbc.JdbcSQLXML
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateSQLXML(String, SQLXML).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateSQLXML(
columnLabel: string,
x: Jdbc.JdbcSQLXML
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateShort(int, short).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateShort(
columnIndex: number,
x: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateShort(String, short).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateShort(
columnLabel: string,
x: number
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateString(int, String).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateString(
columnIndex: number,
x: string
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateString(String, String).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateString(
columnLabel: string,
x: string
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateTime(int, Time).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateTime(
columnIndex: number,
x: Jdbc.JdbcTime
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateTime(String, Time).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateTime(
columnLabel: string,
x: Jdbc.JdbcTime
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateTimestamp(int, Timestamp).
*
* @param columnIndex - The index of the column to update (the first column is 1, the second is 2,
* and so on).
* @param x - The new column value.
*/
updateTimestamp(
columnIndex: number,
x: Jdbc.JdbcTimestamp
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#updateTimestamp(String, Timestamp).
*
* @param columnLabel - The label for the column, specified with the SQL AS clause. If the AS clause
* wasn't specified, then the label is the name of the column.
* @param x - The new column value.
*/
updateTimestamp(
columnLabel: string,
x: Jdbc.JdbcTimestamp
): void
/**
* For documentation of this method, see
* java.sql.ResultSet#wasNull().
*
* @returns true if the last column read was SQL NULL; false otherwise.
*/
wasNull(): Boolean
}
class JdbcResultSetMetaData {
private constructor();
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getCatalogName(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The catalog name for the table in the designated column, or an empty string if not
* applicable.
*/
getCatalogName(
column: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getColumnClassName(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The fully-qualified name of the class of the designated column's values.
*/
getColumnClassName(
column: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getColumnCount().
*
* @returns The number of columns in this result set.
*/
getColumnCount(): number
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getColumnDisplaySize(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The maximum number of characters allowed as the width of the designated columns.
*/
getColumnDisplaySize(
column: number
): number
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getColumnLabel(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns 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.
*/
getColumnLabel(
column: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getColumnName(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The designated column's name.
*/
getColumnName(
column: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getColumnType(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The SQL
* type of the designated column.
*/
getColumnType(
column: number
): number
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getColumnTypeName(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The designated column's database-specific type name. Returns the fully-qualifed type
* name if this is a user-defined type.
*/
getColumnTypeName(
column: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getPrecision(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns 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.
*/
getPrecision(
column: number
): number
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getScale(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The designated columns's number of digits to right of the decimal point. Returns 0 for
* data types where the scale is not applicable.
*/
getScale(
column: number
): number
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getSchemaName(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The table schema of the designated column.
*/
getSchemaName(
column: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#getTableName(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The table name of the designated column, or an empty string if not applicable.
*/
getTableName(
column: number
): string
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#isAutoIncrement(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns true if the specified column is automatically numbered; false
* otherwise.
*/
isAutoIncrement(
column: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#isCaseSensitive(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns true if the specified column is case-sensitive; false otherwise.
*/
isCaseSensitive(
column: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#isCurrency(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns true if the specified column is a cash value; false otherwise.
*/
isCurrency(
column: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#isDefinitelyWritable(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns true if writes to the designated column definitely succeed; false
* otherwise.
*/
isDefinitelyWritable(
column: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#isNullable(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns The nullability status of the specified column, which is Jdbc.ResultSetMetaData.columnNoNulls, Jdbc.ResultSetMetaData.columnNullable, or
* Jdbc.ResultSetMetaData.columnNullableUnknown.
*/
isNullable(
column: number
): number
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#isReadOnly(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns true if the designated column is definitely non-writable; false
* otherwise.
*/
isReadOnly(
column: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#isSearchable(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns true if a where clause can use the specified column; false otherwise.
*/
isSearchable(
column: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#isSigned(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns true if the values in the specified column are signed numbers; false
* otherwise.
*/
isSigned(
column: number
): Boolean
/**
* For documentation of this method, see
* java.sql.ResultSetMetaData#isWritable(int).
*
* @param column - The index of the column to examine (the first column is 1, the second is 2, and
* so on).
*
* @returns true if it is possible to write to the designated column; false
* otherwise.
*/
isWritable(
column: number
): Boolean
}
class JdbcRowId {
private constructor();
/**
* For documentation of this method, see
* java.sql.RowId#getBytes().
*
* @returns The bytes representing the ROWID represented by this JdbcRowId.
*/
getBytes(): number[]
}
class JdbcSQLXML {
private constructor();
/**
* For documentation of this method, see
* java.sql.SQLXML#free().
*/
free(): void
/**
* For documentation of this method, see
* java.sql.SQLXML#getString().
*
* @returns The string representation of the XML value designated by this SQLXML instance.
*/
getString(): string
/**
* For documentation of this method, see
* java.sql.SQLXML#setString(String).
*
* @param value - The string representation of the XML value to set.
*/
setString(
value: string
): void
}
class JdbcSavepoint {
private constructor();
/**
* For documentation of this method, see
* java.sql.Savepoint#getSavepointId().
*
* @returns The numeric ID of this savepoint.
*/
getSavepointId(): number
/**
* For documentation of this method, see
* java.sql.Savepoint#getSavepointName().
*
* @returns The name of this savepoint.
*/
getSavepointName(): string
}
class JdbcStatement {
private constructor();
/**
* For documentation of this method, see
* java.sql.Statement#addBatch(String).
*
* @param sql - The SQL command to add to this statement, typically an SQL INSERT or UPDATE.
*/
addBatch(
sql: string
): void
/**
* For documentation of this method, see
* java.sql.Statement#cancel().
*/
cancel(): void
/**
* For documentation of this method, see
* java.sql.Statement#clearBatch().
*/
clearBatch(): void
/**
* For documentation of this method, see
* java.sql.Statement#clearWarnings().
*/
clearWarnings(): void
/**
* For documentation of this method, see
* java.sql.Statement#close().
*/
close(): void
/**
* For documentation of this method, see
* java.sql.Statement#execute(String).
*
* @param sql - The SQL statement to execute.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String, int).
*
* @param sql - The SQL statement to execute.
* @param autoGeneratedKeys - A flag that indicates whether auto-generated keys are made available
* for future retrieval; either Jdbc.Statement.RETURN_GENERATED_KEYS or Jdbc.Statement.NO_GENERATED_KEYS.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string,
autoGeneratedKeys: number
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String, int[]).
*
* @param sql - The SQL statement to execute.
* @param columnIndexes - The column indices in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string,
columnIndexes: number[]
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#execute(String, String[]).
*
* @param sql - The SQL statement to execute.
* @param columnNames - The names of columns in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns true if the first result is a result set; false if it is an update
* count or if there are no results.
*/
execute(
sql: string,
columnNames: string[]
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#executeBatch().
*
* @returns The update counts for each command in the batch, using the same order in which commands
* were added to the batch.
*/
executeBatch(): number[]
/**
* For documentation of this method, see
* java.sql.Statement#executeQuery(String).
*
* @param sql - The SQL statement to execute, typically a static SELECT.
*
* @returns A result set containing the results of the execution. This is never null.
*/
executeQuery(
sql: string
): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string
): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String, int).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
* @param autoGeneratedKeys - A flag that indicates whether auto-generated keys are made available
* for future retrieval; either Jdbc.Statement.RETURN_GENERATED_KEYS or Jdbc.Statement.NO_GENERATED_KEYS.
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string,
autoGeneratedKeys: number
): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String, int[]).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
* @param columnIndexes - The column indices in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string,
columnIndexes: number[]
): number
/**
* For documentation of this method, see
* java.sql.Statement#executeUpdate(String, String[]).
*
* @param sql - The SQL Data Manipulation Language statement to execute (such as INSERT,
* UPDATE, or DELETE), or else a statement that returns nothing (such as a DDL
* statement).
* @param columnNames - The names of columns in the whose auto-generated keys are made available for
* future retrieval.
*
* @returns Either the row count for for Data Manipulation Language statements, or 0 for statements
* that return nothing.
*/
executeUpdate(
sql: string,
columnNames: string[]
): number
/**
* For documentation of this method, see
* java.sql.Statement#getConnection().
*
* @returns The connection that produced this statement.
*/
getConnection(): Jdbc.JdbcConnection
/**
* For documentation of this method, see
* java.sql.Statement#getFetchDirection().
*
* @returns The default direction for result sets generated by this statement, which is either
* Jdbc.ResultSet.FETCH_FORWARD or Jdbc.ResultSet.FETCH_REVERSE.
*/
getFetchDirection(): number
/**
* For documentation of this method, see
* java.sql.Statement#getFetchSize().
*
* @returns The default row fetch size for result sets generated from this statement.
*/
getFetchSize(): number
/**
* For documentation of this method, see
* java.sql.Statement#getGeneratedKeys().
*
* @returns A result set containing the auto-generated keys generated by the execution of this
* statement.
*/
getGeneratedKeys(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.Statement#getMaxFieldSize().
*
* @returns The current column byte size limit for columns storing character and binary values; a
* value of zero indictates no limit.
*/
getMaxFieldSize(): number
/**
* For documentation of this method, see
* java.sql.Statement#getMaxRows().
*
* @returns The current maximum number of rows for a result set produced by this statement; a value
* of 0 indicates no limit.
*/
getMaxRows(): number
/**
* For documentation of this method, see
* java.sql.Statement#getMoreResults().
*
* @returns true if the next result is a result set; false otherwise.
*/
getMoreResults(): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#getMoreResults(int).
*
* @param current - A flag that indicates what happens to current result sets when retrieved. This
* value is one of Jdbc.Statement.CLOSE_CURRENT_RESULT, Jdbc.Statement.KEEP_CURRENT_RESULT, or Jdbc.Statement.CLOSE_ALL_RESULTS.
*
* @returns true if the next result is a result set; false otherwise.
*/
getMoreResults(
current: number
): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#getQueryTimeout().
*
* @returns The current query timeout in seconds; a value of zero indicates no timeout.
*/
getQueryTimeout(): number
/**
* For documentation of this method, see
* java.sql.Statement#getResultSet().
*
* @returns The current result set, or null if the result is an update count or there are
* no more results.
*/
getResultSet(): Jdbc.JdbcResultSet
/**
* For documentation of this method, see
* java.sql.Statement#getResultSetConcurrency().
*
* @returns The result set concurrency for result sets generated from this statement, which is
* either Jdbc.ResultSet.CONCUR_READ_ONLY or Jdbc.ResultSet.CONCUR_UPDATABLE.
*/
getResultSetConcurrency(): number
/**
* For documentation of this method, see
* java.sql.Statement#getResultSetHoldability().
*
* @returns The result set holdability, which is either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
*/
getResultSetHoldability(): number
/**
* For documentation of this method, see
* java.sql.Statement#getResultSetType().
*
* @returns The result set type for result sets generated from this statement, which is Jdbc.ResultSet.TYPE_FORWARD_ONLY, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, or
* Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
*/
getResultSetType(): number
/**
* For documentation of this method, see
* java.sql.Statement#getUpdateCount().
*
* @returns The current result as an update count, or -1 if the current result is a result set or
* if there are no more results.
*/
getUpdateCount(): number
/**
* For documentation of this method, see
* java.sql.Statement#getWarnings().
*
* @returns The current set of warnings, or null if there are no warnings.
*/
getWarnings(): string[]
/**
* For documentation of this method, see
* java.sql.Statement#isClosed().
*
* @returns true if this statement is closed; false otherwise.
*/
isClosed(): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#isPoolable().
*
* @returns true if this statement is poolable; false otherwise.
*/
isPoolable(): Boolean
/**
* For documentation of this method, see
* java.sql.Statement#setCursorName(String).
*
* @param name - The new cursor name, which must be unique within a connection.
*/
setCursorName(
name: string
): void
/**
* For documentation of this method, see
* java.sql.Statement#setEscapeProcessing(boolean).
*
* @param enable - If true, escape processing is enabled; otherwise it is disabled.
*/
setEscapeProcessing(
enable: Boolean
): void
/**
* For documentation of this method, see
* java.sql.Statement#setFetchDirection(int).
*
* @param direction - The specified direction to set, which is either Jdbc.ResultSet.FETCH_FORWARD or Jdbc.ResultSet.FETCH_REVERSE.
*/
setFetchDirection(
direction: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setFetchSize(int).
*
* @param rows - The number of rows to fetch.
*/
setFetchSize(
rows: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setMaxFieldSize(int).
*
* @param max - The new column byte size limit; a value of zero indicates no limit.
*/
setMaxFieldSize(
max: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setMaxRows(int).
*
* @param max - The maximum number of rows a result set generated by this statement can have. A
* value of 0 indicates no limit.
*/
setMaxRows(
max: number
): void
/**
* For documentation of this method, see
* java.sql.Statement#setPoolable(boolean).
*
* @param poolable - If true, requests that this statement be pooled; otherwise requests it
* not be pooled.
*/
setPoolable(
poolable: Boolean
): void
/**
* For documentation of this method, see
* java.sql.Statement#setQueryTimeout(int).
*
* @param seconds - The new query timeout in seconds; a value of 0 indicates no timeout.
*/
setQueryTimeout(
seconds: number
): void
}
class JdbcStruct {
private constructor();
/**
* For documentation of this method, see
* java.sql.Struct#getAttributes().
*
* @returns The ordered attribute values of this structure.
*/
getAttributes(): object[]
/**
* For documentation of this method, see
* java.sql.Struct#getSQLTypeName().
*
* @returns The fully-qualified type name of the SQL structured type that this structure
* represents.
*/
getSQLTypeName(): string
}
class JdbcTime {
private constructor();
/**
* For documentation of this method, see
* java.sql.Date#after(Date).
*
* @param when - A time to compare to.
*
* @returns true if and only if this time is strictly later than the time specified as a
* parameter; false otherwise.
*/
after(
when: Jdbc.JdbcTime
): Boolean
/**
* For documentation of this method, see
* java.sql.Date#before(Date).
*
* @param when - A time to compare to.
*
* @returns true if and only if this time is strictly earlier than the time specified as a
* parameter; false otherwise.
*/
before(
when: Jdbc.JdbcTime
): Boolean
/**
* For documentation of this method, see
* java.sql.Date#getHours().
*
* @returns The hour represented by this object; the value is a number (0 through 23) representing
* the hour within the day that contains or begins with the instant in time represented by
* this object, as interpreted in the local time zone.
*/
getHours(): number
/**
* For documentation of this method, see
* java.sql.Date#getMinutes().
*
* @returns The minutes past the hour represented by this object, as interpreted in the local time
* zone. The value is a number between 0 through 59 inclusive.
*/
getMinutes(): number
/**
* For documentation of this method, see
* java.sql.Date#getSeconds().
*
* @returns The seconds past the minute represented by this object, as interpreted in the local
* time zone. The value is a number between 0 through 61 inclusive, whiere 60 and 61 are only
* possible for machines that take leap seconds into account.
*/
getSeconds(): number
/**
* For documentation of this method, see
* java.sql.Date#getTime().
*
* @returns The number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this time
* object.
*/
getTime(): number
/**
* For documentation of this method, see
* java.sql.Date#setHours(int).
*
* @param hours - The hour to set; this object is updated to represent a point in time within the
* specified hour of the day, with the year, month, date, minute, and second the same as
* before, as interpreted in the local time zone.
*/
setHours(
hours: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setMinutes(int).
*
* @param minutes - The minutes to set; this object is updated to represent a point in time within
* the specified minute of the hour, with the year, month, date, hour, and second the same as
* before, as interpreted in the local time zone.
*/
setMinutes(
minutes: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setSeconds(int).
*
* @param seconds - The seconds to set; this object is updated to represent a point in time within
* the specified second of the minute, with the year, month, date, hour, and minute the same
* as before, as interpreted in the local time zone.
*/
setSeconds(
seconds: number
): void
/**
* For documentation of this method, see
* java.sql.Time#setTime(long).
*
* @param milliseconds - The time value to set. The value is milliseconds since January 1, 1970,
* 00:00:00 GMT, while a negative number is milliseconds before that time.
*/
setTime(
milliseconds: number
): void
}
class JdbcTimestamp {
private constructor();
/**
* For documentation of this method, see
* java.sql.Timestamp#after(Timestamp).
*
* @param when - A timestamp to compare to.
*
* @returns true if and only if this timestampe is strictly later than the timestamp
* specified as a parameter; false otherwise.
*/
after(
when: Jdbc.JdbcTimestamp
): Boolean
/**
* For documentation of this method, see
* java.sql.Timestamp#before(Timestamp).
*
* @param when - A timestamp to compare to.
*
* @returns true if and only if this timestamp is strictly earlier than the timestamp
* specified as a parameter; false otherwise.
*/
before(
when: Jdbc.JdbcTimestamp
): Boolean
/**
* For documentation of this method, see
* java.sql.Date#getDate().
*
* @returns The day of the month represented by this timestamp. The value returned is between 1 and
* 31 representing the day of the month that contains or begins with the instant in time
* represented by this timestamp, as interpreted in the local time zone.
*/
getDate(): number
/**
* For documentation of this method, see
* java.sql.Date#getHours().
*
* @returns The hour represented by this object; the value is a number (0 through 23) representing
* the hour within the day that contains or begins with the instant in time represented by
* this object, as interpreted in the local time zone.
*/
getHours(): number
/**
* For documentation of this method, see
* java.sql.Date#getMinutes().
*
* @returns The minutes past the hour represented by this object, as interpreted in the local time
* zone. The value is a number between 0 through 59 inclusive.
*/
getMinutes(): number
/**
* For documentation of this method, see
* java.sql.Date#getMonth().
*
* @returns The month that contains or begins with the instant in time represented by this
* timestamp. The value returned is between 0 and 11, with the value 0 representing January.
*/
getMonth(): number
/**
* For documentation of this method, see
* java.sql.Timestamp#getNanos().
*
* @returns This timestamp's fractional seconds value (nanoseconds).
*/
getNanos(): number
/**
* For documentation of this method, see
* java.sql.Date#getSeconds().
*
* @returns The seconds past the minute represented by this object, as interpreted in the local
* time zone. The value is a number between 0 through 61 inclusive, whiere 60 and 61 are only
* possible for machines that take leap seconds into account.
*/
getSeconds(): number
/**
* For documentation of this method, see
* java.sql.Timestamp#getTime().
*
* @returns The number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this time
* object.
*/
getTime(): number
/**
* For documentation of this method, see
* java.sql.Date#getYear().
*
* @returns A value that is the result of subtracting 1900 from the year that contains or begins
* with the instant in time represented by this timestampe, as interpreted in the local time
* zone.
*/
getYear(): number
/**
* For documentation of this method, see
* java.sql.Date#setDate(int).
*
* @param date - The day of month to set. This timestamp is updated to represent a point in time
* within the specified day of month, with the year, month, hour, minute, and second the same
* as before, as interpreted in the local time zone. If the date was April 30, for example,
* and the date is set to 31, then it is treated as if it were on May 1, because April has
* only 30 days.
*/
setDate(
date: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setHours(int).
*
* @param hours - The hour to set; this object is updated to represent a point in time within the
* specified hour of the day, with the year, month, date, minute, and second the same as
* before, as interpreted in the local time zone.
*/
setHours(
hours: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setMinutes(int).
*
* @param minutes - The minutes to set; this object is updated to represent a point in time within
* the specified minute of the hour, with the year, month, date, hour, and second the same as
* before, as interpreted in the local time zone.
*/
setMinutes(
minutes: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setMonth(int).
*
* @param month - The month to set. This timestamp is updated to represent a point in time within
* the specified month, with the year, date, hour, minute, and second the same as before, as
* interpreted in the local time zone. If the date was October 31, for example, and the month
* is set to June, then the new date is treated as if it were on July 1, because June has only
* 30 days.
*/
setMonth(
month: number
): void
/**
* For documentation of this method, see
* java.sql.Timestamp#setNanos(int).
*
* @param nanoseconds - The new fractional seconds value.
*/
setNanos(
nanoseconds: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setSeconds(int).
*
* @param seconds - The seconds to set; this object is updated to represent a point in time within
* the specified second of the minute, with the year, month, date, hour, and minute the same
* as before, as interpreted in the local time zone.
*/
setSeconds(
seconds: number
): void
/**
* For documentation of this method, see
* java.sql.Timestamp#setTime(long).
*
* @param milliseconds - The time value to set. The value is milliseconds since January 1, 1970,
* 00:00:00 GMT.
*/
setTime(
milliseconds: number
): void
/**
* For documentation of this method, see
* java.sql.Date#setYear(int).
*
* @param year - The year value to set; the timestamp's year is set to this value plus 1900. This
* timestamp is updated to represent a point in time within the specified year, with the
* month, date, hour, minute, and second the same as before, as interpreted in the local time
* zone. If the date was February 29, for example, and the year is set to a non-leap year,
* then the new date is treated as if it were on March 1.
*/
setYear(
year: number
): void
}
}