Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: sdbc ::

service Statement
Description
is used for executing a static SQL statement and obtaining the results produced by it.

Only one ResultSet per Statement can be open at any point in time. Therefore, if the reading of one ResultSet is interleaved with the reading of another, each must have been generated by different Statements. All statement execute methods implicitly close a statement's current ResultSet if an open one exists.

Developers Guide
Database - Creating Statements

Exported Interfaces - Summary
::com::sun::star::lang::XComponent

optional for implementation, controls the releasing of resources and the notification of registered listeners. (details)

XCloseable

freeing all resources of a statement. A related resultset will be freed as well.

::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
::com::sun::star::util::XCancellable

could be used for cancelling the execution of SQL statements if both the DBMS and the driver support aborting an SQL statement. The implementation is optional. (details)

XStatement

is the interface for executing SQL commands.

XBatchExecution

provides the ability of batch execution. This interface is optional for execution. (details)

XWarningsSupplier

controls the chaining of warnings, which may occur on every call to the connected database. Chained warnings from previous calls will be cleared before processing a new call.

XMultipleResults

covers the handling of multiple results after executing an SQL command. The implementation is optional. (details)

Properties' Summary
long
QueryTimeOut
retrieves the number of seconds the driver will wait for a Statement to execute. If the limit is exceeded, a SQLException is thrown. There is no limitation, if set to zero.  
long
MaxFieldSize
returns the maximum number of bytes allowed for any column value.  
long
MaxRows
retrieves the maximum number of rows that a ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped.
There is no limitation, if set to zero.  
string
CursorName
defines the SQL cursor name that will be used by subsequent Statement execute methods.  
long
ResultSetConcurrency
retrieves the result set concurrency.  
long
ResultSetType
determine the result set type.  
long
FetchDirection
retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object.
If this Statement object has not set a fetch direction, the return value is implementation-specific.  
long
FetchSize
retrieves the number of result set rows that is the default fetch size for result sets generated from this Statement object.
If this Statement object has not set a fetch size, the return value is implementation-specific.  
boolean
EscapeProcessing
returns if escape processing is on or off. If escape scanning is on (the default), the driver will do escape substitution before sending the SQL to the database.  
Exported Interfaces - Details
::com::sun::star::lang::XComponent
Usage Restrictions
optional
Description
optional for implementation, controls the releasing of resources and the notification of registered listeners.
XCloseable
Description
freeing all resources of a statement. A related resultset will be freed as well.
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
::com::sun::star::util::XCancellable
Usage Restrictions
optional
Description
could be used for cancelling the execution of SQL statements if both the DBMS and the driver support aborting an SQL statement. The implementation is optional.
XStatement
Description
is the interface for executing SQL commands.
XBatchExecution
Usage Restrictions
optional
Description
provides the ability of batch execution. This interface is optional for execution.

A driver implementing batch execution must return true for XDatabaseMetaData::supportsBatchUpdates()

XWarningsSupplier
Description
controls the chaining of warnings, which may occur on every call to the connected database. Chained warnings from previous calls will be cleared before processing a new call.
XMultipleResults
Usage Restrictions
optional
Description
covers the handling of multiple results after executing an SQL command. The implementation is optional.
Properties' Details
QueryTimeOut
long QueryTimeOut;
Description
retrieves the number of seconds the driver will wait for a Statement to execute. If the limit is exceeded, a SQLException is thrown. There is no limitation, if set to zero.
MaxFieldSize
long MaxFieldSize;
Description
returns the maximum number of bytes allowed for any column value.

This limit is the maximum number of bytes that can be returned for any column value. The limit applies only to DataType::BINARY , DataType::VARBINARY , DataType::LONGVARBINARY , DataType::CHAR , DataType::VARCHAR , and DataType::LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.
There is no limitation, if set to zero.

MaxRows
long MaxRows;
Description
retrieves the maximum number of rows that a ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped.
There is no limitation, if set to zero.
CursorName
string CursorName;
Description
defines the SQL cursor name that will be used by subsequent Statement execute methods.

This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database does not support positioned update/delete, this property is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor's SELECT statement should be of the form 'select for update ...'. If the 'for update' phrase is omitted, positioned updates may fail.

Note: By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, cursor names must be unique within a connection.

ResultSetConcurrency
long ResultSetConcurrency;
Description
retrieves the result set concurrency.
See also
ResultSetConcurrency
ResultSetType
long ResultSetType;
Description
determine the result set type.
See also
ResultSetType
FetchDirection
long FetchDirection;
Description
retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement object.
If this Statement object has not set a fetch direction, the return value is implementation-specific.
FetchSize
long FetchSize;
Description
retrieves the number of result set rows that is the default fetch size for result sets generated from this Statement object.
If this Statement object has not set a fetch size, the return value is implementation-specific.
EscapeProcessing
boolean EscapeProcessing;
Description
returns if escape processing is on or off. If escape scanning is on (the default), the driver will do escape substitution before sending the SQL to the database.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.