Class JdbcConnection

For documentation of this method, see java.sql.Connection#clearWarnings().

Authorization

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

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

Release this connection's database and all associated resources.

const conn = Jdbc.getConnection(
    'jdbc:mysql://<host>:<port>/<instance>',
    'user',
    'password',
);
conn.close();

See also

• Connection.close()

Makes all pending changes permanent, releases database locks held by this JdbcConnection.

const conn = Jdbc.getConnection(
    'jdbc:mysql://<host>:<port>/<instance>',
    'user',
    'password',
);
conn.setAutoCommit(false);
const stmt = conn.prepareStatement(
    'insert into person (lname,fname) values (?,?)',
);
const start = new Date();
for (let i = 0; i < 5000; i++) {
  // Objects are accessed using 1-based indexing
  stmt.setObject(1, `firstName${i}`);
  stmt.setObject(2, `lastName${i}`);
  stmt.addBatch();
}
const res = stmt.executeBatch();
conn.commit();  // When this returns, this is when changes are actually
                // committed
conn.close();

Authorization

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

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

See also

• Connection.commit()

For documentation of this method, see java.sql.Connection#createArrayOf(String, Object[]).

Parameters

Return

JdbcArray — An array whose elements map to the specified SQL type.

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.

Return

JdbcBlob — An empty blob object.

For documentation of this method, see java.sql.Connection#createClob().

Return

JdbcClob — An empty clob object.

For documentation of this method, see java.sql.Connection#createNClob().

Return

JdbcClob — An empty nclob object.

For documentation of this method, see java.sql.Connection#createSQLXML().

Return

JdbcSQLXML — An empty SQLXML object.

Creates a JdbcStatement object for sending SQL statements to the database. See also java.sql.Connection#createStatement().

// This sample code assumes authentication is off
const conn = Jdbc.getConnection('jdbc:mysql://<host>:3306/<instance>');
const stmt = conn.createStatement();

stmt.setMaxRows(100);
const rs = stmt.execute('select * from person');

while (rs.next()) {
  // Do something
}

rs.close();
stmt.close();
conn.close();

Return

JdbcStatement — A statement instance to execute queries with.

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)
const conn = Jdbc.getConnection('jdbc:mysql://<host>:3306/<instance>');
const stmt = conn.createStatement(
    Jdbc.ResultSet.TYPE_FORWARD_ONLY,
    Jdbc.ResultSet.CONCUR_READ_ONLY,
);

stmt.setMaxRows(100);
const rs = stmt.execute('select * from person');

while (rs.next()) {
  // Do something
}

rs.close();
stmt.close();
conn.close();

Parameters

Return

JdbcStatement — A statement instance to execute queries with.

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)
const conn = Jdbc.getConnection('jdbc:mysql://<host>:3306/<instance>');
const stmt = conn.createStatement(
    Jdbc.ResultSet.TYPE_FORWARD_ONLY,
    Jdbc.ResultSet.CONCUR_READ_ONLY,
    Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT,
);

stmt.setMaxRows(100);
const rs = stmt.execute('select * from person');

while (rs.next()) {
  // Do something
}

rs.close();
stmt.close();
conn.close();

Parameters

Return

JdbcStatement — A statement instance to execute queries with.

For documentation of this method, see java.sql.Connection#createStruct(String, Object[]).

Parameters

Return

JdbcStruct — A structure object that maps to the given SQL type and is populated with the given attributes.

For documentation of this method, see java.sql.Connection#getAutoCommit().

Return

Boolean — true if the connection's auto-commit mode is enabled; false otherwise.

Authorization

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

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

or documentation of this method, see java.sql.Connection#getCatalog().

Return

String — The current catalog name or null if no name has been set.

Authorization

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

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

For documentation of this method, see java.sql.Connection#getHoldability().

Return

Integer — The holdability setting of the connection; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.

For documentation of this method, see java.sql.Connection#getMetaData().

Return

JdbcDatabaseMetaData — The metadata of the database this connection connects to.

Authorization

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

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

For documentation of this method, see java.sql.Connection#getTransactionIsolation().

Return

Integer — 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.

Authorization

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

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

For documentation of this method, see java.sql.Connection#getWarnings().

Return

String[] — An array of warning strings.

Authorization

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

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

For documentation of this method, see java.sql.Connection#isClosed().

Return

Boolean — true if the connection is closed; false otherwise.

Authorization

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

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

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

Return

Boolean — true if the connection is read-only; false otherwise.

Authorization

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

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

For documentation of this method, see java.sql.Connection#isValid(int).

Parameters

Return

Boolean — true if the connection is valid; false otherwise. Also returns false if the timeout period expires before the operation completes.

Authorization

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

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

For documentation of this method, see java.sql.Connection#nativeSQL(String).

Parameters

Return

String — The native form of the provided statement.

Authorization

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

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

For documentation of this method, see java.sql.Connection#prepareCall(String).

Parameters

Return

JdbcCallableStatement — A callable statement containing the pre-compiled SQL statement.

For documentation of this method, see java.sql.Connection#prepareCall(String, int, int).

Parameters

Return

JdbcCallableStatement — A callable statement containing the pre-compiled SQL statement that produces result sets with the provided type and concurrency.

For documentation of this method, see java.sql.Connection#prepareCall(String, int, int, int).

Parameters

Return

JdbcCallableStatement — A callable statement containing the pre-compiled SQL statement that produces result sets with the provided type, concurrency.

For documentation of this method, see java.sql.Connection#prepareStatement(String).

Parameters

Return

JdbcPreparedStatement — A prepared statement containing the pre-compiled SQL statement.

For documentation of this method, see java.sql.Connection#prepareStatement(String, int).

Parameters

Return

JdbcPreparedStatement — A prepared statement containing the pre-compiled SQL statement, possibly capable of returning auto-generated keys.

For documentation of this method, see java.sql.Connection#prepareStatement(String, int, int).

Parameters

Return

JdbcPreparedStatement — A prepared statement containing the pre-compiled SQL statement that produces result sets with the provided type and concurrency.

For documentation of this method, see java.sql.Connection#prepareStatement(String, int, int, int).

Parameters

Return

JdbcPreparedStatement — A prepared statement containing the pre-compiled SQL statement that produces result sets with the provided type, concurrency, and holdability.

For documentation of this method, see java.sql.Connection#prepareStatement(String, int[]).

Parameters

Return

JdbcPreparedStatement — A prepared statement containing the pre-compiled SQL statement, capable of returning auto-generated keys specified by the provided column indices.

For documentation of this method, see java.sql.Connection#prepareStatement(String, String[]).

Parameters

Return

JdbcPreparedStatement — A prepared statement containing the pre-compiled SQL statement, capable of returning auto-generated keys specified by the provided column names.

For documentation of this method, see java.sql.Connection#releaseSavepoint(Savepoint).

Parameters

Authorization

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

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

For documentation of this method, see java.sql.Connection#rollback().

Authorization

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

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

For documentation of this method, see java.sql.Connection#rollback(Savepoint).

Parameters

Authorization

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

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

For documentation of this method, see java.sql.Connection#setAutoCommit(boolean).

Parameters

Authorization

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

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

For documentation of this method, see java.sql.Connection#setCatalog(String).

Parameters

Authorization

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

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

For documentation of this method, see java.sql.Connection#setHoldability(int).

Parameters

For documentation of this method, see java.sql.Connection#setReadOnly(boolean).

Parameters

Authorization

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

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

For documentation of this method, see java.sql.Connection#setSavepoint().

Return

JdbcSavepoint — The new unnamed save point.

Authorization

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

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

For documentation of this method, see java.sql.Connection#setSavepoint(String).

Parameters

Return

JdbcSavepoint — The new named save point.

Authorization

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

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

For documentation of this method, see java.sql.Connection#setTransactionIsolation(int).

Parameters

Authorization

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

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