提交 41a063a1 authored 作者: Thomas Mueller's avatar Thomas Mueller

--no commit message

--no commit message
上级 8ab34eda
......@@ -256,14 +256,18 @@
</copy>
</target>
<target name="javadocImpl">
<target name="javadocImpl" depends="javadoc">
<mkdir dir="docs/javadocImpl"/>
<javadoc
sourcepath="src/main"
packagenames="org.h2.*"
destDir="docs/javadocImpl"
classpath="${path.lucene.jar};${path.servlet.jar}"
/> <!-- doclet="org.h2.tools.doclet.Doclet" docletpath="bin"-->
destDir="docs/javadocImpl"
/>
<!--
doclet="org.h2.tools.doclet.Doclet" docletpath="bin"
additionalparam="-J-Dh2.interfacesOnly=true -J-Dh2.destDir=docs/javadocImpl"
-->
<copy todir="docs/javadoc">
<fileset dir="src/docsrc/javadoc" includes="**/*"/>
</copy>
......
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<!--
Copyright 2004-2007 H2 Group. Licensed under the H2 License, Version 1.0 (http://h2database.com/html/license.html).
<!--
Copyright 2004-2007 H2 Group. Licensed under the H2 License, Version 1.0 (http://h2database.com/html/license.html).
Initial Developer: H2 Group
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
......@@ -160,14 +160,14 @@ http://groups.google.com/group/h2-database/web/roadmap
<th>MySQL</th>
<th>PostgreSQL</th>
</tr><tr>
<td>Embedded Mode (Java)</td>
<td>Pure Java</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
<td class="compareN">No</td>
<td class="compareN">No</td>
</tr><tr>
<td>Pure Java</td>
<td>Embedded Mode (Java)</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
......@@ -181,6 +181,13 @@ http://groups.google.com/group/h2-database/web/roadmap
<td class="compareN">N/A</td>
<td class="compareN">N/A</td>
</tr><tr>
<td>In-Memory Mode</td>
<td class="compareY">Yes</td>
<td class="compareN">No</td>
<td class="compareY">Yes</td>
<td class="compareN">No</td>
<td class="compareN">No</td>
</tr><tr>
<td>Transaction Isolation</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
......@@ -209,6 +216,27 @@ http://groups.google.com/group/h2-database/web/roadmap
<td class="compareN">No</td>
<td class="compareN">No</td>
</tr><tr>
<td>ODBC Driver</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes?</td>
<td class="compareN">No</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
</tr><tr>
<td>Fulltext Search</td>
<td class="compareY">Yes</td>
<td class="compareN">No</td>
<td class="compareN">No</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
</tr><tr>
<td>User Defined Datatypes</td>
<td class="compareY">Yes</td>
<td class="compareN">No</td>
<td class="compareN">No</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
</tr><tr>
<td>Files per Database</td>
<td class="compareY">Few</td>
<td class="compareN">Many</td>
......@@ -227,9 +255,9 @@ http://groups.google.com/group/h2-database/web/roadmap
<h3>Derby and HSQLDB</h3>
<p>
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' /
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').
</p>
......@@ -258,7 +286,7 @@ http://groups.google.com/group/h2-database/web/h2-in-use
The following connection modes are supported:
</p>
<ul>
<li>Local connections using JDBC (embedded)
<li>Local connections using JDBC (embedded)
</li><li>Remote connections using JDBC over TCP/IP (client/server)
</li><li>Remote connections using ODBC over TCP/IP (client/server)
</li><li>In-Memory databases (private and shared)
......@@ -391,8 +419,8 @@ This is achieved using different database URLs. The settings in the URLs are not
<h3>Connecting to an Embedded (Local) Database</h3>
<p>
The database URL for connecting to a local database is <code>jdbc:h2:[file:][&lt;path&gt;]&lt;databaseName&gt;</code>.
The prefix <code>file:</code> 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
The prefix <code>file:</code> 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 suggested 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.
......@@ -402,7 +430,7 @@ To point to the user home directory, use ~/, as in: jdbc:h2:~/test.
<h2>Memory-Only Databases</h2>
<p>
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.
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.
</p><p>
In some cases, only one connection to a memory-only database is required.
......@@ -412,27 +440,27 @@ means opening two different (private) databases.
</p><p>
Sometimes multiple connections to the same memory-only database are required.
In this case, the database URL must include a name. Example: <code>jdbc:h2:mem:db1</code>.
Accessing the same database in this way only works within the same virtual machine and
Accessing the same database in this way only works within the same virtual machine and
class loader environment.
</p><p>
It is also possible to access a memory-only database remotely
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: <code>jdbc:h2:tcp://localhost/mem:db1</code>
(using private database remotely is also possible).
</p><p>
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
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
</p>
<br /><a name="file_encryption"></a>
<h2>Connecting to a Database with File Encryption</h2>
<p>
To use file encryption, it is required to specify the encryption algorithm (the 'cipher')
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
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:
......@@ -449,20 +477,20 @@ conn = DriverManager.
<br /><a name="database_file_locking"></a>
<h2>Database File Locking</h2>
<p>
Whenever a database is opened, a lock file is created to signal other processes
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 database terminates, this lock file is deleted.
</p><p>
The following file locking methods are implemented:
</p>
<ul>
<li>The default method is 'file' and uses a watchdog thread to
protect the database file. The watchdog reads the lock file each second.
</li><li>The second method is 'socket' and opens a server socket. The socket method does
protect the database file. The watchdog reads the lock file each second.
</li><li>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.
</li><li>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.
in this case it is up to the application to protect the database files.
</li></ul>
<p>
To open the database with a different file locking method, use the parameter 'FILE_LOCK'.
......@@ -471,23 +499,23 @@ The following code opens the database with the 'socket' locking method:
String url = "jdbc:h2:~/test;FILE_LOCK=SOCKET";
</pre>
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
this is unsafe as another process is able to open the same database, possibly leading to
data corruption:
<pre>
String url = "jdbc:h2:~/test;FILE_LOCK=NO";
</pre>
For more information about the algorithms please see in Advanced Topics under
File Locking Protocol.
For more information about the algorithms please see in Advanced Topics under
File Locking Protocol.
</p>
<br /><a name="database_only_if_exists"></a>
<h2>Opening a Database Only if it Already Exists</h2>
<p>
By default, when an application calls <code>DriverManager.getConnection(url,...)</code>
By default, when an application calls <code>DriverManager.getConnection(url,...)</code>
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 <code>;ifexists=true</code>
to the URL. In this case, if the database does not already exist, an exception is thrown when
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:
</p>
......@@ -502,7 +530,7 @@ String url = "jdbc:h2:/data/sample;IFEXISTS=TRUE";
<p>
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
The automatic closing of the database can be delayed or disabled with the SQL statement
SET DB_CLOSE_DELAY &lt;seconds&gt;. 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:
......@@ -521,8 +549,8 @@ By default, a database is closed when the last connection is closed. However, if
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
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:
</p>
......@@ -538,7 +566,7 @@ If the index file is corrupt or missing when opening a database, it is re-create
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.
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
......@@ -548,18 +576,18 @@ The update performance of the database will be reduced when using this option.
<h3>Ignore Unknown Settings</h3>
<p>
Some applications (for example OpenOffice.org Base) pass some additional parameters
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.
;IGNORE_UNKNOWN_SETTINGS=TRUE to the database URL.
</p>
<h3>Changing Other Settings when Opening a Connection</h3>
<p>
In addition to the settings already described (cipher, file_lock, ifexists, user, password),
In addition to the settings already described (cipher, file_lock, ifexists, user, password),
other database settings can be passed in the database URL.
Adding <code>setting=value</code> at the end of an URL is the
same as executing the statement <code>SET setting value</code> just after
......@@ -599,31 +627,31 @@ you need to use the client / server mode. In this case, one process acts as 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).
</p>
<h3>Multithreading Support</h3>
<p>
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
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 all accessing the same database
at the same time, however if one thread executes a long running query, the other threads
need to wait.
</p>
<h3>Locking, Lock-Timeout, Deadlocks</h3>
<p>
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,
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.
then a lock timeout exception is thrown.
</p><p>
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,
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
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:
</p>
......@@ -678,10 +706,10 @@ SET DEFAULT_LOCK_TIMEOUT &lt;milliseconds&gt;. The default lock timeout is persi
<br /><a name="database_file_layout"></a>
<h2>Database File Layout</h2>
<p>
There are a number of files created for persistent databases. Other than some databases,
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,
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:
......@@ -766,7 +794,7 @@ The following files can be created by the database:
<p>
Database name and location are not stored inside the database names.
</p><p>
While a database is closed, the files can be moved to another directory, and they can be renamed
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).
</p><p>
As there is no platform specific data in the files, they can be moved to other operating systems
......@@ -785,8 +813,8 @@ To backup data while the database is running, the SQL command SCRIPT can be used
<br /><a name="logging_recovery"></a>
<h2>Logging and Recovery</h2>
<p>
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
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.
......@@ -794,8 +822,8 @@ 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.
</p><p>
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).
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.
</p><p>
If the database file is corrupted, because the checksum of a record does not match (for example, if the
......@@ -821,11 +849,11 @@ IGNORECASE=TRUE to the database URL (example: jdbc:h2:test;IGNORECASE=TRUE).
<h3>Compatibility Modes</h3>
<p>
For certain features, this database can emulate the behavior of specific databases. Not all features or differences of those
databases are implemented. Currently, this feature is mainly used for randomized comparative testing
databases are implemented. Currently, this feature is mainly used for randomized comparative testing
(where random statements are executed against multiple databases and the results are compared).
The mode can be changed by specifying the mode in the database URL, or using the SQL statement SET MODE.
To use the HSQLDB mode, you can use the database URL <code>jdbc:h2:~/test;MODE=HSQLDB</code>
or the SQL statement <code>SET MODE HSQLDB</code>.
or the SQL statement <code>SET MODE HSQLDB</code>.
Here is the list of currently supported modes and the difference to the regular mode:
</p>
<table>
......@@ -860,7 +888,7 @@ Here is the list of currently supported modes and the difference to the regular
<br /><a name="trace_options"></a>
<h2>Using the Trace Options</h2>
<p>
To find problems in an application, it is sometimes good to see what database operations
To find problems in an application, it is sometimes good to see what database operations
where executed. This database offers the following trace features:
</p>
<ul>
......@@ -874,8 +902,8 @@ where executed. This database offers the following trace features:
<h3>Trace Options</h3>
<p>
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).
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:
<pre>
......@@ -893,7 +921,7 @@ SET TRACE_LEVEL_SYSTEM_OUT 3
<h3>Setting the Maximum Size of the Trace File</h3>
<p>
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
The size of the file can be limited by executing the SQL statement
<code>SET TRACE_MAX_FILE_SIZE maximumFileSizeInMB</code>.
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.
......@@ -909,9 +937,9 @@ When setting the trace level to INFO or DEBUG, Java source code is generated as
problem can be reproduced more easily. The trace file looks like this:
<pre>
...
12-20 20:58:09 jdbc[0]:
12-20 20:58:09 jdbc[0]:
/**/dbMeta3.getURL();
12-20 20:58:09 jdbc[0]:
12-20 20:58:09 jdbc[0]:
/**/dbMeta3.getTables(null, "", null, new String[]{"TABLE", "VIEW"});
...
</pre>
......@@ -935,10 +963,10 @@ Also, the user name and password needs to be set, because they are not listed in
<p>
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
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'.
The file name is the database name plus '.trace.db.start'.
This feature is disabled if the database is encrypted.
</p><p>
Example: if a database is called 'test', then the file to start tracing is 'test.trace.db.start'.
......@@ -980,15 +1008,15 @@ jdbc:h2:zip:data.zip!/test
<p>
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
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.
a regular database.
</p>
<br /><a name="storage_formats"></a>
<h2>Binary and Text Storage Formats</h2>
<p>
This database engine supports both 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.
......@@ -1011,17 +1039,17 @@ be freed up.
</p><p>
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.
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.
See also the DatabaseEventListener API.
</p>
<h3>Opening a Corrupted Database</h3>
<p>
If a database can not 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.
is corrupted, then the database can be opened by specifying a database event listener.
The exceptions are logged, but opening the database will continue.
</p>
......@@ -1034,8 +1062,8 @@ a column is required, just create a computed column with the upper-case version
and index this column:
<pre>
CREATE TABLE ADDRESS(
ID INT PRIMARY KEY,
NAME VARCHAR,
ID INT PRIMARY KEY,
NAME VARCHAR,
UPPER_NAME VARCHAR AS UPPER(NAME)
);
CREATE INDEX IDX_U_NAME ON ADDRESS(UPPER_NAME);
......@@ -1055,16 +1083,16 @@ SELECT * FROM ADDRESS WHERE UPPER_NAME='MILLER';
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.
is converted (mapped) to a single dimensional (scalar) value.
This value specifies the location on a space-filling curve.
</p><p>
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).
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).
</p><p>
The method can result in a drastic performance improvement
over just using an index on the first column. Depending on the
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.
......@@ -1080,7 +1108,7 @@ in TestMultiDimension.java.
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.
letters of a sentence, use upper and lower case characters, and creatively include special characters.
Example:
</p><p>
i'sE2rtPiUKtT (it's easy to remember this password if you know the trick)
......@@ -1089,13 +1117,13 @@ i'sE2rtPiUKtT (it's easy to remember this password if you know the trick)
<h3>Passwords: Using Char Arrays instead of Strings</h3>
<p>
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
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).
</p><p>
An attacker might have access to the swap file of the operating system.
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.
......@@ -1106,7 +1134,7 @@ The following code can be used to do that:
Class.forName("org.h2.Driver");
String url = "jdbc:h2:simple";
String user = "sam";
char[] password =
char[] password =
{'t','i','a','S','&amp;',E','t','r','p'};
Properties prop = new Properties();
prop.setProperty("user", user);
......@@ -1119,7 +1147,7 @@ try {
Arrays.fill(password, 0);
}
</pre>
In this example, the password is hard code in the application, which is not secure of course.
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).
</p>
......@@ -1177,7 +1205,7 @@ to database is provided. This connection does not need to be closed before retur
<h3>Functions throwing an Exception</h3>
<p>
If a function throws an Exception, then the current statement is rolled back
If a function throws an Exception, then the current statement is rolled back
and the exception is thrown to the application.
</p>
......@@ -1188,7 +1216,7 @@ Functions may returns a result set. Such a function can be called with the CALL
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');
</pre>
......@@ -1207,7 +1235,7 @@ public static ResultSet simpleResultSet() throws SQLException {
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();
......@@ -1218,7 +1246,7 @@ CALL SIMPLE();
<p>
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
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
......@@ -1237,7 +1265,7 @@ public static ResultSet getMatrix(Integer id) throws SQLException {
}
}
return rs;
}
}
CREATE ALIAS MATRIX FOR "org.h2.samples.Function.getMatrix";
SELECT * FROM MATRIX(3) WHERE X>0;
......@@ -1258,8 +1286,8 @@ 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)
public void fire(Connection conn,
Object[] oldRow, Object[] newRow)
throws SQLException {
}
}
......@@ -1267,7 +1295,7 @@ public class TriggerSample implements Trigger {
The connection can be used to query or update data in other tables.
The trigger then needs to be defined in the database:
<pre>
CREATE TRIGGER INV_INS AFTER INSERT ON INVOICE
CREATE TRIGGER INV_INS AFTER INSERT ON INVOICE
FOR EACH ROW CALL "org.h2.samples.TriggerSample"
</pre>
The trigger can be used to veto a change, by throwing a SQL Exception.
......@@ -1276,13 +1304,13 @@ The trigger can be used to veto a change, by throwing a SQL Exception.
<br /><a name="compacting"></a>
<h2>Compacting a Database</h2>
<p>
Empty space in the database file is re-used automatically.
Empty space in the database file is re-used automatically.
To re-build the indexes, the most simple 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
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:
<pre>
public static void compact(String dir, String dbName,
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";
......@@ -1300,14 +1328,14 @@ of a database and re-build the database from the script.
<h2>Cache Settings</h2>
<p>
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
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.
</p><p>
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
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 can not be changed
......@@ -1331,23 +1359,23 @@ A few reasons using a Java database are:
</li><li>Unicode support
</li></ul>
<p>
Some people think that Java is still too slow for low level operations,
but this is not the case (not any more). In general, the code can be written a lot faster
than using C or C++. Like that, it is possible to concentrate on improving the algorithms
(that make the application faster) rather than porting the code and dealing with low
level stuff (such as memory management or dealing with threads).
Some people think that Java is still too slow for low level operations,
but this is not the case (not any more). In general, the code can be written a lot faster
than using C or C++. Like that, it is possible to concentrate on improving the algorithms
(that make the application faster) rather than porting the code and dealing with low
level stuff (such as memory management or dealing with threads).
Garbage collection is now probably faster than manual memory management.
</p><p>
A lot of features are already built in (for example Unicode, network libraries).
A lot of features are already built in (for example Unicode, network libraries).
It is very easy to write secure code because buffer overflows and such
problems can be detected very easily. Some features such as the reflection
problems can be detected very easily. Some features such as the reflection
mechanism can be used for randomized testing.
</p><p>
Java is also future proof: A lot of companies support Java,
Java is also future proof: A lot of companies support Java,
and it is now open source.
</p><p>
This software does not rely on many Java libraries or other software, to
increase the portability and ease of use, and for performance reasons. For example,
increase the portability and ease of use, and for performance reasons. For example,
the encryption algorithms and many library functions are implemented in the database
instead of using the existing libraries. Libraries that are not available in open source
Java implementations (such as Swing) are not used or only used for specific features.
......
......@@ -980,13 +980,13 @@ h2.serverCachedObjects
TCP Server: number of cached objects per session
@advanced_1327_td
h2.serverSmallResultSetSize
h2.serverResultSetFetchSize
@advanced_1328_td
100
@advanced_1329_td
TCP Server: result sets below this size are sent in one block
The default result set fetch size when using the server mode
@advanced_1330_h2
Glossary and Links
......@@ -1646,7 +1646,7 @@ MySQL
PostgreSQL
@features_1090_td
Embedded Mode (Java)
Pure Java
@features_1091_td
Yes
......@@ -1664,7 +1664,7 @@ No
No
@features_1096_td
Pure Java
Embedded Mode (Java)
@features_1097_td
Yes
......@@ -1700,25 +1700,25 @@ N/A
N/A
@features_1108_td
Transaction Isolation
In-Memory Mode
@features_1109_td
Yes
@features_1110_td
Yes
No
@features_1111_td
No
Yes
@features_1112_td
Yes
No
@features_1113_td
Yes
No
@features_1114_td
Cost Based Optimizer
Transaction Isolation
@features_1115_td
Yes
......@@ -1736,13 +1736,13 @@ Yes
Yes
@features_1120_td
Clustering
Cost Based Optimizer
@features_1121_td
Yes
@features_1122_td
No
Yes
@features_1123_td
No
......@@ -1754,936 +1754,1008 @@ Yes
Yes
@features_1126_td
Encrypted Database
Clustering
@features_1127_td
Yes
@features_1128_td
Yes
No
@features_1129_td
No
@features_1130_td
No
Yes
@features_1131_td
No
Yes
@features_1132_td
Files per Database
Encrypted Database
@features_1133_td
Few
Yes
@features_1134_td
Many
Yes
@features_1135_td
Few
No
@features_1136_td
Many
No
@features_1137_td
Many
No
@features_1138_td
Footprint (jar/dll size)
ODBC Driver
@features_1139_td
~ 1 MB
Yes
@features_1140_td
~ 2 MB
Yes?
@features_1141_td
~ 600 KB
No
@features_1142_td
~ 4 MB
Yes
@features_1143_td
Yes
@features_1144_td
Fulltext Search
@features_1145_td
Yes
@features_1146_td
No
@features_1147_td
No
@features_1148_td
Yes
@features_1149_td
Yes
@features_1150_td
User Defined Datatypes
@features_1151_td
Yes
@features_1152_td
No
@features_1153_td
No
@features_1154_td
Yes
@features_1155_td
Yes
@features_1156_td
Files per Database
@features_1157_td
Few
@features_1158_td
Many
@features_1159_td
Few
@features_1160_td
Many
@features_1161_td
Many
@features_1162_td
Footprint (jar/dll size)
@features_1163_td
~ 1 MB
@features_1164_td
~ 2 MB
@features_1165_td
~ 600 KB
@features_1166_td
~ 4 MB
@features_1167_td
~ 6 MB
@features_1144_h3
@features_1168_h3
Derby and HSQLDB
@features_1145_p
@features_1169_p
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').
@features_1146_h3
@features_1170_h3
DaffodilDb and One$Db
@features_1147_p
@features_1171_p
It looks like the development of this database has stopped. The last release was February 2006.
@features_1148_h3
@features_1172_h3
McKoi
@features_1149_p
@features_1173_p
It looks like the development of this database has stopped. The last release was August 2004
@features_1150_h2
@features_1174_h2
H2 in Use
@features_1151_p
@features_1175_p
For a list of applications that work with or use H2, see: <a href="http://groups.google.com/group/h2-database/web/h2-in-use">http://groups.google.com/group/h2-database/web/h2-in-use</a>
@features_1152_h2
@features_1176_h2
Connection Modes
@features_1153_p
@features_1177_p
The following connection modes are supported:
@features_1154_li
@features_1178_li
Local connections using JDBC (embedded)
@features_1155_li
@features_1179_li
Remote connections using JDBC over TCP/IP (client/server)
@features_1156_li
@features_1180_li
Remote connections using ODBC over TCP/IP (client/server)
@features_1157_li
@features_1181_li
In-Memory databases (private and shared)
@features_1158_h2
@features_1182_h2
Database URL Overview
@features_1159_p
@features_1183_p
This database does support multiple connection modes and features when connecting to a database. This is achieved using different database URLs. The settings in the URLs are not case sensitive.
@features_1160_th
@features_1184_th
Topic
@features_1161_th
@features_1185_th
URL Format and Examples
@features_1162_td
@features_1186_td
Embedded (local) connection
@features_1163_td
@features_1187_td
jdbc:h2:[file:][&lt;path&gt;]&lt;databaseName&gt;
@features_1164_td
@features_1188_td
jdbc:h2:~/test
@features_1165_td
@features_1189_td
jdbc:h2:file:/data/sample
@features_1166_td
@features_1190_td
jdbc:h2:file:C:/data/sample (Windows only)
@features_1167_td
@features_1191_td
In-Memory (private)
@features_1168_td
@features_1192_td
jdbc:h2:mem:
@features_1169_td
@features_1193_td
In-Memory (named)
@features_1170_td
@features_1194_td
jdbc:h2:mem:&lt;databaseName&gt;
@features_1171_td
@features_1195_td
jdbc:h2:mem:test_mem
@features_1172_td
@features_1196_td
Remote using TCP/IP
@features_1173_td
@features_1197_td
jdbc:h2:tcp://&lt;server&gt;[:&lt;port&gt;]/&lt;databaseName&gt;
@features_1174_td
@features_1198_td
jdbc:h2:tcp://localhost/test
@features_1175_td
@features_1199_td
jdbc:h2:tcp://dbserv:8084/sample
@features_1176_td
@features_1200_td
Remote using SSL/TLS
@features_1177_td
@features_1201_td
jdbc:h2:ssl://&lt;server&gt;[:&lt;port&gt;]/&lt;databaseName&gt;
@features_1178_td
@features_1202_td
jdbc:h2:ssl://secureserv:8085/sample;
@features_1179_td
@features_1203_td
Using Encrypted Files
@features_1180_td
@features_1204_td
jdbc:h2:&lt;url&gt;;CIPHER=[AES|XTEA]
@features_1181_td
@features_1205_td
jdbc:h2:ssl://secureserv/testdb;CIPHER=AES
@features_1182_td
@features_1206_td
jdbc:h2:file:~/secure;CIPHER=XTEA
@features_1183_td
@features_1207_td
File Locking Methods
@features_1184_td
@features_1208_td
jdbc:h2:&lt;url&gt;;FILE_LOCK={NO|FILE|SOCKET}
@features_1185_td
@features_1209_td
jdbc:h2:file:~/quickAndDirty;FILE_LOCK=NO
@features_1186_td
@features_1210_td
jdbc:h2:file:~/private;CIPHER=XTEA;FILE_LOCK=SOCKET
@features_1187_td
@features_1211_td
Only Open if it Already Exists
@features_1188_td
@features_1212_td
jdbc:h2:&lt;url&gt;;IFEXISTS=TRUE
@features_1189_td
@features_1213_td
jdbc:h2:file:~/sample;IFEXISTS=TRUE
@features_1190_td
@features_1214_td
Don't Close the Database when the VM Exits
@features_1191_td
@features_1215_td
jdbc:h2:&lt;url&gt;;DB_CLOSE_ON_EXIT=FALSE
@features_1192_td
@features_1216_td
User Name and/or Password
@features_1193_td
@features_1217_td
jdbc:h2:&lt;url&gt;[;USER=&lt;username&gt;][;PASSWORD=&lt;value&gt;]
@features_1194_td
@features_1218_td
jdbc:h2:file:~/sample;USER=sa;PASSWORD=123
@features_1195_td
@features_1219_td
Log Index Changes
@features_1196_td
@features_1220_td
jdbc:h2:&lt;url&gt;;LOG=2
@features_1197_td
@features_1221_td
jdbc:h2:file:~/sample;LOG=2
@features_1198_td
@features_1222_td
Debug Trace Settings
@features_1199_td
@features_1223_td
jdbc:h2:&lt;url&gt;;TRACE_LEVEL_FILE=&lt;level 0..3&gt;
@features_1200_td
@features_1224_td
jdbc:h2:file:~/sample;TRACE_LEVEL_FILE=3
@features_1201_td
@features_1225_td
Ignore Unknown Settings
@features_1202_td
@features_1226_td
jdbc:h2:&lt;url&gt;;IGNORE_UNKNOWN_SETTINGS=TRUE
@features_1203_td
@features_1227_td
Custom File Access Mode
@features_1204_td
@features_1228_td
jdbc:h2:&lt;url&gt;;ACCESS_MODE_LOG=rws;ACCESS_MODE_DATA=rws
@features_1205_td
@features_1229_td
In-Memory (private)
@features_1206_td
@features_1230_td
jdbc:h2:mem:
@features_1207_td
@features_1231_td
Database in or Zip File
@features_1208_td
@features_1232_td
jdbc:h2:zip:&lt;zipFileName&gt;!/&lt;databaseName&gt;
@features_1209_td
@features_1233_td
jdbc:h2:zip:db.zip!/test
@features_1210_td
@features_1234_td
Changing Other Settings
@features_1211_td
@features_1235_td
jdbc:h2:&lt;url&gt;;&lt;setting&gt;=&lt;value&gt;[;&lt;setting&gt;=&lt;value&gt;...]
@features_1212_td
@features_1236_td
jdbc:h2:file:~/sample;TRACE_LEVEL_SYSTEM_OUT=3
@features_1213_h3
@features_1237_h3
Connecting to an Embedded (Local) Database
@features_1214_p
@features_1238_p
The database URL for connecting to a local database is <code>jdbc:h2:[file:][&lt;path&gt;]&lt;databaseName&gt;</code> . The prefix <code>file:</code> 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 suggested 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.
@features_1215_h2
@features_1239_h2
Memory-Only Databases
@features_1216_p
@features_1240_p
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.
@features_1217_p
@features_1241_p
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 <code>jdbc:h2:mem:</code> Opening two connections within the same virtual machine means opening two different (private) databases.
@features_1218_p
@features_1242_p
Sometimes multiple connections to the same memory-only database are required. In this case, the database URL must include a name. Example: <code>jdbc:h2:mem:db1</code> . Accessing the same database in this way only works within the same virtual machine and class loader environment.
@features_1219_p
@features_1243_p
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: <code>jdbc:h2:tcp://localhost/mem:db1</code> (using private database remotely is also possible).
@features_1220_p
@features_1244_p
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
@features_1221_h2
@features_1245_h2
Connecting to a Database with File Encryption
@features_1222_p
@features_1246_p
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:
@features_1223_h2
@features_1247_h2
Database File Locking
@features_1224_p
@features_1248_p
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.
@features_1225_p
@features_1249_p
The following file locking methods are implemented:
@features_1226_li
@features_1250_li
The default method is 'file' and uses a watchdog thread to protect the database file. The watchdog reads the lock file each second.
@features_1227_li
@features_1251_li
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.
@features_1228_li
@features_1252_li
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.
@features_1229_p
@features_1253_p
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:
@features_1230_p
@features_1254_p
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:
@features_1231_p
@features_1255_p
For more information about the algorithms please see in Advanced Topics under File Locking Protocol.
@features_1232_h2
@features_1256_h2
Opening a Database Only if it Already Exists
@features_1233_p
@features_1257_p
By default, when an application calls <code>DriverManager.getConnection(url,...)</code> 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 <code>;ifexists=true</code> 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:
@features_1234_h2
@features_1258_h2
Closing the Database
@features_1235_h3
@features_1259_h3
Delayed Database Closing
@features_1236_p
@features_1260_p
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 &lt;seconds&gt;. 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:
@features_1237_p
@features_1261_p
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: <code>jdbc:h2:~/test;DB_CLOSE_DELAY=10</code> .
@features_1238_h3
@features_1262_h3
Don't Close the Database when the VM Exits
@features_1239_p
@features_1263_p
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:
@features_1240_h2
@features_1264_h2
Log Index Changes
@features_1241_p
@features_1265_p
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.
@features_1242_h3
@features_1266_h3
Ignore Unknown Settings
@features_1243_p
@features_1267_p
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.
@features_1244_h3
@features_1268_h3
Changing Other Settings when Opening a Connection
@features_1245_p
@features_1269_p
In addition to the settings already described (cipher, file_lock, ifexists, user, password), other database settings can be passed in the database URL. Adding <code>setting=value</code> at the end of an URL is the same as executing the statement <code>SET setting value</code> just after connecting. For a list of settings supported by this database please see the SQL grammar documentation.
@features_1246_h2
@features_1270_h2
Custom File Access Mode
@features_1247_p
@features_1271_p
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). 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:
@features_1248_p
@features_1272_p
For more information see <a href="advanced.html#durability_problems">Durability Problems</a> . On many operating systems the access mode 'rws' does not guarantee that the data is written to the disk.
@features_1249_h2
@features_1273_h2
Multiple Connections
@features_1250_h3
@features_1274_h3
Opening Multiple Databases at the Same Time
@features_1251_p
@features_1275_p
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.
@features_1252_h3
@features_1276_h3
Multiple Connections to the Same Database: Client/Server
@features_1253_p
@features_1277_p
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).
@features_1254_h3
@features_1278_h3
Multithreading Support
@features_1255_p
@features_1279_p
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 all accessing the same database at the same time, however if one thread executes a long running query, the other threads need to wait.
@features_1256_h3
@features_1280_h3
Locking, Lock-Timeout, Deadlocks
@features_1257_p
@features_1281_p
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.
@features_1258_p
@features_1282_p
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:
@features_1259_th
@features_1283_th
Type of Lock
@features_1260_th
@features_1284_th
SQL Statement
@features_1261_td
@features_1285_td
Read
@features_1262_td
@features_1286_td
SELECT * FROM TEST
@features_1263_td
@features_1287_td
CALL SELECT MAX(ID) FROM TEST
@features_1264_td
@features_1288_td
SCRIPT
@features_1265_td
@features_1289_td
Write
@features_1266_td
@features_1290_td
SELECT * FROM TEST WHERE 1=0 FOR UPDATE
@features_1267_td
@features_1291_td
Write
@features_1268_td
@features_1292_td
INSERT INTO TEST VALUES(1, 'Hello')
@features_1269_td
@features_1293_td
INSERT INTO TEST SELECT * FROM TEST
@features_1270_td
@features_1294_td
UPDATE TEST SET NAME='Hi'
@features_1271_td
@features_1295_td
DELETE FROM TEST
@features_1272_td
@features_1296_td
Write
@features_1273_td
@features_1297_td
ALTER TABLE TEST ...
@features_1274_td
@features_1298_td
CREATE INDEX ... ON TEST ...
@features_1275_td
@features_1299_td
DROP INDEX ...
@features_1276_p
@features_1300_p
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 &lt;milliseconds&gt;. The initial lock timeout (that is the timeout used for new connections) can be set using the SQL command SET DEFAULT_LOCK_TIMEOUT &lt;milliseconds&gt;. The default lock timeout is persistent.
@features_1277_h2
@features_1301_h2
Database File Layout
@features_1278_p
@features_1302_p
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:
@features_1279_th
@features_1303_th
File Name
@features_1280_th
@features_1304_th
Description
@features_1281_th
@features_1305_th
Number of Files
@features_1282_td
@features_1306_td
test.data.db
@features_1283_td
@features_1307_td
Data file
@features_1284_td
@features_1308_td
Contains the data for all tables
@features_1285_td
@features_1309_td
Format: &lt;database&gt;.data.db
@features_1286_td
@features_1310_td
1 per database
@features_1287_td
@features_1311_td
test.index.db
@features_1288_td
@features_1312_td
Index file
@features_1289_td
@features_1313_td
Contains the data for all (btree) indexes
@features_1290_td
@features_1314_td
Format: &lt;database&gt;.index.db
@features_1291_td
@features_1315_td
1 per database
@features_1292_td
@features_1316_td
test.0.log.db
@features_1293_td
@features_1317_td
Log file
@features_1294_td
@features_1318_td
The log file is used for recovery
@features_1295_td
@features_1319_td
Format: &lt;database&gt;.&lt;id&gt;.log.db
@features_1296_td
@features_1320_td
0 or more per database
@features_1297_td
@features_1321_td
test.lock.db
@features_1298_td
@features_1322_td
Database lock file
@features_1299_td
@features_1323_td
Exists only if the database is open
@features_1300_td
@features_1324_td
Format: &lt;database&gt;.lock.db
@features_1301_td
@features_1325_td
1 per database
@features_1302_td
@features_1326_td
test.trace.db
@features_1303_td
@features_1327_td
Trace file
@features_1304_td
@features_1328_td
Contains trace information
@features_1305_td
@features_1329_td
Format: &lt;database&gt;.trace.db
@features_1306_td
@features_1330_td
If the file is too big, it is renamed to &lt;database&gt;.trace.db.old
@features_1307_td
@features_1331_td
1 per database
@features_1308_td
@features_1332_td
test.14.15.lob.db
@features_1309_td
@features_1333_td
Large object
@features_1310_td
@features_1334_td
Contains the data for BLOB or CLOB
@features_1311_td
@features_1335_td
Format: &lt;database&gt;.&lt;tableid&gt;.&lt;id&gt;.lob.db
@features_1312_td
@features_1336_td
1 per object
@features_1313_td
@features_1337_td
test.123.temp.db
@features_1314_td
@features_1338_td
Temporary file
@features_1315_td
@features_1339_td
Contains a temporary blob or a large result set
@features_1316_td
@features_1340_td
Format: &lt;database&gt;.&lt;session id&gt;.&lt;object id&gt;.temp.db
@features_1317_td
@features_1341_td
1 per object
@features_1318_td
@features_1342_td
test.7.hash.db
@features_1319_td
@features_1343_td
Hash index file
@features_1320_td
@features_1344_td
Contains the data for a linear hash index
@features_1321_td
@features_1345_td
Format: &lt;database&gt;.&lt;object id&gt;.hash.db
@features_1322_td
@features_1346_td
1 per linear hash index
@features_1323_h3
@features_1347_h3
Moving and Renaming Database Files
@features_1324_p
@features_1348_p
Database name and location are not stored inside the database names.
@features_1325_p
@features_1349_p
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).
@features_1326_p
@features_1350_p
As there is no platform specific data in the files, they can be moved to other operating systems without problems.
@features_1327_h3
@features_1351_h3
Backup
@features_1328_p
@features_1352_p
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.
@features_1329_p
@features_1353_p
To backup data while the database is running, the SQL command SCRIPT can be used.
@features_1330_h2
@features_1354_h2
Logging and Recovery
@features_1331_p
@features_1355_p
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.
@features_1332_p
@features_1356_p
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.
@features_1333_p
@features_1357_p
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.
@features_1334_p
@features_1358_p
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.
@features_1335_h2
@features_1359_h2
Compatibility
@features_1336_p
@features_1360_p
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:
@features_1337_p
@features_1361_p
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).
@features_1338_h3
@features_1362_h3
Compatibility Modes
@features_1339_p
@features_1363_p
For certain features, this database can emulate the behavior of specific databases. Not all features or differences of those databases are implemented. Currently, this feature is mainly used for randomized comparative testing (where random statements are executed against multiple databases and the results are compared). The mode can be changed by specifying the mode in the database URL, or using the SQL statement SET MODE. To use the HSQLDB mode, you can use the database URL <code>jdbc:h2:~/test;MODE=HSQLDB</code> or the SQL statement <code>SET MODE HSQLDB</code> . Here is the list of currently supported modes and the difference to the regular mode:
@features_1340_th
@features_1364_th
Mode
@features_1341_th
@features_1365_th
Differences
@features_1342_td
@features_1366_td
PostgreSQL
@features_1343_td
@features_1367_td
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.
@features_1344_td
@features_1368_td
MySQL
@features_1345_td
@features_1369_td
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.
@features_1346_td
@features_1370_td
HSQLDB
@features_1347_td
@features_1371_td
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.
@features_1348_h2
@features_1372_h2
Using the Trace Options
@features_1349_p
@features_1373_p
To find problems in an application, it is sometimes good to see what database operations where executed. This database offers the following trace features:
@features_1350_li
@features_1374_li
Trace to System.out and/or a file
@features_1351_li
@features_1375_li
Support for trace levels OFF, ERROR, INFO, and DEBUG
@features_1352_li
@features_1376_li
The maximum size of the trace file can be set
@features_1353_li
@features_1377_li
The Java code generation is possible
@features_1354_li
@features_1378_li
Trace can be enabled at runtime by manually creating a file
@features_1355_h3
@features_1379_h3
Trace Options
@features_1356_p
@features_1380_p
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:
@features_1357_p
@features_1381_p
The trace level can be changed at runtime by executing the SQL command <code>SET TRACE_LEVEL_SYSTEM_OUT level</code> (for System.out tracing) or <code>SET TRACE_LEVEL_FILE level</code> (for file tracing). Example:
@features_1358_h3
@features_1382_h3
Setting the Maximum Size of the Trace File
@features_1359_p
@features_1383_p
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 <code>SET TRACE_MAX_FILE_SIZE maximumFileSizeInMB</code> . 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:
@features_1360_h3
@features_1384_h3
Java Code Generation
@features_1361_p
@features_1385_p
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:
@features_1362_p
@features_1386_p
You need to filter out the lines without /**/ to get the Java source code. In Windows, a simple way to do that is:
@features_1363_p
@features_1387_p
Afterwards, you need to complete the file Trace.java before it can be compiled, for example with:
@features_1364_p
@features_1388_p
Also, the user name and password needs to be set, because they are not listed in the trace file.
@features_1365_h3
@features_1389_h3
Enabling the Trace Option at Runtime by Manually Creating a File
@features_1366_p
@features_1390_p
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.
@features_1367_p
@features_1391_p
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.
@features_1368_h2
@features_1392_h2
Read Only Databases
@features_1369_p
@features_1393_p
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().
@features_1370_h2
@features_1394_h2
Read Only Databases in Zip or Jar File
@features_1371_p
@features_1395_p
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 SQL statement:
@features_1372_p
@features_1396_p
Afterwards, you can log out, and directly open the database in the zip file using the following database URL:
@features_1373_p
@features_1397_p
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.
@features_1374_h2
@features_1398_h2
Binary and Text Storage Formats
@features_1375_p
@features_1399_p
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
@features_1376_h2
@features_1400_h2
Graceful Handling of Low Disk Space Situations
@features_1377_p
@features_1401_p
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.
@features_1378_p
@features_1402_p
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.
@features_1379_h3
@features_1403_h3
Opening a Corrupted Database
@features_1380_p
@features_1404_p
If a database can not 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.
@features_1381_h2
@features_1405_h2
Computed Columns / Function Based Index
@features_1382_p
@features_1406_p
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:
@features_1383_p
@features_1407_p
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:
@features_1384_h2
@features_1408_h2
Multi-Dimensional Indexes
@features_1385_p
@features_1409_p
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.
@features_1386_p
@features_1410_p
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).
@features_1387_p
@features_1411_p
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.
@features_1388_h2
@features_1412_h2
Using Passwords
@features_1389_h3
@features_1413_h3
Using Secure Passwords
@features_1390_p
@features_1414_p
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:
@features_1391_p
@features_1415_p
i'sE2rtPiUKtT (it's easy to remember this password if you know the trick)
@features_1392_h3
@features_1416_h3
Passwords: Using Char Arrays instead of Strings
@features_1393_p
@features_1417_p
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).
@features_1394_p
@features_1418_p
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.
@features_1395_p
@features_1419_p
This database supports using char arrays instead of String to pass user and file passwords. The following code can be used to do that:
@features_1396_p
@features_1420_p
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).
@features_1397_h3
@features_1421_h3
Passing the User Name and/or Password in the URL
@features_1398_p
@features_1422_p
Instead of passing the user name as a separate parameter as in <code>Connection conn = DriverManager. getConnection("jdbc:h2:~/test", "sa", "123");</code> the user name (and/or password) can be supplied in the URL itself: <code>Connection conn = DriverManager. getConnection("jdbc:h2:~/test;USER=sa;PASSWORD=123");</code> The settings in the URL override the settings passed as a separate parameter.
@features_1399_h2
@features_1423_h2
User Defined Functions and Stored Procedures
@features_1400_p
@features_1424_p
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:
@features_1401_p
@features_1425_p
The Java function must be registered in the database by calling CREATE ALIAS:
@features_1402_p
@features_1426_p
For a complete sample application, see src/test/org/h2/samples/Function.java.
@features_1403_h3
@features_1427_h3
Function Data Type Mapping
@features_1404_p
@features_1428_p
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'.
@features_1405_h3
@features_1429_h3
Functions that require a Connection
@features_1406_p
@features_1430_p
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.
@features_1407_h3
@features_1431_h3
Functions throwing an Exception
@features_1408_p
@features_1432_p
If a function throws an Exception, then the current statement is rolled back and the exception is thrown to the application.
@features_1409_h3
@features_1433_h3
Functions returning a Result Set
@features_1410_p
@features_1434_p
Functions may returns a result set. Such a function can be called with the CALL statement:
@features_1411_h3
@features_1435_h3
Using SimpleResultSet
@features_1412_p
@features_1436_p
A function that returns a result set can create this result set from scratch using the SimpleResultSet tool:
@features_1413_h3
@features_1437_h3
Using a Function as a Table
@features_1414_p
@features_1438_p
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.
@features_1415_h2
@features_1439_h2
Triggers
@features_1416_p
@features_1440_p
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:
@features_1417_p
@features_1441_p
The connection can be used to query or update data in other tables. The trigger then needs to be defined in the database:
@features_1418_p
@features_1442_p
The trigger can be used to veto a change, by throwing a SQL Exception.
@features_1419_h2
@features_1443_h2
Compacting a Database
@features_1420_p
@features_1444_p
Empty space in the database file is re-used automatically. To re-build the indexes, the most simple 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:
@features_1421_p
@features_1445_p
See also the sample application org.h2.samples.Compact. The commands SCRIPT / RUNSCRIPT can be used as well to create the a backup of a database and re-build the database from the script.
@features_1422_h2
@features_1446_h2
Cache Settings
@features_1423_p
@features_1447_p
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.
@features_1424_p
@features_1448_p
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 can not be changed once the database is open.
@features_1425_p
@features_1449_p
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.
@features_1426_h2
@features_1450_h2
Why Java
@features_1427_p
@features_1451_p
A few reasons using a Java database are:
@features_1428_li
@features_1452_li
Very simple to integrate in Java applications
@features_1429_li
@features_1453_li
Support for many different platforms
@features_1430_li
@features_1454_li
More secure than native applications (no buffer overflows)
@features_1431_li
@features_1455_li
User defined functions (or triggers) run very fast
@features_1432_li
@features_1456_li
Unicode support
@features_1433_p
@features_1457_p
Some people think that Java is still too slow for low level operations, but this is not the case (not any more). In general, the code can be written a lot faster than using C or C++. Like that, it is possible to concentrate on improving the algorithms (that make the application faster) rather than porting the code and dealing with low level stuff (such as memory management or dealing with threads). Garbage collection is now probably faster than manual memory management.
@features_1434_p
@features_1458_p
A lot of features are already built in (for example Unicode, network libraries). It is very easy to write secure code because buffer overflows and such problems can be detected very easily. Some features such as the reflection mechanism can be used for randomized testing.
@features_1435_p
@features_1459_p
Java is also future proof: A lot of companies support Java, and it is now open source.
@features_1436_p
@features_1460_p
This software does not rely on many Java libraries or other software, to increase the portability and ease of use, and for performance reasons. For example, the encryption algorithms and many library functions are implemented in the database instead of using the existing libraries. Libraries that are not available in open source Java implementations (such as Swing) are not used or only used for specific features.
@frame_1000_p
......@@ -5087,7 +5159,7 @@ Using the Native Full Text Search
To initialize, call:
@tutorial_1137_p
Afterwards, you can create a full text index for a table using:
You need to initialize it in each database where you want to use it. Afterwards, you can create a full text index for a table using:
@tutorial_1138_p
PUBLIC is the schema, TEST is the table name. The list of column names (column separated) is optional, in this case all columns are indexed. The index is updated in read time. To search the index, use the following query:
......@@ -5099,10 +5171,10 @@ You can also call the index from within a Java application:
Using the Lucene Fulltext Search
@tutorial_1141_p
To use the Lucene full text search, you first need to rename the file FullTextLucene.java.txt to FullTestLucene.java and compile it. Also, you need the Lucene library in the classpath. To initialize, call:
To use the Lucene full text search, you need the Lucene library in the classpath. How his is done depends on the application; if you use the H2 Console, you can add the Lucene jar file to the the environment variables H2DRIVERS or CLASSPATH. To initialize the Lucene full text search in a database, call:
@tutorial_1142_p
Afterwards, you can create a full text index for a table using:
You need to initialize it in each database where you want to use it. Afterwards, you can create a full text index for a table using:
@tutorial_1143_p
PUBLIC is the schema, TEST is the table name. The list of column names (column separated) is optional, in this case all columns are indexed. The index is updated in read time. To search the index, use the following query:
......
This source diff could not be displayed because it is too large. You can view the blob instead.
......@@ -325,9 +325,9 @@ advanced_1323_td=Relative or absolute directory where the script files are store
advanced_1324_td=h2.serverCachedObjects
advanced_1325_td=64
advanced_1326_td=TCP Server\: number of cached objects per session
advanced_1327_td=h2.serverSmallResultSetSize
advanced_1327_td=h2.serverResultSetFetchSize
advanced_1328_td=100
advanced_1329_td=TCP Server\: result sets below this size are sent in one block
advanced_1329_td=The default result set fetch size when using the server mode
advanced_1330_h2=Glossary and Links
advanced_1331_th=Term
advanced_1332_th=Description
......@@ -547,13 +547,13 @@ features_1086_th=Derby
features_1087_th=HSQLDB
features_1088_th=MySQL
features_1089_th=PostgreSQL
features_1090_td=Embedded Mode (Java)
features_1090_td=Pure Java
features_1091_td=Yes
features_1092_td=Yes
features_1093_td=Yes
features_1094_td=No
features_1095_td=No
features_1096_td=Pure Java
features_1096_td=Embedded Mode (Java)
features_1097_td=Yes
features_1098_td=Yes
features_1099_td=Yes
......@@ -565,335 +565,359 @@ features_1104_td=Slow
features_1105_td=Fast
features_1106_td=N/A
features_1107_td=N/A
features_1108_td=Transaction Isolation
features_1108_td=In-Memory Mode
features_1109_td=Yes
features_1110_td=Yes
features_1111_td=No
features_1112_td=Yes
features_1113_td=Yes
features_1114_td=Cost Based Optimizer
features_1110_td=No
features_1111_td=Yes
features_1112_td=No
features_1113_td=No
features_1114_td=Transaction Isolation
features_1115_td=Yes
features_1116_td=Yes
features_1117_td=No
features_1118_td=Yes
features_1119_td=Yes
features_1120_td=Clustering
features_1120_td=Cost Based Optimizer
features_1121_td=Yes
features_1122_td=No
features_1122_td=Yes
features_1123_td=No
features_1124_td=Yes
features_1125_td=Yes
features_1126_td=Encrypted Database
features_1126_td=Clustering
features_1127_td=Yes
features_1128_td=Yes
features_1128_td=No
features_1129_td=No
features_1130_td=No
features_1131_td=No
features_1132_td=Files per Database
features_1133_td=Few
features_1134_td=Many
features_1135_td=Few
features_1136_td=Many
features_1137_td=Many
features_1138_td=Footprint (jar/dll size)
features_1139_td=~ 1 MB
features_1140_td=~ 2 MB
features_1141_td=~ 600 KB
features_1142_td=~ 4 MB
features_1143_td=~ 6 MB
features_1144_h3=Derby and HSQLDB
features_1145_p=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').
features_1146_h3=DaffodilDb and One$Db
features_1147_p=It looks like the development of this database has stopped. The last release was February 2006.
features_1148_h3=McKoi
features_1149_p=It looks like the development of this database has stopped. The last release was August 2004
features_1150_h2=H2 in Use
features_1151_p=For a list of applications that work with or use H2, see\: <a href\="http\://groups.google.com/group/h2-database/web/h2-in-use">http\://groups.google.com/group/h2-database/web/h2-in-use</a>
features_1152_h2=Connection Modes
features_1153_p=The following connection modes are supported\:
features_1154_li=Local connections using JDBC (embedded)
features_1155_li=Remote connections using JDBC over TCP/IP (client/server)
features_1156_li=Remote connections using ODBC over TCP/IP (client/server)
features_1157_li=In-Memory databases (private and shared)
features_1158_h2=Database URL Overview
features_1159_p=This database does support multiple connection modes and features when connecting to a database. This is achieved using different database URLs. The settings in the URLs are not case sensitive.
features_1160_th=Topic
features_1161_th=URL Format and Examples
features_1162_td=Embedded (local) connection
features_1163_td=jdbc\:h2\:[file\:][&lt;path&gt;]&lt;databaseName&gt;
features_1164_td=jdbc\:h2\:~/test
features_1165_td=jdbc\:h2\:file\:/data/sample
features_1166_td=jdbc\:h2\:file\:C\:/data/sample (Windows only)
features_1167_td=In-Memory (private)
features_1168_td=jdbc\:h2\:mem\:
features_1169_td=In-Memory (named)
features_1170_td=jdbc\:h2\:mem\:&lt;databaseName&gt;
features_1171_td=jdbc\:h2\:mem\:test_mem
features_1172_td=Remote using TCP/IP
features_1173_td=jdbc\:h2\:tcp\://&lt;server&gt;[\:&lt;port&gt;]/&lt;databaseName&gt;
features_1174_td=jdbc\:h2\:tcp\://localhost/test
features_1175_td=jdbc\:h2\:tcp\://dbserv\:8084/sample
features_1176_td=Remote using SSL/TLS
features_1177_td=jdbc\:h2\:ssl\://&lt;server&gt;[\:&lt;port&gt;]/&lt;databaseName&gt;
features_1178_td=jdbc\:h2\:ssl\://secureserv\:8085/sample;
features_1179_td=Using Encrypted Files
features_1180_td=jdbc\:h2\:&lt;url&gt;;CIPHER\=[AES|XTEA]
features_1181_td=jdbc\:h2\:ssl\://secureserv/testdb;CIPHER\=AES
features_1182_td=jdbc\:h2\:file\:~/secure;CIPHER\=XTEA
features_1183_td=File Locking Methods
features_1184_td=jdbc\:h2\:&lt;url&gt;;FILE_LOCK\={NO|FILE|SOCKET}
features_1185_td=jdbc\:h2\:file\:~/quickAndDirty;FILE_LOCK\=NO
features_1186_td=jdbc\:h2\:file\:~/private;CIPHER\=XTEA;FILE_LOCK\=SOCKET
features_1187_td=Only Open if it Already Exists
features_1188_td=jdbc\:h2\:&lt;url&gt;;IFEXISTS\=TRUE
features_1189_td=jdbc\:h2\:file\:~/sample;IFEXISTS\=TRUE
features_1190_td=Don't Close the Database when the VM Exits
features_1191_td=jdbc\:h2\:&lt;url&gt;;DB_CLOSE_ON_EXIT\=FALSE
features_1192_td=User Name and/or Password
features_1193_td=jdbc\:h2\:&lt;url&gt;[;USER\=&lt;username&gt;][;PASSWORD\=&lt;value&gt;]
features_1194_td=jdbc\:h2\:file\:~/sample;USER\=sa;PASSWORD\=123
features_1195_td=Log Index Changes
features_1196_td=jdbc\:h2\:&lt;url&gt;;LOG\=2
features_1197_td=jdbc\:h2\:file\:~/sample;LOG\=2
features_1198_td=Debug Trace Settings
features_1199_td=jdbc\:h2\:&lt;url&gt;;TRACE_LEVEL_FILE\=&lt;level 0..3&gt;
features_1200_td=jdbc\:h2\:file\:~/sample;TRACE_LEVEL_FILE\=3
features_1201_td=Ignore Unknown Settings
features_1202_td=jdbc\:h2\:&lt;url&gt;;IGNORE_UNKNOWN_SETTINGS\=TRUE
features_1203_td=Custom File Access Mode
features_1204_td=jdbc\:h2\:&lt;url&gt;;ACCESS_MODE_LOG\=rws;ACCESS_MODE_DATA\=rws
features_1205_td=In-Memory (private)
features_1206_td=jdbc\:h2\:mem\:
features_1207_td=Database in or Zip File
features_1208_td=jdbc\:h2\:zip\:&lt;zipFileName&gt;\!/&lt;databaseName&gt;
features_1209_td=jdbc\:h2\:zip\:db.zip\!/test
features_1210_td=Changing Other Settings
features_1211_td=jdbc\:h2\:&lt;url&gt;;&lt;setting&gt;\=&lt;value&gt;[;&lt;setting&gt;\=&lt;value&gt;...]
features_1212_td=jdbc\:h2\:file\:~/sample;TRACE_LEVEL_SYSTEM_OUT\=3
features_1213_h3=Connecting to an Embedded (Local) Database
features_1214_p=The database URL for connecting to a local database is <code>jdbc\:h2\:[file\:][&lt;path&gt;]&lt;databaseName&gt;</code> . The prefix <code>file\:</code> 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 suggested 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.
features_1215_h2=Memory-Only Databases
features_1216_p=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.
features_1217_p=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 <code>jdbc\:h2\:mem\:</code> Opening two connections within the same virtual machine means opening two different (private) databases.
features_1218_p=Sometimes multiple connections to the same memory-only database are required. In this case, the database URL must include a name. Example\: <code>jdbc\:h2\:mem\:db1</code> . Accessing the same database in this way only works within the same virtual machine and class loader environment.
features_1219_p=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\: <code>jdbc\:h2\:tcp\://localhost/mem\:db1</code> (using private database remotely is also possible).
features_1220_p=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
features_1221_h2=Connecting to a Database with File Encryption
features_1222_p=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\:
features_1223_h2=Database File Locking
features_1224_p=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.
features_1225_p=The following file locking methods are implemented\:
features_1226_li=The default method is 'file' and uses a watchdog thread to protect the database file. The watchdog reads the lock file each second.
features_1227_li=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.
features_1228_li=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.
features_1229_p=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\:
features_1230_p=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\:
features_1231_p=For more information about the algorithms please see in Advanced Topics under File Locking Protocol.
features_1232_h2=Opening a Database Only if it Already Exists
features_1233_p=By default, when an application calls <code>DriverManager.getConnection(url,...)</code> 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 <code>;ifexists\=true</code> 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\:
features_1234_h2=Closing the Database
features_1235_h3=Delayed Database Closing
features_1236_p=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 &lt;seconds&gt;. 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\:
features_1237_p=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\: <code>jdbc\:h2\:~/test;DB_CLOSE_DELAY\=10</code> .
features_1238_h3=Don't Close the Database when the VM Exits
features_1239_p=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\:
features_1240_h2=Log Index Changes
features_1241_p=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.
features_1242_h3=Ignore Unknown Settings
features_1243_p=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.
features_1244_h3=Changing Other Settings when Opening a Connection
features_1245_p=In addition to the settings already described (cipher, file_lock, ifexists, user, password), other database settings can be passed in the database URL. Adding <code>setting\=value</code> at the end of an URL is the same as executing the statement <code>SET setting value</code> just after connecting. For a list of settings supported by this database please see the SQL grammar documentation.
features_1246_h2=Custom File Access Mode
features_1247_p=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). 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\:
features_1248_p=For more information see <a href\="advanced.html\#durability_problems">Durability Problems</a> . On many operating systems the access mode 'rws' does not guarantee that the data is written to the disk.
features_1249_h2=Multiple Connections
features_1250_h3=Opening Multiple Databases at the Same Time
features_1251_p=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.
features_1252_h3=Multiple Connections to the Same Database\: Client/Server
features_1253_p=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).
features_1254_h3=Multithreading Support
features_1255_p=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 all accessing the same database at the same time, however if one thread executes a long running query, the other threads need to wait.
features_1256_h3=Locking, Lock-Timeout, Deadlocks
features_1257_p=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.
features_1258_p=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\:
features_1259_th=Type of Lock
features_1260_th=SQL Statement
features_1261_td=Read
features_1262_td=SELECT * FROM TEST
features_1263_td=CALL SELECT MAX(ID) FROM TEST
features_1264_td=SCRIPT
features_1265_td=Write
features_1266_td=SELECT * FROM TEST WHERE 1\=0 FOR UPDATE
features_1267_td=Write
features_1268_td=INSERT INTO TEST VALUES(1, 'Hello')
features_1269_td=INSERT INTO TEST SELECT * FROM TEST
features_1270_td=UPDATE TEST SET NAME\='Hi'
features_1271_td=DELETE FROM TEST
features_1272_td=Write
features_1273_td=ALTER TABLE TEST ...
features_1274_td=CREATE INDEX ... ON TEST ...
features_1275_td=DROP INDEX ...
features_1276_p=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 &lt;milliseconds&gt;. The initial lock timeout (that is the timeout used for new connections) can be set using the SQL command SET DEFAULT_LOCK_TIMEOUT &lt;milliseconds&gt;. The default lock timeout is persistent.
features_1277_h2=Database File Layout
features_1278_p=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\:
features_1279_th=File Name
features_1280_th=Description
features_1281_th=Number of Files
features_1282_td=test.data.db
features_1283_td=Data file
features_1284_td=Contains the data for all tables
features_1285_td=Format\: &lt;database&gt;.data.db
features_1286_td=1 per database
features_1287_td=test.index.db
features_1288_td=Index file
features_1289_td=Contains the data for all (btree) indexes
features_1290_td=Format\: &lt;database&gt;.index.db
features_1291_td=1 per database
features_1292_td=test.0.log.db
features_1293_td=Log file
features_1294_td=The log file is used for recovery
features_1295_td=Format\: &lt;database&gt;.&lt;id&gt;.log.db
features_1296_td=0 or more per database
features_1297_td=test.lock.db
features_1298_td=Database lock file
features_1299_td=Exists only if the database is open
features_1300_td=Format\: &lt;database&gt;.lock.db
features_1301_td=1 per database
features_1302_td=test.trace.db
features_1303_td=Trace file
features_1304_td=Contains trace information
features_1305_td=Format\: &lt;database&gt;.trace.db
features_1306_td=If the file is too big, it is renamed to &lt;database&gt;.trace.db.old
features_1307_td=1 per database
features_1308_td=test.14.15.lob.db
features_1309_td=Large object
features_1310_td=Contains the data for BLOB or CLOB
features_1311_td=Format\: &lt;database&gt;.&lt;tableid&gt;.&lt;id&gt;.lob.db
features_1312_td=1 per object
features_1313_td=test.123.temp.db
features_1314_td=Temporary file
features_1315_td=Contains a temporary blob or a large result set
features_1316_td=Format\: &lt;database&gt;.&lt;session id&gt;.&lt;object id&gt;.temp.db
features_1317_td=1 per object
features_1318_td=test.7.hash.db
features_1319_td=Hash index file
features_1320_td=Contains the data for a linear hash index
features_1321_td=Format\: &lt;database&gt;.&lt;object id&gt;.hash.db
features_1322_td=1 per linear hash index
features_1323_h3=Moving and Renaming Database Files
features_1324_p=Database name and location are not stored inside the database names.
features_1325_p=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).
features_1326_p=As there is no platform specific data in the files, they can be moved to other operating systems without problems.
features_1327_h3=Backup
features_1328_p=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.
features_1329_p=To backup data while the database is running, the SQL command SCRIPT can be used.
features_1330_h2=Logging and Recovery
features_1331_p=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.
features_1332_p=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.
features_1333_p=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.
features_1334_p=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.
features_1335_h2=Compatibility
features_1336_p=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\:
features_1337_p=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).
features_1338_h3=Compatibility Modes
features_1339_p=For certain features, this database can emulate the behavior of specific databases. Not all features or differences of those databases are implemented. Currently, this feature is mainly used for randomized comparative testing (where random statements are executed against multiple databases and the results are compared). The mode can be changed by specifying the mode in the database URL, or using the SQL statement SET MODE. To use the HSQLDB mode, you can use the database URL <code>jdbc\:h2\:~/test;MODE\=HSQLDB</code> or the SQL statement <code>SET MODE HSQLDB</code> . Here is the list of currently supported modes and the difference to the regular mode\:
features_1340_th=Mode
features_1341_th=Differences
features_1342_td=PostgreSQL
features_1343_td=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.
features_1344_td=MySQL
features_1345_td=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.
features_1346_td=HSQLDB
features_1347_td=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.
features_1348_h2=Using the Trace Options
features_1349_p=To find problems in an application, it is sometimes good to see what database operations where executed. This database offers the following trace features\:
features_1350_li=Trace to System.out and/or a file
features_1351_li=Support for trace levels OFF, ERROR, INFO, and DEBUG
features_1352_li=The maximum size of the trace file can be set
features_1353_li=The Java code generation is possible
features_1354_li=Trace can be enabled at runtime by manually creating a file
features_1355_h3=Trace Options
features_1356_p=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\:
features_1357_p=The trace level can be changed at runtime by executing the SQL command <code>SET TRACE_LEVEL_SYSTEM_OUT level</code> (for System.out tracing) or <code>SET TRACE_LEVEL_FILE level</code> (for file tracing). Example\:
features_1358_h3=Setting the Maximum Size of the Trace File
features_1359_p=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 <code>SET TRACE_MAX_FILE_SIZE maximumFileSizeInMB</code> . 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\:
features_1360_h3=Java Code Generation
features_1361_p=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\:
features_1362_p=You need to filter out the lines without /**/ to get the Java source code. In Windows, a simple way to do that is\:
features_1363_p=Afterwards, you need to complete the file Trace.java before it can be compiled, for example with\:
features_1364_p=Also, the user name and password needs to be set, because they are not listed in the trace file.
features_1365_h3=Enabling the Trace Option at Runtime by Manually Creating a File
features_1366_p=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.
features_1367_p=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.
features_1368_h2=Read Only Databases
features_1369_p=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().
features_1370_h2=Read Only Databases in Zip or Jar File
features_1371_p=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 SQL statement\:
features_1372_p=Afterwards, you can log out, and directly open the database in the zip file using the following database URL\:
features_1373_p=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.
features_1374_h2=Binary and Text Storage Formats
features_1375_p=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
features_1376_h2=Graceful Handling of Low Disk Space Situations
features_1377_p=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.
features_1378_p=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.
features_1379_h3=Opening a Corrupted Database
features_1380_p=If a database can not 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.
features_1381_h2=Computed Columns / Function Based Index
features_1382_p=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\:
features_1383_p=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\:
features_1384_h2=Multi-Dimensional Indexes
features_1385_p=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.
features_1386_p=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).
features_1387_p=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.
features_1388_h2=Using Passwords
features_1389_h3=Using Secure Passwords
features_1390_p=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\:
features_1391_p=i'sE2rtPiUKtT (it's easy to remember this password if you know the trick)
features_1392_h3=Passwords\: Using Char Arrays instead of Strings
features_1393_p=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).
features_1394_p=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.
features_1395_p=This database supports using char arrays instead of String to pass user and file passwords. The following code can be used to do that\:
features_1396_p=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).
features_1397_h3=Passing the User Name and/or Password in the URL
features_1398_p=Instead of passing the user name as a separate parameter as in <code>Connection conn \= DriverManager. getConnection("jdbc\:h2\:~/test", "sa", "123");</code> the user name (and/or password) can be supplied in the URL itself\: <code>Connection conn \= DriverManager. getConnection("jdbc\:h2\:~/test;USER\=sa;PASSWORD\=123");</code> The settings in the URL override the settings passed as a separate parameter.
features_1399_h2=User Defined Functions and Stored Procedures
features_1400_p=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\:
features_1401_p=The Java function must be registered in the database by calling CREATE ALIAS\:
features_1402_p=For a complete sample application, see src/test/org/h2/samples/Function.java.
features_1403_h3=Function Data Type Mapping
features_1404_p=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'.
features_1405_h3=Functions that require a Connection
features_1406_p=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.
features_1407_h3=Functions throwing an Exception
features_1408_p=If a function throws an Exception, then the current statement is rolled back and the exception is thrown to the application.
features_1409_h3=Functions returning a Result Set
features_1410_p=Functions may returns a result set. Such a function can be called with the CALL statement\:
features_1411_h3=Using SimpleResultSet
features_1412_p=A function that returns a result set can create this result set from scratch using the SimpleResultSet tool\:
features_1413_h3=Using a Function as a Table
features_1414_p=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.
features_1415_h2=Triggers
features_1416_p=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\:
features_1417_p=The connection can be used to query or update data in other tables. The trigger then needs to be defined in the database\:
features_1418_p=The trigger can be used to veto a change, by throwing a SQL Exception.
features_1419_h2=Compacting a Database
features_1420_p=Empty space in the database file is re-used automatically. To re-build the indexes, the most simple 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\:
features_1421_p=See also the sample application org.h2.samples.Compact. The commands SCRIPT / RUNSCRIPT can be used as well to create the a backup of a database and re-build the database from the script.
features_1422_h2=Cache Settings
features_1423_p=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.
features_1424_p=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 can not be changed once the database is open.
features_1425_p=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.
features_1426_h2=Why Java
features_1427_p=A few reasons using a Java database are\:
features_1428_li=Very simple to integrate in Java applications
features_1429_li=Support for many different platforms
features_1430_li=More secure than native applications (no buffer overflows)
features_1431_li=User defined functions (or triggers) run very fast
features_1432_li=Unicode support
features_1433_p=Some people think that Java is still too slow for low level operations, but this is not the case (not any more). In general, the code can be written a lot faster than using C or C++. Like that, it is possible to concentrate on improving the algorithms (that make the application faster) rather than porting the code and dealing with low level stuff (such as memory management or dealing with threads). Garbage collection is now probably faster than manual memory management.
features_1434_p=A lot of features are already built in (for example Unicode, network libraries). It is very easy to write secure code because buffer overflows and such problems can be detected very easily. Some features such as the reflection mechanism can be used for randomized testing.
features_1435_p=Java is also future proof\: A lot of companies support Java, and it is now open source.
features_1436_p=This software does not rely on many Java libraries or other software, to increase the portability and ease of use, and for performance reasons. For example, the encryption algorithms and many library functions are implemented in the database instead of using the existing libraries. Libraries that are not available in open source Java implementations (such as Swing) are not used or only used for specific features.
features_1130_td=Yes
features_1131_td=Yes
features_1132_td=Encrypted Database
features_1133_td=Yes
features_1134_td=Yes
features_1135_td=No
features_1136_td=No
features_1137_td=No
features_1138_td=ODBC Driver
features_1139_td=Yes
features_1140_td=Yes?
features_1141_td=No
features_1142_td=Yes
features_1143_td=Yes
features_1144_td=Fulltext Search
features_1145_td=Yes
features_1146_td=No
features_1147_td=No
features_1148_td=Yes
features_1149_td=Yes
features_1150_td=User Defined Datatypes
features_1151_td=Yes
features_1152_td=No
features_1153_td=No
features_1154_td=Yes
features_1155_td=Yes
features_1156_td=Files per Database
features_1157_td=Few
features_1158_td=Many
features_1159_td=Few
features_1160_td=Many
features_1161_td=Many
features_1162_td=Footprint (jar/dll size)
features_1163_td=~ 1 MB
features_1164_td=~ 2 MB
features_1165_td=~ 600 KB
features_1166_td=~ 4 MB
features_1167_td=~ 6 MB
features_1168_h3=Derby and HSQLDB
features_1169_p=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').
features_1170_h3=DaffodilDb and One$Db
features_1171_p=It looks like the development of this database has stopped. The last release was February 2006.
features_1172_h3=McKoi
features_1173_p=It looks like the development of this database has stopped. The last release was August 2004
features_1174_h2=H2 in Use
features_1175_p=For a list of applications that work with or use H2, see\: <a href\="http\://groups.google.com/group/h2-database/web/h2-in-use">http\://groups.google.com/group/h2-database/web/h2-in-use</a>
features_1176_h2=Connection Modes
features_1177_p=The following connection modes are supported\:
features_1178_li=Local connections using JDBC (embedded)
features_1179_li=Remote connections using JDBC over TCP/IP (client/server)
features_1180_li=Remote connections using ODBC over TCP/IP (client/server)
features_1181_li=In-Memory databases (private and shared)
features_1182_h2=Database URL Overview
features_1183_p=This database does support multiple connection modes and features when connecting to a database. This is achieved using different database URLs. The settings in the URLs are not case sensitive.
features_1184_th=Topic
features_1185_th=URL Format and Examples
features_1186_td=Embedded (local) connection
features_1187_td=jdbc\:h2\:[file\:][&lt;path&gt;]&lt;databaseName&gt;
features_1188_td=jdbc\:h2\:~/test
features_1189_td=jdbc\:h2\:file\:/data/sample
features_1190_td=jdbc\:h2\:file\:C\:/data/sample (Windows only)
features_1191_td=In-Memory (private)
features_1192_td=jdbc\:h2\:mem\:
features_1193_td=In-Memory (named)
features_1194_td=jdbc\:h2\:mem\:&lt;databaseName&gt;
features_1195_td=jdbc\:h2\:mem\:test_mem
features_1196_td=Remote using TCP/IP
features_1197_td=jdbc\:h2\:tcp\://&lt;server&gt;[\:&lt;port&gt;]/&lt;databaseName&gt;
features_1198_td=jdbc\:h2\:tcp\://localhost/test
features_1199_td=jdbc\:h2\:tcp\://dbserv\:8084/sample
features_1200_td=Remote using SSL/TLS
features_1201_td=jdbc\:h2\:ssl\://&lt;server&gt;[\:&lt;port&gt;]/&lt;databaseName&gt;
features_1202_td=jdbc\:h2\:ssl\://secureserv\:8085/sample;
features_1203_td=Using Encrypted Files
features_1204_td=jdbc\:h2\:&lt;url&gt;;CIPHER\=[AES|XTEA]
features_1205_td=jdbc\:h2\:ssl\://secureserv/testdb;CIPHER\=AES
features_1206_td=jdbc\:h2\:file\:~/secure;CIPHER\=XTEA
features_1207_td=File Locking Methods
features_1208_td=jdbc\:h2\:&lt;url&gt;;FILE_LOCK\={NO|FILE|SOCKET}
features_1209_td=jdbc\:h2\:file\:~/quickAndDirty;FILE_LOCK\=NO
features_1210_td=jdbc\:h2\:file\:~/private;CIPHER\=XTEA;FILE_LOCK\=SOCKET
features_1211_td=Only Open if it Already Exists
features_1212_td=jdbc\:h2\:&lt;url&gt;;IFEXISTS\=TRUE
features_1213_td=jdbc\:h2\:file\:~/sample;IFEXISTS\=TRUE
features_1214_td=Don't Close the Database when the VM Exits
features_1215_td=jdbc\:h2\:&lt;url&gt;;DB_CLOSE_ON_EXIT\=FALSE
features_1216_td=User Name and/or Password
features_1217_td=jdbc\:h2\:&lt;url&gt;[;USER\=&lt;username&gt;][;PASSWORD\=&lt;value&gt;]
features_1218_td=jdbc\:h2\:file\:~/sample;USER\=sa;PASSWORD\=123
features_1219_td=Log Index Changes
features_1220_td=jdbc\:h2\:&lt;url&gt;;LOG\=2
features_1221_td=jdbc\:h2\:file\:~/sample;LOG\=2
features_1222_td=Debug Trace Settings
features_1223_td=jdbc\:h2\:&lt;url&gt;;TRACE_LEVEL_FILE\=&lt;level 0..3&gt;
features_1224_td=jdbc\:h2\:file\:~/sample;TRACE_LEVEL_FILE\=3
features_1225_td=Ignore Unknown Settings
features_1226_td=jdbc\:h2\:&lt;url&gt;;IGNORE_UNKNOWN_SETTINGS\=TRUE
features_1227_td=Custom File Access Mode
features_1228_td=jdbc\:h2\:&lt;url&gt;;ACCESS_MODE_LOG\=rws;ACCESS_MODE_DATA\=rws
features_1229_td=In-Memory (private)
features_1230_td=jdbc\:h2\:mem\:
features_1231_td=Database in or Zip File
features_1232_td=jdbc\:h2\:zip\:&lt;zipFileName&gt;\!/&lt;databaseName&gt;
features_1233_td=jdbc\:h2\:zip\:db.zip\!/test
features_1234_td=Changing Other Settings
features_1235_td=jdbc\:h2\:&lt;url&gt;;&lt;setting&gt;\=&lt;value&gt;[;&lt;setting&gt;\=&lt;value&gt;...]
features_1236_td=jdbc\:h2\:file\:~/sample;TRACE_LEVEL_SYSTEM_OUT\=3
features_1237_h3=Connecting to an Embedded (Local) Database
features_1238_p=The database URL for connecting to a local database is <code>jdbc\:h2\:[file\:][&lt;path&gt;]&lt;databaseName&gt;</code> . The prefix <code>file\:</code> 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 suggested 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.
features_1239_h2=Memory-Only Databases
features_1240_p=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.
features_1241_p=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 <code>jdbc\:h2\:mem\:</code> Opening two connections within the same virtual machine means opening two different (private) databases.
features_1242_p=Sometimes multiple connections to the same memory-only database are required. In this case, the database URL must include a name. Example\: <code>jdbc\:h2\:mem\:db1</code> . Accessing the same database in this way only works within the same virtual machine and class loader environment.
features_1243_p=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\: <code>jdbc\:h2\:tcp\://localhost/mem\:db1</code> (using private database remotely is also possible).
features_1244_p=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
features_1245_h2=Connecting to a Database with File Encryption
features_1246_p=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\:
features_1247_h2=Database File Locking
features_1248_p=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.
features_1249_p=The following file locking methods are implemented\:
features_1250_li=The default method is 'file' and uses a watchdog thread to protect the database file. The watchdog reads the lock file each second.
features_1251_li=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.
features_1252_li=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.
features_1253_p=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\:
features_1254_p=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\:
features_1255_p=For more information about the algorithms please see in Advanced Topics under File Locking Protocol.
features_1256_h2=Opening a Database Only if it Already Exists
features_1257_p=By default, when an application calls <code>DriverManager.getConnection(url,...)</code> 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 <code>;ifexists\=true</code> 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\:
features_1258_h2=Closing the Database
features_1259_h3=Delayed Database Closing
features_1260_p=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 &lt;seconds&gt;. 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\:
features_1261_p=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\: <code>jdbc\:h2\:~/test;DB_CLOSE_DELAY\=10</code> .
features_1262_h3=Don't Close the Database when the VM Exits
features_1263_p=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\:
features_1264_h2=Log Index Changes
features_1265_p=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.
features_1266_h3=Ignore Unknown Settings
features_1267_p=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.
features_1268_h3=Changing Other Settings when Opening a Connection
features_1269_p=In addition to the settings already described (cipher, file_lock, ifexists, user, password), other database settings can be passed in the database URL. Adding <code>setting\=value</code> at the end of an URL is the same as executing the statement <code>SET setting value</code> just after connecting. For a list of settings supported by this database please see the SQL grammar documentation.
features_1270_h2=Custom File Access Mode
features_1271_p=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). 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\:
features_1272_p=For more information see <a href\="advanced.html\#durability_problems">Durability Problems</a> . On many operating systems the access mode 'rws' does not guarantee that the data is written to the disk.
features_1273_h2=Multiple Connections
features_1274_h3=Opening Multiple Databases at the Same Time
features_1275_p=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.
features_1276_h3=Multiple Connections to the Same Database\: Client/Server
features_1277_p=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).
features_1278_h3=Multithreading Support
features_1279_p=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 all accessing the same database at the same time, however if one thread executes a long running query, the other threads need to wait.
features_1280_h3=Locking, Lock-Timeout, Deadlocks
features_1281_p=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.
features_1282_p=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\:
features_1283_th=Type of Lock
features_1284_th=SQL Statement
features_1285_td=Read
features_1286_td=SELECT * FROM TEST
features_1287_td=CALL SELECT MAX(ID) FROM TEST
features_1288_td=SCRIPT
features_1289_td=Write
features_1290_td=SELECT * FROM TEST WHERE 1\=0 FOR UPDATE
features_1291_td=Write
features_1292_td=INSERT INTO TEST VALUES(1, 'Hello')
features_1293_td=INSERT INTO TEST SELECT * FROM TEST
features_1294_td=UPDATE TEST SET NAME\='Hi'
features_1295_td=DELETE FROM TEST
features_1296_td=Write
features_1297_td=ALTER TABLE TEST ...
features_1298_td=CREATE INDEX ... ON TEST ...
features_1299_td=DROP INDEX ...
features_1300_p=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 &lt;milliseconds&gt;. The initial lock timeout (that is the timeout used for new connections) can be set using the SQL command SET DEFAULT_LOCK_TIMEOUT &lt;milliseconds&gt;. The default lock timeout is persistent.
features_1301_h2=Database File Layout
features_1302_p=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\:
features_1303_th=File Name
features_1304_th=Description
features_1305_th=Number of Files
features_1306_td=test.data.db
features_1307_td=Data file
features_1308_td=Contains the data for all tables
features_1309_td=Format\: &lt;database&gt;.data.db
features_1310_td=1 per database
features_1311_td=test.index.db
features_1312_td=Index file
features_1313_td=Contains the data for all (btree) indexes
features_1314_td=Format\: &lt;database&gt;.index.db
features_1315_td=1 per database
features_1316_td=test.0.log.db
features_1317_td=Log file
features_1318_td=The log file is used for recovery
features_1319_td=Format\: &lt;database&gt;.&lt;id&gt;.log.db
features_1320_td=0 or more per database
features_1321_td=test.lock.db
features_1322_td=Database lock file
features_1323_td=Exists only if the database is open
features_1324_td=Format\: &lt;database&gt;.lock.db
features_1325_td=1 per database
features_1326_td=test.trace.db
features_1327_td=Trace file
features_1328_td=Contains trace information
features_1329_td=Format\: &lt;database&gt;.trace.db
features_1330_td=If the file is too big, it is renamed to &lt;database&gt;.trace.db.old
features_1331_td=1 per database
features_1332_td=test.14.15.lob.db
features_1333_td=Large object
features_1334_td=Contains the data for BLOB or CLOB
features_1335_td=Format\: &lt;database&gt;.&lt;tableid&gt;.&lt;id&gt;.lob.db
features_1336_td=1 per object
features_1337_td=test.123.temp.db
features_1338_td=Temporary file
features_1339_td=Contains a temporary blob or a large result set
features_1340_td=Format\: &lt;database&gt;.&lt;session id&gt;.&lt;object id&gt;.temp.db
features_1341_td=1 per object
features_1342_td=test.7.hash.db
features_1343_td=Hash index file
features_1344_td=Contains the data for a linear hash index
features_1345_td=Format\: &lt;database&gt;.&lt;object id&gt;.hash.db
features_1346_td=1 per linear hash index
features_1347_h3=Moving and Renaming Database Files
features_1348_p=Database name and location are not stored inside the database names.
features_1349_p=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).
features_1350_p=As there is no platform specific data in the files, they can be moved to other operating systems without problems.
features_1351_h3=Backup
features_1352_p=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.
features_1353_p=To backup data while the database is running, the SQL command SCRIPT can be used.
features_1354_h2=Logging and Recovery
features_1355_p=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.
features_1356_p=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.
features_1357_p=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.
features_1358_p=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.
features_1359_h2=Compatibility
features_1360_p=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\:
features_1361_p=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).
features_1362_h3=Compatibility Modes
features_1363_p=For certain features, this database can emulate the behavior of specific databases. Not all features or differences of those databases are implemented. Currently, this feature is mainly used for randomized comparative testing (where random statements are executed against multiple databases and the results are compared). The mode can be changed by specifying the mode in the database URL, or using the SQL statement SET MODE. To use the HSQLDB mode, you can use the database URL <code>jdbc\:h2\:~/test;MODE\=HSQLDB</code> or the SQL statement <code>SET MODE HSQLDB</code> . Here is the list of currently supported modes and the difference to the regular mode\:
features_1364_th=Mode
features_1365_th=Differences
features_1366_td=PostgreSQL
features_1367_td=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.
features_1368_td=MySQL
features_1369_td=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.
features_1370_td=HSQLDB
features_1371_td=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.
features_1372_h2=Using the Trace Options
features_1373_p=To find problems in an application, it is sometimes good to see what database operations where executed. This database offers the following trace features\:
features_1374_li=Trace to System.out and/or a file
features_1375_li=Support for trace levels OFF, ERROR, INFO, and DEBUG
features_1376_li=The maximum size of the trace file can be set
features_1377_li=The Java code generation is possible
features_1378_li=Trace can be enabled at runtime by manually creating a file
features_1379_h3=Trace Options
features_1380_p=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\:
features_1381_p=The trace level can be changed at runtime by executing the SQL command <code>SET TRACE_LEVEL_SYSTEM_OUT level</code> (for System.out tracing) or <code>SET TRACE_LEVEL_FILE level</code> (for file tracing). Example\:
features_1382_h3=Setting the Maximum Size of the Trace File
features_1383_p=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 <code>SET TRACE_MAX_FILE_SIZE maximumFileSizeInMB</code> . 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\:
features_1384_h3=Java Code Generation
features_1385_p=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\:
features_1386_p=You need to filter out the lines without /**/ to get the Java source code. In Windows, a simple way to do that is\:
features_1387_p=Afterwards, you need to complete the file Trace.java before it can be compiled, for example with\:
features_1388_p=Also, the user name and password needs to be set, because they are not listed in the trace file.
features_1389_h3=Enabling the Trace Option at Runtime by Manually Creating a File
features_1390_p=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.
features_1391_p=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.
features_1392_h2=Read Only Databases
features_1393_p=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().
features_1394_h2=Read Only Databases in Zip or Jar File
features_1395_p=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 SQL statement\:
features_1396_p=Afterwards, you can log out, and directly open the database in the zip file using the following database URL\:
features_1397_p=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.
features_1398_h2=Binary and Text Storage Formats
features_1399_p=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
features_1400_h2=Graceful Handling of Low Disk Space Situations
features_1401_p=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.
features_1402_p=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.
features_1403_h3=Opening a Corrupted Database
features_1404_p=If a database can not 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.
features_1405_h2=Computed Columns / Function Based Index
features_1406_p=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\:
features_1407_p=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\:
features_1408_h2=Multi-Dimensional Indexes
features_1409_p=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.
features_1410_p=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).
features_1411_p=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.
features_1412_h2=Using Passwords
features_1413_h3=Using Secure Passwords
features_1414_p=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\:
features_1415_p=i'sE2rtPiUKtT (it's easy to remember this password if you know the trick)
features_1416_h3=Passwords\: Using Char Arrays instead of Strings
features_1417_p=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).
features_1418_p=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.
features_1419_p=This database supports using char arrays instead of String to pass user and file passwords. The following code can be used to do that\:
features_1420_p=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).
features_1421_h3=Passing the User Name and/or Password in the URL
features_1422_p=Instead of passing the user name as a separate parameter as in <code>Connection conn \= DriverManager. getConnection("jdbc\:h2\:~/test", "sa", "123");</code> the user name (and/or password) can be supplied in the URL itself\: <code>Connection conn \= DriverManager. getConnection("jdbc\:h2\:~/test;USER\=sa;PASSWORD\=123");</code> The settings in the URL override the settings passed as a separate parameter.
features_1423_h2=User Defined Functions and Stored Procedures
features_1424_p=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\:
features_1425_p=The Java function must be registered in the database by calling CREATE ALIAS\:
features_1426_p=For a complete sample application, see src/test/org/h2/samples/Function.java.
features_1427_h3=Function Data Type Mapping
features_1428_p=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'.
features_1429_h3=Functions that require a Connection
features_1430_p=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.
features_1431_h3=Functions throwing an Exception
features_1432_p=If a function throws an Exception, then the current statement is rolled back and the exception is thrown to the application.
features_1433_h3=Functions returning a Result Set
features_1434_p=Functions may returns a result set. Such a function can be called with the CALL statement\:
features_1435_h3=Using SimpleResultSet
features_1436_p=A function that returns a result set can create this result set from scratch using the SimpleResultSet tool\:
features_1437_h3=Using a Function as a Table
features_1438_p=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.
features_1439_h2=Triggers
features_1440_p=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\:
features_1441_p=The connection can be used to query or update data in other tables. The trigger then needs to be defined in the database\:
features_1442_p=The trigger can be used to veto a change, by throwing a SQL Exception.
features_1443_h2=Compacting a Database
features_1444_p=Empty space in the database file is re-used automatically. To re-build the indexes, the most simple 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\:
features_1445_p=See also the sample application org.h2.samples.Compact. The commands SCRIPT / RUNSCRIPT can be used as well to create the a backup of a database and re-build the database from the script.
features_1446_h2=Cache Settings
features_1447_p=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.
features_1448_p=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 can not be changed once the database is open.
features_1449_p=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.
features_1450_h2=Why Java
features_1451_p=A few reasons using a Java database are\:
features_1452_li=Very simple to integrate in Java applications
features_1453_li=Support for many different platforms
features_1454_li=More secure than native applications (no buffer overflows)
features_1455_li=User defined functions (or triggers) run very fast
features_1456_li=Unicode support
features_1457_p=Some people think that Java is still too slow for low level operations, but this is not the case (not any more). In general, the code can be written a lot faster than using C or C++. Like that, it is possible to concentrate on improving the algorithms (that make the application faster) rather than porting the code and dealing with low level stuff (such as memory management or dealing with threads). Garbage collection is now probably faster than manual memory management.
features_1458_p=A lot of features are already built in (for example Unicode, network libraries). It is very easy to write secure code because buffer overflows and such problems can be detected very easily. Some features such as the reflection mechanism can be used for randomized testing.
features_1459_p=Java is also future proof\: A lot of companies support Java, and it is now open source.
features_1460_p=This software does not rely on many Java libraries or other software, to increase the portability and ease of use, and for performance reasons. For example, the encryption algorithms and many library functions are implemented in the database instead of using the existing libraries. Libraries that are not available in open source Java implementations (such as Swing) are not used or only used for specific features.
frame_1000_p=H2 (for 'Hypersonic 2') is free a Java SQL DBMS. Clustering, embedded and server mode, transactions, referential integrity, views, subqueries, triggers, encryption, and disk based or in-memory operation are supported. A browser based console application is included. If you see this page your browser does not support frames. Please click here to view the <a href\="search.html">index</a> .
history_1000_h1=History and Roadmap
history_1001_a=History of this Database Engine
......@@ -1694,11 +1718,11 @@ tutorial_1133_h2=Fulltext Search
tutorial_1134_p=H2 supports Lucene full text search and native full text search implementation.
tutorial_1135_h3=Using the Native Full Text Search
tutorial_1136_p=To initialize, call\:
tutorial_1137_p=Afterwards, you can create a full text index for a table using\:
tutorial_1137_p=You need to initialize it in each database where you want to use it. Afterwards, you can create a full text index for a table using\:
tutorial_1138_p=PUBLIC is the schema, TEST is the table name. The list of column names (column separated) is optional, in this case all columns are indexed. The index is updated in read time. To search the index, use the following query\:
tutorial_1139_p=You can also call the index from within a Java application\:
tutorial_1140_h3=Using the Lucene Fulltext Search
tutorial_1141_p=To use the Lucene full text search, you first need to rename the file FullTextLucene.java.txt to FullTestLucene.java and compile it. Also, you need the Lucene library in the classpath. To initialize, call\:
tutorial_1142_p=Afterwards, you can create a full text index for a table using\:
tutorial_1141_p=To use the Lucene full text search, you need the Lucene library in the classpath. How his is done depends on the application; if you use the H2 Console, you can add the Lucene jar file to the the environment variables H2DRIVERS or CLASSPATH. To initialize the Lucene full text search in a database, call\:
tutorial_1142_p=You need to initialize it in each database where you want to use it. Afterwards, you can create a full text index for a table using\:
tutorial_1143_p=PUBLIC is the schema, TEST is the table name. The list of column names (column separated) is optional, in this case all columns are indexed. The index is updated in read time. To search the index, use the following query\:
tutorial_1144_p=You can also call the index from within a Java application\:
......@@ -28,10 +28,23 @@ public class Sentence {
return System.currentTimeMillis() > max;
}
/**
* Add a word to the set of next tokens.
*
* @param n the token name
* @param string an example text
* @param type the type
*/
public void add(String n, String string, int type) {
next.put(type+"#"+n, string);
}
/**
* Add an alias name and object
*
* @param alias the alias name
* @param table the alias table
*/
public void addAlias(String alias, DbTableOrView table) {
if (aliases == null) {
aliases = new HashMap();
......@@ -39,6 +52,11 @@ public class Sentence {
aliases.put(alias, table);
}
/**
* Add a table.
*
* @param table the table
*/
public void addTable(DbTableOrView table) {
lastTable = table;
if (tables == null) {
......@@ -47,14 +65,29 @@ public class Sentence {
tables.add(table);
}
/**
* Get the set of tables.
*
* @return the set of tables
*/
public HashSet getTables() {
return tables;
}
/**
* Get the alias map.
*
* @return the alias map
*/
public HashMap getAliases() {
return aliases;
}
/**
* Get the last added table.
*
* @return the last table
*/
public DbTableOrView getLastTable() {
return lastTable;
}
......
......@@ -21,17 +21,65 @@ import org.h2.util.ObjectArray;
* Represents a SQL statement. This object is only used on the server side.
*/
public abstract class Command implements CommandInterface {
private final String sql;
/**
* The session.
*/
protected final Session session;
/**
* The trace module.
*/
protected final Trace trace;
/**
* The last start time.
*/
protected long startTime;
/**
* If this query was cancelled.
*/
private volatile boolean cancel;
private final String sql;
/**
* Check if this command is transactional.
* If it is not, then it forces the current transaction to commit.
*
* @return true if it is
*/
public abstract boolean isTransactional();
/**
* Check if this command is a query.
*
* @return true if it is
*/
public abstract boolean isQuery();
/**
* Get the list of parameters.
*
* @return the list of parameters
*/
public abstract ObjectArray getParameters();
/**
* Check if this command is read only.
*
* @return true if it is
*/
public abstract boolean isReadOnly();
/**
* Get an empty result set containing the meta data.
*
* @return an empty result set
*/
public abstract LocalResult queryMeta() throws SQLException;
public Command(Parser parser, String sql) {
this.session = parser.getSession();
this.sql = sql;
......@@ -46,8 +94,6 @@ public abstract class Command implements CommandInterface {
throw Message.getSQLException(ErrorCode.METHOD_ONLY_ALLOWED_FOR_QUERY);
}
public abstract LocalResult queryMeta() throws SQLException;
public final LocalResult getMetaDataLocal() throws SQLException {
return queryMeta();
}
......
......@@ -41,13 +41,13 @@ public class CommandContainer extends Command {
private void recompileIfRequired() throws SQLException {
if (prepared.needRecompile()) {
// TODO test with 'always recompile'
prepared.setModificationId(0);
prepared.setModificationMetaId(0);
String sql = prepared.getSQL();
ObjectArray oldValues = prepared.getParameters();
Parser parser = new Parser(session);
prepared = parser.parseOnly(sql);
long mod = prepared.getModificationId();
prepared.setModificationId(0);
long mod = prepared.getModificationMetaId();
prepared.setModificationMetaId(0);
ObjectArray newParams = prepared.getParameters();
for (int i = 0; i < newParams.size(); i++) {
Value v = ((Expression) oldValues.get(i)).getValue(session);
......@@ -55,7 +55,7 @@ public class CommandContainer extends Command {
p.setValue(v);
}
prepared.prepare();
prepared.setModificationId(mod);
prepared.setModificationMetaId(mod);
}
}
......
......@@ -21,21 +21,76 @@ import org.h2.util.ObjectArray;
*/
public abstract class Prepared {
/**
* The session.
*/
protected Session session;
/**
* The SQL string.
*/
protected String sql;
/**
* The position of the head record (used for indexes).
*/
protected int headPos = -1;
/**
* The list of parameters.
*/
protected ObjectArray parameters;
private long modificationId;
/**
* If the query should be prepared before each execution.
* This is set for queries with LIKE ?, because the query plan depends on the parameter value.
*/
protected boolean prepareAlways;
private long modificationMetaId;
private Command command;
private int objectId;
protected boolean prepareAlways;
private int currentRowNumber;
/**
* Check if this command is transactional.
* If it is not, then it forces the current transaction to commit.
*
* @return true if it is
*/
public abstract boolean isTransactional();
/**
* Get an empty result set containing the meta data.
*
* @return an empty result set
*/
public abstract LocalResult queryMeta() throws SQLException;
/**
* Check if this command is read only.
*
* @return true if it is
*/
public boolean isReadOnly() {
return false;
}
/**
* Create a new object.
*
* @param session the session
*/
public Prepared(Session session) {
this.session = session;
modificationId = session.getDatabase().getModificationMetaId();
modificationMetaId = session.getDatabase().getModificationMetaId();
}
/**
* Check if the statement needs to be re-compiled.
*
* @return true if it must
*/
public boolean needRecompile() throws SQLException {
Database db = session.getDatabase();
if (db == null) {
......@@ -43,27 +98,41 @@ public abstract class Prepared {
}
// TODO parser: currently, compiling every create/drop/... twice!
// because needRecompile return true even for the first execution
return SysProperties.RECOMPILE_ALWAYS || prepareAlways || modificationId < db.getModificationMetaId();
return SysProperties.RECOMPILE_ALWAYS || prepareAlways || modificationMetaId < db.getModificationMetaId();
}
public abstract boolean isTransactional();
public boolean isReadOnly() {
return false;
}
long getModificationId() {
return modificationId;
/**
* Get the meta data modification id of the database when this statement was compiled.
*
* @return the meta data modification id
*/
long getModificationMetaId() {
return modificationMetaId;
}
void setModificationId(long id) {
this.modificationId = id;
/**
* Set the meta data modification id of this statement.
*
* @param id the new id
*/
void setModificationMetaId(long id) {
this.modificationMetaId = id;
}
/**
* Set the parameter list of this statement.
*
* @param parameters the parameter list
*/
public void setParameterList(ObjectArray parameters) {
this.parameters = parameters;
}
/**
* Get the parameter list.
*
* @return the parameter list
*/
public ObjectArray getParameters() {
return parameters;
}
......@@ -75,32 +144,66 @@ public abstract class Prepared {
}
}
/**
* Set the command.
*
* @param command the new command
*/
public void setCommand(Command command) {
this.command = command;
}
/**
* Check if this object is a query.
*
* @return true if it is
*/
public boolean isQuery() {
return false;
}
/**
* Prepare this statement.
*/
public void prepare() throws SQLException {
// nothing to do
}
/**
* Execute the statement.
*
* @return the update count
* @throws SQLException if it is a query
*/
public int update() throws SQLException {
throw Message.getSQLException(ErrorCode.METHOD_NOT_ALLOWED_FOR_QUERY);
}
/**
* Execute the query.
*
* @param maxrows the maximum number of rows to return
* @return the result set
* @throws SQLException if it is not a query
*/
public LocalResult query(int maxrows) throws SQLException {
throw Message.getSQLException(ErrorCode.METHOD_ONLY_ALLOWED_FOR_QUERY);
}
public abstract LocalResult queryMeta() throws SQLException;
/**
* Set the SQL statement.
*
* @param sql the SQL statement
*/
public void setSQL(String sql) {
this.sql = sql;
}
/**
* Get the SQL statement.
*
* @return the SQL statement
*/
public String getSQL() {
return sql;
}
......@@ -115,10 +218,20 @@ public abstract class Prepared {
return id;
}
/**
* Get the SQL statement with the execution plan.
*
* @return the execution plan
*/
public String getPlanSQL() {
return null;
}
/**
* Check if this statement was cancelled.
*
* @throws SQLException if it was cancelled
*/
public void checkCancelled() throws SQLException {
// TODO strange code: probably checkCancelled should always be called on the session. fix & test after release 1.0
if (command != null) {
......@@ -128,14 +241,29 @@ public abstract class Prepared {
}
}
/**
* Set the object id for this statement.
*
* @param i the object id
*/
public void setObjectId(int i) {
this.objectId = i;
}
/**
* Set the head position.
*
* @param headPos the head position
*/
public void setHeadPos(int headPos) {
this.headPos = headPos;
}
/**
* Set the session for this statement.
*
* @param currentSession the new session
*/
public void setSession(Session currentSession) {
this.session = currentSession;
}
......@@ -163,18 +291,39 @@ public abstract class Prepared {
}
}
/**
* Set the prepare always flag.
* If set, the statement is re-compiled whenever it is executed.
*
* @param prepareAlways the new value
*/
public void setPrepareAlways(boolean prepareAlways) {
this.prepareAlways = prepareAlways;
}
/**
* Set the current row number.
*
* @param rowNumber the row number
*/
protected void setCurrentRowNumber(int rowNumber) {
this.currentRowNumber = rowNumber;
}
/**
* Get the current row number.
*
* @return the row number
*/
public int getCurrentRowNumber() {
return currentRowNumber;
}
/**
* Convert the statement to a String.
*
* @return the SQL statement
*/
public String toString() {
return sql;
}
......
......@@ -13,18 +13,32 @@ import org.h2.result.LocalResult;
*/
public abstract class DefineCommand extends Prepared {
/**
* Create a new command for the given session.
*
* @param session the session
*/
public DefineCommand(Session session) {
super(session);
}
/**
* {@inheritDoc}
*/
public boolean isTransactional() {
return false;
}
/**
* {@inheritDoc}
*/
public boolean isReadOnly() {
return false;
}
/**
* {@inheritDoc}
*/
public LocalResult queryMeta() {
return null;
}
......
......@@ -16,11 +16,22 @@ public abstract class SchemaCommand extends DefineCommand {
private final Schema schema;
/**
* Create a new command.
*
* @param session the session
* @param schema the schema
*/
public SchemaCommand(Session session, Schema schema) {
super(session);
this.schema = schema;
}
/**
* Get the schema
*
* @return the schema
*/
protected Schema getSchema() throws SQLException {
return schema;
}
......
......@@ -32,7 +32,19 @@ import org.h2.value.ValueNull;
*/
public abstract class Query extends Prepared {
protected Expression limit, offset;
/**
* The limit expression as specified in the LIMIT or TOP clause.
*/
protected Expression limit;
/**
* The offset expression as specified in the LIMIT .. OFFSET clause.
*/
protected Expression offset;
/**
* The sample size
*/
protected int sampleSize;
private int lastLimit;
......@@ -40,8 +52,119 @@ public abstract class Query extends Prepared {
private LocalResult lastResult;
private Value[] lastParameters;
/**
* Execute the query without checking the cache.
*
* @param limit the limit as specified in the JDBC method call
* @return the result
*/
abstract LocalResult queryWithoutCache(int limit) throws SQLException;
/**
* Initialize the query.
*/
public abstract void init() throws SQLException;
/**
* The the list of select expressions.
* This may include invisible expressions such as order by expressions.
*
* @return the list of expressions
*/
public abstract ObjectArray getExpressions();
/**
* Calculate the cost to execute this query.
*
* @return the cost
*/
public abstract double getCost();
/**
* Get all tables that are involved in this query.
*
* @return the set of tables
*/
public abstract HashSet getTables();
/**
* Set the order by list.
*
* @param order the order by list
*/
public abstract void setOrder(ObjectArray order);
/**
* Set the 'for update' flag.
*
* @param forUpdate the new setting
*/
public abstract void setForUpdate(boolean forUpdate);
/**
* Get the column count of this query.
*
* @return the column count
*/
public abstract int getColumnCount();
/**
* Map the columns to the given column resolver.
*
* @param resolver the resolver
* @param level the subquery level (0 is the top level query, 1 is the first subquery level)
*/
public abstract void mapColumns(ColumnResolver resolver, int level) throws SQLException;
/**
* Change the evaluatable flag. This is used when building the execution plan.
*
* @param tableFilter the table filter
* @param b the new value
*/
public abstract void setEvaluatable(TableFilter tableFilter, boolean b);
/**
* Add a condition to the query. This is used for views.
*
* @param param the parameter
* @param columnId the column index (0 meaning the first column)
* @param comparisonType the comparison type
*/
public abstract void addGlobalCondition(Parameter param, int columnId, int comparisonType) throws SQLException;
/**
* Set the distinct flag.
*
* @param b the new value
*/
public abstract void setDistinct(boolean b);
/**
* Get the alias (or column name) of the first column.
* This is used to convert IN(SELECT ...) queries to inner joins.
*
* @param session the session
* @return the alias or column name
*/
public abstract String getFirstColumnAlias(Session session);
/**
* Check if this expression and all sub-expressions can fulfill a criteria.
* If any part returns false, the result is false.
*
* @param visitor the visitor
* @return if the criteria can be fulfilled
*/
public abstract boolean isEverything(ExpressionVisitor visitor);
/**
* Update all aggregate function values.
*
* @param session the session
*/
public abstract void updateAggregate(Session session) throws SQLException;
public Query(Session session) {
super(session);
}
......@@ -237,19 +360,6 @@ public abstract class Query extends Prepared {
this.limit = limit;
}
public abstract void init() throws SQLException;
public abstract ObjectArray getExpressions();
public abstract double getCost();
public abstract HashSet getTables();
public abstract void setOrder(ObjectArray order);
public abstract void setForUpdate(boolean forUpdate);
public abstract int getColumnCount();
public abstract void mapColumns(ColumnResolver resolver, int level) throws SQLException;
public abstract void setEvaluatable(TableFilter tableFilter, boolean b);
public abstract void addGlobalCondition(Parameter param, int columnId, int comparisonType) throws SQLException;
public abstract void setDistinct(boolean b);
public abstract String getFirstColumnAlias(Session session);
void addParameter(Parameter param) {
if (parameters == null) {
parameters = new ObjectArray();
......@@ -267,13 +377,9 @@ public abstract class Query extends Prepared {
return visitor.getMaxDataModificationId();
}
public abstract boolean isEverything(ExpressionVisitor visitor);
public final boolean isEverything(int expressionVisitorType) {
ExpressionVisitor visitor = ExpressionVisitor.get(expressionVisitorType);
return isEverything(visitor);
}
public abstract void updateAggregate(Session session) throws SQLException;
}
......@@ -33,14 +33,26 @@ import org.h2.value.Value;
*/
public abstract class ScriptBase extends Prepared implements DataHandler {
/**
* The output stream.
*/
protected OutputStream out;
/**
* The input stream.
*/
protected InputStream in;
/**
* The file name (if set).
*/
protected String fileName;
private String cipher;
private byte[] key;
private FileStore store;
private OutputStream outStream;
private InputStream inStream;
protected OutputStream out;
protected InputStream in;
protected String fileName;
private String compressionAlgorithm;
public ScriptBase(Session session) {
......@@ -76,7 +88,7 @@ public abstract class ScriptBase extends Prepared implements DataHandler {
FileUtils.delete(fileName);
}
}
private void initStore() throws SQLException {
byte[] magic = Database.getMagic(true);
Database db = session.getDatabase();
......@@ -85,7 +97,7 @@ public abstract class ScriptBase extends Prepared implements DataHandler {
store.setCheckedWriting(false);
store.init();
}
protected void openOutput() throws SQLException {
if (fileName == null) {
return;
......@@ -194,7 +206,7 @@ public abstract class ScriptBase extends Prepared implements DataHandler {
public String getLobCompressionAlgorithm(int type) {
return session.getDatabase().getLobCompressionAlgorithm(type);
}
public void setCompressionAlgorithm(String algorithm) {
this.compressionAlgorithm = algorithm;
}
......
......@@ -573,8 +573,6 @@ public class Select extends Query {
if (!type.isHash() && (!type.isUnique() || columnIndex.getColumns().length > 1)) {
topTableFilter.setIndex(columnIndex);
isDistinctQuery = true;
int test;
System.out.println("##distinct: " + this.sql);
}
}
}
......
......@@ -46,6 +46,7 @@ public interface Compressor {
/**
* Expand a number of compressed bytes.
*
* @param in the compressed data
* @param inPos the offset at the input array
* @param inLen the number of bytes to read
......@@ -54,5 +55,12 @@ public interface Compressor {
* @param outLen the size of the uncompressed data
*/
void expand(byte[] in, int inPos, int inLen, byte[] out, int outPos, int outLen) throws SQLException;
/**
* Set the compression options. This may include settings for
* higher performance but less compression.
*
* @param options the options
*/
void setOptions(String options) throws SQLException;
}
......@@ -21,9 +21,90 @@ import org.h2.table.Table;
*/
public abstract class Constraint extends SchemaObjectBase {
public static final String CHECK = "CHECK", REFERENTIAL = "REFERENTIAL", UNIQUE = "UNIQUE";
/**
* The constraint type name for check constraints.
*/
public static final String CHECK = "CHECK";
/**
* The constraint type name for referential constraints.
*/
public static final String REFERENTIAL = "REFERENTIAL";
/**
* The constraint type name for unique constraints.
*/
public static final String UNIQUE = "UNIQUE";
/**
* The table for which this constraint is defined.
*/
protected Table table;
/**
* The constraint type name
*
* @return the name
*/
public abstract String getConstraintType();
/**
* Check if this row fulfils the constraint.
* This method throws an exception if not.
*
* @param session the session
* @param t the table
* @param oldRow the old row
* @param newRow the new row
*/
public abstract void checkRow(Session session, Table t, Row oldRow, Row newRow) throws SQLException;
/**
* Check if this constraint needs the specified index.
*
* @param index the index
* @return true if the index is used
*/
public abstract boolean usesIndex(Index index);
/**
* Check if this constraint contains the given column.
*
* @param col the column
* @return true if it does
*/
public abstract boolean containsColumn(Column col);
/**
* Get the SQL statement to create this constraint.
*
* @return the SQL statement
*/
public abstract String getCreateSQLWithoutIndexes();
/**
* Check if this constraint needs to be checked before updating the data.
*
* @return true if it must be checked before updating
*/
public abstract boolean isBefore();
/**
* Get a short description of the constraint. This includes the constraint name (if set),
* and the constraint expression.
*
* @return the description
*/
public abstract String getShortDescription();
/**
* Check the existing data. This method is called if the constraint is added after
* data has been inserted into the table.
*
* @param session the session
*/
public abstract void checkExistingData(Session session) throws SQLException;
public Constraint(Schema schema, int id, String name, Table table) {
super(schema, id, name, Trace.CONSTRAINT);
this.table = table;
......@@ -38,15 +119,6 @@ public abstract class Constraint extends SchemaObjectBase {
return DbObject.CONSTRAINT;
}
public abstract String getConstraintType();
public abstract void checkRow(Session session, Table t, Row oldRow, Row newRow) throws SQLException;
public abstract boolean usesIndex(Index index);
public abstract boolean containsColumn(Column col);
public abstract String getCreateSQLWithoutIndexes();
public abstract boolean isBefore();
public abstract String getShortDescription();
public abstract void checkExistingData(Session session) throws SQLException;
public Table getTable() {
return table;
}
......
......@@ -32,9 +32,6 @@ import org.h2.value.ValueNull;
public class ConstraintReferential extends Constraint {
public static final int RESTRICT = 0, CASCADE = 1, SET_DEFAULT = 2, SET_NULL = 3;
// TODO referential constraints: maybe use a own class for self referencing
// constraints
private int deleteAction;
private int updateAction;
private Table refTable;
......
......@@ -12,20 +12,80 @@ import org.h2.util.ObjectArray;
* A database object such as a table, an index, or a user.
*/
public interface DbObject {
/**
* The object is of the type table or view.
*/
int TABLE_OR_VIEW = 0;
/**
* This object is an index.
*/
int INDEX = 1;
/**
* This object is a user.
*/
int USER = 2;
/**
* This object is a sequence.
*/
int SEQUENCE = 3;
/**
* This object is a trigger.
*/
int TRIGGER = 4;
/**
* This object is a constraint (check constraint, unique constraint, or referential constraint).
*/
int CONSTRAINT = 5;
/**
* This object is a setting.
*/
int SETTING = 6;
/**
* This object is a role.
*/
int ROLE = 7;
/**
* This object is a right.
*/
int RIGHT = 8;
/**
* This object is an alias for a Java function.
*/
int FUNCTION_ALIAS = 9;
/**
* This object is a schema.
*/
int SCHEMA = 10;
/**
* This object is a constant.
*/
int CONSTANT = 11;
/**
* This object is a user data type (domain).
*/
int USER_DATATYPE = 12;
/**
* This object is a comment.
*/
int COMMENT = 13;
/**
* This object is a user defined aggregate function.
*/
int AGGREGATE = 14;
/**
......
......@@ -17,13 +17,68 @@ import org.h2.util.ObjectArray;
*/
public abstract class DbObjectBase implements DbObject {
private int id;
/**
* The database.
*/
protected Database database;
/**
* The trace module.
*/
protected Trace trace;
/**
* The comment (if set).
*/
protected String comment;
private int id;
private String objectName;
private long modificationId;
private boolean temporary;
protected String comment;
/**
* Build a SQL statement to re-create the object, or to create a copy of the object
* with a different name or referencing a different table
*
* @param table the new table name
* @param quotedName the new quoted name
* @return the SQL statement
*/
public abstract String getCreateSQLForCopy(Table table, String quotedName);
/**
* Build a SQL statement to re-create this object.
*
* @return the SQL statement
*/
public abstract String getCreateSQL();
/**
* Build a SQL statement to drop this object.
*
* @return the SQL statement
*/
public abstract String getDropSQL();
/**
* Get the object type.
*
* @return the object type
*/
public abstract int getType();
/**
* Remove all dependent objects and free all resources (files, blocks in files) of this object.
*
* @param session the session
*/
public abstract void removeChildrenAndResources(Session session) throws SQLException;
/**
* Check if this object can be renamed. System objects may not be renamed.
*/
public abstract void checkRename() throws SQLException;
protected DbObjectBase(Database database, int id, String name, String traceModule) {
this.database = database;
......@@ -65,18 +120,6 @@ public abstract class DbObjectBase implements DbObject {
return objectName;
}
public abstract String getCreateSQLForCopy(Table table, String quotedName);
public abstract String getCreateSQL();
public abstract String getDropSQL();
public abstract int getType();
public abstract void removeChildrenAndResources(Session session) throws SQLException;
public abstract void checkRename() throws SQLException;
protected void invalidate() {
setModified();
id = -1;
......
......@@ -17,9 +17,18 @@ import org.h2.table.Table;
*/
public abstract class RightOwner extends DbObjectBase {
// key: role; value: right
/**
* The map of granted roles.
* The key is the role,
* and the value is the right.
*/
private HashMap grantedRoles;
// key: table; value: right
/**
* The map of granted rights.
* The key is the table,
* and the value is the right.
*/
private HashMap grantedRights;
protected RightOwner(Database database, int id, String name, String traceModule) {
......
......@@ -76,20 +76,4 @@ public interface FunctionCall {
*/
String getSQL();
/**
* Check if the function can return the row count
* (if the function returns a number of rows).
*
* @return true if the function can return the row count
*/
// boolean canGetRowCount();
/**
* Get the number of rows
* (if the function returns a number of rows).
*
* @return the row count
*/
// int getRowCount(Session session);
}
......@@ -36,6 +36,82 @@ public abstract class BaseIndex extends SchemaObjectBase implements Index {
protected IndexType indexType;
protected long rowCount;
/**
* Close this index.
*
* @param session the session
*/
public abstract void close(Session session) throws SQLException;
/**
* Add a row to this index.
*
* @param session the session
* @param row the row to add
*/
public abstract void add(Session session, Row row) throws SQLException;
/**
* Remove a row from the index.
*
* @param session the session
* @param row the row
*/
public abstract void remove(Session session, Row row) throws SQLException;
/**
* Create a cursor to iterate over a number of rows.
*
* @param session the session
* @param first the first row to return (null if no limit)
* @param last the last row to return (null if no limit)
*/
public abstract Cursor find(Session session, SearchRow first, SearchRow last) throws SQLException;
/**
* Calculate the cost to find rows.
*
* @param session the session
* @param masks the condition mask
*/
public abstract double getCost(Session session, int[] masks) throws SQLException;
/**
* Remove the index.
*
* @param session the session
*/
public abstract void remove(Session session) throws SQLException;
/**
* Truncate the index.
*
* @param session the session
*/
public abstract void truncate(Session session) throws SQLException;
/**
* Check if this index can quickly find the first or last value.
*
* @return true if it can
*/
public abstract boolean canGetFirstOrLast();
/**
* Find the first (or last) value of this index.
*
* @param session the session
* @param first true for the first value, false for the last
*/
public abstract SearchRow findFirstOrLast(Session session, boolean first) throws SQLException;
/**
* Check if this index needs to be re-built.
*
* @return true if it must be re-built.
*/
public abstract boolean needRebuild();
public BaseIndex(Table table, int id, String name, IndexColumn[] indexColumns, IndexType indexType) {
super(table.getSchema(), id, name, Trace.INDEX);
this.indexType = indexType;
......@@ -77,14 +153,6 @@ public abstract class BaseIndex extends SchemaObjectBase implements Index {
remove(session);
}
public abstract void close(Session session) throws SQLException;
public abstract void add(Session session, Row row) throws SQLException;
public abstract void remove(Session session, Row row) throws SQLException;
public abstract Cursor find(Session session, SearchRow first, SearchRow last) throws SQLException;
public boolean canFindNext() {
return false;
}
......@@ -93,18 +161,6 @@ public abstract class BaseIndex extends SchemaObjectBase implements Index {
throw Message.getInternalError();
}
public abstract double getCost(Session session, int[] masks) throws SQLException;
public abstract void remove(Session session) throws SQLException;
public abstract void truncate(Session session) throws SQLException;
public abstract boolean canGetFirstOrLast();
public abstract SearchRow findFirstOrLast(Session session, boolean first) throws SQLException;
public abstract boolean needRebuild();
public long getRowCount(Session session) {
return rowCount;
}
......
......@@ -180,7 +180,7 @@ public class BtreeIndex extends BaseIndex implements RecordReader {
truncate(session);
} else {
BtreePage root = getRoot(session);
root.remove(session, row, 0);
root.remove(session, row);
rowCount--;
}
}
......
......@@ -84,7 +84,7 @@ public class BtreeLeaf extends BtreePage {
return splitPoint;
}
public SearchRow remove(Session session, Row oldRow, int level) throws SQLException {
public SearchRow remove(Session session, Row oldRow) throws SQLException {
int l = 0, r = pageData.size();
if (r == 0) {
if (!Constants.ALLOW_EMPTY_BTREE_PAGES && !root) {
......
......@@ -112,7 +112,7 @@ public class BtreeNode extends BtreePage {
return 0;
}
public SearchRow remove(Session session, Row oldRow, int level) throws SQLException {
public SearchRow remove(Session session, Row oldRow) throws SQLException {
int l = 0, r = pageData.size();
if (!Constants.ALLOW_EMPTY_BTREE_PAGES && pageChildren.size() == 0) {
throw Message.getInternalError("Empty btree page");
......@@ -134,7 +134,7 @@ public class BtreeNode extends BtreePage {
int at = l;
// merge is not implemented to allow concurrent usage of btrees
BtreePage page = index.getPage(session, pageChildren.get(at));
SearchRow first = page.remove(session, oldRow, level + 1);
SearchRow first = page.remove(session, oldRow);
if (first == null) {
// the first row didn't change - nothing to do here
return null;
......
......@@ -30,14 +30,24 @@ public abstract class BtreePage extends Record {
protected ObjectArray pageData;
protected boolean root;
BtreePage(BtreeIndex index) {
this.index = index;
}
/**
* Add a row to the index.
*
* @param row the row
* @param session the session
* @return the split point of this page, or 0 if no split is required
*/
abstract int add(Row row, Session session) throws SQLException;
// Returns the new first row in the list; null if no change; the deleted row if not empty
abstract SearchRow remove(Session session, Row row, int level) throws SQLException;
/**
* Remove a row from the page.
*
* @param session the session
* @param row the row
* @return the new first row in the list; null if no change; the deleted row if not empty
*/
abstract SearchRow remove(Session session, Row row) throws SQLException;
abstract BtreePage split(Session session, int splitPoint) throws SQLException;
abstract boolean findFirst(BtreeCursor cursor, SearchRow row, boolean bigger) throws SQLException;
abstract SearchRow getFirst(Session session) throws SQLException;
......@@ -46,6 +56,10 @@ public abstract class BtreePage extends Record {
abstract void first(BtreeCursor cursor) throws SQLException;
abstract int getRealByteCount() throws SQLException;
BtreePage(BtreeIndex index) {
this.index = index;
}
SearchRow getData(int i) throws SQLException {
return (SearchRow) pageData.get(i);
}
......
......@@ -34,7 +34,7 @@ public class JdbcStatement extends TraceObject implements Statement {
protected int queryTimeout;
protected boolean queryTimeoutSet;
protected int fetchSize = SysProperties.SERVER_RESULT_SET_FETCH_SIZE;
; protected int updateCount;
protected int updateCount;
private CommandInterface executingCommand;
private ObjectArray batchCommands;
protected int resultSetType;
......
......@@ -42,10 +42,115 @@ import org.h2.value.ValueUuid;
public abstract class DataPage {
static final boolean CHECKSUM = true;
/**
* The data handler responsible for lob objects.
*/
protected DataHandler handler;
/**
* The data itself.
*/
protected byte[] data;
/**
* The current write or read position.
*/
protected int pos;
/**
* Calculate the checksum and write.
*
*/
public abstract void updateChecksum();
/**
* Test if the checksum is correct.
*
* @param len the number of bytes
* @throws SQLException if the checksum does not match
*/
public abstract void check(int len) throws SQLException;
/**
* The space required for the checksum and additional fillers.
*
* @return the size
*/
public abstract int getFillerLength();
/**
* Update an integer at the given position.
* The current position is not change.
*
* @param pos the position
* @param x the value
*/
public abstract void setInt(int pos, int x);
/**
* Write an integer at the current position.
* The current position is incremented.
*
* @param x the value
*/
public abstract void writeInt(int x);
/**
* Read an integer at the current position.
* The current position is incremented.
*
* @return the value
*/
public abstract int readInt();
/**
* Get the length of an integer value.
*
* @return the length
*/
public abstract int getIntLen();
/**
* Get the length of a long value.
*
* @param x the value
* @return the length
*/
public abstract int getLongLen(long x);
/**
* Get the length of a String value.
*
* @param s the value
* @return the length
*/
public abstract int getStringLen(String s);
/**
* Read a String value.
* The current position is incremented.
*
* @return the value
*/
public abstract String readString();
/**
* Write a String value.
* The current position is incremented.
*
* @param s the value
*/
public abstract void writeString(String s);
/**
* Increase the size to the given length.
* The current position is set to the given value.
*
* @param len the new length
*/
public abstract void fill(int len);
public static DataPage create(DataHandler handler, int capacity) {
if (handler.getTextStorage()) {
return new DataPageText(handler, new byte[capacity]);
......@@ -77,14 +182,6 @@ public abstract class DataPage {
}
}
public abstract void updateChecksum();
public abstract void check(int len) throws SQLException;
public abstract int getFillerLength();
public abstract void setInt(int pos, int x);
public int length() {
return pos;
}
......@@ -132,20 +229,6 @@ public abstract class DataPage {
return data[pos++];
}
public abstract void writeInt(int x);
public abstract int readInt();
public abstract int getIntLen();
public abstract int getLongLen(long x);
public abstract int getStringLen(String s);
public abstract String readString();
public abstract void writeString(String s);
public long readLong() {
return ((long) (readInt()) << 32) + (readInt() & 0xffffffffL);
}
......@@ -418,8 +501,6 @@ public abstract class DataPage {
}
}
public abstract void fill(int len);
public void fillAligned() {
// TODO datapage: fillAligned should not use a fixed constant '2'
// 0..6 > 8, 7..14 > 16, 15..22 > 24, ...
......
......@@ -20,8 +20,21 @@ public abstract class Record extends CacheObject {
private int lastLog = LogSystem.LOG_WRITTEN;
private int lastPos = LogSystem.LOG_WRITTEN;
/**
* Get the number of bytes required for the data if the given data page would be used.
*
* @param dummy the template data page
* @return the number of bytes
*/
public abstract int getByteCount(DataPage dummy) throws SQLException;
/**
* Write the record to the data page.
*
* @param buff the data page
*/
public abstract void write(DataPage buff) throws SQLException;
/**
* This method is called just before the page is written.
* If a read operation is required before writing, this needs to be done here.
......@@ -31,8 +44,6 @@ public abstract class Record extends CacheObject {
public void prepareWrite() throws SQLException {
}
public abstract void write(DataPage buff) throws SQLException;
public boolean isEmpty() {
return false;
}
......@@ -40,18 +51,18 @@ public abstract class Record extends CacheObject {
public void setDeleted(boolean deleted) {
this.deleted = deleted;
}
public void setSessionId(int sessionId) {
this.sessionId = sessionId;
}
public int getSessionId() {
return sessionId;
}
public void commit() {
this.sessionId = 0;
}
}
public boolean getDeleted() {
return deleted;
......
......@@ -47,7 +47,16 @@ public abstract class Table extends SchemaObjectBase {
public static final String TABLE = "TABLE";
public static final String VIEW = "VIEW";
/**
* The columns of this table.
*/
protected Column[] columns;
/**
* The amount of memory required for a row if all values would be very small.
*/
protected int memoryPerRow;
private final HashMap columnMap = new HashMap();
private final boolean persistent;
private ObjectArray triggers;
......@@ -56,7 +65,142 @@ public abstract class Table extends SchemaObjectBase {
private ObjectArray views;
private boolean checkForeignKeyConstraints = true;
private boolean onCommitDrop, onCommitTruncate;
protected int memoryPerRow;
/**
* Lock the table for the given session.
* This method waits until the lock is granted.
*
* @param session the session
* @param exclusive true for write locks, false for read locks
* @param force lock even in the MVCC mode
* @throws SQLException if a lock timeout occured
*/
public abstract void lock(Session session, boolean exclusive, boolean force) throws SQLException;
/**
* Close the table object and flush changes.
*
* @param session the session
*/
public abstract void close(Session session) throws SQLException;
/**
* Release the lock for this session.
*
* @param s the session
*/
public abstract void unlock(Session s);
/**
* Create an index for this table
*
* @param session the session
* @param indexName the name of the index
* @param indexId the id
* @param cols the index columns
* @param indexType the index type
* @param headPos the position of the head (if the index already exists)
* @param comment the comment
* @return the index
*/
public abstract Index addIndex(Session session, String indexName, int indexId, IndexColumn[] cols, IndexType indexType,
int headPos, String comment) throws SQLException;
/**
* Remove a row from the table and all indexes.
*
* @param session the session
* @param row the row
*/
public abstract void removeRow(Session session, Row row) throws SQLException;
/**
* Remove all rows from the table and indexes.
*
* @param session the session
*/
public abstract void truncate(Session session) throws SQLException;
/**
* Add a row to the table and all indexes.
*
* @param session the session
* @param row the row
* @throws SQLException if a constraint was violated
*/
public abstract void addRow(Session session, Row row) throws SQLException;
/**
* Check if this table supports ALTER TABLE.
*
* @throws SQLException if it is not supported
*/
public abstract void checkSupportAlter() throws SQLException;
/**
* Get the table type name
*
* @return the table type name
*/
public abstract String getTableType();
/**
* Get the scan index to iterate through all rows.
*
* @param session the session
* @return the index
*/
public abstract Index getScanIndex(Session session) throws SQLException;
/**
* Get any unique index for this table if one exists.
*
* @return a unique index
*/
public abstract Index getUniqueIndex();
/**
* Get all indexes for this table.
*
* @return the list of indexes
*/
public abstract ObjectArray getIndexes();
/**
* Check if this table is locked exclusively.
*
* @return true if it is.
*/
public abstract boolean isLockedExclusively();
/**
* Get the last data modification id.
*
* @return the modification id
*/
public abstract long getMaxDataModificationId();
/**
* Check if the row count can be retrieved quickly.
*
* @return true if it can
*/
public abstract boolean canGetRowCount();
/**
* Check if this table can be dropped.
*
* @return true if it can
*/
public abstract boolean canDrop();
/**
* Get the row count for this table.
*
* @param session the session
* @return the row count
*/
public abstract long getRowCount(Session session) throws SQLException;
public Table(Schema schema, int id, String name, boolean persistent) {
super(schema, id, name, Trace.TABLE);
......@@ -133,39 +277,10 @@ public abstract class Table extends SchemaObjectBase {
columnMap.put(newName, column);
}
public abstract void lock(Session session, boolean exclusive, boolean force) throws SQLException;
public boolean isLockExclusive(Session s) {
return false;
}
public abstract void close(Session session) throws SQLException;
public abstract void unlock(Session s);
public abstract Index addIndex(Session session, String indexName, int indexId, IndexColumn[] cols, IndexType indexType,
int headPos, String comment) throws SQLException;
public abstract void removeRow(Session session, Row row) throws SQLException;
public abstract void truncate(Session session) throws SQLException;
public abstract void addRow(Session session, Row row) throws SQLException;
public abstract void checkSupportAlter() throws SQLException;
public abstract String getTableType();
public abstract Index getScanIndex(Session session) throws SQLException;
public abstract Index getUniqueIndex();
public abstract ObjectArray getIndexes();
public abstract boolean isLockedExclusively();
public abstract long getMaxDataModificationId();
public void updateRows(Prepared prepared, Session session, RowList rows)
throws SQLException {
// remove the old rows
......@@ -474,12 +589,6 @@ public abstract class Table extends SchemaObjectBase {
return cols;
}
public abstract boolean canGetRowCount();
public abstract boolean canDrop();
public abstract long getRowCount(Session session) throws SQLException;
public boolean getGlobalTemporary() {
return false;
}
......
/*
* Copyright 2004-2007 H2 Group. Licensed under the H2 License, Version 1.0 (http://h2database.com/html/license.html).
* Initial Developer: H2 Group
*/
package org.h2.util;
import java.io.IOException;
......
......@@ -14,11 +14,23 @@ import org.h2.store.DiskFile;
* The base object for all cached objects.
*/
public abstract class CacheObject {
private boolean changed;
/**
* The number of blocks occupied by this object.
*/
protected int blockCount;
public CacheObject previous, next, chained;
public int cacheQueue;
protected int blockCount;
private int pos;
private boolean changed;
/**
* Check if the object can be removed from the cache.
* For example pinned objects can not be removed.
*
* @return true if it can be removed
*/
public abstract boolean canRemove();
public static void sort(ObjectArray recordList) {
recordList.sort(new Comparator() {
......@@ -61,10 +73,9 @@ public abstract class CacheObject {
return false;
}
public abstract boolean canRemove();
/*
/**
* Get the estimated memory size.
*
* @return number of double words (4 bytes)
*/
public int getMemorySize() {
......
......@@ -10,11 +10,47 @@ import java.sql.SQLException;
* The base for other hash classes.
*/
public abstract class HashBase {
protected int mask, len, size, deletedCount, level;
/**
* The bit mask to get the index from the hash code.
*/
protected int mask;
/**
* The number of slots in the table.
*/
protected int len;
/**
* The number of occupied slots, excluding the zero key (if any).
*/
protected int size;
/**
* The number of deleted slots.
*/
protected int deletedCount;
/**
* The level. The number of slots is 2 ^ level.
*/
protected int level;
/**
* Whether the zero key is used.
*/
protected boolean zeroKey;
private int maxSize, minSize, maxDeleted;
private static final int MAX_LOAD = 90;
/**
* Increase the size of the underlying table and re-distribute the elements.
*
* @param newLevel the new level
*/
protected abstract void rehash(int newLevel) throws SQLException;
public HashBase() {
reset(2);
}
......@@ -40,8 +76,6 @@ public abstract class HashBase {
}
}
protected abstract void rehash(int newLevel) throws SQLException;
protected void reset(int newLevel) {
minSize = size * 3 / 4;
size = 0;
......
......@@ -33,9 +33,9 @@ import org.h2.util.StringUtils;
*/
public abstract class Value {
// TODO value: float is missing
// remember to keep the order
/**
* The data type is unknown at this time.
*/
public static final int UNKNOWN = -1;
public static final int NULL = 0, BOOLEAN = 1, BYTE = 2, SHORT = 3, INT = 4, LONG = 5, DECIMAL = 6;
public static final int DOUBLE = 7, FLOAT = 8, TIME = 9, DATE = 10, TIMESTAMP = 11, BYTES = 12;
......@@ -45,14 +45,76 @@ public abstract class Value {
public static final int TYPE_COUNT = STRING_FIXED + 1;
private static WeakReference weakCache = new WeakReference(null);
// private static int cacheCleaner = 0;
// testing: cacheHit / miss are public!
// public static int cacheHit = 0, cacheMiss = 0;
// private static Value[] cache = new Value[Constants.OBJECT_CACHE_SIZE];
private static final BigDecimal MAX_LONG_DECIMAL = new BigDecimal("" + Long.MAX_VALUE);
private static final BigDecimal MIN_LONG_DECIMAL = new BigDecimal("" + Long.MIN_VALUE);
/**
* Get the SQL expression for this value.
*
* @return the SQL expression
*/
public abstract String getSQL();
/**
* Get the value type.
*
* @return the type
*/
public abstract int getType();
/**
* Get the precision.
*
* @return the precision
*/
public abstract long getPrecision();
/**
* Get the display size in characters.
*
* @return the display size
*/
public abstract int getDisplaySize();
/**
* Get the value as a string.
*
* @return the string
*/
public abstract String getString() throws SQLException;
/**
* Get the value as an object.
*
* @return the object
*/
public abstract Object getObject() throws SQLException;
/**
* Set the value as a parameter in a prepared statement.
*
* @param prep the prepared statement
* @param parameterIndex the parameter index
*/
public abstract void set(PreparedStatement prep, int parameterIndex) throws SQLException;
/**
* Compare the value with another value of the same type.
*
* @param v the other value
* @param mode the compare mode
* @return 0 if both values are equal, -1 if the other value is smaller, and 1 otherwise
*/
protected abstract int compareSecure(Value v, CompareMode mode) throws SQLException;
/**
* Check if the two values are equal.
*
* @param v the other value
* @return true if they are equal
*/
protected abstract boolean isEqual(Value v);
public static int getOrder(int type) {
switch(type) {
case UNKNOWN:
......@@ -142,17 +204,6 @@ public abstract class Value {
return v;
}
public abstract String getSQL();
public abstract int getType();
public abstract long getPrecision();
public abstract int getDisplaySize();
public abstract String getString() throws SQLException;
protected abstract int compareSecure(Value v, CompareMode mode) throws SQLException;
protected abstract boolean isEqual(Value v);
public abstract Object getObject() throws SQLException;
public abstract void set(PreparedStatement prep, int parameterIndex) throws SQLException;
public Boolean getBoolean() throws SQLException {
return ((ValueBoolean) convertTo(Value.BOOLEAN)).getBoolean();
}
......
......@@ -14,6 +14,10 @@ import org.h2.util.StringUtils;
* The base class for all ValueString* classes.
*/
abstract class ValueStringBase extends Value {
/**
* The string data.
*/
protected final String value;
protected ValueStringBase(String value) {
......
......@@ -154,6 +154,8 @@ java org.h2.test.TestAll timer
/*
Javadocs: abstract class (Table)
add tests with select distinct type (code coverage)
documentation: package.html
......
......@@ -22,6 +22,14 @@ PostgreSQL
--------------------------------------------------------------------------------------------------------
HSQLDB
--------------------------------------------------------------------------------------------------------
To use the same default settings as H2, use:
jdbc:hsqldb:data/test;hsqldb.default_table_type=cached;sql.enforce_size=true
Also, you need to execute the following statement:
SET WRITE_DELAY 1
Derby
--------------------------------------------------------------------------------------------------------
To call getFD().sync() (which results in the OS call fsync()),
......
......@@ -518,4 +518,6 @@ llc computing oliver road inaccessible android velasques duplicates eduardo chu
encapsulates negating igor midnight fulfill prefixes communicates nesting convenience negated resides optimizing principal applets dobrovolskyi
involves ukrainian chile machines restricting summer aliased backus naur multiples avl operates grow normalized rijndael
countdown paused javac analyzing accesses solving forcefully urgent originally defect coordinates
camel council merges spelled adaptive pull controller abstractions workarounds driven
\ No newline at end of file
camel council merges spelled adaptive pull controller abstractions workarounds driven
thousands ridvan incremented slots debugging inherit agar fulvio invisible biondi hundreds occupied remap retrieved involved
turkish fulfils iapi filesync
\ No newline at end of file
......@@ -27,10 +27,13 @@ import com.sun.javadoc.Type;
* Javadoc for this product.
*/
public class Doclet {
private static final boolean INTERFACES_ONLY = Boolean.getBoolean("h2.interfacesOnly");
public static boolean start(RootDoc root) throws IOException {
ClassDoc[] classes = root.classes();
String[][] options = root.options();
String destDir = "docs/javadoc";
String destDir = System.getProperty("h2.destDir", "docs/javadoc");
for (int i = 0; i < options.length; i++) {
if (options[i][0].equals("destdir")) {
destDir = options[i][1];
......@@ -227,6 +230,10 @@ public class Doclet {
}
private static boolean skipMethod(MethodDoc method) {
ClassDoc clazz = method.containingClass();
if (INTERFACES_ONLY && (!clazz.isAbstract() || !method.isAbstract()) && !clazz.isInterface()) {
return true;
}
String name = method.name();
if (!method.isPublic() || name.equals("finalize")) {
return true;
......@@ -236,7 +243,7 @@ public class Doclet {
}
String firstSentence = getFirstSentence(method.firstSentenceTags());
if (firstSentence == null || firstSentence.trim().length() == 0) {
throw new Error("undocumented method? " + name + " " + method.containingClass().name() + " "
throw new Error("undocumented method? " + clazz.name() + "." + name + " "
+ method.getRawCommentText());
}
if (firstSentence.startsWith("INTERNAL")) {
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论