gas-types-detailed
Version:
Enhanced Google Apps Script Type Definitions with detailed documentation. Includes type definitions plus code snippets, return values, required authorization scopes, and other details not found in @types/google-apps-script.
1,112 lines (1,036 loc) • 526 kB
TypeScript
// Type definitions for Google Apps Script 2025-11-10
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference path="google-apps-script.types.d.ts" />
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
namespace JDBC {
/**
* The JDBC service allows scripts to connect to Google Cloud SQL, MySQL,
* Microsoft SQL Server, and Oracle databases. For more information, see the guide to JDBC.
*/
interface Jdbc {
/**
* Attempts to establish a connection to the given Google Cloud SQL URL.
*
* Return:
* - JdbcConnection — A JdbcConnection object.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/sqlservice
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#getCloudSqlConnection(String)
* @param url A database URL of the form jdbc:google:mysql://subname.
*/
getCloudSqlConnection(url: string): JdbcConnection;
/**
* Attempts to establish a connection to the given Google Cloud SQL URL.
*
* Return:
* - JdbcConnection — A JdbcConnection object.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/sqlservice
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#getCloudSqlConnection(String,Object)
* @param url A database URL of the form jdbc:google:mysql://subname.
* @param info Optional JavaScript object specifying advanced parameters as defined below.
*/
getCloudSqlConnection(url: string, info: any): JdbcConnection;
/**
* Attempts to establish a connection to the given Google Cloud SQL URL.
*
* Return:
* - JdbcConnection — A JdbcConnection object.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/sqlservice
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#getCloudSqlConnection(String,String,String)
* @param url A database URL of the form jdbc:google:mysql://subname.
* @param userName The username to pass to the database.
* @param password The user's password.
*/
getCloudSqlConnection(url: string, userName: string, password: string): JdbcConnection;
/**
* Attempts to establish a connection to the given database URL.
*
* const conn = Jdbc.getConnection(
* 'jdbc:mysql://yoursqlserver.example.com:3306/database_name',
* );
*
* Return:
* - JdbcConnection — A JdbcConnection object.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#getConnection(String)
* @param url A database URL of the form jdbc:subprotocol:subname.
*/
getConnection(url: string): JdbcConnection;
/**
* Attempts to establish a connection to the given database URL.
*
* const conn = Jdbc.getConnection(
* 'jdbc:mysql://yoursqlserver.example.com:3306/database_name',
* {user: 'username', password: 'password'},
* );
*
* Return:
* - JdbcConnection — A JdbcConnection object.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#getConnection(String,Object)
* @param url A database URL of the form jdbc:subprotocol:subname.
* @param info Optional JavaScript object specifying advanced parameters as defined below.
*/
getConnection(url: string, info: any): JdbcConnection;
/**
* Attempts to establish a connection to the given database using a username and password.
*
* const conn = Jdbc.getConnection(
* 'jdbc:mysql://yoursqlserver.example.com:3306/database_name',
* 'username',
* 'password',
* );
*
* Return:
* - JdbcConnection — A JdbcConnection object.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#getConnection(String,String,String)
* @param url A database URL of the form jdbc:subprotocol:subname.
* @param userName The username to pass to the database.
* @param password The user's password.
*/
getConnection(url: string, userName: string, password: string): JdbcConnection;
/**
* Create a date from milliseconds since epoch.
*
* Return:
* - JdbcDate — A JdbcDate object.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#newDate(Integer)
* @param milliseconds Milliseconds since epoch.
*/
newDate(milliseconds: Integer): JdbcDate;
/**
* Create a time from milliseconds since epoch.
*
* Return:
* - JdbcTime — A JdbcTime object.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#newTime(Integer)
* @param milliseconds Milliseconds since epoch.
*/
newTime(milliseconds: Integer): JdbcTime;
/**
* Create a timestamp from milliseconds since epoch.
*
* Return:
* - JdbcTimestamp — A JdbcTimestamp object.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#newTimestamp(Integer)
* @param milliseconds Milliseconds since epoch.
*/
newTimestamp(milliseconds: Integer): JdbcTimestamp;
/**
* Create a date by parsing the SQL date string.
*
* Return:
* - JdbcDate — A JdbcDate object.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#parseDate(String)
* @param date A string containing a SQL date string.
*/
parseDate(date: string): JdbcDate;
/**
* Create a time by parsing the SQL time string.
*
* Return:
* - JdbcTime — A JdbcTime object.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#parseTime(String)
* @param time A string containing a SQL time string.
*/
parseTime(time: string): JdbcTime;
/**
* Create a timestamp by parsing the SQL timestamp string.
*
* Return:
* - JdbcTimestamp — A JdbcTimestamp object.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc#parseTimestamp(String)
* @param timestamp A string containing a SQL timestamp string.
*/
parseTimestamp(timestamp: string): JdbcTimestamp;
}
/**
* A JDBC Array. For documentation of this class, see java.sql.Array
* .
*/
interface JdbcArray {
/**
* For documentation of this method, see java.sql.Array#free().
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-array#free()
*/
free(): void;
/**
* For documentation of this method, see java.sql.Array#getArray()
*
* Return:
* - Object — An object containing the ordered elements of the SQL array value.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-array#getArray()
*/
getArray(): any;
/**
* For documentation of this method, see java.sql.Array#getArray(long, int).
*
* Return:
* - Object — An object containing up to the specified number of consecutive SQL array elements.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-array#getArray(Integer,Integer)
* @param index The array index of the first element to retrieve, where the first element has an index of 1.
* @param count The number of successive SQL array elements to retrieve.
*/
getArray(index: Integer, count: Integer): any;
/**
* For documentation of this method, see java.sql.Array#getBaseType().
*
* Return:
* - Integer — The type code for the elements in this array.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-array#getBaseType()
*/
getBaseType(): Integer;
/**
* For documentation of this method, see java.sql.Array#getBaseTypeName().
*
* Return:
* - String — The database-specific name for the built-in base type or else the fully-qualified SQL type name for a base type that is a UDT.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-array#getBaseTypeName()
*/
getBaseTypeName(): string;
/**
* For documentation of this method, see java.sql.Array#getResultSet().
*
* Return:
* - JdbcResultSet — The JdbcResultSet containing one row for each of the elements in the array designated by this Array object, with the rows in ascending order based on the indices.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-array#getResultSet()
*/
getResultSet(): JdbcResultSet;
/**
* For documentation of this method, see java.sql.Array#getResultSet(long, int).
*
* Return:
* - JdbcResultSet — A JdbcResultSet containing up to the specified number of consecutive SQL array elements.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-array#getResultSet(Integer,Integer)
* @param index The array index of the first element to retrieve, where the first element has an index of 1.
* @param count The number of successive SQL array elements to retrieve.
*/
getResultSet(index: Integer, count: Integer): JdbcResultSet;
}
/**
* A JDBC Blob. For documentation of this class, see java.sql.Blob
* .
*/
interface JdbcBlob {
/**
* For documentation of this method, see java.sql.Blob#free().
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#free()
*/
free(): void;
/**
* Gets the content of this JdbcBlob as an Apps Script blob.
*
* Return:
* - Blob — A Blob that can be used directly by other Apps Script APIs.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#getAppsScriptBlob()
*/
getAppsScriptBlob(): Base.Blob;
/**
* Return the data inside this object as a blob converted to the specified content type. This method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it assumes that the part of the filename that follows the last period (if any) is an existing extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes "ShoppingList.12.25.pdf".
* To view the daily quotas for conversions, see Quotas for Google Services. Newly created Google Workspace domains might be temporarily subject to stricter quotas.
*
* Return:
* - Blob — The data as a blob.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#getAs(String)
* @param contentType The MIME type to convert to. For most blobs, 'application/pdf' is the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp', 'image/gif', 'image/jpeg', or 'image/png' are also valid. For a Google Docs document, 'text/markdown' is also valid.
*/
getAs(contentType: string): Base.Blob;
/**
* For documentation of this method, see java.sql.Blob#getBytes(long, int).
*
* Return:
* - Byte[] — A byte array containing up to the specified number of consecutive bytes from the blob value.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#getBytes(Integer,Integer)
* @param position The ordinal position of the first byte in the blob value to be extracted; the first byte is at position 1.
* @param length The number of consecutive bytes to copy; the value for length must be zero or greater.
*/
getBytes(position: Integer, length: Integer): Byte[];
/**
* For documentation of this method, see java.sql.Blob#length().
*
* Return:
* - Integer — The number of bytes in this blob.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#length()
*/
length(): Integer;
/**
* For documentation of this method, see java.sql.Blob#position(byte[], long).
*
* Return:
* - Integer — The position at which the specified pattern begins, or else -1 if the pattern is not found.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#position(Byte,Integer)
* @param pattern The byte array to search for.
* @param start The position in the blob value where to beging searching; the first position is 1.
*/
position(pattern: Byte[], start: Integer): Integer;
/**
* For documentation of this method, see java.sql.Blob#position(blob, long).
*
* Return:
* - Integer — The position at which the specified pattern begins, or else -1 if the pattern is not found.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#position(JdbcBlob,Integer)
* @param pattern The JdbcBlob indicating the value to search for.
* @param start The position in the blob value where to beging searching; the first position is 1.
*/
position(pattern: JdbcBlob, start: Integer): Integer;
/**
* Convenience method for writing a JdbcBlob to this blob.
*
* Return:
* - Integer — The number of bytes written.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#setBytes(Integer,BlobSource)
* @param position The position in the blob at which to start writing; the first position is 1.
* @param blobSource The source of data to write to this blob.
*/
setBytes(position: Integer, blobSource: Base.BlobSource): Integer;
/**
* Convenience method for writing a JdbcBlob to this blob.
*
* Return:
* - Integer — The number of bytes written.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#setBytes(Integer,BlobSource,Integer,Integer)
* @param position The position in the blob at which to start writing; the first position is 1.
* @param blobSource The source of data to write to this blob.
* @param offset The offset into the provided byte array at which to start reading bytes to set.
* @param length The number of bytes to write to the blob.
*/
setBytes(position: Integer, blobSource: Base.BlobSource, offset: Integer, length: Integer): Integer;
/**
* For documentation of this method, see java.sql.Blob#setBytes(long, byte[]).
*
* Return:
* - Integer — The number of bytes written.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#setBytes(Integer,Byte)
* @param position The position in the blob at which to start writing; the first position is 1.
* @param bytes The array of bytes to write to this blob.
*/
setBytes(position: Integer, bytes: Byte[]): Integer;
/**
* For documentation of this method, see java.sql.Blob#setBytes(long, byte[], int, int).
*
* Return:
* - Integer — The number of bytes written.
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#setBytes(Integer,Byte,Integer,Integer)
* @param position The position in the blob at which to start writing; the first position is 1.
* @param bytes The array of bytes to write to this blob.
* @param offset The offset into the provided byte array at which to start reading bytes to set.
* @param length The number of bytes to write to the blob.
*/
setBytes(position: Integer, bytes: Byte[], offset: Integer, length: Integer): Integer;
/**
* For documentation of this method, see java.sql.Blob#truncate(long).
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-blob#truncate(Integer)
* @param length The size (in bytes) of this blob after truncation.
*/
truncate(length: Integer): void;
}
/**
* A JDBC CallableStatement. For documentation of this class, see
* java.sql.CallableStatement.
*/
interface JdbcCallableStatement {
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#addBatch()
*/
addBatch(): void;
/**
* For documentation of this method, see java.sql.Statement#addBatch(String).
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#addBatch(String)
* @param sql The SQL command to add to this statement, typically an SQL INSERT or UPDATE.
*/
addBatch(sql: string): void;
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#cancel()
*/
cancel(): void;
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#clearBatch()
*/
clearBatch(): void;
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#clearParameters()
*/
clearParameters(): void;
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#clearWarnings()
*/
clearWarnings(): void;
/**
* For documentation of this method, see java.sql.Statement#close().
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#close()
*/
close(): void;
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#execute()
*/
execute(): boolean;
/**
* For documentation of this method, see java.sql.Statement#execute(String).
*
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#execute(String)
* @param sql The SQL statement to execute.
*/
execute(sql: string): boolean;
/**
* For documentation of this method, see java.sql.Statement#execute(String, int).
*
* 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
* For documentation of this method, see java.sql.Statement#execute(String, int[]).
*
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#execute(String,Integer)
* @param sql The SQL statement to execute.
* @param autoGeneratedKeys 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.
* @param sql The SQL statement to execute.
* @param columnIndexes The column indices in the whose auto-generated keys are made available for future retrieval.
*/
execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean;
/**
* For documentation of this method, see java.sql.Statement#execute(String, int).
*
* 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
* For documentation of this method, see java.sql.Statement#execute(String, int[]).
*
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#execute(String,Integer)
* @param sql The SQL statement to execute.
* @param autoGeneratedKeys 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.
* @param sql The SQL statement to execute.
* @param columnIndexes The column indices in the whose auto-generated keys are made available for future retrieval.
*/
execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean;
/**
* For documentation of this method, see java.sql.Statement#execute(String, String[]).
*
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#execute(String,String)
* @param sql The SQL statement to execute.
* @param columnNames The names of columns in the whose auto-generated keys are made available for future retrieval.
*/
execute(sql: string, columnNames: string[]): boolean;
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#executeBatch()
*/
executeBatch(): Integer[];
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#executeQuery()
*/
executeQuery(): JdbcResultSet;
/**
* For documentation of this method, see java.sql.Statement#executeQuery(String).
*
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#executeQuery(String)
* @param sql The SQL statement to execute, typically a static SELECT.
*/
executeQuery(sql: string): JdbcResultSet;
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#executeUpdate()
*/
executeUpdate(): Integer;
/**
* For documentation of this method, see java.sql.Statement#executeUpdate(String).
*
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#executeUpdate(String)
* @param sql 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).
*/
executeUpdate(sql: string): Integer;
/**
* For documentation of this method, see java.sql.Statement#executeUpdate(String, int).
*
* 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
* For documentation of this method, see java.sql.Statement#executeUpdate(String, int[]).
*
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#executeUpdate(String,Integer)
* @param sql 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).
* @param autoGeneratedKeys 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.
* @param sql 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).
* @param columnIndexes The column indices in the whose auto-generated keys are made available for future retrieval.
*/
executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer;
/**
* For documentation of this method, see java.sql.Statement#executeUpdate(String, int).
*
* 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
* For documentation of this method, see java.sql.Statement#executeUpdate(String, int[]).
*
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#executeUpdate(String,Integer)
* @param sql 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).
* @param autoGeneratedKeys 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.
* @param sql 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).
* @param columnIndexes The column indices in the whose auto-generated keys are made available for future retrieval.
*/
executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer;
/**
* For documentation of this method, see java.sql.Statement#executeUpdate(String, String[]).
*
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#executeUpdate(String,String)
* @param sql 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).
* @param columnNames The names of columns in the whose auto-generated keys are made available for future retrieval.
*/
executeUpdate(sql: string, columnNames: string[]): Integer;
/**
* For documentation of this method, see java.sql.CallableStatement#getArray(int).
*
* Return:
* - JdbcArray — The value of a ARRAY parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getArray(Integer)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
*/
getArray(parameterIndex: Integer): JdbcArray;
/**
* For documentation of this method, see java.sql.CallableStatement#getArray(String).
*
* Return:
* - JdbcArray — The value of a ARRAY parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getArray(String)
* @param parameterName The name of the parameter.
*/
getArray(parameterName: string): JdbcArray;
/**
* For documentation of this method, see java.sql.CallableStatement#getBigDecimal(int).
*
* Return:
* - BigNumber — The value of a NUMERIC parameter in full precision. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getBigDecimal(Integer)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
*/
getBigDecimal(parameterIndex: Integer): BigNumber;
/**
* For documentation of this method, see java.sql.CallableStatement#getBigDecimal(String).
*
* Return:
* - BigNumber — The value of a NUMERIC parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getBigDecimal(String)
* @param parameterName The name of the parameter.
*/
getBigDecimal(parameterName: string): BigNumber;
/**
* For documentation of this method, see java.sql.CallableStatement#getBlob(int).
*
* Return:
* - JdbcBlob — The value of a BLOB parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getBlob(Integer)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
*/
getBlob(parameterIndex: Integer): JdbcBlob;
/**
* For documentation of this method, see java.sql.CallableStatement#getBlob(String).
*
* Return:
* - JdbcBlob — The value of a BLOB parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getBlob(String)
* @param parameterName The name of the parameter.
*/
getBlob(parameterName: string): JdbcBlob;
/**
* For documentation of this method, see java.sql.CallableStatement#getBoolean(int).
*
* Return:
* - Boolean — The value of a BIT or BOOLEAN parameter. Returns false if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getBoolean(Integer)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
*/
getBoolean(parameterIndex: Integer): boolean;
/**
* For documentation of this method, see java.sql.CallableStatement#getBoolean(String).
*
* Return:
* - Boolean — The value of a BIT or BOOLEAN parameter. Returns false if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getBoolean(String)
* @param parameterName The name of the parameter.
*/
getBoolean(parameterName: string): boolean;
/**
* For documentation of this method, see java.sql.CallableStatement#getByte(int).
*
* Return:
* - Byte — The value of a TINYINT parameter. Returns 0 if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getByte(Integer)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
*/
getByte(parameterIndex: Integer): Byte;
/**
* For documentation of this method, see java.sql.CallableStatement#getByte(String).
*
* Return:
* - Byte — The value of a TINYINT parameter. Returns 0 if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getByte(String)
* @param parameterName The name of the parameter.
*/
getByte(parameterName: string): Byte;
/**
* For documentation of this method, see java.sql.CallableStatement#getBytes(int).
*
* Return:
* - Byte[] — The value of a BINARY or VARBINARY parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getBytes(Integer)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
*/
getBytes(parameterIndex: Integer): Byte[];
/**
* For documentation of this method, see java.sql.CallableStatement#getBytes(String).
*
* Return:
* - Byte[] — The value of a BINARY or VARBINARY parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getBytes(String)
* @param parameterName The name of the parameter.
*/
getBytes(parameterName: string): Byte[];
/**
* For documentation of this method, see java.sql.CallableStatement#getClob(int).
*
* Return:
* - JdbcClob — The value of a CLOB parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getClob(Integer)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
*/
getClob(parameterIndex: Integer): JdbcClob;
/**
* For documentation of this method, see java.sql.CallableStatement#getClob(String).
*
* Return:
* - JdbcClob — The value of a CLOB parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getClob(String)
* @param parameterName The name of the parameter.
*/
getClob(parameterName: string): JdbcClob;
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getConnection()
*/
getConnection(): JdbcConnection;
/**
* For documentation of this method, see java.sql.CallableStatement#getDate(int).
*
* Return:
* - JdbcDate — The value of a DATE parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getDate(Integer)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
*/
getDate(parameterIndex: Integer): JdbcDate;
/**
* For documentation of this method, see java.sql.CallableStatement#getDate(int, Calendar).
*
* Return:
* - JdbcDate — The value of a DATE parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getDate(Integer,String)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
* @param timeZone 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).
*/
getDate(parameterIndex: Integer, timeZone: string): JdbcDate;
/**
* For documentation of this method, see java.sql.CallableStatement#getDate(String).
*
* Return:
* - JdbcDate — The value of a DATE parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getDate(String)
* @param parameterName The name of the parameter.
*/
getDate(parameterName: string): JdbcDate;
/**
* For documentation of this method, see java.sql.CallableStatement#getDate(String, Calendar).
*
* Return:
* - JdbcDate — The value of a DATE parameter. Returns null if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getDate(String,String)
* @param parameterName The name of the parameter.
* @param timeZone 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).
*/
getDate(parameterName: string, timeZone: string): JdbcDate;
/**
* For documentation of this method, see java.sql.CallableStatement#getDouble(int).
*
* Return:
* - Number — The value of a DOUBLE parameter. Returns 0 if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getDouble(Integer)
* @param parameterIndex The index of the parameter to retrieve (the first parameter is 1, the second is 2, and so on).
*/
getDouble(parameterIndex: Integer): number;
/**
* For documentation of this method, see java.sql.CallableStatement#getDouble(String).
*
* Return:
* - Number — The value of a DOUBLE parameter. Returns 0 if the value is null.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getDouble(String)
* @param parameterName The name of the parameter.
*/
getDouble(parameterName: string): number;
/**
* 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
*
* https://developers.google.com/apps-script/reference/jdbc/jdbc-callable-statement#getFetchDirection()
*/
getFetchDirection(): Integer;
/**
* 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