features.html 52.2 KB
Newer Older
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
<!--
3
Copyright 2004-2008 H2 Group. Licensed under the H2 License, Version 1.0 (http://h2database.com/html/license.html).
4 5
Initial Developer: H2 Group
-->
6 7
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head><meta http-equiv="Content-Type" content="text/html;charset=utf-8" /><title>
8
Features
9
</title><link rel="stylesheet" type="text/css" href="stylesheet.css" />
10 11 12 13 14 15 16
<script type="text/javascript" src="navigation.js"></script>
</head><body onload="frameMe();">
<table class="content"><tr class="content"><td class="content"><div class="contentDiv">

<h1>Features</h1>

<a href="#feature_list">
17
    Feature List</a><br />
18 19
<a href="#limitations">
    Limitations</a><br />
20
<a href="#comparison">
21
    Comparison to Other Database Engines</a><br />
22
<a href="#products_work_with">
23
    H2 in Use</a><br />
24
<a href="#connection_modes">
25
    Connection Modes</a><br />
26
<a href="#database_url">
27
    Database URL Overview</a><br />
28 29
<a href="#memory_only_databases">
    Memory-Only Databases</a><br />
30
<a href="#file_encryption">
31
    Connecting to a Database with File Encryption</a><br />
32
<a href="#database_file_locking">
33
    Database File Locking</a><br />
34
<a href="#database_only_if_exists">
35
    Opening a Database Only if it Already Exists</a><br />
36
<a href="#closing_the_database">
37
    Closing the Database</a><br />
38
<a href="#log_index_changes">
39
    Log Index Changes</a><br />
40 41
<a href="#custom_access_mode">
    Custom File Access Mode</a><br />
42
<a href="#multiple_connections">
43
    Multiple Connections</a><br />
44
<a href="#database_file_layout">
45
    Database File Layout</a><br />
46
<a href="#logging_recovery">
47
    Logging and Recovery</a><br />
48 49
<a href="#compatibility">
    Compatibility</a><br />
50
<a href="#trace_options">
51
    Using the Trace Options</a><br />
52
<a href="#read_only">
53
    Read Only Databases</a><br />
54 55
<a href="#database_in_zip">
    Read Only Databases in Zip or Jar File</a><br />
56
<a href="#storage_formats">
57
    Binary and Text Storage Formats</a><br />
58
<a href="#low_disk_space">
59
    Graceful Handling of Low Disk Space Situations</a><br />
60
<a href="#computed_columns">
61
    Computed Columns / Function Based Index</a><br />
62
<a href="#multi_dimensional">
63
    Multi-Dimensional Indexes</a><br />
64
<a href="#passwords">
65
    Using Passwords</a><br />
66
<a href="#user_defined_functions">
67
    User-Defined Functions and Stored Procedures</a><br />
68
<a href="#triggers">
69
    Triggers</a><br />
70
<a href="#compacting">
71
    Compacting a Database</a><br />
72
<a href="#cache_settings">
73
    Cache Settings</a><br />
74

75
<br /><a name="feature_list"></a>
76 77 78 79
<h2>Feature List</h2>
<h3>Main Features</h3>
<ul>
<li>Very fast database engine
80 81 82 83 84 85 86
</li><li>Free, with source code
</li><li>Written in Java
</li><li>Supports standard SQL, JDBC API
</li><li>Embedded and Server mode, Clustering support
</li><li>Strong security features
</li><li>Experimental native version (GCJ) and ODBC drivers
</li></ul>
87 88 89 90

<h3>Additional Features</h3>
<ul>
<li>Disk based or in-memory databases and tables, read-only database support, temporary tables
91
</li><li>Transaction support (read committed and serializable transaction isolation), 2-phase-commit
92 93 94 95 96
</li><li>Multiple connections, table level locking
</li><li>Cost based optimizer, using a genetic algorithm for complex queries, zero-administration
</li><li>Scrollable and updatable result set support, large result set, external result sorting, functions can return a result set
</li><li>Encrypted database (AES or XTEA), SHA-256 password encryption, encryption functions, SSL
</li></ul>
97 98 99

<h3>SQL Support</h3>
<ul>
100
<li>Support for multiple schemas, information schema
101 102 103 104
</li><li>Referential integrity / foreign key constraints with cascade, check constraints
</li><li>Inner and outer joins, subqueries, read only views and inline views
</li><li>Triggers and Java functions / stored procedures
</li><li>Many built-in functions, including XML and lossless data compression
105
</li><li>Wide range of data types including large objects (BLOB/CLOB) and arrays
106 107
</li><li>Sequence and autoincrement columns, computed columns (can be used for function based indexes)
</li><li>ORDER BY, GROUP BY, HAVING, UNION, LIMIT, TOP
108 109
</li><li>Collation support, users, roles
</li><li>Compatibility modes for HSQLDB, MySQL and PostgreSQL
110
</li></ul>
111 112 113

<h3>Security Features</h3>
<ul>
114 115
<li>Includes a solution for the SQL injection problem
</li><li>User password authenticated uses SHA-256 and salt
116 117 118 119 120 121
</li><li>User passwords are never transmitted in plain text over the network (even when using insecure connections)
</li><li>All database files (including script files that can be used to backup data) can be encrypted using AES-256 and XTEA encryption algorithms
</li><li>The remote JDBC driver supports TCP/IP connections over SSL/TLS
</li><li>The built-in web server supports connections over SSL/TLS
</li><li>Passwords can be sent to the database using char arrays instead of Strings
</li></ul>
122 123 124 125

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

142 143
<br /><a name="limitations"></a>
<h2>Limitations</h2>
144
<p>
145 146 147
For the list of limitations, please have a look at the road map page at:
<a href="http://groups.google.com/group/h2-database/web/roadmap">
http://groups.google.com/group/h2-database/web/roadmap
148 149
</a>
</p>
150

151
<br /><a name="comparison"></a>
152 153 154 155 156 157
<h2>Comparison to Other Database Engines</h2>

<table><tr>
<th>Feature</th>
<th>H2</th>
<th>Derby</th>
158
<th>HSQLDB</th>
159 160 161
<th>MySQL</th>
<th>PostgreSQL</th>
</tr><tr>
162
<td>Pure Java</td>
163 164 165
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
166 167 168
<td class="compareN">No</td>
<td class="compareN">No</td>
</tr><tr>
169
<td>Embedded Mode (Java)</td>
170 171
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
172 173 174 175 176 177 178
<td class="compareY">Yes</td>
<td class="compareN">No</td>
<td class="compareN">No</td>
</tr><tr>
<td>Performance (Embedded)</td>
<td class="compareY">Fast</td>
<td class="compareN">Slow</td>
179
<td class="compareY">Fast</td>
180 181 182
<td class="compareN">N/A</td>
<td class="compareN">N/A</td>
</tr><tr>
183 184 185 186 187 188 189
<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>
190 191 192
<td>Transaction Isolation</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
193
<td class="compareN">No</td>
194 195 196 197 198 199
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
</tr><tr>
<td>Cost Based Optimizer</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
200
<td class="compareN">No</td>
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
</tr><tr>
<td>Clustering</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>Encrypted Database</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
<td class="compareN">No</td>
<td class="compareN">No</td>
<td class="compareN">No</td>
</tr><tr>
218 219 220 221 222 223 224 225 226 227 228 229 230 231
<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>
232
<td>User-Defined Datatypes</td>
233 234 235 236 237 238
<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>
239 240 241 242 243 244 245 246
<td>Files per Database</td>
<td class="compareY">Few</td>
<td class="compareN">Many</td>
<td class="compareY">Few</td>
<td class="compareN">Many</td>
<td class="compareN">Many</td>
</tr><tr>
<td>Footprint (jar/dll size)</td>
247 248 249 250 251
<td>~ 1 MB</td>
<td>~ 2 MB</td>
<td>~ 600 KB</td>
<td>~ 4 MB</td>
<td>~ 6 MB</td>
252 253 254
</tr>
</table>

255
<h3>Derby and HSQLDB</h3>
256
<p>
257 258 259
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' /
260
'The database is already in use by another process').
261
</p>
262

263
<h3>DaffodilDb and One$Db</h3>
264
<p>
265
It looks like the development of this database has stopped. The last release was February 2006.
266
</p>
267 268

<h3>McKoi</h3>
269
<p>
270
It looks like the development of this database has stopped. The last release was August 2004
271
</p>
272

273
<br /><a name="products_work_with"></a>
274 275 276
<h2>H2 in Use</h2>
<p>
For a list of applications that work with or use H2, see:
277
<a href="links.html">Links</a>.
278
</p>
279

280 281
<br /><a name="connection_modes"></a>
<h2>Connection Modes</h2>
282
<p>
283
The following connection modes are supported:
284
</p>
285
<ul>
286
<li>Local connections using JDBC (embedded)
287 288 289 290
</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)
</li></ul>
291

292
<br /><a name="database_url"></a>
293
<h2>Database URL Overview</h2>
294
<p>
295 296
This database supports multiple connection modes and connection settings.
This is achieved using different database URLs. Settings in the URLs are not case sensitive.
297
</p>
298 299 300 301
<table><tr><th>Topic</th><th>URL Format and Examples</th></tr>
<tr>
  <td>Embedded (local) connection</td>
  <td>
302
    jdbc:h2:[file:][&lt;path&gt;]&lt;databaseName&gt;<br />
303
      jdbc:h2:~/test<br />
304 305
     jdbc:h2:file:/data/sample<br />
     jdbc:h2:file:C:/data/sample (Windows only)<br />
306 307 308 309 310 311 312 313 314
  </td>
</tr>
<tr>
  <td>In-Memory (private)</td>
  <td>jdbc:h2:mem:</td>
</tr>
<tr>
  <td>In-Memory (named)</td>
  <td>
315
    jdbc:h2:mem:&lt;databaseName&gt;<br />
316
    jdbc:h2:mem:test_mem
317 318 319 320 321
  </td>
</tr>
<tr>
  <td>Remote using TCP/IP</td>
  <td>
322
    jdbc:h2:tcp://&lt;server&gt;[:&lt;port&gt;]/&lt;databaseName&gt;<br />
323 324
    jdbc:h2:tcp://localhost/~/test<br />
    jdbc:h2:tcp://dbserv:8084/~/sample
325 326 327 328 329
  </td>
</tr>
<tr>
  <td>Remote using SSL/TLS</td>
  <td>
330
    jdbc:h2:ssl://&lt;server&gt;[:&lt;port&gt;]/&lt;databaseName&gt;<br />
331
    jdbc:h2:ssl://secureserv:8085/~/sample;
332 333 334 335 336
  </td>
</tr>
<tr>
  <td>Using Encrypted Files</td>
  <td>
337
    jdbc:h2:&lt;url&gt;;CIPHER=[AES|XTEA]<br />
338
    jdbc:h2:ssl://secureserv/~/testdb;CIPHER=AES<br />
339
    jdbc:h2:file:~/secure;CIPHER=XTEA<br />
340 341 342 343 344
  </td>
</tr>
<tr>
  <td>File Locking Methods</td>
  <td>
345
    jdbc:h2:&lt;url&gt;;FILE_LOCK={NO|FILE|SOCKET}<br />
346 347
    jdbc:h2:file:~/quickAndDirty;FILE_LOCK=NO<br />
    jdbc:h2:file:~/private;CIPHER=XTEA;FILE_LOCK=SOCKET<br />
348 349 350 351 352
  </td>
</tr>
<tr>
  <td>Only Open if it Already Exists</td>
  <td>
353
    jdbc:h2:&lt;url&gt;;IFEXISTS=TRUE<br />
354
    jdbc:h2:file:~/sample;IFEXISTS=TRUE<br />
355 356 357 358 359 360 361 362 363 364 365
  </td>
</tr>
<tr>
    <td>Don't Close the Database when the VM Exits</td>
    <td>
    jdbc:h2:&lt;url&gt;;DB_CLOSE_ON_EXIT=FALSE
    </td>
</tr>
<tr>
  <td>User Name and/or Password</td>
  <td>
366
    jdbc:h2:&lt;url&gt;[;USER=&lt;username&gt;][;PASSWORD=&lt;value&gt;]<br />
367
    jdbc:h2:file:~/sample;USER=sa;PASSWORD=123<br />
368 369 370 371 372
  </td>
</tr>
<tr>
  <td>Log Index Changes</td>
  <td>
373
    jdbc:h2:&lt;url&gt;;LOG=2<br />
374
    jdbc:h2:file:~/sample;LOG=2<br />
375 376 377 378 379
  </td>
</tr>
<tr>
  <td>Debug Trace Settings</td>
  <td>
380
    jdbc:h2:&lt;url&gt;;TRACE_LEVEL_FILE=&lt;level 0..3&gt;<br />
381
    jdbc:h2:file:~/sample;TRACE_LEVEL_FILE=3<br />
382 383 384 385 386
  </td>
</tr>
<tr>
  <td>Ignore Unknown Settings</td>
  <td>
387
    jdbc:h2:&lt;url&gt;;IGNORE_UNKNOWN_SETTINGS=TRUE<br />
388 389
  </td>
</tr>
390 391 392 393 394 395
<tr>
  <td>Custom File Access Mode</td>
  <td>
    jdbc:h2:&lt;url&gt;;ACCESS_MODE_LOG=rws;ACCESS_MODE_DATA=rws<br />
  </td>
</tr>
396 397 398 399 400
<tr>
  <td>In-Memory (private)</td>
  <td>jdbc:h2:mem:</td>
</tr>
<tr>
401
  <td>Database in or Zip File</td>
402 403
  <td>
    jdbc:h2:zip:&lt;zipFileName&gt;!/&lt;databaseName&gt;<br />
404
    jdbc:h2:zip:~/db.zip!/test
405 406
  </td>
</tr>
407 408 409
<tr>
  <td>Changing Other Settings</td>
  <td>
410
    jdbc:h2:&lt;url&gt;;&lt;setting&gt;=&lt;value&gt;[;&lt;setting&gt;=&lt;value&gt;...]<br />
411
    jdbc:h2:file:~/sample;TRACE_LEVEL_SYSTEM_OUT=3<br />
412 413 414 415 416
  </td>
</tr>
</table>

<h3>Connecting to an Embedded (Local) Database</h3>
417
<p>
418
The database URL for connecting to a local database is <code>jdbc:h2:[file:][&lt;path&gt;]&lt;databaseName&gt;</code>.
419 420
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
421
operating system, however it is recommended to use lowercase letters only.
422
The database name must be at least three characters long (a limitation of File.createTempFile).
423
To point to the user home directory, use ~/, as in: jdbc:h2:~/test.
424
</p>
425

426 427
<br /><a name="memory_only_databases"></a>
<h2>Memory-Only Databases</h2>
428
<p>
429
For certain use cases (for example: rapid prototyping, testing, high performance
430
operations, read-only databases), it may not be required to persist (changes to) the data at all.
431
This database supports the memory-only mode, where the data is not persisted.
432
</p><p>
433 434 435 436
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.
437
</p><p>
438 439
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>.
440
Accessing the same database in this way only works within the same virtual machine and
441
class loader environment.
442
</p><p>
443
It is also possible to access a memory-only database remotely
444
(or from multiple processes in the same machine) using TCP/IP or SSL/TLS.
445 446
An example database URL is: <code>jdbc:h2:tcp://localhost/mem:db1</code>
(using private database remotely is also possible).
447
</p><p>
448 449 450
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
451
jdbc:h2:mem:test;DB_CLOSE_DELAY=-1
452
</p>
453

454
<br /><a name="file_encryption"></a>
455
<h2>Connecting to a Database with File Encryption</h2>
456
<p>
457
To use file encryption, it is required to specify the encryption algorithm (the 'cipher')
458 459
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,
460
before the user password. A single space needs to be added between the file password
461
and the user password; the file password itself may not contain spaces. File passwords
462 463
(as well as user passwords) are case sensitive. Here is an example to connect to a 
password-encrypted database:
464
</p>
465 466
<pre>
Class.forName("org.h2.Driver");
467
String url = "jdbc:h2:~/test;CIPHER=AES";
468 469 470 471 472 473
String user = "sa";
String pwds = "filepwd userpwd";
conn = DriverManager.
    getConnection(url, user, pwds);
</pre>

474
<br /><a name="database_file_locking"></a>
475
<h2>Database File Locking</h2>
476
<p>
477
Whenever a database is opened, a lock file is created to signal other processes
478
that the database is in use. If database is closed, or if the process that opened
479
the database terminates, this lock file is deleted.
480
</p><p>
481
The following file locking methods are implemented:
482
</p>
483 484
<ul>
<li>The default method is 'file' and uses a watchdog thread to
485 486
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
487 488
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.
489
</li><li>It is also possible to open the database without file locking;
490
in this case it is up to the application to protect the database files.
491
</li></ul>
492
<p>
493 494 495
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:
<pre>
496
String url = "jdbc:h2:~/test;FILE_LOCK=SOCKET";
497 498
</pre>
The following code forces the database to not create a lock file at all. Please note that
499
this is unsafe as another process is able to open the same database, possibly leading to
500 501
data corruption:
<pre>
502
String url = "jdbc:h2:~/test;FILE_LOCK=NO";
503
</pre>
504 505
For more information about the algorithms please see in Advanced Topics under
File Locking Protocol.
506
</p>
507

508
<br /><a name="database_only_if_exists"></a>
509
<h2>Opening a Database Only if it Already Exists</h2>
510
<p>
511
By default, when an application calls <code>DriverManager.getConnection(url,...)</code>
512 513 514
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>
515
to the URL. In this case, if the database does not already exist, an exception is thrown when
516 517
trying to connect. The connection only succeeds when the database already exists.
The complete URL may look like this:
518
</p>
519 520 521 522
<pre>
String url = "jdbc:h2:/data/sample;IFEXISTS=TRUE";
</pre>

523
<br /><a name="closing_the_database"></a>
524 525 526
<h2>Closing the Database</h2>

<h3>Delayed Database Closing</h3>
527
<p>
528 529
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.
530
The automatic closing of the database can be delayed or disabled with the SQL statement
531 532 533 534 535 536 537 538 539
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:
<pre>
SET DB_CLOSE_DELAY 10
</pre>
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.
540
It is possible to set the value in the database URL: <code>jdbc:h2:~/test;DB_CLOSE_DELAY=10</code>.
541
</p>
542 543

<h3>Don't Close the Database when the VM Exits</h3>
544
<p>
545 546 547 548
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).
549 550
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
551 552
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:
553
</p>
554
<pre>
555
String url = "jdbc:h2:~/test;DB_CLOSE_ON_EXIT=FALSE";
556 557
</pre>

558
<br /><a name="log_index_changes"></a>
559
<h2>Log Index Changes</h2>
560
<p>
561 562 563 564 565
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),
566
re-creating the index file takes very long.
567 568
In these situations it may be better to log changes to the index file,
so that recovery from a corrupted index file is fast.
569
To enable log index changes, add LOG=2 to the URL, as in jdbc:h2:~/test;LOG=2
570 571
This setting should be specified when connecting.
The update performance of the database will be reduced when using this option.
572
</p>
573 574

<h3>Ignore Unknown Settings</h3>
575
<p>
576
Some applications (for example OpenOffice.org Base) pass some additional parameters
577
when connecting to the database. Why those parameters are passed is unknown.
578
The parameters PREFERDOSLIKELINEENDS and IGNOREDRIVERPRIVILEGES are such examples;
579 580 581
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
582
;IGNORE_UNKNOWN_SETTINGS=TRUE to the database URL.
583
</p>
584 585

<h3>Changing Other Settings when Opening a Connection</h3>
586
<p>
587
In addition to the settings already described (cipher, file_lock, ifexists, user, password),
588 589 590 591 592
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.
593
</p>
594

595 596
<br /><a name="custom_access_mode"></a>
<h2>Custom File Access Mode</h2>
597
<p>
598 599
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).
600 601
To open a database in read-only mode if the files are not read-only, use
ACCESS_MODE_DATA=r.
602 603 604 605 606
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:
<pre>
607
String url = "jdbc:h2:~/test;ACCESS_MODE_LOG=rws;ACCESS_MODE_DATA=rws";
608 609 610
</pre>
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.
611
</p>
612

613
<br /><a name="multiple_connections"></a>
614 615 616
<h2>Multiple Connections</h2>

<h3>Opening Multiple Databases at the Same Time</h3>
617
<p>
618 619
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.
620
</p>
621 622

<h3>Multiple Connections to the Same Database: Client/Server</h3>
623 624 625 626 627 628
<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).
</p>
629

630
<h3>Multithreading Support</h3>
631 632
<p>
This database is multithreading-safe. That means, if an application is multi-threaded, it does not need
633
o worry about synchronizing the access to the database. Internally, most requests to the same database
634
are synchronized. That means an application can use multiple threads accessing the same database
635 636 637
at the same time, however if one thread executes a long running query, the other threads
need to wait.
</p>
638

639
<h3>Locking, Lock-Timeout, Deadlocks</h3>
640
<p>
641 642
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).
643
If a connection wants to reads from a table, and there is no write lock on the table,
644 645
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,
646
then a lock timeout exception is thrown.
647
</p><p>
648 649
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,
650 651 652
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.
653
The locks are also released when the autocommit mode changes, and for connections with
654 655
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:
656
</p>
657 658 659 660 661 662
<table><tr><th>Type of Lock</th><th>SQL Statement</th></tr>
<tr>
  <td>
    Read
  </td>
  <td>
663 664
    SELECT * FROM TEST<br />
    CALL SELECT MAX(ID) FROM TEST<br />
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
    SCRIPT
  </td>
</tr>
<tr>
  <td>
    Write
  </td>
  <td>
    SELECT * FROM TEST WHERE 1=0 FOR UPDATE
  </td>
</tr>
<tr>
  <td>
    Write
  </td>
  <td>
681 682 683
    INSERT INTO TEST VALUES(1, 'Hello')<br />
    INSERT INTO TEST SELECT * FROM TEST<br />
    UPDATE TEST SET NAME='Hi'<br />
684 685 686 687 688 689 690 691
    DELETE FROM TEST
  </td>
</tr>
<tr>
  <td>
    Write
  </td>
  <td>
692 693
    ALTER TABLE TEST ...<br />
    CREATE INDEX ... ON TEST ...<br />
694 695 696 697 698 699 700 701 702
    DROP INDEX ...
  </td>
</tr>
</table>
<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.
703
</p>
704

705
<br /><a name="database_file_layout"></a>
706
<h2>Database File Layout</h2>
707
<p>
708
There are a number of files created for persistent databases. Other than some databases,
709 710
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).
711
In addition to that, a file is created for each large object (CLOB/BLOB), a file for each linear index,
712 713 714
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:
715
</p>
716 717 718 719
<table><tr><th>File Name</th><th>Description</th><th>Number of Files</th></tr>
<tr><td>
    test.data.db
</td><td>
720 721
    Data file<br />
    Contains the data for all tables<br />
722 723 724 725 726 727 728
    Format: &lt;database&gt;.data.db
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.index.db
</td><td>
729 730
    Index file<br />
    Contains the data for all (btree) indexes<br />
731 732 733 734 735 736 737
    Format: &lt;database&gt;.index.db
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.0.log.db
</td><td>
738 739
    Log file<br />
    The log file is used for recovery<br />
740 741 742 743 744 745 746
    Format: &lt;database&gt;.&lt;id&gt;.log.db
</td><td>
    0 or more per database
</td></tr>
<tr><td>
    test.lock.db
</td><td>
747 748
    Database lock file<br />
    Exists only if the database is open<br />
749 750 751 752 753 754 755
    Format: &lt;database&gt;.lock.db
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.trace.db
</td><td>
756 757 758
    Trace file<br />
    Contains trace information<br />
    Format: &lt;database&gt;.trace.db<br />
759 760 761 762 763 764 765
    If the file is too big, it is renamed to &lt;database&gt;.trace.db.old
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.14.15.lob.db
</td><td>
766 767
    Large object<br />
    Contains the data for BLOB or CLOB<br />
768 769 770 771 772 773 774
    Format: &lt;database&gt;.&lt;tableid&gt;.&lt;id&gt;.lob.db
</td><td>
    1 per object
</td></tr>
<tr><td>
    test.123.temp.db
</td><td>
775 776
    Temporary file<br />
    Contains a temporary blob or a large result set<br />
777 778 779 780 781 782 783
    Format: &lt;database&gt;.&lt;session id&gt;.&lt;object id&gt;.temp.db
</td><td>
    1 per object
</td></tr>
<tr><td>
    test.7.hash.db
</td><td>
784 785
    Hash index file<br />
    Contains the data for a linear hash index<br />
786 787 788 789 790 791 792 793
    Format: &lt;database&gt;.&lt;object id&gt;.hash.db
</td><td>
    1 per linear hash index
</td></tr>
</table>

<h3>Moving and Renaming Database Files</h3>
<p>
794 795
Database name and location are not stored inside the database names.
</p><p>
796
While a database is closed, the files can be moved to another directory, and they can be renamed
797
as well (as long as all files start with the same name).
798
</p><p>
799 800
As there is no platform specific data in the files, they can be moved to other operating systems
without problems.
801
</p>
802 803

<h3>Backup</h3>
804
<p>
805 806 807
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.
808
</p><p>
809
To backup data while the database is running, the SQL command SCRIPT can be used.
810
</p>
811

812
<br /><a name="logging_recovery"></a>
813
<h2>Logging and Recovery</h2>
814
<p>
815 816
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
817 818 819
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.
820
</p><p>
821 822
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.
823
</p><p>
824 825
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).
826
It is possible to force the log switching by using the CHECKPOINT command.
827
</p><p>
828 829 830 831
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
832
must contain RECOVER=1, as in jdbc:h2:~/test;RECOVER=1. Indexes are rebuilt in this case, and
833
the summary (object allocation table) is not read in this case, so opening the database takes longer.
834
</p>
835

836 837 838 839 840 841
<br /><a name="compatibility"></a>
<h2>Compatibility</h2>
<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:
</p>
842
<p>
843 844
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
845
IGNORECASE=TRUE to the database URL (example: jdbc:h2:~/test;IGNORECASE=TRUE).
846 847 848
</p>

<h3>Compatibility Modes</h3>
849
<p>
850
For certain features, this database can emulate the behavior of specific databases. Not all features or differences of those
851
databases are implemented. Currently, this feature is mainly used for randomized comparative testing
852 853
(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.
854
To use the HSQLDB mode, you can use the database URL <code>jdbc:h2:~/test;MODE=HSQLDB</code>
855
or the SQL statement <code>SET MODE HSQLDB</code>.
856
Here is the list of currently supported modes and the difference to the regular mode:
857
</p>
858 859 860 861 862
<table>
<tr><th>Mode</th><th>Differences</th></tr>
<tr><td>
  PostgreSQL
</td><td>
863
  Concatenation of a NULL with another value results in NULL.
864 865 866 867 868 869
  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.
</td></tr>
<tr><td>
  MySQL
</td><td>
870
  When inserting data, if a column is defined to be NOT NULL and NULL is inserted,
871 872 873 874 875 876 877 878 879 880 881 882
  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.
</td></tr>
<tr><td>
  HSQLDB
</td><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.
</td></tr>
</table>

883
<br /><a name="trace_options"></a>
884
<h2>Using the Trace Options</h2>
885
<p>
886
To find problems in an application, it is sometimes good to see what database operations
887
where executed. This database offers the following trace features:
888
</p>
889 890
<ul>
<li>Trace to System.out and/or a file
891 892 893 894 895
</li><li>Support for trace levels OFF, ERROR, INFO, and DEBUG
</li><li>The maximum size of the trace file can be set
</li><li>The Java code generation is possible
</li><li>Trace can be enabled at runtime by manually creating a file
</li></ul>
896 897

<h3>Trace Options</h3>
898
<p>
899
The simplest way to enable the trace option is setting it in the database URL.
900 901
There are two settings, one for System.out (TRACE_LEVEL_SYSTEM_OUT) tracing,
and one for file tracing (TRACE_LEVEL_FILE).
902
The trace levels are 0 for OFF, 1 for ERROR (the default), 2 for INFO and 3 for DEBUG.
903 904
A database URL with both levels set to DEBUG is:
<pre>
905
jdbc:h2:~/test;TRACE_LEVEL_FILE=3;TRACE_LEVEL_SYSTEM_OUT=3
906 907 908 909 910 911 912 913
</pre>
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:
<pre>
SET TRACE_LEVEL_SYSTEM_OUT 3
</pre>
914
</p>
915 916

<h3>Setting the Maximum Size of the Trace File</h3>
917
<p>
918
When using a high trace level, the trace file can get very big quickly.
919
The size of the file can be limited by executing the SQL statement
920 921 922 923
<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:
924
</p>
925 926 927 928 929
<pre>
SET TRACE_MAX_FILE_SIZE 1
</pre>

<h3>Java Code Generation</h3>
930
<p>
931 932 933 934
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:
<pre>
...
935
12-20 20:58:09 jdbc[0]:
936
/**/dbMeta3.getURL();
937
12-20 20:58:09 jdbc[0]:
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
/**/dbMeta3.getTables(null, "", null, new String[]{"TABLE", "VIEW"});
...
</pre>
You need to filter out the lines without /**/ to get the Java source code.
In Windows, a simple way to do that is:
<pre>
find "**" test.trace.db > Trace.java
</pre>
Afterwards, you need to complete the file Trace.java before it can be compiled, for example with:
<pre>
import java.sql.*;
public class Trace { public static void main(String[]a)throws Exception {
Class.forName("org.h2.Driver");
...
}}
</pre>
Also, the user name and password needs to be set, because they are not listed in the trace file.
955
</p>
956 957

<h3>Enabling the Trace Option at Runtime by Manually Creating a File</h3>
958
<p>
959 960
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
961
the database connection is open). You only need to create a special file in the directory
962 963
where the database files are stored.
The database engine checks every 4 seconds if this file exists (only while executing a statement).
964
The file name is the database name plus '.trace.db.start'.
965
This feature is disabled if the database is encrypted.
966
</p><p>
967 968 969 970 971 972
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.
973
</p>
974

975
<br /><a name="read_only"></a>
976
<h2>Read Only Databases</h2>
977
<p>
978 979 980
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.
981
To create a read-only database, close the database so that the log file gets smaller. Do not delete the log file.
982 983 984 985
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().
986
</p>
987

988 989 990 991 992 993 994 995 996 997 998 999 1000
<br /><a name="database_in_zip"></a>
<h2>Read Only Databases in Zip or Jar File</h2>
<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:
</p>
<pre>
BACKUP TO 'data.zip'
</pre>
<p>
Afterwards, you can log out, and directly open the database in the zip file using the following database URL:
</p>
<pre>
1001
jdbc:h2:zip:~/data.zip!/test
1002 1003 1004 1005
</pre>
<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
1006
affects the performance depends on the queries and the data. The database
1007
is not read in memory; so large databases are supported as well. The same indexes are used than when using
1008
a regular database.
1009 1010
</p>

1011
<br /><a name="storage_formats"></a>
1012
<h2>Binary and Text Storage Formats</h2>
1013
<p>
1014
This database engine supports both binary and text storage formats.
1015 1016 1017 1018 1019
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
1020
the parameter STORAGE=TEXT. Example URL: jdbc:h2:~/test;STORAGE=TEXT
1021
</p>
1022

1023
<br /><a name="low_disk_space"></a>
1024
<h2>Graceful Handling of Low Disk Space Situations</h2>
1025
<p>
1026 1027 1028 1029 1030 1031 1032 1033
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.
1034
</p><p>
1035 1036
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
1037
SET DATABASE_EVENT_LISTENER.
1038
The listener can also be set at connection time, using an URL of the form
1039
jdbc:h2:~/test;DATABASE_EVENT_LISTENER='com.acme.DbListener'
1040
(the quotes around the class name are required).
1041
See also the DatabaseEventListener API.
1042
</p>
1043 1044

<h3>Opening a Corrupted Database</h3>
1045
<p>
1046
If a database cannot be opened because the boot info (the SQL script that is run at startup)
1047
is corrupted, then the database can be opened by specifying a database event listener.
1048
The exceptions are logged, but opening the database will continue.
1049
</p>
1050

1051
<br /><a name="computed_columns"></a>
1052
<h2>Computed Columns / Function Based Index</h2>
1053
<p>
1054 1055 1056 1057 1058 1059
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:
<pre>
CREATE TABLE ADDRESS(
1060 1061
  ID INT PRIMARY KEY,
  NAME VARCHAR,
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
  UPPER_NAME VARCHAR AS UPPER(NAME)
);
CREATE INDEX IDX_U_NAME ON ADDRESS(UPPER_NAME);
</pre>
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:
<pre>
INSERT INTO ADDRESS(ID, NAME) VALUES(1, 'Miller');
SELECT * FROM ADDRESS WHERE UPPER_NAME='MILLER';
</pre>
1073
</p>
1074

1075
<br /><a name="multi_dimensional"></a>
1076
<h2>Multi-Dimensional Indexes</h2>
1077
<p>
1078 1079 1080
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
1081
is converted (mapped) to a single dimensional (scalar) value.
1082
This value specifies the location on a space-filling curve.
1083
</p><p>
1084 1085 1086 1087
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).
1088
</p><p>
1089 1090
The method can result in a drastic performance improvement
over just using an index on the first column. Depending on the
1091 1092 1093 1094 1095
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.
1096
</p>
1097

1098
<br /><a name="passwords"></a>
1099 1100 1101
<h2>Using Passwords</h2>

<h3>Using Secure Passwords</h3>
1102
<p>
1103 1104 1105
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
1106
letters of a sentence, use upper and lower case characters, and creatively include special characters.
1107
Example:
1108
</p><p>
1109
i'sE2rtPiUKtT (it's easy to remember this password if you know the trick)
1110
</p>
1111 1112

<h3>Passwords: Using Char Arrays instead of Strings</h3>
1113
<p>
1114
Java Strings are immutable objects and cannot be safely 'destroyed' by the application.
1115
After creating a String, it will remain in the main memory of the computer at least
1116 1117 1118 1119
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).
1120
</p><p>
1121
An attacker might have access to the swap file of the operating system.
1122 1123 1124
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.
1125
</p><p>
1126 1127 1128 1129
This database supports using char arrays instead of String to pass user and file passwords.
The following code can be used to do that:
<pre>
Class.forName("org.h2.Driver");
1130
String url = "jdbc:h2:~/simple";
1131
String user = "sam";
1132
char[] password =
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
{'t','i','a','S','&amp;',E','t','r','p'};
Properties prop = new Properties();
prop.setProperty("user", user);
prop.put("password", password);
Connection conn = null;
try {
    conn = DriverManager.
      getConnection(url, prop);
} finally {
    Arrays.fill(password, 0);
}
</pre>
1145
In this example, the password is hard code in the application, which is not secure of course.
1146
However, Java Swing supports a way to get passwords using a char array (JPasswordField).
1147
</p>
1148 1149

<h3>Passing the User Name and/or Password in the URL</h3>
1150
<p>
1151 1152 1153
Instead of passing the user name as a separate parameter as in
<code>
Connection conn = DriverManager.
1154
  getConnection("jdbc:h2:~/test", "sa", "123");
1155 1156 1157 1158
</code>
the user name (and/or password) can be supplied in the URL itself:
<code>
Connection conn = DriverManager.
1159
  getConnection("jdbc:h2:~/test;USER=sa;PASSWORD=123");
1160 1161
</code>
The settings in the URL override the settings passed as a separate parameter.
1162
</p>
1163

1164
<br /><a name="user_defined_functions"></a>
1165
<h2>User-Defined Functions and Stored Procedures</h2>
1166
<p>
1167
In addition to the built-in functions, this database supports user-defined Java functions.
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
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:
<pre>
package org.h2.samples;
...
public class Function {
    public static boolean isPrime(int value) {
        return new BigInteger(String.valueOf(value)).isProbablePrime(100);
    }
}
</pre>
The Java function must be registered in the database by calling CREATE ALIAS:
<pre>
1183
CREATE ALIAS IS_PRIME FOR "org.h2.samples.Function.isPrime"
1184 1185
</pre>
For a complete sample application, see src/test/org/h2/samples/Function.java.
1186
</p>
1187 1188

<h3>Function Data Type Mapping</h3>
1189
<p>
1190 1191 1192
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'.
1193
</p>
1194 1195

<h3>Functions that require a Connection</h3>
1196
<p>
1197 1198
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.
1199
</p>
1200 1201

<h3>Functions throwing an Exception</h3>
1202
<p>
1203
If a function throws an Exception, then the current statement is rolled back
1204
and the exception is thrown to the application.
1205
</p>
1206 1207

<h3>Functions returning a Result Set</h3>
1208
<p>
1209 1210 1211 1212 1213
Functions may returns a result set. Such a function can be called with the CALL statement:
<pre>
public static ResultSet query(Connection conn, String sql) throws SQLException {
    return conn.createStatement().executeQuery(sql);
}
1214

1215 1216 1217
CREATE ALIAS QUERY FOR "org.h2.samples.Function.query";
CALL QUERY('SELECT * FROM TEST');
</pre>
1218
</p>
1219 1220

<h3>Using SimpleResultSet</h3>
1221
<p>
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
A function that returns a result set can create this result set from scratch using the SimpleResultSet tool:
<pre>
import org.h2.tools.SimpleResultSet;
...
public static ResultSet simpleResultSet() throws SQLException {
    SimpleResultSet rs = new SimpleResultSet();
    rs.addColumn("ID", Types.INTEGER, 10, 0);
    rs.addColumn("NAME", Types.VARCHAR, 255, 0);
    rs.addRow(new Object[] { new Integer(0), "Hello" });
    rs.addRow(new Object[] { new Integer(1), "World" });
    return rs;
1233
}
1234 1235 1236 1237

CREATE ALIAS SIMPLE FOR "org.h2.samples.Function.simpleResultSet";
CALL SIMPLE();
</pre>
1238
</p>
1239 1240

<h3>Using a Function as a Table</h3>
1241
<p>
1242 1243
A function returning a result set can be like a table.
However, in this case the function is called at least twice:
1244
First while parsing the statement to collect the column names
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
(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.
<pre>
public static ResultSet getMatrix(Integer id) throws SQLException {
    SimpleResultSet rs = new SimpleResultSet();
    rs.addColumn("X", Types.INTEGER, 10, 0);
    rs.addColumn("Y", Types.INTEGER, 10, 0);
    if(id == null) {
        return rs;
    }
1257 1258
    for(int x = 0; x &lt; id.intValue(); x++) {
        for(int y = 0; y &lt; id.intValue(); y++) {
1259 1260 1261 1262
            rs.addRow(new Object[] { new Integer(x), new Integer(y) });
        }
      }
    return rs;
1263
}
1264 1265 1266 1267

CREATE ALIAS MATRIX FOR "org.h2.samples.Function.getMatrix";
SELECT * FROM MATRIX(3) WHERE X>0;
</pre>
1268
</p>
1269

1270
<br /><a name="triggers"></a>
1271
<h2>Triggers</h2>
1272
<p>
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
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:
<pre>
import org.h2.api.Trigger;
...
public class TriggerSample implements Trigger {
    public void init(String triggerName, String tableName) {
    }
1284 1285
    public void fire(Connection conn,
            Object[] oldRow, Object[] newRow)
1286 1287 1288 1289 1290 1291 1292
            throws SQLException {
    }
}
</pre>
The connection can be used to query or update data in other tables.
The trigger then needs to be defined in the database:
<pre>
1293
CREATE TRIGGER INV_INS AFTER INSERT ON INVOICE
1294 1295 1296
  FOR EACH ROW CALL "org.h2.samples.TriggerSample"
</pre>
The trigger can be used to veto a change, by throwing a SQL Exception.
1297
</p>
1298

1299
<br /><a name="compacting"></a>
1300
<h2>Compacting a Database</h2>
1301
<p>
1302
Empty space in the database file is re-used automatically.
1303
To re-build the indexes, the simplest way is to delete the .index.db file
1304 1305
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
1306 1307
(compact a database). Here is a sample function to do this:
<pre>
1308
public static void compact(String dir, String dbName,
1309 1310
        String user, String password) throws Exception {
    String url = "jdbc:h2:" + dir + "/" + dbName;
1311 1312 1313 1314
    String file = "data/test.sql";
    Script.execute(url, user, password, file);
    DeleteDbFiles.execute(dir, dbName, true);
    RunScript.execute(url, user, password, file, null, false);
1315 1316 1317
}
</pre>
See also the sample application org.h2.samples.Compact.
1318
The commands SCRIPT / RUNSCRIPT can be used as well to create a backup
1319
of a database and re-build the database from the script.
1320
</p>
1321

1322
<br /><a name="cache_settings"></a>
1323 1324 1325
<h2>Cache Settings</h2>
<p>
The database keeps most frequently used data and index pages in the main memory.
1326 1327
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
1328
(jdbc:h2:~/test;CACHE_SIZE=131072), or it can be changed at runtime using
1329
SET CACHE_SIZE size.
1330
</p><p>
1331 1332
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
1333
cache if it becomes full. The 2Q algorithm is a bit more complicated: basically two
1334
queues are used. The 2Q algorithm is more resistant to table scans, however the overhead
1335
is a bit higher compared to the LRU. To use the cache algorithm 2Q, use a database URL
1336
of the form jdbc:h2:~/test;CACHE_TYPE=TQ. The cache algorithm cannot be changed
1337
once the database is open.
1338
</p><p>
1339 1340 1341 1342 1343
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.
</p>

1344
</div></td></tr></table><!-- analytics --></body></html>