Class JdbcStatement Stay organized with collections Save and categorize content based on your preferences.
Page Summary
JdbcStatement represents a JDBC Statement and mirrors the documentation found in
java.sql.Statement.It includes methods for executing various SQL commands like
addBatch,execute,executeQuery, andexecuteUpdate.Methods are available to manage the statement's state, such as
cancel,clearBatch,clearWarnings, andclose.You can retrieve information about the statement and its results using methods like
getWarnings,getResultSet, andgetUpdateCount.Several methods allow setting properties like
setFetchSize,setMaxRows, andsetQueryTimeout.
A JDBCStatement. For documentation of this class, seejava.sql.Statement.
Methods
Detailed documentation
addBatch(sql)
For documentation of this method, seejava.sql.Statement#addBatch(String).
Parameters
| Name | Type | Description |
|---|---|---|
sql | String | The SQL command to add to this statement, typically an SQLINSERT orUPDATE. |
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
cancel()
For documentation of this method, seejava.sql.Statement#cancel().
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
clearBatch()
For documentation of this method, seejava.sql.Statement#clearBatch().
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
clearWarnings()
For documentation of this method, seejava.sql.Statement#clearWarnings().
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
close()
For documentation of this method, seejava.sql.Statement#close().
execute(sql)
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
execute(sql, autoGeneratedKeys)
For documentation of this method, seejava.sql.Statement#execute(String, int).
Parameters
| Name | Type | Description |
|---|---|---|
sql | String | The SQL statement to execute. |
auto | Integer | A flag that indicates whether auto-generated keys are made available for future retrieval; eitherJdbc.Statement.RETURN_GENERATED_KEYS orJdbc.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
execute(sql, columnIndexes)
For documentation of this method, seejava.sql.Statement#execute(String, int[]).
Parameters
| Name | Type | Description |
|---|---|---|
sql | String | The SQL statement to execute. |
column | 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 followingscopes:
https://www.googleapis.com/auth/script.external_request
execute(sql, columnNames)
For documentation of this method, seejava.sql.Statement#execute(String, String[]).
Parameters
| Name | Type | Description |
|---|---|---|
sql | String | The SQL statement to execute. |
column | 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 followingscopes:
https://www.googleapis.com/auth/script.external_request
executeBatch()
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
executeQuery(sql)
For documentation of this method, seejava.sql.Statement#executeQuery(String).
Parameters
| Name | Type | Description |
|---|---|---|
sql | String | The SQL statement to execute, typically a staticSELECT. |
Return
Jdbc — A result set containing the results of the execution. This is nevernull.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
executeUpdate(sql)
For documentation of this method, seejava.sql.Statement#executeUpdate(String).
Parameters
| Name | Type | Description |
|---|---|---|
sql | String | The SQL Data Manipulation Language statement to execute (such asINSERT,UPDATE, orDELETE), 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 followingscopes:
https://www.googleapis.com/auth/script.external_request
executeUpdate(sql, autoGeneratedKeys)
For documentation of this method, seejava.sql.Statement#executeUpdate(String, int).
Parameters
| Name | Type | Description |
|---|---|---|
sql | String | The SQL Data Manipulation Language statement to execute (such asINSERT,UPDATE, orDELETE), or else a statement that returns nothing (such as a DDL statement). |
auto | Integer | A flag that indicates whether auto-generated keys are made available for future retrieval; eitherJdbc.Statement.RETURN_GENERATED_KEYS orJdbc.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
executeUpdate(sql, columnIndexes)
For documentation of this method, seejava.sql.Statement#executeUpdate(String, int[]).
Parameters
| Name | Type | Description |
|---|---|---|
sql | String | The SQL Data Manipulation Language statement to execute (such asINSERT,UPDATE, orDELETE), or else a statement that returns nothing (such as a DDL statement). |
column | 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 followingscopes:
https://www.googleapis.com/auth/script.external_request
executeUpdate(sql, columnNames)
For documentation of this method, seejava.sql.Statement#executeUpdate(String, String[]).
Parameters
| Name | Type | Description |
|---|---|---|
sql | String | The SQL Data Manipulation Language statement to execute (such asINSERT,UPDATE, orDELETE), or else a statement that returns nothing (such as a DDL statement). |
column | 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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getConnection()
For documentation of this method, seejava.sql.Statement#getConnection().
Return
Jdbc — The connection that produced this statement.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
getFetchDirection()
For documentation of this method, seejava.sql.Statement#getFetchDirection().
Return
Integer — The default direction for result sets generated by this statement, which is eitherJdbc.ResultSet.FETCH_FORWARD orJdbc.ResultSet.FETCH_REVERSE.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
getFetchSize()
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getGeneratedKeys()
For documentation of this method, seejava.sql.Statement#getGeneratedKeys().
Return
Jdbc — 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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getMaxFieldSize()
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getMaxRows()
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getMoreResults()
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getMoreResults(current)
For documentation of this method, seejava.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 ofJdbc.Statement.CLOSE_CURRENT_RESULT,Jdbc.Statement.KEEP_CURRENT_RESULT, orJdbc.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getQueryTimeout()
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getResultSet()
For documentation of this method, seejava.sql.Statement#getResultSet().
Return
Jdbc — The current result set, ornull 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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getResultSetConcurrency()
For documentation of this method, seejava.sql.Statement#getResultSetConcurrency().
Return
Integer — The result set concurrency for result sets generated from this statement, which is eitherJdbc.ResultSet.CONCUR_READ_ONLY orJdbc.ResultSet.CONCUR_UPDATABLE.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
getResultSetHoldability()
For documentation of this method, seejava.sql.Statement#getResultSetHoldability().
Return
Integer — The result set holdability, which is eitherJdbc.ResultSet.HOLD_CURSORS_OVER_COMMIT orJdbc.ResultSet.CLOSE_CURSORS_AT_COMMIT.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
getResultSetType()
For documentation of this method, seejava.sql.Statement#getResultSetType().
Return
Integer — The result set type for result sets generated from this statement, which isJdbc.ResultSet.TYPE_FORWARD_ONLY,Jdbc.ResultSet.TYPE_SCROLL_INSENSITIVE, orJdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
getUpdateCount()
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
getWarnings()
For documentation of this method, seejava.sql.Statement#getWarnings().
Return
String[] — The current set of warnings, ornull if there are no warnings.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
isClosed()
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
isPoolable()
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
setCursorName(name)
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
setEscapeProcessing(enable)
For documentation of this method, seejava.sql.Statement#setEscapeProcessing(boolean).
Parameters
| Name | Type | Description |
|---|---|---|
enable | Boolean | Iftrue, escape processing is enabled; otherwise it is disabled. |
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
setFetchDirection(direction)
For documentation of this method, seejava.sql.Statement#setFetchDirection(int).
Parameters
| Name | Type | Description |
|---|---|---|
direction | Integer | The specified direction to set, which is eitherJdbc.ResultSet.FETCH_FORWARD orJdbc.ResultSet.FETCH_REVERSE. |
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/script.external_request
setFetchSize(rows)
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
setMaxFieldSize(max)
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
setMaxRows(max)
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
setPoolable(poolable)
For documentation of this method, seejava.sql.Statement#setPoolable(boolean).
Parameters
| Name | Type | Description |
|---|---|---|
poolable | Boolean | Iftrue, 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 followingscopes:
https://www.googleapis.com/auth/script.external_request
setQueryTimeout(seconds)
For documentation of this method, seejava.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 followingscopes:
https://www.googleapis.com/auth/script.external_request
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.