The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star ::

module sdbc
Description
Database component interfaces.

Services
CallableStatement is used to execute SQL stored procedures.
Connection represents a connection (session) with a specific database. Within the context of a Connection, SQL statements are executed and results are returned.
ConnectionPool is the basic service for pooling SDBC connections.
ConnectionProperties represents the properties for a connection (session) with a specific database. These properties can be used when calling the method XDriver::connect() or XDriverManager::getConnectionWithInfo().
DBASEConnectionProperties represents the properties for a dBase connection (session) with a specific database. These properties can be used when calling the method XDriver::connect() or XDriverManager::getConnectionWithInfo().
Driver is the service that every driver class must implement.
DriverManager is the basic service for managing a set of SDBC drivers.
FILEConnectionProperties represents the properties for a FILE connection (session) with a specific database. These properties can be used when calling the method XDriver::connect() or XDriverManager::getConnectionWithInfo().
FLATConnectionProperties represents the properties for a FLAT connection (session) with a specific database. These properties can be used when calling the method XDriver::connect() or XDriverManager::getConnectionWithInfo().
JDBCConnectionProperties represents the properties for a JDBC connection (session) with a specific database. These properties can be used when calling the method XDriver::connect() or XDriverManager::getConnectionWithInfo().
ODBCConnectionProperties represents the properties for a ODBC connection (session) with a specific database. These properties can be used when calling the method XDriver::connect() or XDriverManager::getConnectionWithInfo().
PreparedStatement represents a precompiled SQL statement.
ResultSet provides access to a table of data. A ResultSet object is usually generated by executing a Statement.
RowSet is a client side ResultSet, which combines the characteristics of a Statement and a ResultSet.
Statement is used for executing a static SQL statement and obtaining the results produced by it.
Interfaces
XArray is used for mapping the SQL type DataType::ARRAY . By default, an Array is a transaction duration reference to an SQL array. By default, an Array is implemented using a SQL LOCATOR(array) internally.
XBatchExecution is used for collecting and executing a set of SQL statements.
XBlob is the representation (mapping) of an SQL BLOB .
XClob is the mapping for the SQL CLOB type.
XCloseable provides for the releasing of resources acquired by the implementing object.
XColumnLocate provides the possibility to find columns by their name.
XConnection represents a connection (session) with a specific database. Within the context of a Connection, SQL statements are executed and results are returned.
XDataSource is used for establishing connections via a factory which is identified by its name. A DataSource object is typically registered by a naming service provider.
XDatabaseMetaData provides comprehensive information about the database as a whole.
XDatabaseMetaData2 extends the XDatabaseMetaData interface to allow retrieval of additional information.
XDriver is the interface that every driver class must implement.
XDriverAccess provides the access of sdbc driver components
XDriverManager is the basic interface for managing a set of SDBC drivers.
XGeneratedResultSet provides a result set which gives access to automatically generated values after a new row was inserted.
XIsolatedConnection is used for establishing isolated connections via a factory.
XMultipleResults is used for inspecting multiple results produced by the execution of a SQL statement.
XOutParameters is used to register Out-Parameters for stored procedures.
XParameters is used for parameter setting, commonly implemented in conjunction with PreparedStatements.
XPooledConnection defines a pooled connection which can share a unused connection.
XPreparedBatchExecution is used for batch execution on PreparedStatements.
XPreparedStatement provides the possibilty of executing a precompiled SQL statement.
XRef is the reference to a SQL structured type value in the database. A Ref can be saved to persistent storage. A Ref is dereferenced by passing it as a parameter to a SQL statement and executing the statement.
XResultSet provides the navigation on a table of data. A ResultSet object is usually generated by executing a Statement .
XResultSetMetaData can be used to find out about the types and properties of the columns in a ResultSet.
XResultSetMetaDataSupplier provides access to the meta data of a result set.
XResultSetUpdate provides the possiblity to write changes made on a result set back to database.
XRow is used to access data which is collected in a row. All methods raise a SQLException if a database access error occurs.
XRowSet 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.
XRowSetListener is used for receiving "cursorMoved", "rowChanged", and "rowSetChanged" events posted by, for example, a rowset.
XRowUpdate is used to update data which is collected in a row.
XSQLData is used for the custom mapping of SQL user-defined types.
XSQLInput represents an input stream that contains a stream of values representing an instance of a SQL structured or distinct type.
XSQLOutput is used as an output stream for writing the attributes of a user-defined type back to the database. This interface, used only for custom mapping, is used by the driver, and its methods are never directly invoked by a programmer.
XStatement is used for executing a static SQL statement and obtaining the results produced by it.
XStruct is used for the standard mapping for a SQL structured type.
XWarningsSupplier should be implemented of objects which may report warnings or non critical errors.
Structs
ChangeEvent [ DEPRECATED ]
DriverPropertyInfo describes the driver properties for making a connection.
Exceptions
BatchUpdateException is thrown when an error occurs during a batch update operation.
DataTruncation reports a DataTruncation warning, on reads, or is thrown as a DataTruncation exception, on writes, when a data value is unexpectedly truncated.
SQLException is an exception that provides information on a database access error.
SQLWarning is an exception that provides information on database access warnings. Warnings are silently chained to the object whose method caused it to be reported.
Constant Groups
BestRowScope determines how long a row identifier is valid.
BestRowType determines the type of the best row identifier.
ChangeAction [ DEPRECATED ]
ColumnSearch indicates in which way a column can be used in the WHERE search.
ColumnType determines the type of a version column.
ColumnValue determines whether a column allows SQL NULL values or not.
DataType These constants are used to specify database data types which are used to identify the generic SQL types. The definition is based on JDBC 3.0.
Deferrability indicates the Deferrability of key constraints.
FetchDirection indicates in which direction a resultset should fetch next, just for optimization.
IndexType indicates the type of index.
KeyRule determines the rules for foreign key constraints.
ProcedureColumn indicates the type of a procedure column.
ProcedureResult determines whether a procedure returns a result or not.
ResultSetConcurrency describes the different scroll capabilities of a result set.
ResultSetType describes the different scroll capabilities of a result set.
TransactionIsolation distinguishes different possible transaction isolation levels.
Top of Page

Apache Software Foundation

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

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. 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.