A JDBC Connection
. For documentation of this class, see java.sql.Connection
.
Methods
Method | Return type | Brief description |
---|---|---|
void
|
For documentation of this method, see java.sql.Connection#clearWarnings()
. |
|
void
|
Release this connection's database and all associated resources. | |
void
|
Makes all pending changes permanent, releases database locks held by this Jdbc
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#createArrayOf(String, Object[])
. |
|
Jdbc
|
Constructs a Jdbc
instance. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#createClob()
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#createNClob()
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#createSQLXML()
. |
|
Jdbc
|
Creates a Jdbc
object for sending SQL statements to the database. |
|
Jdbc
|
Creates a Jdbc
object for sending SQL statements to the database. |
|
Jdbc
|
Creates a Jdbc
object for sending SQL statements to the database. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#createStruct(String, Object[])
. |
|
Boolean
|
For documentation of this method, see java.sql.Connection#getAutoCommit()
. |
|
String
|
or documentation of this method, see java.sql.Connection#getCatalog()
. |
|
Integer
|
For documentation of this method, see java.sql.Connection#getHoldability()
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#getMetaData()
. |
|
Integer
|
For documentation of this method, see java.sql.Connection#getTransactionIsolation()
. |
|
String[]
|
For documentation of this method, see java.sql.Connection#getWarnings()
. |
|
Boolean
|
For documentation of this method, see java.sql.Connection#isClosed()
. |
|
Boolean
|
For documentation of this method, see java.sql.Connection#isReadOnly()
. |
|
Boolean
|
For documentation of this method, see java.sql.Connection#isValid(int)
. |
|
String
|
For documentation of this method, see java.sql.Connection#nativeSQL(String)
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#prepareCall(String)
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#prepareCall(String, int, int)
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#prepareCall(String, int, int, int)
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#prepareStatement(String)
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#prepareStatement(String, int)
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#prepareStatement(String, int, int)
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#prepareStatement(String, int, int, int)
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#prepareStatement(String, int[])
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#prepareStatement(String, String[])
. |
|
void
|
For documentation of this method, see java.sql.Connection#releaseSavepoint(Savepoint)
. |
|
void
|
For documentation of this method, see java.sql.Connection#rollback()
. |
|
void
|
For documentation of this method, see java.sql.Connection#rollback(Savepoint)
. |
|
void
|
For documentation of this method, see java.sql.Connection#setAutoCommit(boolean)
. |
|
void
|
For documentation of this method, see java.sql.Connection#setCatalog(String)
. |
|
void
|
For documentation of this method, see java.sql.Connection#setHoldability(int)
. |
|
void
|
For documentation of this method, see java.sql.Connection#setReadOnly(boolean)
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#setSavepoint()
. |
|
Jdbc
|
For documentation of this method, see java.sql.Connection#setSavepoint(String)
. |
|
void
|
For documentation of this method, see java.sql.Connection#setTransactionIsolation(int)
. |
Detailed documentation
clear
Warnings()
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
close()
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()
commit()
Makes all pending changes permanent, releases database locks held by this Jdbc
.
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()
create
Array
Of(typeName, elements)
For documentation of this method, see java.sql.Connection#createArrayOf(String, Object[])
.
Parameters
Name | Type | Description |
---|---|---|
type
|
String
|
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. |
elements
|
Object[]
|
The elements to populate in the returned object. |
Return
Jdbc
— An array whose elements map to the specified SQL type.
create
Blob()
Constructs a Jdbc
instance. See also java.sql.Connection#createBlob()
.
The object returned initially contains no data. You can use the set
methods of Jdbc
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 get
and set
methods.
Alternatively, both Jdbc
and Jdbc
provide a get
convenience method for converting to a format that can be used by Apps Script.
Return
Jdbc
— An empty blob object.
create
Clob()
For documentation of this method, see java.sql.Connection#createClob()
.
Return
Jdbc
— An empty clob object.
create
NClob()
For documentation of this method, see java.sql.Connection#createNClob()
.
Return
Jdbc
— An empty nclob object.
create
SQLXML()
For documentation of this method, see java.sql.Connection#createSQLXML()
.
Return
Jdbc
— An empty SQLXML object.
create
Statement()
Creates a Jdbc
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
Jdbc
— A statement instance to execute queries with.
create
Statement(resultSetType, resultSetConcurrency)
Creates a Jdbc
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
Name | Type | Description |
---|---|---|
result
|
Integer
|
A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY
, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE
, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE
. |
result
|
Integer
|
A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
or Jdbc.ResultSet.CONCUR_UPDATABLE
. |
Return
Jdbc
— A statement instance to execute queries with.
create
Statement(resultSetType, resultSetConcurrency, resultSetHoldability)
Creates a Jdbc
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
Name | Type | Description |
---|---|---|
result
|
Integer
|
A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY
, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE
, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE
. |
result
|
Integer
|
A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
or Jdbc.ResultSet.CONCUR_UPDATABLE
. |
result
|
Integer
|
A holdability setting; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT
or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT
. |
Return
Jdbc
— A statement instance to execute queries with.
create
Struct(typeName, attributes)
For documentation of this method, see java.sql.Connection#createStruct(String, Object[])
.
Parameters
Name | Type | Description |
---|---|---|
type
|
String
|
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. |
attributes
|
Object[]
|
The attributes that populate the returned object. |
Return
Jdbc
— A structure object that maps to the given SQL type and is populated with the given
attributes.
get
Auto
Commit()
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
get
Catalog()
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
get
Holdability()
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
.
get
Meta
Data()
For documentation of this method, see java.sql.Connection#getMetaData()
.
Return
Jdbc
— 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
get
Transaction
Isolation()
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
get
Warnings()
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
is
Closed()
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
is
Read
Only()
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
is
Valid(timeout)
For documentation of this method, see java.sql.Connection#isValid(int)
.
Parameters
Name | Type | Description |
---|---|---|
timeout
|
Integer
|
The time in seconds to wait for the validation operation to complete. A value of 0 indicates no timeout is applied. |
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
native
SQL(sql)
For documentation of this method, see java.sql.Connection#nativeSQL(String)
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' placeholders. |
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
prepare
Call(sql)
For documentation of this method, see java.sql.Connection#prepareCall(String)
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' placeholders, typically provided using JDBC call escape syntax. |
Return
Jdbc
— A callable statement containing the pre-compiled SQL statement.
prepare
Call(sql, resultSetType, resultSetConcurrency)
For documentation of this method, see java.sql.Connection#prepareCall(String, int, int)
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' placeholders, typically provided using JDBC call escape syntax. |
result
|
Integer
|
A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY
, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE
, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE
. |
result
|
Integer
|
A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
or Jdbc.ResultSet.CONCUR_UPDATABLE
. |
Return
Jdbc
— A callable statement containing the pre-compiled SQL statement that produces result
sets with the provided type and concurrency.
prepare
Call(sql, resultSetType, resultSetConcurrency, resultSetHoldability)
For documentation of this method, see java.sql.Connection#prepareCall(String, int, int, int)
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' placeholders, typically provided using JDBC call escape syntax. |
result
|
Integer
|
A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY
, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE
, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE
. |
result
|
Integer
|
A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
or Jdbc.ResultSet.CONCUR_UPDATABLE
. |
result
|
Integer
|
A holdability setting; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT
or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT
. |
Return
Jdbc
— A callable statement containing the pre-compiled SQL statement that produces result
sets with the provided type, concurrency.
prepare
Statement(sql)
For documentation of this method, see java.sql.Connection#prepareStatement(String)
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' IN parameter placeholders. |
Return
Jdbc
— A prepared statement containing the pre-compiled SQL statement.
prepare
Statement(sql, autoGeneratedKeys)
For documentation of this method, see java.sql.Connection#prepareStatement(String, int)
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' IN parameter placeholders. |
auto
|
Integer
|
A flag that indicates whether auto-generated keys are returned; either Jdbc.Statement.RETURN_GENERATED_KEYS
or Jdbc.Statement.NO_GENERATED_KEYS
. |
Return
Jdbc
— A prepared statement containing the pre-compiled SQL statement, possibly capable of
returning auto-generated keys.
prepare
Statement(sql, resultSetType, resultSetConcurrency)
For documentation of this method, see java.sql.Connection#prepareStatement(String, int, int)
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' IN parameter placeholders. |
result
|
Integer
|
A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY
, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE
, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE
. |
result
|
Integer
|
A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
or Jdbc.ResultSet.CONCUR_UPDATABLE
. |
Return
Jdbc
— A prepared statement containing the pre-compiled SQL statement that produces result
sets with the provided type and concurrency.
prepare
Statement(sql, resultSetType, resultSetConcurrency, resultSetHoldability)
For documentation of this method, see java.sql.Connection#prepareStatement(String, int, int, int)
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' IN parameter placeholders. |
result
|
Integer
|
A result set type; one of Jdbc.ResultSet.TYPE_FORWARD_ONLY
, Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE
, or Jdbc.ResultSet.TYPE_SCROLL_SENSITIVE
. |
result
|
Integer
|
A concurrency type; either Jdbc.ResultSet.CONCUR_READ_ONLY
or Jdbc.ResultSet.CONCUR_UPDATABLE
. |
result
|
Integer
|
A holdability setting; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT
or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT
. |
Return
Jdbc
— A prepared statement containing the pre-compiled SQL statement that produces result
sets with the provided type, concurrency, and holdability.
prepare
Statement
By
Index(sql, indices)
For documentation of this method, see java.sql.Connection#prepareStatement(String, int[])
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' IN parameter placeholders. |
indices
|
Integer[]
|
The column indices of columns that are returned from the inserted row or rows. |
Return
Jdbc
— A prepared statement containing the pre-compiled SQL statement, capable of returning
auto-generated keys specified by the provided column indices.
prepare
Statement
By
Name(sql, columnNames)
For documentation of this method, see java.sql.Connection#prepareStatement(String, String[])
.
Parameters
Name | Type | Description |
---|---|---|
sql
|
String
|
An SQL statement that may contain one more more '?' IN parameter placeholders. |
column
|
String[]
|
The column names that specify which columns the method should return from the inserted row or rows. |
Return
Jdbc
— A prepared statement containing the pre-compiled SQL statement, capable of returning
auto-generated keys specified by the provided column names.
release
Savepoint(savepoint)
For documentation of this method, see java.sql.Connection#releaseSavepoint(Savepoint)
.
Parameters
Name | Type | Description |
---|---|---|
savepoint
|
Jdbc
|
The save point to remove. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/script.external_request
rollback()
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
rollback(savepoint)
For documentation of this method, see java.sql.Connection#rollback(Savepoint)
.
Parameters
Name | Type | Description |
---|---|---|
savepoint
|
Jdbc
|
The save point to rollback 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
set
Auto
Commit(autoCommit)
For documentation of this method, see java.sql.Connection#setAutoCommit(boolean)
.
Parameters
Name | Type | Description |
---|---|---|
auto
|
Boolean
|
If true
, auto-commit mode is enabled; false
disables. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/script.external_request
set
Catalog(catalog)
For documentation of this method, see java.sql.Connection#setCatalog(String)
.
Parameters
Name | Type | Description |
---|---|---|
catalog
|
String
|
The name of a catalog (the subspace in the connection's database) in which to work. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/script.external_request
set
Holdability(holdability)
For documentation of this method, see java.sql.Connection#setHoldability(int)
.
Parameters
Name | Type | Description |
---|---|---|
holdability
|
Integer
|
The default holdability of Jdbc
objects created with this
connection; either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT
or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT
. |
set
Read
Only(readOnly)
For documentation of this method, see java.sql.Connection#setReadOnly(boolean)
.
Parameters
Name | Type | Description |
---|---|---|
read
|
Boolean
|
If true
, read-only mode is enabled; false
disables. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/script.external_request
set
Savepoint()
For documentation of this method, see java.sql.Connection#setSavepoint()
.
Return
Jdbc
— 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
set
Savepoint(name)
For documentation of this method, see java.sql.Connection#setSavepoint(String)
.
Parameters
Name | Type | Description |
---|---|---|
name
|
String
|
The name of the created save point. |
Return
Jdbc
— 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
set
Transaction
Isolation(level)
For documentation of this method, see java.sql.Connection#setTransactionIsolation(int)
.
Parameters
Name | Type | Description |
---|---|---|
level
|
Integer
|
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
. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/script.external_request