Class JdbcPreparedStatement

JdbcPreparedStatement

A JDBC PreparedStatement. For documentation of this class, see java.sql.PreparedStatement.

Methods

Method	Return type	Brief description
addBatch()	void	For documentation of this method, see java.sql.PreparedStatement#addBatch().
addBatch(sql)	void	For documentation of this method, see java.sql.Statement#addBatch(String).
cancel()	void	For documentation of this method, see java.sql.Statement#cancel().
clearBatch()	void	For documentation of this method, see java.sql.Statement#clearBatch().
clearParameters()	void	For documentation of this method, see java.sql.PreparedStatement#clearParameters().
clearWarnings()	void	For documentation of this method, see java.sql.Statement#clearWarnings().
close()	void	For documentation of this method, see java.sql.Statement#close().
execute()	Boolean	For documentation of this method, see java.sql.PreparedStatement#execute().
execute(sql)	Boolean	For documentation of this method, see java.sql.Statement#execute(String).
execute(sql, autoGeneratedKeys)	Boolean	For documentation of this method, see java.sql.Statement#execute(String, int).
execute(sql, columnIndexes)	Boolean	For documentation of this method, see java.sql.Statement#execute(String, int[]).
execute(sql, columnNames)	Boolean	For documentation of this method, see java.sql.Statement#execute(String, String[]).
executeBatch()	Integer[]	For documentation of this method, see java.sql.Statement#executeBatch().
executeQuery()	JdbcResultSet	For documentation of this method, see java.sql.PreparedStatement#executeQuery().
executeQuery(sql)	JdbcResultSet	For documentation of this method, see java.sql.Statement#executeQuery(String).
executeUpdate()	Integer	For documentation of this method, see java.sql.PreparedStatement#executeUpdate().
executeUpdate(sql)	Integer	For documentation of this method, see java.sql.Statement#executeUpdate(String).
executeUpdate(sql, autoGeneratedKeys)	Integer	For documentation of this method, see java.sql.Statement#executeUpdate(String, int).
executeUpdate(sql, columnIndexes)	Integer	For documentation of this method, see java.sql.Statement#executeUpdate(String, int[]).
executeUpdate(sql, columnNames)	Integer	For documentation of this method, see java.sql.Statement#executeUpdate(String, String[]).
getConnection()	JdbcConnection	For documentation of this method, see java.sql.Statement#getConnection().
getFetchDirection()	Integer	For documentation of this method, see java.sql.Statement#getFetchDirection().
getFetchSize()	Integer	For documentation of this method, see java.sql.Statement#getFetchSize().
getGeneratedKeys()	JdbcResultSet	For documentation of this method, see java.sql.Statement#getGeneratedKeys().
getMaxFieldSize()	Integer	For documentation of this method, see java.sql.Statement#getMaxFieldSize().
getMaxRows()	Integer	For documentation of this method, see java.sql.Statement#getMaxRows().
getMetaData()	JdbcResultSetMetaData	For documentation of this method, see java.sql.PreparedStatement#getMetaData().
getMoreResults()	Boolean	For documentation of this method, see java.sql.Statement#getMoreResults().
getMoreResults(current)	Boolean	For documentation of this method, see java.sql.Statement#getMoreResults(int).
getParameterMetaData()	JdbcParameterMetaData	For documentation of this method, see java.sql.PreparedStatement#getParameterMetaData().
getQueryTimeout()	Integer	For documentation of this method, see java.sql.Statement#getQueryTimeout().
getResultSet()	JdbcResultSet	For documentation of this method, see java.sql.Statement#getResultSet().
getResultSetConcurrency()	Integer	For documentation of this method, see java.sql.Statement#getResultSetConcurrency().
getResultSetHoldability()	Integer	For documentation of this method, see java.sql.Statement#getResultSetHoldability().
getResultSetType()	Integer	For documentation of this method, see java.sql.Statement#getResultSetType().
getUpdateCount()	Integer	For documentation of this method, see java.sql.Statement#getUpdateCount().
getWarnings()	String[]	For documentation of this method, see java.sql.Statement#getWarnings().
isClosed()	Boolean	For documentation of this method, see java.sql.Statement#isClosed().
isPoolable()	Boolean	For documentation of this method, see java.sql.Statement#isPoolable().
setArray(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setArray(int, Array).
setBigDecimal(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setBigDecimal(int, BigDecimal).
setBlob(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setBlob(int, Clob).
setBoolean(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setBoolean(int, boolean).
setByte(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setByte(int, byte).
setBytes(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setBytes(int, byte[]).
setClob(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setClob(int, Clob).
setCursorName(name)	void	For documentation of this method, see java.sql.Statement#setCursorName(String).
setDate(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setDate(int, Date).
setDate(parameterIndex, x, timeZone)	void	For documentation of this method, see java.sql.PreparedStatement#setDate(int, Date, Calendar).
setDouble(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setDouble(int, double).
setEscapeProcessing(enable)	void	For documentation of this method, see java.sql.Statement#setEscapeProcessing(boolean).
setFetchDirection(direction)	void	For documentation of this method, see java.sql.Statement#setFetchDirection(int).
setFetchSize(rows)	void	For documentation of this method, see java.sql.Statement#setFetchSize(int).
setFloat(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setFloat(int, float).
setInt(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setInt(int, int).
setLong(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setLong(int, long).
setMaxFieldSize(max)	void	For documentation of this method, see java.sql.Statement#setMaxFieldSize(int).
setMaxRows(max)	void	For documentation of this method, see java.sql.Statement#setMaxRows(int).
setNClob(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setNClob(int, NClob).
setNString(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setNString(int, String).
setNull(parameterIndex, sqlType)	void	For documentation of this method, see java.sql.PreparedStatement#setNull(int, int).
setNull(parameterIndex, sqlType, typeName)	void	For documentation of this method, see java.sql.PreparedStatement#setNull(int, int, String).
setObject(index, x)	void	For documentation of this method, see java.sql.PreparedStatement#setObject(int, Object).
setObject(parameterIndex, x, targetSqlType)	void	For documentation of this method, see java.sql.PreparedStatement#setObject(int, Object, int).
setObject(parameterIndex, x, targetSqlType, scaleOrLength)	void	For documentation of this method, see java.sql.PreparedStatement#setObject(int, Object, int, int).
setPoolable(poolable)	void	For documentation of this method, see java.sql.Statement#setPoolable(boolean).
setQueryTimeout(seconds)	void	For documentation of this method, see java.sql.Statement#setQueryTimeout(int).
setRef(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setRef(int, Ref).
setRowId(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setRowId(int, RowId).
setSQLXML(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setSQLXML(int, SQLXML).
setShort(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setShort(int, short).
setString(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setString(int, String).
setTime(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setTime(int, Time).
setTime(parameterIndex, x, timeZone)	void	For documentation of this method, see java.sql.PreparedStatement#setTime(int, Time, Calendar).
setTimestamp(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setTimestamp(int, Timestamp).
setTimestamp(parameterIndex, x, timeZone)	void	For documentation of this method, see java.sql.PreparedStatement#setTimestamp(int, Timestamp, Calendar).
setURL(parameterIndex, x)	void	For documentation of this method, see java.sql.PreparedStatement#setURL(int, URL).

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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