Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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

com::sun::star::sdbc::ResultSet
Description
provides access to a table of data. A ResultSet object is usually generated by executing a Statement.

Exported Interfaces

com::sun::star::sdbc::XRowSet
Description
enhances the functionality of a result set. It allows implementation of a special behavior for a result set and notifies an application on certain row set events such as a change in its value.
com::sun::star::sdbc::XParameters
Description
is used for parameter setting, commonly implemented in conjunction with PreparedStatements.

Properties' Summary

DataSourceName is the name of a named datasource to use.
URL is the connection URL. Could be used instead of the DataSourceName.
Command is the command which should be executed.
TransactionIsolation indicates the transaction isolation level, which should be used for the connection.
TypeMap is the type map that will be used for the custom mapping of SQL structured types and distinct types.
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.
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.
MaxFieldSize returns the maximum number of bytes allowed for any column value.
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.
User determines the user for whom to open the connection.
Password determines the user for whom to open the connection.
ResultSetType determine the result set type.

Properties' Details

DataSourceName
 
string DataSourceName;
Description
is the name of a named datasource to use.
See also
com::sun::star::sdbc:XDataSource
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
com::sun::star::sdbc::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
com::sun::star::sdbc::ResultSetType;

Top of Page