A JDBC CallableStatement
. For documentation of this class, see
java.sql.CallableStatement
.
Methods
Detailed documentation
addBatch()
For documentation of this method, see
java.sql.PreparedStatement#addBatch()
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
addBatch(sql)
For documentation of this method, see
java.sql.Statement#addBatch(String)
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | The SQL command to add to this statement, typically an SQL INSERT or UPDATE . |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
cancel()
For documentation of this method, see
java.sql.Statement#cancel()
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
clearBatch()
For documentation of this method, see
java.sql.Statement#clearBatch()
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
clearParameters()
For documentation of this method, see
java.sql.PreparedStatement#clearParameters()
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
clearWarnings()
For documentation of this method, see
java.sql.Statement#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()
For documentation of this method, see
java.sql.Statement#close()
.
execute()
For documentation of this method, see
java.sql.PreparedStatement#execute()
.
Return
Boolean
— true
if the first result is a result set; false
if the first result is
an update count or there is no result.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
execute(sql)
For documentation of this method, see
java.sql.Statement#execute(String)
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | The SQL statement to execute. |
Return
Boolean
— true
if the first result is a result set; false
if it is an update
count or if there are no results.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
execute(sql, autoGeneratedKeys)
For documentation of this method, see
java.sql.Statement#execute(String, int)
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | The SQL statement to execute. |
autoGeneratedKeys | Integer | 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 . |
Return
Boolean
— true
if the first result is a result set; false
if it is an update
count or if there are no results.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
execute(sql, columnIndexes)
For documentation of this method, see
java.sql.Statement#execute(String, int[])
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | The SQL statement to execute. |
columnIndexes | Integer[] | The column indices in the whose auto-generated keys are made available for future retrieval. |
Return
Boolean
— true
if the first result is a result set; false
if it is an update
count or if there are no results.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
execute(sql, columnNames)
For documentation of this method, see
java.sql.Statement#execute(String, String[])
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | The SQL statement to execute. |
columnNames | String[] | The names of columns in the whose auto-generated keys are made available for future retrieval. |
Return
Boolean
— true
if the first result is a result set; false
if it is an update
count or if there are no results.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
executeBatch()
For documentation of this method, see
java.sql.Statement#executeBatch()
.
Return
Integer[]
— The update counts for each command in the batch, using the same order in which commands
were added to the batch.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
executeQuery()
For documentation of this method, see
java.sql.PreparedStatement#executeQuery()
.
Return
JdbcResultSet
— A result set that contains the data produced by the query.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
executeQuery(sql)
For documentation of this method, see
java.sql.Statement#executeQuery(String)
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | The SQL statement to execute, typically a static SELECT . |
Return
JdbcResultSet
— A result set containing the results of the execution. This is never null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
executeUpdate()
For documentation of this method, see
java.sql.PreparedStatement#executeUpdate()
.
Return
Integer
— The row count ofr SQL Data Manipulation Language statements, or 0 for SQL statements
that return nothing.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
executeUpdate(sql)
For documentation of this method, see
java.sql.Statement#executeUpdate(String)
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | 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). |
Return
Integer
— Either the row count for for Data Manipulation Language statements, or 0 for statements
that return nothing.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
executeUpdate(sql, autoGeneratedKeys)
For documentation of this method, see
java.sql.Statement#executeUpdate(String, int)
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | 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). |
autoGeneratedKeys | Integer | 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 . |
Return
Integer
— Either the row count for for Data Manipulation Language statements, or 0 for statements
that return nothing.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
executeUpdate(sql, columnIndexes)
For documentation of this method, see
java.sql.Statement#executeUpdate(String, int[])
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | 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). |
columnIndexes | Integer[] | The column indices in the whose auto-generated keys are made available for future retrieval. |
Return
Integer
— Either the row count for for Data Manipulation Language statements, or 0 for statements
that return nothing.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
executeUpdate(sql, columnNames)
For documentation of this method, see
java.sql.Statement#executeUpdate(String, String[])
.
Parameters
Name | Type | Description |
---|---|---|
sql | String | 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). |
columnNames | String[] | The names of columns in the whose auto-generated keys are made available for future retrieval. |
Return
Integer
— Either the row count for for Data Manipulation Language statements, or 0 for statements
that return nothing.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getArray(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getArray(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
JdbcArray
— The value of a ARRAY
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getArray(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getArray(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcArray
— The value of a ARRAY
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getBigDecimal(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getBigDecimal(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
BigNumber
— The value of a NUMERIC
parameter in full precision. Returns null
if the
value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getBigDecimal(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getBigDecimal(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
BigNumber
— The value of a NUMERIC
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getBlob(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getBlob(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
JdbcBlob
— The value of a BLOB
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getBlob(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getBlob(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcBlob
— The value of a BLOB
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getBoolean(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getBoolean(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
Boolean
— The value of a BIT
or BOOLEAN
parameter. Returns false
if the
value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getBoolean(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getBoolean(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
Boolean
— The value of a BIT
or BOOLEAN
parameter. Returns false
if the
value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getByte(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getByte(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
Byte
— The value of a TINYINT
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getByte(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getByte(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
Byte
— The value of a TINYINT
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getBytes(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getBytes(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
Byte[]
— The value of a BINARY
or VARBINARY
parameter. Returns null
if
the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getBytes(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getBytes(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
Byte[]
— The value of a BINARY
or VARBINARY
parameter. Returns null
if
the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getClob(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getClob(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
JdbcClob
— The value of a CLOB
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getClob(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getClob(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcClob
— The value of a CLOB
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getConnection()
For documentation of this method, see
java.sql.Statement#getConnection()
.
Return
JdbcConnection
— The connection that produced this 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
getDate(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getDate(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
JdbcDate
— The value of a DATE
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getDate(parameterIndex, timeZone)
For documentation of this method, see
java.sql.CallableStatement#getDate(int, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
timeZone | String | 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 ). |
Return
JdbcDate
— The value of a DATE
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getDate(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getDate(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcDate
— The value of a DATE
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getDate(parameterName, timeZone)
For documentation of this method, see
java.sql.CallableStatement#getDate(String, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
timeZone | String | 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 ). |
Return
JdbcDate
— The value of a DATE
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getDouble(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getDouble(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
Number
— The value of a DOUBLE
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getDouble(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getDouble(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
Number
— The value of a DOUBLE
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getFetchDirection()
For documentation of this method, see
java.sql.Statement#getFetchDirection()
.
Return
Integer
— The default direction for result sets generated by this statement, which is either
Jdbc.ResultSet.FETCH_FORWARD
or Jdbc.ResultSet.FETCH_REVERSE
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getFetchSize()
For documentation of this method, see
java.sql.Statement#getFetchSize()
.
Return
Integer
— The default row fetch size for result sets generated from this 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
getFloat(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getFloat(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
Number
— The value of a FLOAT
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getFloat(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getFloat(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
Number
— The value of a FLOAT
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getGeneratedKeys()
For documentation of this method, see
java.sql.Statement#getGeneratedKeys()
.
Return
JdbcResultSet
— A result set containing the auto-generated keys generated by the execution of this
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
getInt(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getInt(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
Integer
— The value of a INTEGER
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getInt(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getInt(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
Integer
— The value of a INTEGER
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getLong(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getLong(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
Integer
— The value of a BIGINT
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getLong(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getLong(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
Integer
— The value of a BIGINT
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getMaxFieldSize()
For documentation of this method, see
java.sql.Statement#getMaxFieldSize()
.
Return
Integer
— The current column byte size limit for columns storing character and binary values; a
value of zero indictates no limit.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getMaxRows()
For documentation of this method, see
java.sql.Statement#getMaxRows()
.
Return
Integer
— The current maximum number of rows for a result set produced by this statement; a value
of 0 indicates no limit.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getMetaData()
For documentation of this method, see
java.sql.PreparedStatement#getMetaData()
.
Return
JdbcResultSetMetaData
— The description of a result set's columns, or NULL
if this metadata is
unavailable.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getMoreResults()
For documentation of this method, see
java.sql.Statement#getMoreResults()
.
Return
Boolean
— true
if the next result is a result set; 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
getMoreResults(current)
For documentation of this method, see
java.sql.Statement#getMoreResults(int)
.
Parameters
Name | Type | Description |
---|---|---|
current | Integer | 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 . |
Return
Boolean
— true
if the next result is a result set; 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
getNClob(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getNClob(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | An index indicating which paramater to register (the first parameter is 1, the second is 2, and so on). |
Return
JdbcClob
— The value of a NCLOB
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getNClob(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getNClob(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcClob
— The value of a NCLOB
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getNString(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getNString(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | An index indicating which paramater to register (the first parameter is 1, the second is 2, and so on). |
Return
String
— A string that maps a NCHAR
, NVARCHAR
, or LONGNVARCHAR
value.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getNString(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getNString(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
String
— A string that maps a NCHAR
, NVARCHAR
, or LONGNVARCHAR
value.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getObject(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getObject(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
Object
— An object holding the parameter value.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getObject(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getObject(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
Object
— An object holding the parameter value.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getParameterMetaData()
For documentation of this method, see
java.sql.PreparedStatement#getParameterMetaData()
.
Return
JdbcParameterMetaData
— The parameter metadata, including the number, types, and properties for each parameter.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getQueryTimeout()
For documentation of this method, see
java.sql.Statement#getQueryTimeout()
.
Return
Integer
— The current query timeout in seconds; a value of zero indicates no timeout.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getRef(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getRef(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
JdbcRef
— The value of a REF
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getRef(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getRef(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcRef
— The value of a REF
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getResultSet()
For documentation of this method, see
java.sql.Statement#getResultSet()
.
Return
JdbcResultSet
— The current result set, or null
if the result is an update count or there are
no more results.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getResultSetConcurrency()
For documentation of this method, see
java.sql.Statement#getResultSetConcurrency()
.
Return
Integer
— The result set concurrency for result sets generated from this statement, which is
either Jdbc.ResultSet.CONCUR_READ_ONLY
or Jdbc.ResultSet.CONCUR_UPDATABLE
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getResultSetHoldability()
For documentation of this method, see
java.sql.Statement#getResultSetHoldability()
.
Return
Integer
— The result set holdability, which is either Jdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT
or Jdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getResultSetType()
For documentation of this method, see
java.sql.Statement#getResultSetType()
.
Return
Integer
— 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
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getRowId(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getRowId(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | An index indicating which paramater to register (the first parameter is 1, the second is 2, and so on). |
Return
JdbcRowId
— The ROWID
value. Returns null
if the parameter contains an SQL NULL
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getRowId(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getRowId(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcRowId
— The ROWID
value. Returns null
if the parameter contains an SQL NULL
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getSQLXML(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getSQLXML(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | An index indicating which paramater to register (the first parameter is 1, the second is 2, and so on). |
Return
JdbcSQLXML
— A SQLXML object that maps to an SQL XML value.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getSQLXML(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getSQLXML(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcSQLXML
— A SQLXML object that maps to an SQL XML value.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getShort(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getShort(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
Integer
— The value of a SMALLINT
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getShort(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getShort(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
Integer
— The value of a SMALLINT
parameter. Returns 0 if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getString(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getString(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
String
— The value of a CHAR
, VARCHAR
, or LONGVARCHAR
parameter.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getString(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getString(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
String
— The value of a CHAR
, VARCHAR
, or LONGVARCHAR
parameter. Returns
null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getTime(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getTime(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
JdbcTime
— The value of a TIME
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getTime(parameterIndex, timeZone)
For documentation of this method, see
java.sql.CallableStatement#getTime(int, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
timeZone | String | 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 ). |
Return
JdbcTime
— The value of a TIME
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getTime(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getTime(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcTime
— The value of a TIME
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getTime(parameterName, timeZone)
For documentation of this method, see
java.sql.CallableStatement#getTime(String, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
timeZone | String | 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 ). |
Return
JdbcTime
— The value of a TIME
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getTimestamp(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getTimestamp(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
JdbcTimestamp
— The value of a TIMESTAMP
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getTimestamp(parameterIndex, timeZone)
For documentation of this method, see
java.sql.CallableStatement#getTimestamp(int, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
timeZone | String | 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 ). |
Return
JdbcTimestamp
— The value of a TIMESTAMP
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getTimestamp(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getTimestamp(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
JdbcTimestamp
— The value of a TIMESTAMP
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getTimestamp(parameterName, timeZone)
For documentation of this method, see
java.sql.CallableStatement#getTimestamp(String, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
timeZone | String | 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 ). |
Return
JdbcTimestamp
— The value of a TIMESTAMP
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getURL(parameterIndex)
For documentation of this method, see
java.sql.CallableStatement#getURL(int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
Return
String
— The value of a DATALINK
parameter as a string.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getURL(parameterName)
For documentation of this method, see
java.sql.CallableStatement#getURL(String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter. |
Return
String
— The value of a DATALINK
parameter. Returns null
if the value is null
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getUpdateCount()
For documentation of this method, see
java.sql.Statement#getUpdateCount()
.
Return
Integer
— The current result as an update count, or -1 if the current result is a result set or
if there are no more results.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
getWarnings()
For documentation of this method, see
java.sql.Statement#getWarnings()
.
Return
String[]
— The current set of warnings, or null
if there are no warnings.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
isClosed()
For documentation of this method, see
java.sql.Statement#isClosed()
.
Return
Boolean
— true
if this statement 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
isPoolable()
For documentation of this method, see
java.sql.Statement#isPoolable()
.
Return
Boolean
— true
if this statement is poolable; 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
registerOutParameter(parameterIndex, sqlType)
For documentation of this method, see
java.sql.CallableStatement#registerOutParameter(int, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | An index indicating which paramater to register (the first parameter is 1, the second is 2, and so on). |
sqlType | Integer | The JDBC type code to
register. If the parameter is of JDBC type NUMERIC or DECIMAL ,
use registerOutParameter(parameterIndex, sqlType, scale) instead. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
registerOutParameter(parameterIndex, sqlType, scale)
For documentation of this method, see
java.sql.CallableStatement#registerOutParameter(int, int, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | An index indicating which paramater to register (the first parameter is 1, the second is 2, and so on). |
sqlType | Integer | The JDBC type code to register. |
scale | Integer | The desired number of digits to the right of the decimal point (must be zero or greater). |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
registerOutParameter(parameterIndex, sqlType, typeName)
For documentation of this method, see
java.sql.CallableStatement#registerOutParameter(int, int, String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on). |
sqlType | Integer | A type code value. |
typeName | String | The fully-qualified name of an SQL structured type. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
registerOutParameter(parameterName, sqlType)
For documentation of this method, see
java.sql.CallableStatement#registerOutParameter(String, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to be registered. |
sqlType | Integer | A type code value. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
registerOutParameter(parameterName, sqlType, scale)
For documentation of this method, see
java.sql.CallableStatement#registerOutParameter(String, int, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to be registered. |
sqlType | Integer | A type code value. |
scale | Integer | The desired number of digits to the right of the decimal point, which must be zero or greater. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
registerOutParameter(parameterName, sqlType, typeName)
For documentation of this method, see
java.sql.CallableStatement#registerOutParameter(String, int, String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to be registered. |
sqlType | Integer | A type code value. |
typeName | String | The fully-qualified name of an SQL structured type. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setArray(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setArray(int, Array)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcArray | The parameter value to 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
setBigDecimal(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setBigDecimal(int, BigDecimal)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | BigNumber | The parameter value to 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
setBigDecimal(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setBigDecimal(String, BigDecimal)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | BigNumber | The parameter value to 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
setBlob(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setBlob(int, Clob)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcBlob | The parameter value to 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
setBlob(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setBlob(String, Blob)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | JdbcBlob | A blob that maps to an SQL BLOB value. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setBoolean(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setBoolean(int, boolean)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Boolean | The parameter value to 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
setBoolean(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setBoolean(String, boolean)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Boolean | The parameter value to 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
setByte(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setByte(int, byte)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Byte | The parameter value to 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
setByte(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setByte(String, byte)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Byte | The parameter value to 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
setBytes(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setBytes(int, byte[])
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Byte[] | The parameter value to 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
setBytes(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setBytes(String, byte[])
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Byte[] | The parameter value to 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
setClob(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setClob(int, Clob)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcClob | The parameter value to 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
setClob(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setBlob(String, Clob)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | JdbcClob | A clob that maps to an SQL CLOB value. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setCursorName(name)
For documentation of this method, see
java.sql.Statement#setCursorName(String)
.
Parameters
Name | Type | Description |
---|---|---|
name | String | The new cursor name, which must be unique within a connection. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setDate(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setDate(int, Date)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcDate | The parameter value to 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
setDate(parameterIndex, x, timeZone)
For documentation of this method, see
java.sql.PreparedStatement#setDate(int, Date, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcDate | The parameter value to set. |
timeZone | String | 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 ). |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setDate(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setDate(String, Date)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | JdbcDate | The parameter value to 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
setDate(parameterName, x, timeZone)
For documentation of this method, see
java.sql.CallableStatement#setDate(String, Date, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | JdbcDate | The parameter value to set. |
timeZone | String | 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 ). |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setDouble(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setDouble(int, double)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Number | The parameter value to 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
setDouble(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setDouble(String, double)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Number | The parameter value to 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
setEscapeProcessing(enable)
For documentation of this method, see
java.sql.Statement#setEscapeProcessing(boolean)
.
Parameters
Name | Type | Description |
---|---|---|
enable | Boolean | If true , escape processing is enabled; otherwise it is disabled. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setFetchDirection(direction)
For documentation of this method, see
java.sql.Statement#setFetchDirection(int)
.
Parameters
Name | Type | Description |
---|---|---|
direction | Integer | The specified direction to set, which is either Jdbc.ResultSet.FETCH_FORWARD or Jdbc.ResultSet.FETCH_REVERSE . |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setFetchSize(rows)
For documentation of this method, see
java.sql.Statement#setFetchSize(int)
.
Parameters
Name | Type | Description |
---|---|---|
rows | Integer | The number of rows to fetch. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setFloat(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setFloat(int, float)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Number | The parameter value to 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
setFloat(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setFloat(String, float)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Number | The parameter value to 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
setInt(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setInt(int, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Integer | The parameter value to 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
setInt(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setInt(String, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Integer | The parameter value to 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
setLong(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setLong(int, long)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Integer | The parameter value to 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
setLong(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setLong(String, long)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Integer | The parameter value to 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
setMaxFieldSize(max)
For documentation of this method, see
java.sql.Statement#setMaxFieldSize(int)
.
Parameters
Name | Type | Description |
---|---|---|
max | Integer | The new column byte size limit; a value of zero indicates no limit. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setMaxRows(max)
For documentation of this method, see
java.sql.Statement#setMaxRows(int)
.
Parameters
Name | Type | Description |
---|---|---|
max | Integer | The maximum number of rows a result set generated by this statement can have. A value of 0 indicates no limit. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setNClob(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setNClob(int, NClob)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcClob | The parameter value to 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
setNClob(parameterName, value)
For documentation of this method, see
java.sql.CallableStatement#setNClob(String, NClob)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
value | JdbcClob | The parameter value to 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
setNString(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setNString(int, String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | String | The parameter value to 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
setNString(parameterName, value)
For documentation of this method, see
java.sql.CallableStatement#setNString(String, String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
value | String | The parameter value to 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
setNull(parameterIndex, sqlType)
For documentation of this method, see
java.sql.PreparedStatement#setNull(int, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
sqlType | Integer | The SQL type of the specified parameter. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setNull(parameterIndex, sqlType, typeName)
For documentation of this method, see
java.sql.PreparedStatement#setNull(int, int, String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
sqlType | Integer | The SQL type of the specified parameter. |
typeName | String | The fully-qualifed name of an SQL user-defined type. Ignored if the parameter
isn't a user-defined type or REF . |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setNull(parameterName, sqlType)
For documentation of this method, see
java.sql.CallableStatement#setNull(String, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
sqlType | Integer | The SQL type code. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setNull(parameterName, sqlType, typeName)
For documentation of this method, see
java.sql.CallableStatement#setNull(String, int, String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
sqlType | Integer | The SQL type. |
typeName | String | The fully-qualified name of an SQL user-defined type; ignored if the parameter
is not a user-defined type or SQL REF value. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setObject(index, x)
For documentation of this method, see
java.sql.PreparedStatement#setObject(int, Object)
.
Parameters
Name | Type | Description |
---|---|---|
index | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Object | The object containing the value to set the parameter 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
setObject(parameterIndex, x, targetSqlType)
For documentation of this method, see
java.sql.PreparedStatement#setObject(int, Object, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Object | The object containing the value to set the parameter to. |
targetSqlType | Integer | The SQL type to send to the database. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setObject(parameterIndex, x, targetSqlType, scaleOrLength)
For documentation of this method, see
java.sql.PreparedStatement#setObject(int, Object, int, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Object | The object containing the value to set the parameter to. |
targetSqlType | Integer | The SQL type to send to the database. The scale argument may further qualify this type. |
scaleOrLength | Integer | 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. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setObject(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setObject(String, Object)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Object | The object containing the value to 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
setObject(parameterName, x, targetSqlType)
For documentation of this method, see
java.sql.CallableStatement#setObject(String, Object, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Object | The object containing the value to set. |
targetSqlType | Integer | The SQL type sent to the database. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setObject(parameterName, x, targetSqlType, scale)
For documentation of this method, see
java.sql.CallableStatement#setObject(String, Object, int, int)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Object | The object containing the value to set. |
targetSqlType | Integer | The SQL type sent to the database. The scale parameter may further qualify this type. |
scale | Integer | The number of digits after the decimal point for DECIMAL and NUMERIC types. Ignored for all other types. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setPoolable(poolable)
For documentation of this method, see
java.sql.Statement#setPoolable(boolean)
.
Parameters
Name | Type | Description |
---|---|---|
poolable | Boolean | If true , requests that this statement be pooled; otherwise requests it
not be pooled. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setQueryTimeout(seconds)
For documentation of this method, see
java.sql.Statement#setQueryTimeout(int)
.
Parameters
Name | Type | Description |
---|---|---|
seconds | Integer | The new query timeout in seconds; a value of 0 indicates no timeout. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setRef(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setRef(int, Ref)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcRef | The SQL REF value to 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
setRowId(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setRowId(int, RowId)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcRowId | The parameter value to 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
setRowId(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setRowId(String, RowId)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | JdbcRowId | The parameter value to 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
setSQLXML(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setSQLXML(int, SQLXML)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcSQLXML | The parameter value to 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
setSQLXML(parameterName, xmlObject)
For documentation of this method, see
java.sql.CallableStatement#setSQLXML(String, SQLXML)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
xmlObject | JdbcSQLXML | A SQLXML object that maps to an SQL XML value. |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setShort(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setShort(int, short)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | Integer | The parameter value to 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
setShort(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setShort(String, short)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | Integer | The parameter value to 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
setString(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setString(int, String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | String | The parameter value to 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
setString(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setString(String, String)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | String | The parameter value to 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
setTime(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setTime(int, Time)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcTime | The parameter value to 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
setTime(parameterIndex, x, timeZone)
For documentation of this method, see
java.sql.PreparedStatement#setTime(int, Time, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcTime | The parameter value to set. |
timeZone | String | 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 ). |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setTime(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setTime(String, Time)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | JdbcTime | The parameter value to 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
setTime(parameterName, x, timeZone)
For documentation of this method, see
java.sql.CallableStatement#setTime(String, Time, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | JdbcTime | The parameter value to set. |
timeZone | String | 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 ). |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setTimestamp(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setTimestamp(int, Timestamp)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcTimestamp | The parameter value to 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
setTimestamp(parameterIndex, x, timeZone)
For documentation of this method, see
java.sql.PreparedStatement#setTimestamp(int, Timestamp, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | JdbcTimestamp | The parameter value to set. |
timeZone | String | 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 ). |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setTimestamp(parameterName, x)
For documentation of this method, see
java.sql.CallableStatement#setTimestamp(String, Timestamp)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | JdbcTimestamp | The parameter value to 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
setTimestamp(parameterName, x, timeZone)
For documentation of this method, see
java.sql.CallableStatement#setTimestamp(String, Timestamp, Calendar)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
x | JdbcTimestamp | The parameter value to set. |
timeZone | String | 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 ). |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/script.external_request
setURL(parameterIndex, x)
For documentation of this method, see
java.sql.PreparedStatement#setURL(int, URL)
.
Parameters
Name | Type | Description |
---|---|---|
parameterIndex | Integer | The index of the parameter to set (the first parameter is 1, the second is 2, and so on). |
x | String | The parameter value to 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
setURL(parameterName, val)
For documentation of this method, see
java.sql.CallableStatement#setURL(String, URL)
.
Parameters
Name | Type | Description |
---|---|---|
parameterName | String | The name of the parameter to set. |
val | String | The parameter value to 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
wasNull()
For documentation of this method, see
java.sql.CallableStatement#wasNull()
.
Return
Boolean
— true
if the last parameter read was null
; returns 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