Skip to main content

%XDBC.Gateway.Statement

abstract class %XDBC.Gateway.Statement extends %Library.RegisteredObject

FOR INTERNAL USE - do not invoke directly

Method Inventory

Methods

abstract method AddBatch(sql As %String)
Sets the value of the designated parameter with the given object. Method SetObject(parameterName As %String, parameter As %ObjectHandle) {} Adds the given SQL command to the current list of commands for this Statement object.
abstract method Cancel()
Cancels this Statement object if both the DBMS and driver support aborting an SQL statement.
abstract method ClearBatch()
Empties this Statement object's current list of SQL commands.
abstract method Close()
Releases this Statement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
abstract method Execute(sql As %String, autoGeneratedKeys As %Integer = "") as %Boolean
Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval
abstract method ExecuteBatch() as %ListOfDataTypes
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts
abstract method ExecuteQuery(sql As %String) as ResultSet
list of int Executes the given SQL statement, which returns a single ResultSet object
abstract method ExecuteUpdate(sql As %String, autoGeneratedKeys As %Integer = "") as %Integer
Executes the given SQL statement, which may be an INSERT, UPDATE, or DELETE statement or an SQL statement that returns nothing, such as an SQL DDL statement Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement object should be made available for retrieval.
abstract method GetConnection() as Connection
Retrieves the Connection object that produced this Statement object
abstract method GetFetchSize() as %Integer
Retrieves the number of result set rows that is the default fetch size for ResultSet objects generated from this Statement object
abstract method GetGeneratedKeys() as ResultSet
Retrieves any auto-generated keys created as a result of executing this Statement object
abstract method GetMaxFieldSize() as %Integer
Retrieves the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object
abstract method GetMaxRows() as %Integer
Retrieves the maximum number of rows that a ResultSet object produced by this Statement object can contain
abstract method GetMoreResults() as %Boolean
Moves to this Statement object's next result, returns true if it is a ResultSet object, and implicitly closes any current ResultSet object(s) obtained with the method getResultSet.
abstract method GetQueryTimeout() as %Integer
Retrieves the number of seconds the driver will wait for a Statement object to execute.
abstract method GetResultSet() as ResultSet
Retrieves the current result as a ResultSet object.
abstract method GetResultSetMetaData() as ResultSetMetaData
Retrieves the column metadata for the result set that will be returned for this statement as a ResultSetMetaData object.
abstract method GetUpdateCount() as %Integer
Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned
abstract method IsClosed() as %Boolean
Retrieves whether this Statement object has been closed
abstract method SetFetchSize(rows As %Integer)
Gives the driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet objects genrated by this Statement.
abstract method SetMaxFieldSize(max As %Integer)
Sets the limit for the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object.
abstract method SetMaxRows(max As %Integer)
Sets the limit for the maximum number of rows that any ResultSet object generated by this Statement object can contain to the given number.
abstract method SetQueryTimeout(seconds As %Integer)
Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab