# Features

Feature List
Limitations
Comparison to Other Database Engines
H2 in Use
Connection Modes
Database URL Overview
Memory-Only Databases
Connecting to a Database with File Encryption
Database File Locking
Opening a Database Only if it Already Exists
Closing the Database
Log Index Changes
Custom File Access Mode
Multiple Connections
Database File Layout
Logging and Recovery
Compatibility
Using the Trace Options
Using Other Logging APIs
Read Only Databases
Read Only Databases in Zip or Jar File
Binary and Text Storage Formats
Graceful Handling of Low Disk Space Situations
Computed Columns / Function Based Index
Multi-Dimensional Indexes
Using Passwords
User-Defined Functions and Stored Procedures
Triggers
Compacting a Database
Cache Settings

## Feature List

### Main Features

- Very fast database engine
- Free, with source code
- Written in Java
- Supports standard SQL, JDBC API
- Embedded and Server mode, Clustering support
- Strong security features
- The PostgreSQL ODBC driver can be used
- Multi version concurrency

### Additional Features

- Disk based or in-memory databases and tables, read-only database support, temporary tables
- Transaction support (read committed and serializable transaction isolation), 2-phase-commit
- Multiple connections, table level locking
- Cost based optimizer, using a genetic algorithm for complex queries, zero-administration
- Scrollable and updatable result set support, large result set, external result sorting, functions can return a result set
- Encrypted database (AES or XTEA), SHA-256 password encryption, encryption functions, SSL

### SQL Support

- Support for multiple schemas, information schema
- Referential integrity / foreign key constraints with cascade, check constraints
- Inner and outer joins, subqueries, read only views and inline views
- Triggers and Java functions / stored procedures
- Many built-in functions, including XML and lossless data compression
- Wide range of data types including large objects (BLOB/CLOB) and arrays
- Sequence and autoincrement columns, computed columns (can be used for function based indexes)
- ORDER BY, GROUP BY, HAVING, UNION, LIMIT, TOP
- Collation support, users, roles
- Compatibility modes for HSQLDB, MySQL and PostgreSQL

### Security Features

- Includes a solution for the SQL injection problem
- User password authenticated uses SHA-256 and salt
- User passwords are never transmitted in plain text over the network (even when using insecure connections)
- All database files (including script files that can be used to backup data) can be encrypted using AES-256 and XTEA encryption algorithms
- The remote JDBC driver supports TCP/IP connections over SSL/TLS
- The built-in web server supports connections over SSL/TLS
- Passwords can be sent to the database using char arrays instead of Strings

### Other Features and Tools

- Small footprint (smaller than 1 MB), low memory requirements
- Multiple index types (b-tree, tree, hash)
- Support for multi-dimensional indexes
- CSV (comma separated values) file support
- Support for linked tables, and a built-in virtual 'range' table
- EXPLAIN PLAN support, sophisticated trace options
- Database closing can be delayed or disabled to improve the performance
- Web-based Console application (English, German, partially French and Spanish) with autocomplete
- The database can generate SQL script files
- Contains a recovery tool that can dump the contents of the data file
- Support for variables (for example to calculate running totals)
- Automatic re-compilation of prepared statements
- Uses a small number of database files, binary and text storage formats, graceful handling of low disk space situations
- Uses a checksum for each record and log entry for data integrity
- Well tested (high code coverage, randomized stress tests)

## Limitations

For the list of limitations, please have a look at the road map page at: http://groups.google.com/group/h2-database/web/roadmap

## Comparison to Other Database Engines

Feature | H2 | Derby | HSQLDB | MySQL | PostgreSQL
--- | --- | --- | --- | --- | ---
Pure Java | Yes | Yes | Yes | No | No
Embedded Mode (Java) | Yes | Yes | Yes | No | No
Performance (Embedded) | Fast | Slow | Fast | N/A | N/A
In-Memory Mode | Yes | No | Yes | No | No
Transaction Isolation | Yes | Yes | No | Yes | Yes
Cost Based Optimizer | Yes | Yes | No | Yes | Yes
Clustering | Yes | No | No | Yes | Yes
Encrypted Database | Yes | Yes | No | No | No
Linked Tables | Yes | No | Partially *1 | Partially *2 | No
ODBC Driver | Yes | Yes? | No | Yes | Yes
Fulltext Search | Yes | No | No | Yes | Yes
User-Defined Datatypes | Yes | No | No | Yes | Yes
Files per Database | Few | Many | Few | Many | Many
Table Level Locking | Yes | Yes | No | Yes | Yes
Row Level Locking | No | Yes | No | Yes | Yes
Multi Version Concurrency | Yes | No | No | No | Yes
Role Based Security | Yes | Yes *3 | Yes | Yes | Yes
Updatable Result Sets | Yes | Yes | No | Yes | Yes
Sequences | Yes | No | Yes | No | Yes
Limit and Offset | Yes | No | Yes | Yes | Yes
Temporary Tables | Yes | Yes *4 | Yes | Yes | Yes
Computed Columns | Yes | No | No | No | Yes *6
Case Insensitive Columns | Yes | No | Yes | Yes | Yes *6
Custom Aggregate Functions | Yes | No | No | Yes | Yes
Footprint (jar/dll size) | ~1 MB *5 | ~2 MB | ~600 KB | ~4 MB | ~6 MB

*1 HSQLDB supports text tables.
*2 MySQL supports linked MySQL tables under the name 'federated tables'.
*3 Derby support for roles based security and password checking as an option.
*4 Derby only supports global temporary tables.
*5 The default H2 jar file contains debug information, jar files for other databases do not.
*6 PostgreSQL supports functional indexes.

### Derby and HSQLDB

After an unexpected process termination (for example power failure), H2 can recover safely and automatically without any user interaction. For Derby and HSQLDB, there are some manual steps required ('Another instance of Derby may have already booted the database' / 'The database is already in use by another process').

### DaffodilDb and One$Db

It looks like the development of this database has stopped. The last release was February 2006.

### McKoi

It looks like the development of this database has stopped. The last release was August 2004

## H2 in Use

For a list of applications that work with or use H2, see: Links.

## Connection Modes

The following connection modes are supported:

- Embedded mode (local connections using JDBC)
- Remote mode (remote connections using JDBC or ODBC over TCP/IP)
- Mixed mode (local and remote connections at the same time)

### Embedded Mode

In embedded mode, an application opens a database from within the same JVM using JDBC. This is the fastest and easiest connection mode. The disadvantage is that a database may only be open in one virtual machine (and class loader) at any time. As in all modes, both persistent and in-memory databases are supported. There is no limit on the number of database open concurrently, or on the number of open connections.

### Remote Mode

When using the remote mode (sometimes called client/server mode), an application opens a database remotely using the JDBC or ODBC API. A server needs to be started within the same or another virtual machine (or on another computer). Many applications can connect to the same database at the same time. The remote mode is slower than the embedded mode, because all data is transferred over TCP/IP. As in all modes, both persistent and in-memory databases are supported. There is no limit on the number of database open concurrently, or on the number of open connections.

### Mixed Mode

The mixed mode is a combination of the embedded and the remote mode. The main application connects to a database in embedded mode, but also starts a server so that other applications (running in different virtual machines) can concurrently access the same data.

## Database URL Overview

This database supports multiple connection modes and connection settings. This is achieved using different database URLs. Settings in the URLs are not case sensitive.

Topic | URL Format and Examples
--- | ---
Embedded (local) connection | jdbc:h2:[file:][<path>]<databaseName> jdbc:h2:~/test jdbc:h2:file:/data/sample jdbc:h2:file:C:/data/sample (Windows only)
In-Memory (private) | jdbc:h2:mem:
In-Memory (named) | jdbc:h2:mem:<databaseName> jdbc:h2:mem:test_mem
Remote using TCP/IP | jdbc:h2:tcp://<server>[:<port>]/<databaseName> jdbc:h2:tcp://localhost/~/test jdbc:h2:tcp://dbserv:8084/~/sample
Remote using SSL/TLS | jdbc:h2:ssl://<server>[:<port>]/<databaseName> jdbc:h2:ssl://secureserv:8085/~/sample;
Using Encrypted Files | jdbc:h2:<url>;CIPHER=[AES|XTEA] jdbc:h2:ssl://secureserv/~/testdb;CIPHER=AES jdbc:h2:file:~/secure;CIPHER=XTEA
File Locking Methods | jdbc:h2:<url>;FILE_LOCK={NO|FILE|SOCKET} jdbc:h2:file:~/quickAndDirty;FILE_LOCK=NO jdbc:h2:file:~/private;CIPHER=XTEA;FILE_LOCK=SOCKET
Only Open if it Already Exists | jdbc:h2:<url>;IFEXISTS=TRUE jdbc:h2:file:~/sample;IFEXISTS=TRUE
Don't Close the Database when the VM Exits | jdbc:h2:<url>;DB_CLOSE_ON_EXIT=FALSE
User Name and/or Password | jdbc:h2:<url>[;USER=<username>][;PASSWORD=<value>] jdbc:h2:file:~/sample;USER=sa;PASSWORD=123
Log Index Changes | jdbc:h2:<url>;LOG=2 jdbc:h2:file:~/sample;LOG=2
Debug Trace Settings | jdbc:h2:<url>;TRACE_LEVEL_FILE=<level 0..3> jdbc:h2:file:~/sample;TRACE_LEVEL_FILE=3
Ignore Unknown Settings | jdbc:h2:<url>;IGNORE_UNKNOWN_SETTINGS=TRUE
Custom File Access Mode | jdbc:h2:<url>;ACCESS_MODE_LOG=rws;ACCESS_MODE_DATA=rws
In-Memory (private) | jdbc:h2:mem:
Database in or Zip File | jdbc:h2:zip:<zipFileName>!/<databaseName> jdbc:h2:zip:~/db.zip!/test
Changing Other Settings | jdbc:h2:<url>;<setting>=<value>[;<setting>=<value>...] jdbc:h2:file:~/sample;TRACE_LEVEL_SYSTEM_OUT=3

### Connecting to an Embedded (Local) Database

The database URL for connecting to a local database is `jdbc:h2:[file:][<path>]<databaseName>`. The prefix `file:` is optional. If no or only a relative path is used, then the current working directory is used as a starting point. The case sensitivity of the path and database name depend on the operating system, however it is recommended to use lowercase letters only. The database name must be at least three characters long (a limitation of File.createTempFile). To point to the user home directory, use ~/, as in: jdbc:h2:~/test.

## Memory-Only Databases

For certain use cases (for example: rapid prototyping, testing, high performance operations, read-only databases), it may not be required to persist (changes to) the data at all. This database supports the memory-only mode, where the data is not persisted.

In some cases, only one connection to a memory-only database is required. This means the database to be opened is private. In this case, the database URL is `jdbc:h2:mem:` Opening two connections within the same virtual machine means opening two different (private) databases.

Sometimes multiple connections to the same memory-only database are required. In this case, the database URL must include a name. Example: `jdbc:h2:mem:db1`. Accessing the same database in this way only works within the same virtual machine and class loader environment.

It is also possible to access a memory-only database remotely (or from multiple processes in the same machine) using TCP/IP or SSL/TLS. An example database URL is: `jdbc:h2:tcp://localhost/mem:db1` (using private database remotely is also possible).

By default, when the last connection to a in-memory database is closed, the contents are lost. This can be disabled by adding ;DB_CLOSE_DELAY=-1 to the database URL. That means to keep the contents of an in-memory database as long as the virtual machine is alive, use jdbc:h2:mem:test;DB_CLOSE_DELAY=-1

## Connecting to a Database with File Encryption

To use file encryption, it is required to specify the encryption algorithm (the 'cipher') and the file password. The algorithm needs to be specified using the connection parameter. Two algorithms are supported: XTEA and AES. The file password is specified in the password field, before the user password. A single space needs to be added between the file password and the user password; the file password itself may not contain spaces. File passwords (as well as user passwords) are case sensitive. Here is an example to connect to a password-encrypted database:

    Class.forName("org.h2.Driver");
    String url = "jdbc:h2:~/test;CIPHER=AES";
    String user = "sa";
    String pwds = "filepwd userpwd";
    conn = DriverManager.
        getConnection(url, user, pwds);

## Database File Locking

Whenever a database is opened, a lock file is created to signal other processes that the database is in use. If database is closed, or if the process that opened the database terminates, this lock file is deleted.

The following file locking methods are implemented:

- The default method is 'file' and uses a watchdog thread to protect the database file. The watchdog reads the lock file each second.
- The second method is 'socket' and opens a server socket. The socket method does not require reading the lock file every second. The socket method should only be used if the database files are only accessed by the one (and always the same) computer.
- It is also possible to open the database without file locking; in this case it is up to the application to protect the database files.

To open the database with a different file locking method, use the parameter 'FILE_LOCK'. The following code opens the database with the 'socket' locking method:

    String url = "jdbc:h2:~/test;FILE_LOCK=SOCKET";

The following code forces the database to not create a lock file at all. Please note that this is unsafe as another process is able to open the same database, possibly leading to data corruption:

    String url = "jdbc:h2:~/test;FILE_LOCK=NO";

For more information about the algorithms please see in Advanced Topics under File Locking Protocol.

## Opening a Database Only if it Already Exists

By default, when an application calls `DriverManager.getConnection(url,...)` and the database specified in the URL does not yet exist, a new (empty) database is created. In some situations, it is better to restrict creating new database, and only open the database if it already exists. This can be done by adding `;ifexists=true` to the URL. In this case, if the database does not already exist, an exception is thrown when trying to connect. The connection only succeeds when the database already exists. The complete URL may look like this:

    String url = "jdbc:h2:/data/sample;IFEXISTS=TRUE";

## Closing the Database

### Delayed Database Closing

Usually, the database is closed when the last connection to it is closed. In some situations this slows down the application, for example when it is not possible leave the connection open. The automatic closing of the database can be delayed or disabled with the SQL statement SET DB_CLOSE_DELAY <seconds>. The seconds specifies the number of seconds to keep a database open after the last connection to it was closed. For example the following statement will keep the database open for 10 seconds:

    SET DB_CLOSE_DELAY 10

The value -1 means the database is never closed automatically. The value 0 is the default and means the database is closed when the last connection is closed. This setting is persistent and can be set by an administrator only. It is possible to set the value in the database URL: `jdbc:h2:~/test;DB_CLOSE_DELAY=10`.

### Don't Close the Database when the VM Exits

By default, a database is closed when the last connection is closed. However, if it is never closed, the database is closed when the virtual machine exits normally. This is done using a shutdown hook. In some situations, the database should not be closed in this case, for example because the database is still used at virtual machine shutdown (to store the shutdown process in the database for example). For those cases, the automatic closing of the database can be disabled in the database URL. The first connection (the one that is opening the database) needs to set the option in the database URL (it is not possible to change the setting afterwards). The database URL to disable database closing on exit is:

    String url = "jdbc:h2:~/test;DB_CLOSE_ON_EXIT=FALSE";

## Log Index Changes

Usually, changes to the index file are not logged for performance. If the index file is corrupt or missing when opening a database, it is re-created from the data. The index file can get corrupt when the database is not shut down correctly, because of power failure or abnormal program termination. In some situations, for example when using very large databases (over a few hundred MB), re-creating the index file takes very long. In these situations it may be better to log changes to the index file, so that recovery from a corrupted index file is fast. To enable log index changes, add LOG=2 to the URL, as in jdbc:h2:~/test;LOG=2 This setting should be specified when connecting. The update performance of the database will be reduced when using this option.

### Ignore Unknown Settings

Some applications (for example OpenOffice.org Base) pass some additional parameters when connecting to the database. Why those parameters are passed is unknown. The parameters PREFERDOSLIKELINEENDS and IGNOREDRIVERPRIVILEGES are such examples; they are simply ignored to improve the compatibility with OpenOffice.org. If an application passes other parameters when connecting to the database, usually the database throws an exception saying the parameter is not supported. It is possible to ignored such parameters by adding ;IGNORE_UNKNOWN_SETTINGS=TRUE to the database URL.

### Changing Other Settings when Opening a Connection

In addition to the settings already described (cipher, file_lock, ifexists, user, password), other database settings can be passed in the database URL. Adding `setting=value` at the end of an URL is the same as executing the statement `SET setting value` just after connecting. For a list of settings supported by this database please see the SQL grammar documentation.

## Custom File Access Mode

Usually, the database opens log, data and index files with the access mode 'rw', meaning read-write (except for read only databases, where the mode 'r' is used). To open a database in read-only mode if the files are not read-only, use ACCESS_MODE_DATA=r. Also supported are 'rws' and 'rwd'. The access mode used for log files is set via ACCESS_MODE_LOG; for data and index files use ACCESS_MODE_DATA. These settings must be specified in the database URL:

    String url = "jdbc:h2:~/test;ACCESS_MODE_LOG=rws;ACCESS_MODE_DATA=rws";

For more information see Durability Problems. On many operating systems the access mode 'rws' does not guarantee that the data is written to the disk.

## Multiple Connections

### Opening Multiple Databases at the Same Time

An application can open multiple databases at the same time, including multiple connections to the same database. The number of open database is only limited by the memory available.

### Multiple Connections to the Same Database: Client/Server

If you want to access the same database at the same time from different processes or computers, you need to use the client / server mode. In this case, one process acts as the server, and the other processes (that could reside on other computers as well) connect to the server via TCP/IP (or SSL/TLS over TCP/IP for improved security).

### Multithreading Support

This database is multithreading-safe. That means, if an application is multi-threaded, it does not need o worry about synchronizing the access to the database. Internally, most requests to the same database are synchronized. That means an application can use multiple threads accessing the same database at the same time, however if one thread executes a long running query, the other threads need to wait.

### Locking, Lock-Timeout, Deadlocks

The database uses table level locks to give each connection a consistent state of the data. There are two kinds of locks: read locks (shared locks) and write locks (exclusive locks). If a connection wants to reads from a table, and there is no write lock on the table, then a read lock is added to the table. If there is a write lock, then this connection waits for the other connection to release the lock. If connection cannot get a lock for a specified time, then a lock timeout exception is thrown.

Usually, SELECT statement will generate read locks. This includes subqueries. Statements that modify data use write locks. It is also possible to lock a table exclusively without modifying data, using the statement SELECT ... FOR UPDATE. The statements COMMIT and ROLLBACK releases all open locks. The commands SAVEPOINT and ROLLBACK TO SAVEPOINT don't affect locks. The locks are also released when the autocommit mode changes, and for connections with autocommit set to true (this is the default), locks are released after each statement. Here is an overview on what statements generate what type of lock:

Type of Lock | SQL Statement
--- | ---
Read | SELECT * FROM TEST CALL SELECT MAX(ID) FROM TEST SCRIPT
Write | SELECT * FROM TEST WHERE 1=0 FOR UPDATE
Write | INSERT INTO TEST VALUES(1, 'Hello') INSERT INTO TEST SELECT * FROM TEST UPDATE TEST SET NAME='Hi' DELETE FROM TEST
Write | ALTER TABLE TEST ... CREATE INDEX ... ON TEST ... DROP INDEX ...

The number of seconds until a lock timeout exception is thrown can be set separately for each connection using the SQL command SET LOCK_TIMEOUT <milliseconds>. The initial lock timeout (that is the timeout used for new connections) can be set using the SQL command SET DEFAULT_LOCK_TIMEOUT <milliseconds>. The default lock timeout is persistent.

## Database File Layout

There are a number of files created for persistent databases. Other than some databases, not every table and/or index is stored in its own file. Instead, usually only the following files are created: A data file, an index file, a log file, and a database lock file (exists only while the database is in use). In addition to that, a file is created for each large object (CLOB/BLOB), a file for each linear index, and temporary files for large result sets. Then the command SCRIPT can create script files. If the database trace option is enabled, trace files are created. The following files can be created by the database:

File Name | Description | Number of Files
--- | --- | ---
test.data.db | Data file Contains the data for all tables Format: <database>.data.db | 1 per database
test.index.db | Index file Contains the data for all (btree) indexes Format: <database>.index.db | 1 per database
test.0.log.db | Log file The log file is used for recovery Format: <database>.<id>.log.db | 0 or more per database
test.lock.db | Database lock file Exists only if the database is open Format: <database>.lock.db | 1 per database
test.trace.db | Trace file Contains trace information Format: <database>.trace.db If the file is too big, it is renamed to <database>.trace.db.old | 1 per database
test.14.15.lob.db | Large object Contains the data for BLOB or CLOB Format: <database>.<tableid>.<id>.lob.db | 1 per object
test.123.temp.db | Temporary file Contains a temporary blob or a large result set Format: <database>.<session id>.<object id>.temp.db | 1 per object
test.7.hash.db | Hash index file Contains the data for a linear hash index Format: <database>.<object id>.hash.db | 1 per linear hash index

### Moving and Renaming Database Files

Database name and location are not stored inside the database names.

While a database is closed, the files can be moved to another directory, and they can be renamed as well (as long as all files start with the same name).

As there is no platform specific data in the files, they can be moved to other operating systems without problems.

### Backup

When the database is closed, it is possible to backup the database files. Please note that index files do not need to be backed up, because they contain redundant data, and will be recreated automatically if they don't exist.

To backup data while the database is running, the SQL command SCRIPT can be used.

## Logging and Recovery

Whenever data is modified in the database and those changes are committed, the changes are logged to disk (except for in-memory objects). The changes to the data file itself are usually written later on, to optimize disk access. If there is a power failure, the data and index files are not up-to-date. But because the changes are in the log file, the next time the database is opened, the changes that are in the log file are re-applied automatically.

Please note that index file updates are not logged by default. If the database is opened and recovery is required, the index file is rebuilt from scratch.

There is usually only one log file per database. This file grows until the database is closed successfully, and is then deleted. Or, if the file gets too big, the database switches to another log file (with a higher id). It is possible to force the log switching by using the CHECKPOINT command.

If the database file is corrupted, because the checksum of a record does not match (for example, if the file was edited with another application), the database can be opened in recovery mode. In this case, errors in the database are logged but not thrown. The database should be backed up to a script and re-built as soon as possible. To open the database in the recovery mode, use a database URL must contain RECOVER=1, as in jdbc:h2:~/test;RECOVER=1. Indexes are rebuilt in this case, and the summary (object allocation table) is not read in this case, so opening the database takes longer.

## Compatibility

All database engines behave a little bit different. Where possible, H2 supports the ANSI SQL standard, and tries to be compatible to other databases. There are still a few differences however:

In MySQL text columns are case insensitive by default, while in H2 they are case sensitive. However H2 supports case insensitive columns as well. To create the tables with case insensitive texts, append IGNORECASE=TRUE to the database URL (example: jdbc:h2:~/test;IGNORECASE=TRUE).

### Compatibility Modes

For certain features, this database can emulate the behavior of specific databases. Not all features or differences of those databases are implemented. Here is the list of currently supported modes and the difference to the regular mode:

### PostgreSQL Compatibility Mode

To use the PostgreSQL mode, use the database URL `jdbc:h2:~/test;MODE=PostgreSQL` or the SQL statement `SET MODE PostgreSQL`.

- Concatenation of a NULL with another value results in NULL. Usually, the NULL is treated as an empty string if only one of the operators is NULL, and NULL is only returned if both values are NULL.
- When converting a floating point number to a integer, the fractional digits should not be truncated, but the value should be rounded.
- The system columns 'CTID' and 'OID' should be supported.

### MySQL Compatibility Mode

To use the MySQL mode, use the database URL `jdbc:h2:~/test;MODE=MySQL` or the SQL statement `SET MODE MySQL`.

- When inserting data, if a column is defined to be NOT NULL and NULL is inserted, then a 0 (or empty string, or the current timestamp for timestamp columns) value is used. Usually, this operation is not allowed and an exception is thrown.
- When converting a floating point number to a integer, the fractional digits should not be truncated, but the value should be rounded.
- The identifiers should be returned in lower case.
- Creating indexes in the CREATE TABLE statement should be supported.

### HSQLDB Compatibility Mode

To use the HSQLDB mode, use the database URL `jdbc:h2:~/test;MODE=HSQLDB` or the SQL statement `SET MODE HSQLDB`.

- Concatenation of a NULL with another value results in NULL. Usually, the NULL is treated as an empty string if only one of the operators is NULL, and NULL is only returned if both values are NULL.
- When converting the scale of decimal data, the number is only converted if the new scale is smaller then current scale. Usually, the scale is converted and 0s are added if required.
- When using unique indexes, multiple rows with NULL in one of the columns are allowed by default. However many databases view NULL as distinct in this regard and only allow one row with NULL.

### MS SQL Server Compatibility Mode

To use the MS SQL Server mode, use the database URL `jdbc:h2:~/test;MODE=MSSQLServer` or the SQL statement `SET MODE MSSQLServer`.

- Identifiers may be quoted using square brackets as in [Test].
- When using unique indexes, multiple rows with NULL in one of the columns are allowed by default. However many databases view NULL as distinct in this regard and only allow one row with NULL.

### Derby Compatibility Mode

To use the Derby mode, use the database URL `jdbc:h2:~/test;MODE=Derby` or the SQL statement `SET MODE Derby`.

- When using unique indexes, multiple rows with NULL in one of the columns are allowed by default. However many databases view NULL as distinct in this regard and only allow one row with NULL.

### Oracle Compatibility Mode

To use the Oracle mode, use the database URL `jdbc:h2:~/test;MODE=Oracle` or the SQL statement `SET MODE Oracle`.

- When using unique indexes, multiple rows with NULL in one of the columns are allowed by default. However many databases view NULL as distinct in this regard and only allow one row with NULL.

## Using the Trace Options

To find problems in an application, it is sometimes good to see what database operations where executed. This database offers the following trace features:

- Trace to System.out and/or a file
- Support for trace levels OFF, ERROR, INFO, and DEBUG
- The maximum size of the trace file can be set
- The Java code generation is possible
- Trace can be enabled at runtime by manually creating a file

### Trace Options

The simplest way to enable the trace option is setting it in the database URL. There are two settings, one for System.out (TRACE_LEVEL_SYSTEM_OUT) tracing, and one for file tracing (TRACE_LEVEL_FILE). The trace levels are 0 for OFF, 1 for ERROR (the default), 2 for INFO and 3 for DEBUG. A database URL with both levels set to DEBUG is:

    jdbc:h2:~/test;TRACE_LEVEL_FILE=3;TRACE_LEVEL_SYSTEM_OUT=3

The trace level can be changed at runtime by executing the SQL command `SET TRACE_LEVEL_SYSTEM_OUT level` (for System.out tracing) or `SET TRACE_LEVEL_FILE level` (for file tracing). Example:

    SET TRACE_LEVEL_SYSTEM_OUT 3

### Setting the Maximum Size of the Trace File

When using a high trace level, the trace file can get very big quickly. The size of the file can be limited by executing the SQL statement `SET TRACE_MAX_FILE_SIZE maximumFileSizeInMB`. If the log file exceeds the limit, the file is renamed to .old and a new file is created. If another .old file exists, it is deleted. The default setting is 16 MB. Example:

    SET TRACE_MAX_FILE_SIZE 1

### Java Code Generation

When setting the trace level to INFO or DEBUG, Java source code is generated as well, so that problem can be reproduced more easily. The trace file looks like this:

    ...
    12-20 20:58:09 jdbc[0]:
    /**/dbMeta3.getURL();
    12-20 20:58:09 jdbc[0]:
    /**/dbMeta3.getTables(null, "", null, new String[]{"TABLE", "VIEW"});
    ...

You need to filter out the lines without /**/ to get the Java source code. In Windows, a simple way to do that is:

    find "**" test.trace.db > Trace.java

Afterwards, you need to complete the file Trace.java before it can be compiled, for example with:

    import java.sql.*;
    public class Trace { public static void main(String[]a)throws Exception {
    Class.forName("org.h2.Driver");
    ...
    }}

Also, the user name and password needs to be set, because they are not listed in the trace file.

### Enabling the Trace Option at Runtime by Manually Creating a File

Sometimes, you can't or don't want to change the application or database URL. There is still a way to enable the trace mode in these cases, even at runtime (while the database connection is open). You only need to create a special file in the directory where the database files are stored. The database engine checks every 4 seconds if this file exists (only while executing a statement). The file name is the database name plus '.trace.db.start'. This feature is disabled if the database is encrypted.

Example: if a database is called 'test', then the file to start tracing is 'test.trace.db.start'. The database engine tries to delete this file when it detects it. If trace is enabled using the start file, the trace level is not persistent to the database, and trace is switched back to the level that was set before when connecting to the database. However, if the start file is read only, the database engine cannot delete the file and will always enable the trace mode when connecting.

## Using Other Logging APIs

By default, this database uses its own native 'trace' facility. This facility is called 'trace' and not 'log' within this database to avoid confusion with the transaction log. Trace messages can be written to both file and System.out. In most cases, this is sufficient, however sometimes it is better to use the same facility as the application, for example Log4j. To do that, this database support SLF4J.

SLF4J is a simple facade for various logging APIs and allows to plug in the desired implementation at deployment time. SLF4J supports implementations such as Logback, Log4j, Jakarta Commons Logging (JCL), JDK 1.4 logging, x4juli, and Simple Log.

To enable SLF4J, set the file trace level to 4 in the database URL:

    jdbc:h2:~/test;TRACE_LEVEL_FILE=4

Changing the log mechanism is not possible after the database is open, that means executing the SQL statement SET TRACE_LEVEL_FILE 4 when the database is already open will not have the desired effect. To use SLF4J, all required jar files need to be in the classpath. If it does not work, check in the file <database>.trace.db for error messages.

## Read Only Databases

If the database files are read-only, then the database is read-only as well. It is not possible to create new tables, add or modify data in this database. Only SELECT statements are allowed. To create a read-only database, close the database so that the log file gets smaller. Do not delete the log file. Then, make the database files read-only using the operating system. When you open the database now, it is read-only. There are two ways an application can find out a database is read-only: By calling Connection.isReadOnly() or by executing the SQL statement CALL READONLY().

## Read Only Databases in Zip or Jar File

To create a read-only database in a zip, first create a regular persistent database, and then create a backup. If you are using a database named 'test', an easy way to do that is using the Backup tool or the BACKUP SQL statement:

    BACKUP TO 'data.zip'

The database must not have pending changes, that means you need to close all connections to the database, open one single connection, and then execute the statement. Afterwards, you can log out, and directly open the database in the zip file using the following database URL:

    jdbc:h2:zip:~/data.zip!/test

Databases in a zip file are read-only. The performance for some queries will be slower than when using a regular database, because random access in zip files is not supported (only streaming). How much this affects the performance depends on the queries and the data. The database is not read in memory; so large databases are supported as well. The same indexes are used than when using a regular database.

## Binary and Text Storage Formats

This database engine supports both binary and text storage formats. The binary format is faster, but the text storage format can be useful as well, for example to debug the database engine. If a database already exists, the storage format is recognized automatically. New databases are created in the binary storage format by default. To create a new database in the text storage format, the database URL must contain the parameter STORAGE=TEXT. Example URL: jdbc:h2:~/test;STORAGE=TEXT

## Graceful Handling of Low Disk Space Situations

The database is able to deal with situations where the disk space available is running low. Whenever the database starts, an 'emergency space' file is created (size is 1 MB), and if there is no more space available, the file will shrink. If the space available is lower than 128 KB, the database will go into a special read only mode, where writing operations are no longer allowed: All writing operations will throw the exception 'No disk space available' from this point on. To go back to the normal operating mode, all connections to the database need to be closed first, and space needs to be freed up.

It is possible to install a database event listener to detect low disk space situations early on (when only 1 MB if space is available). To do this, use the SQL statement SET DATABASE_EVENT_LISTENER. The listener can also be set at connection time, using an URL of the form jdbc:h2:~/test;DATABASE_EVENT_LISTENER='com.acme.DbListener' (the quotes around the class name are required). See also the DatabaseEventListener API.

### Opening a Corrupted Database

If a database cannot be opened because the boot info (the SQL script that is run at startup) is corrupted, then the database can be opened by specifying a database event listener. The exceptions are logged, but opening the database will continue.

## Computed Columns / Function Based Index

Function indexes are not directly supported by this database, but they can be easily emulated by using computed columns. For example, if an index on the upper-case version of a column is required, just create a computed column with the upper-case version of the original column, and index this column:

    CREATE TABLE ADDRESS(
      ID INT PRIMARY KEY,
      NAME VARCHAR,
      UPPER_NAME VARCHAR AS UPPER(NAME)
    );
    CREATE INDEX IDX_U_NAME ON ADDRESS(UPPER_NAME);

When inserting data, it is not required (better: not allowed) to specify a value for the upper-case version of the column, because the value is generated. But you can use the column when querying the table:

    INSERT INTO ADDRESS(ID, NAME) VALUES(1, 'Miller');
    SELECT * FROM ADDRESS WHERE UPPER_NAME='MILLER';

## Multi-Dimensional Indexes

A tool is provided to execute efficient multi-dimension (spatial) range queries. This database does not support a specialized spatial index (R-Tree or similar). Instead, the B-Tree index is used. For each record, the multi-dimensional key is converted (mapped) to a single dimensional (scalar) value. This value specifies the location on a space-filling curve.

Currently, Z-order (also called N-order or Morton-order) is used; Hilbert curve could also be used, but the implementation is more complex. The algorithm to convert the multi-dimensional value is called bit-interleaving. The scalar value is indexed using a B-Tree index (usually using a computed column).

The method can result in a drastic performance improvement over just using an index on the first column. Depending on the data and number of dimensions, the improvement is usually higher than factor 5. The tool generates a SQL query from a specified multi-dimensional range. The method used is not database dependent, and the tool can easily be ported to other databases. For an example how to use the tool, please have a look at the sample code provided in TestMultiDimension.java.

## Using Passwords

### Using Secure Passwords

Remember that weak passwords can be broken no matter of the encryption and security protocol. Don't use passwords that can be found in a dictionary. Also appending numbers does not make them secure. A way to create good passwords that can be remembered is, take the first letters of a sentence, use upper and lower case characters, and creatively include special characters. Example:

i'sE2rtPiUKtT (it's easy to remember this password if you know the trick)

### Passwords: Using Char Arrays instead of Strings

Java Strings are immutable objects and cannot be safely 'destroyed' by the application. After creating a String, it will remain in the main memory of the computer at least until it is garbage collected. The garbage collection cannot be controlled by the application, and even if it is garbage collected the data may still remain in memory. It might also be possible that the part of memory containing the password is swapped to disk (because not enough main memory is available).

An attacker might have access to the swap file of the operating system. It is therefore a good idea to use char arrays instead of Strings to store passwords. Char arrays can be cleared (filled with zeros) after use, and therefore the password will not be stored in the swap file.

This database supports using char arrays instead of String to pass user and file passwords. The following code can be used to do that:

    Class.forName("org.h2.Driver");
    String url = "jdbc:h2:~/simple";
    String user = "sam";
    char[] password =
    {'t','i','a','S','&',E','t','r','p'};
    Properties prop = new Properties();
    prop.setProperty("user", user);
    prop.put("password", password);
    Connection conn = null;
    try {
        conn = DriverManager.
          getConnection(url, prop);
    } finally {
        Arrays.fill(password, 0);
    }

In this example, the password is hard code in the application, which is not secure of course. However, Java Swing supports a way to get passwords using a char array (JPasswordField).

### Passing the User Name and/or Password in the URL

Instead of passing the user name as a separate parameter as in `Connection conn = DriverManager. getConnection("jdbc:h2:~/test", "sa", "123");` the user name (and/or password) can be supplied in the URL itself: `Connection conn = DriverManager. getConnection("jdbc:h2:~/test;USER=sa;PASSWORD=123");` The settings in the URL override the settings passed as a separate parameter.

## User-Defined Functions and Stored Procedures

In addition to the built-in functions, this database supports user-defined Java functions. In this database, Java functions can be used as stored procedures as well. A function must be declared (registered) before it can be used. Only static Java methods are supported; both the class and the method must be public. Example Java method:

    package org.h2.samples;
    ...
    public class Function {
        public static boolean isPrime(int value) {
            return new BigInteger(String.valueOf(value)).isProbablePrime(100);
        }
    }

The Java function must be registered in the database by calling CREATE ALIAS:

    CREATE ALIAS IS_PRIME FOR "org.h2.samples.Function.isPrime"

For a complete sample application, see src/test/org/h2/samples/Function.java.

### Function Data Type Mapping

Functions that accept non-nullable parameters such as 'int' will not be called if one of those parameters is NULL. In this case, the value NULL is used as the result. If the function should be called in this case, you need to use 'java.lang.Integer' instead of 'int'.

### Functions that require a Connection

If the first parameter in a Java function is a java.sql.Connection, then the connection to database is provided. This connection does not need to be closed before returning.

### Functions throwing an Exception

If a function throws an Exception, then the current statement is rolled back and the exception is thrown to the application.

### Functions returning a Result Set

Functions may returns a result set. Such a function can be called with the CALL statement:

    public static ResultSet query(Connection conn, String sql) throws SQLException {
        return conn.createStatement().executeQuery(sql);
    }

    CREATE ALIAS QUERY FOR "org.h2.samples.Function.query";
    CALL QUERY('SELECT * FROM TEST');

### Using SimpleResultSet

A function that returns a result set can create this result set from scratch using the SimpleResultSet tool:

    import org.h2.tools.SimpleResultSet;
    ...
    public static ResultSet simpleResultSet() throws SQLException {
        SimpleResultSet rs = new SimpleResultSet();
        rs.addColumn("ID", Types.INTEGER, 10, 0);
        rs.addColumn("NAME", Types.VARCHAR, 255, 0);
        rs.addRow(new Object[] { new Integer(0), "Hello" });
        rs.addRow(new Object[] { new Integer(1), "World" });
        return rs;
    }

    CREATE ALIAS SIMPLE FOR "org.h2.samples.Function.simpleResultSet";
    CALL SIMPLE();

### Using a Function as a Table

A function returning a result set can be like a table. However, in this case the function is called at least twice: First while parsing the statement to collect the column names (with parameters set to null where not known at compile time). And then, while executing the statement to get the data (may be repeatedly if this is a join). If the function is called just to get the column list, the URL of the connection passed to the function is jdbc:columnlist:connection. Otherwise, the URL of the connection is jdbc:default:connection.

    public static ResultSet getMatrix(Integer id) throws SQLException {
        SimpleResultSet rs = new SimpleResultSet();
        rs.addColumn("X", Types.INTEGER, 10, 0);
        rs.addColumn("Y", Types.INTEGER, 10, 0);
        if(id == null) {
            return rs;
        }
        for(int x = 0; x < id.intValue(); x++) {
            for(int y = 0; y < id.intValue(); y++) {
                rs.addRow(new Object[] { new Integer(x), new Integer(y) });
            }
          }
        return rs;
    }

    CREATE ALIAS MATRIX FOR "org.h2.samples.Function.getMatrix";
    SELECT * FROM MATRIX(3) WHERE X>0;

## Triggers

This database supports Java triggers that are called before or after a row is updated, inserted or deleted. Triggers can be used for complex consistency checks, or to update related data in the database. It is also possible to use triggers to simulate materialized views. For a complete sample application, see src/test/org/h2/samples/TriggerSample.java. A Java trigger must implement the interface org.h2.api.Trigger:

    import org.h2.api.Trigger;
    ...
    public class TriggerSample implements Trigger {
        public void init(String triggerName, String tableName) {
        }
        public void fire(Connection conn,
                Object[] oldRow, Object[] newRow)
                throws SQLException {
        }
    }

The connection can be used to query or update data in other tables. The trigger then needs to be defined in the database:

    CREATE TRIGGER INV_INS AFTER INSERT ON INVOICE
      FOR EACH ROW CALL "org.h2.samples.TriggerSample"

The trigger can be used to veto a change, by throwing a SQL Exception.

## Compacting a Database

Empty space in the database file is re-used automatically. To re-build the indexes, the simplest way is to delete the .index.db file while the database is closed. However in some situations (for example after deleting a lot of data in a database), one sometimes wants to shrink the size of the database (compact a database). Here is a sample function to do this:

    public static void compact(String dir, String dbName,
            String user, String password) throws Exception {
        String url = "jdbc:h2:" + dir + "/" + dbName;
        String file = "data/test.sql";
        Script.execute(url, user, password, file);
        DeleteDbFiles.execute(dir, dbName, true);
        RunScript.execute(url, user, password, file, null, false);
    }

See also the sample application org.h2.samples.Compact. The commands SCRIPT / RUNSCRIPT can be used as well to create a backup of a database and re-build the database from the script.

## Cache Settings

The database keeps most frequently used data and index pages in the main memory. The amount of memory used for caching can be changed using the setting CACHE_SIZE. This setting can be set in the database connection URL (jdbc:h2:~/test;CACHE_SIZE=131072), or it can be changed at runtime using SET CACHE_SIZE size.

This database supports two cache page replacement algorithms: LRU (the default) and 2Q. For LRU, the pages that were least frequently used are removed from the cache if it becomes full. The 2Q algorithm is a bit more complicated: basically two queues are used. The 2Q algorithm is more resistant to table scans, however the overhead is a bit higher compared to the LRU. To use the cache algorithm 2Q, use a database URL of the form jdbc:h2:~/test;CACHE_TYPE=TQ. The cache algorithm cannot be changed once the database is open.

To get information about page reads and writes, and the current caching algorithm in use, call SELECT * FROM INFORMATION_SCHEMA.SETTINGS. The number of pages read / written is listed for the data and index file.