Database
Introduction
The Database API provides a set of functions to interact with databases in the codbex platform environment. This guide will walk you through the available methods and how to use them effectively.
Methods
getDataSources()
Retrieves the available data sources.
// Example
const datasources = getDataSources();
console.log(datasources); // Outputs an array of available data sources
getMetadata(datasourceName?)
Retrieves metadata for a specified data source. If no data source is provided, it retrieves metadata for all data sources.
// Example
const metadata = getMetadata("exampleDS");
console.log(metadata); // Outputs metadata for the specified data source
getProductName(datasourceName?)
Retrieves the product name for a specified data source. If no data source is provided, it retrieves the product name for all data sources.
// Example
const productName = getProductName("exampleDS");
console.log(productName); // Outputs the product name for the specified data source
getConnection(datasourceName?)
Establishes a connection to the specified data source. If no data source is provided, it establishes a connection to the default data source.
// Example
const connection = getConnection("exampleDS");
// Use the connection object for further database operations
isHanaDatabase(connection)
Checks if the provided database connection is of type SAP HANA database.
// Example
const connection = ...; // obtain a database connection
const isHana = isHanaDatabase(connection);
readBlobValue(value)
Reads a Blob value and returns it as a byte array.
// Example
const blobValue = ...; // obtain a Blob value
const byteArray = readBlobValue(blobValue);
createBlobValue(native, value)
Creates a new Blob value based on the provided byte array. The creation process depends on the database type.
// Example
const nativeConnection = ...; // obtain the native connection
const byteValue = ...; // byte array data
const blob = createBlobValue(nativeConnection, byteValue);
readClobValue(value)
Reads a Clob value and returns it as a string.
// Example
const clobValue = ...; // obtain a Clob value
const stringValue = readClobValue(clobValue);
createClobValue(native, value)
Creates a new Clob value based on the provided string. The creation process depends on the database type.
// Example
const nativeConnection = ...; // obtain the native connection
const stringValue = ...; // string data
const clob = createClobValue(nativeConnection, stringValue);
readNClobValue(value)
Reads an NClob value and returns it as a string.
// Example
const nclobValue = ...; // obtain an NClob value
const stringValue = readNClobValue(nclobValue);
createNClobValue(native, value)
Creates a new NClob value based on the provided string. The creation process depends on the database type.
// Example
const nativeConnection = ...; // obtain the native connection
const stringValue = ...; // string data
const nclob = createNClobValue(nativeConnection, stringValue);
getDateValue(value)
Converts the input value to a JavaScript Date object. If the input is a string, it is parsed into a Date.
// Example
const dateString = "2024-02-25";
const dateObject = getDateValue(dateString);
SQLTypes Constants
The SQLTypes constants represent various SQL data types. Each constant is associated with a specific integer value that corresponds to a particular SQL data type. Below is a description of each constant:
BOOLEAN(16): Represents the SQLBOOLEANdata type.DATE(91): Represents the SQLDATEdata type.TIME(92): Represents the SQLTIMEdata type.TIMESTAMP(93): Represents the SQLTIMESTAMPdata type.DOUBLE(8): Represents the SQLDOUBLEdata type.FLOAT(6): Represents the SQLFLOATdata type.REAL(7): Represents the SQLREALdata type.TINYINT(-6): Represents the SQLTINYINTdata type.SMALLINT(5): Represents the SQLSMALLINTdata type.INTEGER(4): Represents the SQLINTEGERdata type.BIGINT(-5): Represents the SQLBIGINTdata type.VARCHAR(12): Represents the SQLVARCHARdata type.CHAR(1): Represents the SQLCHARdata type.CLOB(2005): Represents the SQLCLOBdata type.BLOB(2004): Represents the SQLBLOBdata type.VARBINARY(-3): Represents the SQLVARBINARYdata type.DECIMAL(3): Represents the SQLDECIMALdata type.ARRAY(2003): Represents the SQLARRAYdata type.NVARCHAR(-9): Represents the SQLNVARCHARdata type.NCLOB(2011): Represents the SQLNCLOBdata type.BIT(-7): Represents the SQLBITdata type.
Connection Object Methods
The Connection object provides methods for various operations on the database connection.
prepareStatement(sql)
Creates a PreparedStatement object for the given SQL query.
// Example
const preparedStatement = connection.prepareStatement("SELECT * FROM example_table");
prepareCall(sql)
Creates a CallableStatement object for the given SQL query.
// Example
const callableStatement = connection.prepareCall("call example_procedure()");
close()
Closes the database connection.
// Example
connection.close();
commit()
Commits the current transaction.
// Example
connection.commit();
getAutoCommit()
Retrieves the current auto-commit mode.
// Example
const autoCommitMode = connection.getAutoCommit();
console.log(autoCommitMode); // Outputs true or false
getCatalog()
Retrieves the current catalog name.
// Example
const catalogName = connection.getCatalog();
console.log(catalogName); // Outputs the catalog name
getSchema()
Retrieves the current schema name.
// Example
const schemaName = connection.getSchema();
console.log(schemaName); // Outputs the schema name
getTransactionIsolation()
Retrieves the current transaction isolation level.
// Example
const isolationLevel = connection.getTransactionIsolation();
console.log(isolationLevel); // Outputs the transaction isolation level
isClosed()
Checks whether the connection is closed.
// Example
const isClosed = connection.isClosed();
console.log(isClosed); // Outputs true or false
isReadOnly()
Checks whether the connection is in read-only mode.
// Example
const isReadOnly = connection.isReadOnly();
console.log(isReadOnly); // Outputs true or false
isValid()
Checks whether the connection is valid.
// Example
const isValid = connection.isValid();
console.log(isValid); // Outputs true or false
rollback()
Rolls back the current transaction.
// Example
connection.rollback();
setAutoCommit(autoCommit)
Sets the auto-commit mode for the connection.
// Example
connection.setAutoCommit(true); // or connection.setAutoCommit(false);
setCatalog(catalog)
Sets the current catalog name for the connection.
// Example
connection.setCatalog("new_catalog");
setReadOnly(readOnly)
Sets the read-only mode for the connection.
// Example
connection.setReadOnly(true); // or connection.setReadOnly(false);
setSchema(schema)
Sets the current schema name for the connection.
// Example
connection.setSchema("new_schema");
setTransactionIsolation(transactionIsolation)
Sets the transaction isolation level for the connection.
// Example
connection.setTransactionIsolation(Connection.TRANSACTION_READ_COMMITTED);
These methods provide essential functionalities for managing and interacting with the database connection in the platform. Depending on your use case, you may need to utilize these methods to control transactions, handle connection properties, and more.
PreparedStatement Object Methods
The PreparedStatement object provides methods for managing and executing precompiled SQL statements.
close()
Closes the prepared statement.
// Example
preparedStatement.close();
getResultSet()
Retrieves the result set of the prepared statement.
// Example
const resultSet = preparedStatement.getResultSet();
execute()
Executes the SQL query.
// Example
const result = preparedStatement.execute();
executeQuery()
Executes a SELECT SQL query and returns a ResultSet object.
// Example
const result = preparedStatement.execute();
executeUpdate()
Executes an SQL INSERT, UPDATE, or DELETE query.
// Example
const rowCount = preparedStatement.executeUpdate();
setNull(index, sqlType)
Sets a parameter to NULL.
// Example
preparedStatement.setNull(1, SQLTypes.INTEGER);
setBinaryStream(parameter, inputStream, length)
Sets a binary stream as a parameter.
// Example
preparedStatement.setBinaryStream(1, inputStream, length);
setBoolean(index, value)
Sets a Boolean parameter.
// Example
preparedStatement.setBoolean(1, true);
setByte(index, value)
Sets a Byte parameter.
// Example
preparedStatement.setByte(1, 42);
setBlob(index, value)
Sets a Blob parameter.
// Example
preparedStatement.setBlob(1, blobValue);
setClob(index, value)
Sets a Clob parameter.
// Example
preparedStatement.setClob(1, clobValue);
setNClob(index, value)
Sets an NClob parameter.
// Example
preparedStatement.setNClob(1, nclobValue);
setBytesNative(index, value)
Sets a native byte parameter.
// Example
preparedStatement.setBytesNative(1, byteArray);
setBytes(index, value)
Sets a byte array as a parameter.
// Example
preparedStatement.setBytes(1, byteArray);
setDate(index, value)
Sets a Date parameter.
// Example
preparedStatement.setDate(1, new Date());
setDouble(index, value)
Sets a Double parameter.
// Example
preparedStatement.setDouble(1, 3.14);
setFloat(index, value)
Sets a Float parameter.
// Example
preparedStatement.setFloat(1, 2.718);
setInt(index, value)
Sets an Integer parameter.
// Example
preparedStatement.setInt(1, 42);
setLong(index, value)
Sets a Long parameter.
// Example
preparedStatement.setLong(1, 123456789);
setShort(index, value)
Sets a Short parameter.
// Example
preparedStatement.setShort(1, 7);
setString(index, value)
Sets a String parameter.
// Example
preparedStatement.setString(1, "example");
setTime(index, value)
Sets a Time parameter.
// Example
preparedStatement.setTime(1, new Date());
setTimestamp(index, value)
Sets a Timestamp parameter.
// Example
preparedStatement.setTimestamp(1, new Date());
setBigDecimal(index, value)
Sets a BigDecimal parameter.
// Example
preparedStatement.setBigDecimal(1, bigDecimalValue);
setNString(index, value)
Sets an NString parameter.
// Example
preparedStatement.setNString(1, "example");
addBatch()
Adds the current set of parameters to the batch for later execution.
// Example
preparedStatement.addBatch();
executeBatch()
Executes the batch of commands.
// Example
const results = preparedStatement.executeBatch();
getMetaData()
Retrieves the metadata for the prepared statement.
// Example
const metaData = preparedStatement.getMetaData();
getMoreResults()
Moves to the next result set, if available.
// Example
const hasMoreResults = preparedStatement.getMoreResults();
getParameterMetaData()
Retrieves the parameter metadata for the prepared statement.
// Example
const parameterMetaData = preparedStatement.getParameterMetaData();
getSQLWarning()
Retrieves the first warning reported by calls on this statement.
// Example
const sqlWarning = preparedStatement.getSQLWarning();
isClosed()
Checks if the prepared statement is closed.
// Example
const isClosed = preparedStatement.isClosed();
These methods provide a comprehensive set of functionalities for handling prepared statements, setting parameters, executing queries, and managing result sets. Depending on your use case, you can leverage these methods to interact with your database effectively.
CallableStatement Object Methods
The CallableStatement object provides methods for executing SQL stored procedures.
getResultSet()
Retrieves the result set of the callable statement.
// Example
const resultSet = callableStatement.getResultSet();
executeQuery()
Executes a stored procedure that returns a result set.
// Example
const resultSet = callableStatement.executeQuery();
executeUpdate()
Executes a stored procedure that performs an update.
// Example
const rowCount = callableStatement.executeUpdate();
registerOutParameter(parameterIndex, sqlType)
Registers the output parameter with the given SQL type.
// Example
callableStatement.registerOutParameter(1, SQLTypes.INTEGER);
registerOutParameterByScale(parameterIndex, sqlType, scale)
Registers the output parameter with the given SQL type and scale.
// Example
callableStatement.registerOutParameterByScale(1, SQLTypes.DECIMAL, 2);
registerOutParameterByTypeName(parameterIndex, sqlType, typeName)
Registers the output parameter with the given SQL type and type name.
// Example
callableStatement.registerOutParameterByTypeName(1, SQLTypes.VARCHAR, "VARCHAR");
wasNull()
Determines if the last column read was NULL.
// Example
const isNull = callableStatement.wasNull();
getString(parameter)
Retrieves the value of the specified parameter as a String.
// Example
const value = callableStatement.getString(1);
getBoolean(parameter)
Retrieves the value of the specified parameter as a Boolean.
// Example
const value = callableStatement.getBoolean(1);
getByte(parameter)
Retrieves the value of the specified parameter as a Byte.
// Example
const value = callableStatement.getByte(1);
getShort(parameter)
Retrieves the value of the specified parameter as a Short.
// Example
const value = callableStatement.getShort(1);
getInt(parameter)
Retrieves the value of the specified parameter as an Integer.
// Example
const value = callableStatement.getInt(1);
getLong(parameter)
Retrieves the value of the specified parameter as a Long.
// Example
const value = callableStatement.getLong(1);
getFloat(parameter)
Retrieves the value of the specified parameter as a Float.
// Example
const value = callableStatement.getFloat(1);
getDouble(parameter)
Retrieves the value of the specified parameter as a Double.
// Example
const value = callableStatement.getDouble(1);
getDate(parameter)
Retrieves the value of the specified parameter as a Date.
// Example
const value = callableStatement.getDate(1);
getTime(parameter)
Retrieves the value of the specified parameter as a Time.
// Example
const value = callableStatement.getTime(1);
getTimestamp(parameter)
Retrieves the value of the specified parameter as a Timestamp.
// Example
const value = callableStatement.getTimestamp(1);
getObject(parameter)
Retrieves the value of the specified parameter as an Object.
// Example
const value = callableStatement.getObject(1);
getBigDecimal(parameter)
Retrieves the value of the specified parameter as a BigDecimal.
// Example
const value = callableStatement.getBigDecimal(1);
getRef(parameter)
Retrieves the value of the specified parameter as a Ref.
// Example
const value = callableStatement.getRef(1);
getBytes(parameter)
Retrieves the value of the specified parameter as a byte array.
// Example
const value = callableStatement.getBytes(1);
getBytesNative(parameter)
Retrieves the value of the specified parameter as a byte array in native format.
// Example
const value = callableStatement.getBytesNative(1);
getBlob(parameter)
Retrieves the value of the specified parameter as a Blob.
// Example
const value = callableStatement.getBlob(1);
getBlobNative(parameter)
Retrieves the value of the specified parameter as a Blob in native format.
// Example
const value = callableStatement.getBlobNative(1);
getClob(parameter)
Retrieves the value of the specified parameter as a Clob.
// Example
const value = callableStatement.getClob(1);
getNClob(parameter)
Retrieves the value of the specified parameter as an NClob.
// Example
const value = callableStatement.getNClob(1);
getNString(parameter)
Retrieves the value of the specified parameter as an NString.
// Example
const value = callableStatement.getNString(1);
getArray(parameter)
Retrieves the value of the specified parameter as an Array.
// Example
const value = callableStatement.getArray(1);
getURL(parameter)
Retrieves the value of the specified parameter as a URL.
// Example
const value = callableStatement.getURL(1);
getRowId(parameter)
Retrieves the value of the specified parameter as a RowId.
// Example
const value = callableStatement.getRowId(1);
getSQLXML(parameter)
Retrieves the value of the specified parameter as an SQLXML.
// Example
const value = callableStatement.getSQLXML(1);
setURL(parameter, value)
Sets the value of the specified parameter as a URL.
// Example
callableStatement.setURL(1, "https://example.com");
setNull(parameter, sqlTypeStr, typeName)
Sets the value of the specified parameter to NULL.
// Example
callableStatement.setNull(1, SQLTypes.INTEGER);
setBoolean(parameter, value)
Sets the value of the specified parameter as a Boolean.
// Example
callableStatement.setBoolean(1, true);
setByte(parameter, value)
Sets the value of the specified parameter as a Byte.
// Example
callableStatement.setByte(1, 42);
setShort(parameter, value)
Sets the value of the specified parameter as a Short.
// Example
callableStatement.setShort(1, 7);
setInt(parameter, value)
Sets the value of the specified parameter as an Integer.
// Example
callableStatement.setInt(1, 42);
setLong(parameter, value)
Sets the value of the specified parameter as a Long.
// Example
callableStatement.setLong(1, 123456789);
setFloat(parameter, value)
Sets the value of the specified parameter as a Float.
// Example
callableStatement.setFloat(1, 2.718);
setDouble(parameter, value)
Sets the value of the specified parameter as a Double.
// Example
callableStatement.setDouble(1, 3.14);
setBigDecimal(parameter, value)
Sets the value of the specified parameter as a BigDecimal.
// Example
callableStatement.setBigDecimal(1, bigDecimalValue);
setString(parameter, value)
Sets the value of the specified parameter as a String.
// Example
callableStatement.setString(1, "example");
setBytes(parameter, value)
Sets the value of the specified parameter as a byte array.
// Example
callableStatement.setBytes(1, byteArray);
setDate(parameter, value)
Sets the value of the specified parameter as a Date.
// Example
callableStatement.setDate(1, new Date());
setTime(parameter, value)
Sets the value of the specified parameter as a Time.
// Example
callableStatement.setTime(1, new Date());
setTimestamp(parameter, value)
Sets the value of the specified parameter as a Timestamp.
// Example
callableStatement.setTimestamp(1, new Date());
setAsciiStream(parameter, inputStream, length)
Sets the value of the specified parameter as an ASCII stream.
// Example
callableStatement.setAsciiStream(1, inputStream, length);
setBinaryStream(parameter, inputStream, length)
Sets the value of the specified parameter as a binary stream.
// Example
callableStatement.setBinaryStream(1, inputStream, length);
setObject(parameter, value, targetSqlType, scale)
Sets the value of the specified parameter as an Object.
// Example
callableStatement.setObject(1, value, SQLTypes.INTEGER, 2);
setRowId(parameter, value)
Sets the value of the specified parameter as a RowId.
// Example
callableStatement.setRowId(1, rowIdValue);
setNString(parameter, value)
Sets the value of the specified parameter as an NString.
// Example
callableStatement.setNString(1, "example");
setSQLXML(parameter, value)
Sets the value of the specified parameter as an SQLXML.
// Example
callableStatement.setSQLXML(1, sqlxmlValue);
setBlob(parameter, value)
Sets the value of the specified parameter as a Blob.
// Example
callableStatement.setBlob(1, blobValue);
setClob(parameter, value)
Sets the value of the specified parameter as a Clob.
// Example
callableStatement.setClob(1, clobValue);
setNClob(parameter, value)
Sets the value of the specified parameter as an NClob.
// Example
callableStatement.setNClob(1, nclobValue);
execute()
Executes the callable statement.
// Example
const result = callableStatement.execute();
getMoreResults()
Moves to the next result set, if available.
// Example
const hasMoreResults = callableStatement.getMoreResults();
getParameterMetaData()
Retrieves the parameter metadata for the callable statement.
// Example
const parameterMetaData = callableStatement.getParameterMetaData();
isClosed()
Checks if the callable statement is closed.
// Example
const isClosed = callableStatement.isClosed();
close()
Closes the callable statement.
// Example
callableStatement.close();
These methods provide a comprehensive set of functionalities for handling callable statements, registering parameters, executing queries, and managing result sets. Depending on your use case, you can leverage these methods to interact with your database effectively.
ResultSet Object Methods
The ResultSet object provides methods for retrieving and processing query results.
toJson(limited?)
Converts the result set to JSON format. If `limited`` is true, only a limited number of rows are included.
// Example
const jsonResult = resultSet.toJson(true);
console.log(jsonResult); // Outputs JSON representation of the result set
close()
Closes the result set.
// Example
resultSet.close();
getBigDecimal(identifier)
Retrieves the value of the specified column as a BigDecimal.
// Example
const value = resultSet.getBigDecimal(1);
getBoolean(identifier)
Retrieves the value of the specified column as a Boolean.
// Example
const value = resultSet.getBoolean(1);
getByte(identifier)
Retrieves the value of the specified column as a Byte.
// Example
const value = resultSet.getByte(1);
getBytes(identifier)
Retrieves the value of the specified column as a byte array.
// Example
const value = resultSet.getBytes(1);
getBytesNative(identifier)
Retrieves the value of the specified column as a byte array in native format.
// Example
const value = resultSet.getBytesNative(1);
getBlob(identifier)
Retrieves the value of the specified column as a Blob.
// Example
const value = resultSet.getBlob(1);
getBlobNative(identifier)
Retrieves the value of the specified column as a Blob in native format.
// Example
const value = resultSet.getBlobNative(1);
getClob(identifier)
Retrieves the value of the specified column as a Clob.
// Example
const value = resultSet.getClob(1);
getNClob(columnIndex)
Retrieves the value of the specified column as an NClob.
// Example
const value = resultSet.getNClob(1);
getDate(identifier)
Retrieves the value of the specified column as a Date.
// Example
const value = resultSet.getDate(1);
getDouble(identifier)
Retrieves the value of the specified column as a Double.
// Example
const value = resultSet.getDouble(1);
getFloat(identifier)
Retrieves the value of the specified column as a Float.
// Example
const value = resultSet.getFloat(1);
getInt(identifier)
Retrieves the value of the specified column as an Integer.
// Example
const value = resultSet.getInt(1);
getLong(identifier)
Retrieves the value of the specified column as a Long.
// Example
const value = resultSet.getLong(1);
getShort(identifier)
Retrieves the value of the specified column as a Short.
// Example
const value = resultSet.getShort(1);
getString(identifier)
Retrieves the value of the specified column as a String.
// Example
const value = resultSet.getString(1);
getTime(identifier)
Retrieves the value of the specified column as a Time.
// Example
const value = resultSet.getTime(1);
getTimestamp(identifier)
Retrieves the value of the specified column as a Timestamp.
// Example
const value = resultSet.getTimestamp(1);
isAfterLast()
Checks if the result set cursor is positioned after the last row.
// Example
const isAfterLast = resultSet.isAfterLast();
isBeforeFirst()
Checks if the result set cursor is positioned before the first row.
// Example
const isBeforeFirst = resultSet.isBeforeFirst();
isClosed()
Checks if the result set is closed.
// Example
const isClosed = resultSet.isClosed();
isFirst()
Checks if the result set cursor is positioned on the first row.
// Example
const isFirst = resultSet.isFirst();
isLast()
Checks if the result set cursor is positioned on the last row.
// Example
const isLast = resultSet.isLast();
next()
Moves the result set cursor to the next row.
// Example
const hasNextRow = resultSet.next();
getMetaData()
Retrieves the metadata for the result set.
// Example
const metaData = resultSet.getMetaData();
getNString(columnIndex)
Retrieves the value of the specified column as an NString.
// Example
const value = resultSet.getNString(1);
These methods offer various functionalities for accessing and manipulating data within a result set. Use them according to your requirements to interact with the retrieved data effectively.
Functions
| Function | Description | Returns |
|---|---|---|
| getDatabaseTypes() | deprecated as all the datasources now are in a single list |
list of string |
| getDataSources() | Returns the list of the available data-sources in this instance. The data-sources of the default database type are listed | list of string |
| createDataSource(name, driver, url, username, password, properties) | Creates a named dynamic datasource based on the provided parameters | - |
| getMetadata(datasourceName) | Returns the metadata of the selected datasourceName. In case the datasourceName parameter is omitted, then the default data-source for the selected database is taken. | metadata object |
| getConnection(datasourceName) | Establishes a connection to the selected data-source. Both parameters are optional | Connection |
Objects
Connection
| Function | Description | Returns |
|---|---|---|
| prepareStatement(sql) | Creates a prepared statement by the given SQL script | PreparedStatement |
| prepareCall(sql) | Creates a callable statement by the given SQL script | CallableStatement |
| close() | Closes the Connection and returns it to the pool | - |
| commit() | Commits the current transaction | - |
| getAutoCommit() | Returns the value of the auto commit setting | boolean |
| getCatalog() | Returns the Catalog name, which the Connection is related to | string |
| getSchema() | Returns the Schema name, which the Connection is related to | string |
| getTransactionIsolation() | Returns the value of the transaction isolation setting | int |
| isClosed() | Returns true if the Connection is already closed and false otherwise | boolean |
| isReadOnly() | Returns true if the Connection is opened in a read only state and false otherwise | boolean |
| isValid() | Returns true if the Connection is still valid and false otherwise | boolean |
| rollback() | Rolls the current transaction back | - |
| setAutoCommit(autoCommit) | Sets the value of the auto commit setting | - |
| setCatalog(catalog) | Sets the Catalog name, which the Connection is related to | - |
| setSchema(schema) | Sets the Schema name, which the Connection is related to | - |
| setReadOnly(readOnly) | Sets the value of the read only state | - |
| setTransactionIsolation(transactionIsolation) | Sets the value of the transaction isolation setting | - |
PreparedStatement
| Function | Description | Returns |
|---|---|---|
| close() | Closes the Statement | - |
| execute() | Executes an SQL query, script, procedure, etc. | boolean |
| executeQuery() | Executes a query and returns a ResultSet | ResultSet |
| executeUpdate() | Executes an update SQL statement | - |
| setNull(index, value) | Sets a parameter as null | - |
| setBoolean(index, value) | Sets a parameter of type boolean | - |
| setDate(index, value) | Sets a parameter of type date | - |
| setClob(index, value) | Sets a parameter of type clob | - |
| setBlob(index, value) | Sets a parameter of type blob | - |
| setBytes(index, value) | Sets a parameter of type bytes | - |
| setBinaryStream(index, inputStreamValue, length?) | Sets a parameter of type binary stream | - |
| setDouble(index, value) | Sets a parameter of type double | - |
| setFloat(index, value) | Sets a parameter of type float | - |
| setInt(index, value) | Sets a parameter of type integer | - |
| setLong(index, value) | Sets a parameter of type long | - |
| setShort(index, value) | Sets a parameter of type short | - |
| setString(index, value) | Sets a parameter of type string | - |
| setTime(index, value) | Sets a parameter of type time | - |
| setTimestamp(index, value) | Sets a parameter of type timestamp | - |
| addBatch() | Adds a set of parameters to this PreparedStatement batch of commands | - |
| executeBatch() | Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. | integer array |
| getMetaData() | Retrieves a metadata object that contains information about the columns of the object that will be returned when this PreparedStatement is executed | object |
| getMoreResults() | Returns true, if there are more ResultSet objects to be retrieved. | boolean |
| getParameterMetaData() | Retrieves the number, types and properties of this PreparedStatement parameters | object |
| getSQLWarning() | Retrieves the first warning reported | object |
| isClosed() | Returns true, if closed | boolean |
CallableStatement
| Function | Description | Returns |
|---|---|---|
| close() | Closes the Statement | - |
| execute() | Executes an SQL query, script, procedure, etc. | boolean |
| executeQuery() | Executes a query and returns a ResultSet | ResultSet |
| executeUpdate() | Executes an update SQL statement | - |
| setNull(index, value) | Sets a parameter as null | - |
| setBoolean(index, value) | Sets a parameter of type boolean | - |
| setDate(index, value) | Sets a parameter of type date | - |
| setClob(index, value) | Sets a parameter of type clob | - |
| setBlob(index, value) | Sets a parameter of type blob | - |
| setBytes(index, value) | Sets a parameter of type bytes | - |
| setDouble(index, value) | Sets a parameter of type double | - |
| setFloat(index, value) | Sets a parameter of type float | - |
| setInt(index, value) | Sets a parameter of type integer | - |
| setLong(index, value) | Sets a parameter of type long | - |
| setShort(index, value) | Sets a parameter of type short | - |
| setString(index, value) | Sets a parameter of type string | - |
| setTime(index, value) | Sets a parameter of type time | - |
| setTimestamp(index, value) | Sets a parameter of type timestamp | - |
| addBatch() | Adds a set of parameters to this PreparedStatement batch of commands | - |
| executeBatch() | Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. | integer array |
| getMetaData() | Retrieves a metadata object that contains information about the columns of the object that will be returned when this PreparedStatement is executed | object |
| getMoreResults() | Returns true, if there are more ResultSet objects to be retrieved. | boolean |
| getParameterMetaData() | Retrieves the number, types and properties of this PreparedStatement parameters | object |
| getSQLWarning() | Retrieves the first warning reported | object |
| isClosed() | Returns true, if closed | boolean |
ResultSet
| Function | Description | Returns |
|---|---|---|
| toJson(limited) | Returns the result set as stringfied JSON, limited = true will return only the first 100 records |
string |
| close() | Closes the ResultSet | - |
| getBoolean(identifier) | Returns a value of type boolean | boolean |
| getDate(identifier) | Returns a value of type date | Date |
| getDouble(identifier) | Returns a value of type double | double |
| getFloat(identifier) | Returns a value of type float | float |
| getInt(identifier) | Returns a value of type integer | int |
| getLong(identifier) | Returns a value of type long | long |
| getShort(identifier) | Returns a value of type short | short |
| getString(identifier) | Returns a value of type string | string |
| getTime(identifier) | Returns a value of type time | Date |
| getTimestamp(identifier) | Returns a value of type timestamp | Date |
| isAfterLast() | Returns true if the ResultSet is iterated at the end and false otherwise | boolean |
| isBeforeFirst() | Returns true if the ResultSet is iterated at the beginning and false otherwise | boolean |
| isFirst() | Returns true if the ResultSet is iterated at the first row and false otherwise | boolean |
| isLast() | Returns true if the ResultSet is iterated at the last row and false otherwise | boolean |
| isClosed() | Returns true if the ResultSet is already closed and false otherwise | boolean |
| next() | Iterates the ResultSet to the next row and returns true if it is successful. Returns false if no more rows remain. | boolean |