Class JdbcStatement  |  Apps Script  |  Google for Developers (original) (raw)

Skip to main content

Class JdbcStatement

Stay organized with collections Save and categorize content based on your preferences.

Methods

Method Return type Brief description
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().
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(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(sql) JdbcResultSet For documentation of this method, see java.sql.Statement#executeQuery(String).
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().
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).
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().
setCursorName(name) void For documentation of this method, see java.sql.Statement#setCursorName(String).
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).
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).
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).

Detailed documentation

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.

Scripts that use this method require authorization with one or more of the following scopes:

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:

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:

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:

close()

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:

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:

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:

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:

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:

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](/apps-script/reference/jdbc/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:

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:

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:

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:

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:

getConnection()

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

Return

[JdbcConnection](/apps-script/reference/jdbc/jdbc-connection) — The connection that produced this statement.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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 eitherJdbc.ResultSet.FETCH_FORWARD or Jdbc.ResultSet.FETCH_REVERSE.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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:

getGeneratedKeys()

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

Return

[JdbcResultSet](/apps-script/reference/jdbc/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:

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:

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:

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:

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:

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:

getResultSet()

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

Return

[JdbcResultSet](/apps-script/reference/jdbc/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:

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:

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:

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, orJdbc.ResultSet.TYPE_SCROLL_INSENSITIVE.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-03 UTC.