## hsqldb v.1.61 Source Documentation

### Package documentation

This 'javadoc' documentation contains information about the JDBC interface of hsqldb v.1.61. Things that are specific to hsqldb v.1.61 are green. Additionally the Servlet, the WebServer and the Profile classes are documented:

hsqldb v.1.61 API Index

### Components of Hypersonic SQL

#### Demonstration programs and Tools

- hsqldbServlet The main servlet file (simply extends hsql.org.Servlet)
- CodeSwitcher Can modify source code
- DatabaseManager Database administration tool
- Transfer Can transfer from one to another database
- Grid AWT Grid component
- Tree AWT Tree component
- PerformanceTest Small Benchmark program
- QueryTool Simple statement processor
- SelfTest Used to test main database functions
- FindFile Demo application to find files

#### JDBC Driver classes

- jdbcConnection Implements the Connecion interface
- jdbcDatabaseMetaData Implements the DatabaseMetaData interface
- jdbcDriver Implements the Driver interface
- jdbcPreparedStatement Implements the PreparedStatement and the CallableStatement interfaces
- jdbcResultSet Implements the ResultSet and the ResultSetMetaData interfaces
- jdbcStatement Implements the Statement interface

#### Database Engine

- Access Encapsulates access rights (together with User)
- ByteArray Helper class for serialization and byte[]
- Cache Used to cache records in memory
- CacheFree A free cache item
- Channel An open database connection or session
- Column A table column object, and all data type specific code
- Database The main class, one object per database
- DatabaseInformation Helper class, creates meta data and script
- Expression Expression tree item
- Index Logic for the binary tree index
- Like Helper class to compare using the LIKE command
- Log Implements the databases file handling
- Node Node of an index
- Parser Engine to process SELECT, INSERT, UPDATE, DELETE
- Record Record in a linked list (used also in jdbc classes)
- Result The linked list (used also in jdbc classes)
- Row A Data Row
- Select SELECT statement and processor
- StringConverter Helper class to convert String
- Table Class representing a database table
- TableFilter Links to one table, including search conditions
- Tokenizer Used to process a statement
- Trace Error, trace and assert functions
- Transaction Represents a single transaction item (a row)
- User A database user including access rights

#### Utilities

- Profile Used to profile and test the engine
- Servlet A simple servlet that connects to one database
- WebServer Application that can be used as a HTTP and database server
- WebServerConnection A single connection to the WebServer

There are other files in the source directory, whose names should give some hint of their function. We are currently working on their documentation and use-cases. See the CHANGELOG and websites for early details.