Class JdbcPreparedStatement

    • The JdbcPreparedStatement class in Apps Script facilitates interaction with SQL databases using prepared statements, mirroring Java JDBC API functionality.

    • Key methods are available for batch operations, statement execution, setting parameters, retrieving information, and managing the statement itself.

    • Numerous set methods are provided to configure parameters for the prepared statement at specific indices, supporting various data types.

    • Statement properties can be configured using methods like setCursorName , setFetchDirection , setMaxRows , and setQueryTimeout .

    • Most methods require authorization with the https://www.googleapis.com/auth/script.external_request scope.
    Jdbc Prepared Statement

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

    Methods

    Method Return type Brief description
    add Batch()
    		void For documentation of this method, see java.sql.PreparedStatement#addBatch() .
    add Batch(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() .
    clear Batch()
    		void For documentation of this method, see java.sql.Statement#clearBatch() .
    clear Parameters()
    		void For documentation of this method, see java.sql.PreparedStatement#clearParameters() .
    clear Warnings()
    		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[]) .
    execute Batch()
    		Integer[] For documentation of this method, see java.sql.Statement#executeBatch() .
    execute Query()
    		Jdbc Result Set For documentation of this method, see java.sql.PreparedStatement#executeQuery() .
    execute Query(sql)
    		Jdbc Result Set For documentation of this method, see java.sql.Statement#executeQuery(String) .
    execute Update()
    		Integer For documentation of this method, see java.sql.PreparedStatement#executeUpdate() .
    execute Update(sql)
    		Integer For documentation of this method, see java.sql.Statement#executeUpdate(String) .
    execute Update(sql, autoGeneratedKeys)
    		Integer For documentation of this method, see java.sql.Statement#executeUpdate(String, int) .
    execute Update(sql, columnIndexes)
    		Integer For documentation of this method, see java.sql.Statement#executeUpdate(String, int[]) .
    execute Update(sql, columnNames)
    		Integer For documentation of this method, see java.sql.Statement#executeUpdate(String, String[]) .
    get Connection()
    		Jdbc Connection For documentation of this method, see java.sql.Statement#getConnection() .
    get Fetch Direction()
    		Integer For documentation of this method, see java.sql.Statement#getFetchDirection() .
    get Fetch Size()
    		Integer For documentation of this method, see java.sql.Statement#getFetchSize() .
    get Generated Keys()
    		Jdbc Result Set For documentation of this method, see java.sql.Statement#getGeneratedKeys() .
    get Max Field Size()
    		Integer For documentation of this method, see java.sql.Statement#getMaxFieldSize() .
    get Max Rows()
    		Integer For documentation of this method, see java.sql.Statement#getMaxRows() .
    get Meta Data()
    		Jdbc Result Set Meta Data For documentation of this method, see java.sql.PreparedStatement#getMetaData() .
    get More Results()
    		Boolean For documentation of this method, see java.sql.Statement#getMoreResults() .
    get More Results(current)
    		Boolean For documentation of this method, see java.sql.Statement#getMoreResults(int) .
    get Parameter Meta Data()
    		Jdbc Parameter Meta Data For documentation of this method, see java.sql.PreparedStatement#getParameterMetaData() .
    get Query Timeout()
    		Integer For documentation of this method, see java.sql.Statement#getQueryTimeout() .
    get Result Set()
    		Jdbc Result Set For documentation of this method, see java.sql.Statement#getResultSet() .
    get Result Set Concurrency()
    		Integer For documentation of this method, see java.sql.Statement#getResultSetConcurrency() .
    get Result Set Holdability()
    		Integer For documentation of this method, see java.sql.Statement#getResultSetHoldability() .
    get Result Set Type()
    		Integer For documentation of this method, see java.sql.Statement#getResultSetType() .
    get Update Count()
    		Integer For documentation of this method, see java.sql.Statement#getUpdateCount() .
    get Warnings()
    		String[] For documentation of this method, see java.sql.Statement#getWarnings() .
    is Closed()
    		Boolean For documentation of this method, see java.sql.Statement#isClosed() .
    is Poolable()
    		Boolean For documentation of this method, see java.sql.Statement#isPoolable() .
    set Array(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setArray(int, Array) .
    set Big Decimal(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setBigDecimal(int, BigDecimal) .
    set Blob(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setBlob(int, Clob) .
    set Boolean(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setBoolean(int, boolean) .
    set Byte(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setByte(int, byte) .
    set Bytes(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setBytes(int, byte[]) .
    set Clob(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setClob(int, Clob) .
    set Cursor Name(name)
    		void For documentation of this method, see java.sql.Statement#setCursorName(String) .
    set Date(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setDate(int, Date) .
    set Date(parameterIndex, x, timeZone)
    		void For documentation of this method, see java.sql.PreparedStatement#setDate(int, Date, Calendar) .
    set Double(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setDouble(int, double) .
    set Escape Processing(enable)
    		void For documentation of this method, see java.sql.Statement#setEscapeProcessing(boolean) .
    set Fetch Direction(direction)
    		void For documentation of this method, see java.sql.Statement#setFetchDirection(int) .
    set Fetch Size(rows)
    		void For documentation of this method, see java.sql.Statement#setFetchSize(int) .
    set Float(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setFloat(int, float) .
    set Int(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setInt(int, int) .
    set Long(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setLong(int, long) .
    set Max Field Size(max)
    		void For documentation of this method, see java.sql.Statement#setMaxFieldSize(int) .
    set Max Rows(max)
    		void For documentation of this method, see java.sql.Statement#setMaxRows(int) .
    set NClob(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setNClob(int, NClob) .
    set NString(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setNString(int, String) .
    set Null(parameterIndex, sqlType)
    		void For documentation of this method, see java.sql.PreparedStatement#setNull(int, int) .
    set Null(parameterIndex, sqlType, typeName)
    		void For documentation of this method, see java.sql.PreparedStatement#setNull(int, int, String) .
    set Object(index, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setObject(int, Object) .
    set Object(parameterIndex, x, targetSqlType)
    		void For documentation of this method, see java.sql.PreparedStatement#setObject(int, Object, int) .
    set Object(parameterIndex, x, targetSqlType, scaleOrLength)
    		void For documentation of this method, see java.sql.PreparedStatement#setObject(int, Object, int, int) .
    set Poolable(poolable)
    		void For documentation of this method, see java.sql.Statement#setPoolable(boolean) .
    set Query Timeout(seconds)
    		void For documentation of this method, see java.sql.Statement#setQueryTimeout(int) .
    set Ref(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setRef(int, Ref) .
    set Row Id(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setRowId(int, RowId) .
    set SQLXML(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setSQLXML(int, SQLXML) .
    set Short(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setShort(int, short) .
    set String(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setString(int, String) .
    set Time(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setTime(int, Time) .
    set Time(parameterIndex, x, timeZone)
    		void For documentation of this method, see java.sql.PreparedStatement#setTime(int, Time, Calendar) .
    set Timestamp(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setTimestamp(int, Timestamp) .
    set Timestamp(parameterIndex, x, timeZone)
    		void For documentation of this method, see java.sql.PreparedStatement#setTimestamp(int, Timestamp, Calendar) .
    set URL(parameterIndex, x)
    		void For documentation of this method, see java.sql.PreparedStatement#setURL(int, URL) .

    Detailed documentation

    add Batch()

    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

    add Batch(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

    clear Batch()

    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

    clear Parameters()

    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

    clear Warnings()

    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.
    auto Generated Keys
    		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.
    column Indexes
    		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.
    column Names
    		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

    execute Batch()

    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

    execute Query()

    For documentation of this method, see java.sql.PreparedStatement#executeQuery() .

    Return

    Jdbc Result Set — 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

    execute Query(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

    Jdbc Result Set — 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

    execute Update()

    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

    execute Update(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

    execute Update(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).
    auto Generated Keys
    		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

    execute Update(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).
    column Indexes
    		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

    execute Update(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).
    column Names
    		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

    get Connection()

    For documentation of this method, see java.sql.Statement#getConnection() .

    Return

    Jdbc Connection — 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

    get Fetch Direction()

    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

    get Fetch Size()

    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

    get Generated Keys()

    For documentation of this method, see java.sql.Statement#getGeneratedKeys() .

    Return

    Jdbc Result Set — 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

    get Max Field Size()

    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

    get Max Rows()

    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

    get Meta Data()

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

    Return

    Jdbc Result Set Meta Data — 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

    get More Results()

    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

    get More Results(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

    get Parameter Meta Data()

    For documentation of this method, see java.sql.PreparedStatement#getParameterMetaData() .

    Return

    Jdbc Parameter Meta Data — 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

    get Query Timeout()

    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

    get Result Set()

    For documentation of this method, see java.sql.Statement#getResultSet() .

    Return

    Jdbc Result Set — 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

    get Result Set Concurrency()

    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

    get Result Set Holdability()

    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

    get Result Set Type()

    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

    get Update Count()

    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

    get Warnings()

    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

    is Closed()

    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

    is Poolable()

    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

    set Array(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setArray(int, Array) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Array 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

    set Big Decimal(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setBigDecimal(int, BigDecimal) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Big 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

    set Blob(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setBlob(int, Clob) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Blob 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

    set Boolean(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setBoolean(int, boolean) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set Byte(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setByte(int, byte) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set Bytes(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setBytes(int, byte[]) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set Clob(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setClob(int, Clob) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Clob 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

    set Cursor Name(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

    set Date(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setDate(int, Date) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Date 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

    set Date(parameterIndex, x, timeZone)

    For documentation of this method, see java.sql.PreparedStatement#setDate(int, Date, Calendar) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Date The parameter value to set.
    time Zone
    		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

    set Double(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setDouble(int, double) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set Escape Processing(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

    set Fetch Direction(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

    set Fetch Size(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

    set Float(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setFloat(int, float) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set Int(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setInt(int, int) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set Long(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setLong(int, long) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set Max Field Size(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

    set Max Rows(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

    set NClob(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setNClob(int, NClob) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Clob 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

    set NString(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setNString(int, String) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set Null(parameterIndex, sqlType)

    For documentation of this method, see java.sql.PreparedStatement#setNull(int, int) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    sql Type
    		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

    set Null(parameterIndex, sqlType, typeName)

    For documentation of this method, see java.sql.PreparedStatement#setNull(int, int, String) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    sql Type
    		Integer The SQL type of the specified parameter.
    type Name
    		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

    set Object(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

    set Object(parameterIndex, x, targetSqlType)

    For documentation of this method, see java.sql.PreparedStatement#setObject(int, Object, int) .

    Parameters

    Name Type Description
    parameter 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.
    target Sql Type
    		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

    set Object(parameterIndex, x, targetSqlType, scaleOrLength)

    For documentation of this method, see java.sql.PreparedStatement#setObject(int, Object, int, int) .

    Parameters

    Name Type Description
    parameter 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.
    target Sql Type
    		Integer The SQL type to send to the database. The scale argument may further qualify this type.
    scale Or Length
    		Integer The number of digits after the decimal for DECIMAL or NUMERIC types, or the length of data for Input Stream 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

    set Poolable(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

    set Query Timeout(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

    set Ref(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setRef(int, Ref) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Ref 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

    set Row Id(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setRowId(int, RowId) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Row Id 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

    set SQLXML(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setSQLXML(int, SQLXML) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc SQLXML 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

    set Short(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setShort(int, short) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set String(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setString(int, String) .

    Parameters

    Name Type Description
    parameter Index
    		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

    set Time(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setTime(int, Time) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Time 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

    set Time(parameterIndex, x, timeZone)

    For documentation of this method, see java.sql.PreparedStatement#setTime(int, Time, Calendar) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Time The parameter value to set.
    time Zone
    		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

    set Timestamp(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setTimestamp(int, Timestamp) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Timestamp 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

    set Timestamp(parameterIndex, x, timeZone)

    For documentation of this method, see java.sql.PreparedStatement#setTimestamp(int, Timestamp, Calendar) .

    Parameters

    Name Type Description
    parameter Index
    		Integer The index of the parameter to set (the first parameter is 1, the second is 2, and so on).
    x
    		Jdbc Timestamp The parameter value to set.
    time Zone
    		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

    set URL(parameterIndex, x)

    For documentation of this method, see java.sql.PreparedStatement#setURL(int, URL) .

    Parameters

    Name Type Description
    parameter Index
    		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
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: