%XDBC.Gateway.ODBC.Statement
class %XDBC.Gateway.ODBC.Statement extends %XDBC.Gateway.Statement
Property Inventory
Method Inventory
- %OnNew()
- AddBatch()
- Cancel()
- ClearBatch()
- Close()
- Execute()
- ExecuteBatch()
- ExecuteDirect()
- ExecuteQuery()
- ExecuteUpdate()
- GetConnection()
- GetFetchSize()
- GetGeneratedKeys()
- GetMaxFieldSize()
- GetMaxRows()
- GetMoreResults()
- GetQueryTimeout()
- GetResultSet()
- GetTablePriviligies()
- GetTables()
- GetUpdateCount()
- IsClosed()
- Prepare()
- SetFetchSize()
- SetMaxFieldSize()
- SetMaxRows()
- SetQueryTimeout()
Properties
property connection as %XDBC.Gateway.ODBC.Connection;
Property methods: connectionGet(), connectionGetSwizzled(), connectionIsValid(), connectionNewObject(), connectionSet()
property statement as %ObjectHandle;
Property methods: statementGet(), statementIsValid(), statementSet()
Methods
method %OnNew(connection As %XDBC.Gateway.ODBC.Connection, statement As %ObjectHandle) as %Status
Inherited description: This callback method is invoked by the %New() method to
provide notification that a new instance of an object is being created.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.
method AddBatch(sql As %String, ColumnBinding As %Boolean, size As %Integer, statusArray As %Boolean)
Method Not Supported, use PreparedStatement.AddBatchEx
method Cancel()
Cancels this Statement object if both the DBMS and driver support aborting an SQL statement.
method ClearBatch()
Method Not Supported
method Close()
Releases this Statement object's database and resources immediately instead of waiting for this to happen when it is automatically closed.
method Execute(sql As %Library.String, autoGeneratedKeys As %Library.Integer = "") as %Boolean
Executes the prepared SQL statement, which may return multiple results
method ExecuteBatch() as %ListOfDataTypes
Method Not Supported, use PreparedStatement.ExecuteBatchEx
Executes the given SQL statement, which may return multiple results
method ExecuteQuery(sql As %String) as %XDBC.Gateway.ResultSet
Executes the given SQL statement, which returns a single ResultSet object
method ExecuteUpdate(sql As %Library.String, autoGeneratedKeys As %Library.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.
method GetConnection() as Connection
Retrieves the Connection object that produced this Statement object
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
method GetGeneratedKeys() as %XDBC.Gateway.ResultSet
Method Not Supported
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
method GetMaxRows() as %Integer
Retrieves the maximum number of rows that a ResultSet object produced by this Statement object can contain
method GetMoreResults() as %Boolean
Inherited description: 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.
method GetQueryTimeout() as %Integer
Retrieves the number of seconds the driver will wait for a Statement object to execute.
method GetResultSet() as %XDBC.Gateway.ResultSet
Retrieves the current result as a ResultSet object.
method GetUpdateCount() as %Integer
Method Not Supported
method IsClosed() as %Boolean
Method Not Supported
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.
method SetMaxFieldSize(max As %Integer)
Method Not Supported
method SetMaxRows(max As %Integer)
Method Not Supported
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
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()