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 RowSet
Description
is a client side ResultSet, which combines the characteristics of a Statement and a ResultSet.

It acts like a typical bean. Before you use the RowSet, you have to specify a set of properties like a DataSource and a Command and other properties known of Statement.
Afterwards, you can populate the RowSet by its execute method to fill the set with data.

On the one hand, a RowSet can be used as a short cut to retrieve the data of a DataSource. You don't have to establish a connection, create a Statement, and then create a ResultSet. On the other hand, a rowset can be used to implement capabilties for a result set, which are not supported by a driver result set, like caching strategies or update capabilities.


Included Services - Summary
ResultSet
(referenced entity's summary:)
provides access to a table of data. A ResultSet object is usually generated by executing a Statement.
Exported Interfaces - Summary
XRowSet

used to execute and to add/remove listeners. (details)

XParameters
(referenced entity's summary:)
is used for parameter setting, commonly implemented in conjunction with PreparedStatements.
XColumnLocate

allows locating columns which's name is known only.

Properties' Summary
string
DataSourceName
is the name of a named datasource to use. 
string
URL
is the connection URL. Could be used instead of the DataSourceName.  
string
Command
is the command which should be executed.  
long
TransactionIsolation
indicates the transaction isolation level, which should be used for the connection. 
::com::sun::star::container::XNameAccess
TypeMap
is the type map that will be used for the custom mapping of SQL structured types and distinct types.  
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. This is only evaluated, if the CommandType is COMMAND.  
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
User
determines the user for whom to open the connection.  
string
Password
determines the user for whom to open the connection.  
long
ResultSetType
determine the result set type.  
Included Services - Details
ResultSet
(referenced entity's summary:)
provides access to a table of data. A ResultSet object is usually generated by executing a Statement.
Exported Interfaces - Details
XRowSet
Description
used to execute and to add/remove listeners.

To refresh the content of a RowSet, use this interface's XRowSet::execute method.

XParameters
(referenced entity's summary:)
is used for parameter setting, commonly implemented in conjunction with PreparedStatements.
XColumnLocate
Description
allows locating columns which's name is known only.
Properties' Details
DataSourceName
string DataSourceName;
Description
is the name of a named datasource to use.
See also
URL
string URL;
Description
is the connection URL. Could be used instead of the DataSourceName.
Command
string Command;
Description
is the command which should be executed.
TransactionIsolation
long TransactionIsolation;
Description
indicates the transaction isolation level, which should be used for the connection.
See also
TransactionIsolation
TypeMap
::com::sun::star::container::XNameAccess TypeMap;
Description
is the type map that will be used for the custom mapping of SQL structured types and distinct types.
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. This is only evaluated, if the CommandType is COMMAND.
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.
User
string User;
Description
determines the user for whom to open the connection.
Password
string Password;
Description
determines the user for whom to open the connection.
ResultSetType
long ResultSetType;
Description
determine the result set type.
See also
ResultSetType

 
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.