features.html 54.3 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 4 5
Copyright 2004-2008 H2 Group. Multiple-Licensed under the H2 License, Version 1.0,,
and under the Eclipse Public License, Version 1.0
(http://h2database.com/html/license.html).
6 7
Initial Developer: H2 Group
-->
8 9
<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>
10
Features
11
</title><link rel="stylesheet" type="text/css" href="stylesheet.css" />
12 13 14 15 16 17 18
<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">
19
    Feature List</a><br />
20 21
<a href="#limitations">
    Limitations</a><br />
22
<a href="#comparison">
23
    Comparison to Other Database Engines</a><br />
24
<a href="#products_work_with">
25
    H2 in Use</a><br />
26
<a href="#connection_modes">
27
    Connection Modes</a><br />
28
<a href="#database_url">
29
    Database URL Overview</a><br />
30 31
<a href="#memory_only_databases">
    Memory-Only Databases</a><br />
32
<a href="#file_encryption">
33
    Connecting to a Database with File Encryption</a><br />
34
<a href="#database_file_locking">
35
    Database File Locking</a><br />
36
<a href="#database_only_if_exists">
37
    Opening a Database Only if it Already Exists</a><br />
38
<a href="#closing_the_database">
39
    Closing the Database</a><br />
40
<a href="#log_index_changes">
41
    Log Index Changes</a><br />
42 43
<a href="#custom_access_mode">
    Custom File Access Mode</a><br />
44
<a href="#multiple_connections">
45
    Multiple Connections</a><br />
46
<a href="#database_file_layout">
47
    Database File Layout</a><br />
48
<a href="#logging_recovery">
49
    Logging and Recovery</a><br />
50 51
<a href="#compatibility">
    Compatibility</a><br />
52
<a href="#trace_options">
53
    Using the Trace Options</a><br />
54
<a href="#read_only">
55
    Read Only Databases</a><br />
56 57
<a href="#database_in_zip">
    Read Only Databases in Zip or Jar File</a><br />
58
<a href="#storage_formats">
59
    Binary and Text Storage Formats</a><br />
60
<a href="#low_disk_space">
61
    Graceful Handling of Low Disk Space Situations</a><br />
62
<a href="#computed_columns">
63
    Computed Columns / Function Based Index</a><br />
64
<a href="#multi_dimensional">
65
    Multi-Dimensional Indexes</a><br />
66
<a href="#passwords">
67
    Using Passwords</a><br />
68
<a href="#user_defined_functions">
69
    User-Defined Functions and Stored Procedures</a><br />
70
<a href="#triggers">
71
    Triggers</a><br />
72
<a href="#compacting">
73
    Compacting a Database</a><br />
74
<a href="#cache_settings">
75
    Cache Settings</a><br />
76

77
<br /><a name="feature_list"></a>
78 79 80 81
<h2>Feature List</h2>
<h3>Main Features</h3>
<ul>
<li>Very fast database engine
82 83 84 85 86 87 88
</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>
89 90 91 92

<h3>Additional Features</h3>
<ul>
<li>Disk based or in-memory databases and tables, read-only database support, temporary tables
93
</li><li>Transaction support (read committed and serializable transaction isolation), 2-phase-commit
94 95 96 97 98
</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>
99 100 101

<h3>SQL Support</h3>
<ul>
102
<li>Support for multiple schemas, information schema
103 104 105 106
</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
107
</li><li>Wide range of data types including large objects (BLOB/CLOB) and arrays
108 109
</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
110 111
</li><li>Collation support, users, roles
</li><li>Compatibility modes for HSQLDB, MySQL and PostgreSQL
112
</li></ul>
113 114 115

<h3>Security Features</h3>
<ul>
116 117
<li>Includes a solution for the SQL injection problem
</li><li>User password authenticated uses SHA-256 and salt
118 119 120 121 122 123
</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>
124 125 126 127

<h3>Other Features and Tools</h3>
<ul>
<li>Small footprint (smaller than 1 MB), low memory requirements
128 129
</li><li>Multiple index types (b-tree, tree, hash, linear hash)
</li><li>Support for multi-dimensional indexes
130
</li><li>CSV (comma separated values) file support
131 132 133 134 135 136
</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
137
</li><li>Support for variables (for example to calculate running totals)
138 139 140 141 142 143
</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>

144 145
<br /><a name="limitations"></a>
<h2>Limitations</h2>
146
<p>
147 148 149
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
150 151
</a>
</p>
152

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

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

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

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

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

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

282 283
<br /><a name="connection_modes"></a>
<h2>Connection Modes</h2>
284
<p>
285
The following connection modes are supported:
286
</p>
287
<ul>
288 289 290
<li>Embedded mode (local connections using JDBC)
</li><li>Remote mode (remote connections using JDBC or ODBC over TCP/IP)
</li><li>Mixed mode (local and remote connections at the same time)
291
</li></ul>
292

293 294 295 296 297 298 299 300 301
<h3>Embedded Mode</h3>
<p>
In embedded mode, an application opens a database from within the same JVM using JDBC.
This is the fastest and easiest connection mode.
The disadvantage is that a database may only be open in one virtual machine (and class loader) at any time.
As in all modes, both persistent and in-memory databases are supported.
There is no limit on the number of database open concurrently,
or on the number of open connections.
</p>
302 303
<img src="images/connection-mode-embedded.png" 
    alt="The database is embedded in the application" />
304 305 306 307 308 309 310 311 312 313 314 315 316

<h3>Remote Mode</h3>
<p>
When using the remote mode (sometimes called client/server mode), an application opens a 
database remotely using the JDBC or ODBC API. A server needs to be started within the same
or another virtual machine (or on another computer).
Many applications can connect to the same database at the same time.
The remote mode is slower than the embedded mode, because all data
is transferred over TCP/IP.
As in all modes, both persistent and in-memory databases are supported.
There is no limit on the number of database open concurrently,
or on the number of open connections.
</p>
317 318
<img src="images/connection-mode-remote.png" 
    alt="The database is running in a server; the application connects to the server" />
319 320 321 322 323 324 325 326

<h3>Mixed Mode</h3>
<p>
The mixed mode is a combination of the embedded and the remote mode.
The main application connects to a database in embedded mode, but also starts
a server so that other applications (running in different virtual machines) can
concurrently access the same data.
</p>
327 328
<img src="images/connection-mode-mixed.png" 
    alt="The database and the server is running inside the application; another application connects remotely" />
329

330
<br /><a name="database_url"></a>
331
<h2>Database URL Overview</h2>
332
<p>
333 334
This database supports multiple connection modes and connection settings.
This is achieved using different database URLs. Settings in the URLs are not case sensitive.
335
</p>
336 337 338 339
<table><tr><th>Topic</th><th>URL Format and Examples</th></tr>
<tr>
  <td>Embedded (local) connection</td>
  <td>
340
    jdbc:h2:[file:][&lt;path&gt;]&lt;databaseName&gt;<br />
341
      jdbc:h2:~/test<br />
342 343
     jdbc:h2:file:/data/sample<br />
     jdbc:h2:file:C:/data/sample (Windows only)<br />
344 345 346 347 348 349 350 351 352
  </td>
</tr>
<tr>
  <td>In-Memory (private)</td>
  <td>jdbc:h2:mem:</td>
</tr>
<tr>
  <td>In-Memory (named)</td>
  <td>
353
    jdbc:h2:mem:&lt;databaseName&gt;<br />
354
    jdbc:h2:mem:test_mem
355 356 357 358 359
  </td>
</tr>
<tr>
  <td>Remote using TCP/IP</td>
  <td>
360
    jdbc:h2:tcp://&lt;server&gt;[:&lt;port&gt;]/&lt;databaseName&gt;<br />
361 362
    jdbc:h2:tcp://localhost/~/test<br />
    jdbc:h2:tcp://dbserv:8084/~/sample
363 364 365 366 367
  </td>
</tr>
<tr>
  <td>Remote using SSL/TLS</td>
  <td>
368
    jdbc:h2:ssl://&lt;server&gt;[:&lt;port&gt;]/&lt;databaseName&gt;<br />
369
    jdbc:h2:ssl://secureserv:8085/~/sample;
370 371 372 373 374
  </td>
</tr>
<tr>
  <td>Using Encrypted Files</td>
  <td>
375
    jdbc:h2:&lt;url&gt;;CIPHER=[AES|XTEA]<br />
376
    jdbc:h2:ssl://secureserv/~/testdb;CIPHER=AES<br />
377
    jdbc:h2:file:~/secure;CIPHER=XTEA<br />
378 379 380 381 382
  </td>
</tr>
<tr>
  <td>File Locking Methods</td>
  <td>
383
    jdbc:h2:&lt;url&gt;;FILE_LOCK={NO|FILE|SOCKET}<br />
384 385
    jdbc:h2:file:~/quickAndDirty;FILE_LOCK=NO<br />
    jdbc:h2:file:~/private;CIPHER=XTEA;FILE_LOCK=SOCKET<br />
386 387 388 389 390
  </td>
</tr>
<tr>
  <td>Only Open if it Already Exists</td>
  <td>
391
    jdbc:h2:&lt;url&gt;;IFEXISTS=TRUE<br />
392
    jdbc:h2:file:~/sample;IFEXISTS=TRUE<br />
393 394 395 396 397 398 399 400 401 402 403
  </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>
404
    jdbc:h2:&lt;url&gt;[;USER=&lt;username&gt;][;PASSWORD=&lt;value&gt;]<br />
405
    jdbc:h2:file:~/sample;USER=sa;PASSWORD=123<br />
406 407 408 409 410
  </td>
</tr>
<tr>
  <td>Log Index Changes</td>
  <td>
411
    jdbc:h2:&lt;url&gt;;LOG=2<br />
412
    jdbc:h2:file:~/sample;LOG=2<br />
413 414 415 416 417
  </td>
</tr>
<tr>
  <td>Debug Trace Settings</td>
  <td>
418
    jdbc:h2:&lt;url&gt;;TRACE_LEVEL_FILE=&lt;level 0..3&gt;<br />
419
    jdbc:h2:file:~/sample;TRACE_LEVEL_FILE=3<br />
420 421 422 423 424
  </td>
</tr>
<tr>
  <td>Ignore Unknown Settings</td>
  <td>
425
    jdbc:h2:&lt;url&gt;;IGNORE_UNKNOWN_SETTINGS=TRUE<br />
426 427
  </td>
</tr>
428 429 430 431 432 433
<tr>
  <td>Custom File Access Mode</td>
  <td>
    jdbc:h2:&lt;url&gt;;ACCESS_MODE_LOG=rws;ACCESS_MODE_DATA=rws<br />
  </td>
</tr>
434 435 436 437 438
<tr>
  <td>In-Memory (private)</td>
  <td>jdbc:h2:mem:</td>
</tr>
<tr>
439
  <td>Database in or Zip File</td>
440 441
  <td>
    jdbc:h2:zip:&lt;zipFileName&gt;!/&lt;databaseName&gt;<br />
442
    jdbc:h2:zip:~/db.zip!/test
443 444
  </td>
</tr>
445 446 447
<tr>
  <td>Changing Other Settings</td>
  <td>
448
    jdbc:h2:&lt;url&gt;;&lt;setting&gt;=&lt;value&gt;[;&lt;setting&gt;=&lt;value&gt;...]<br />
449
    jdbc:h2:file:~/sample;TRACE_LEVEL_SYSTEM_OUT=3<br />
450 451 452 453 454
  </td>
</tr>
</table>

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

464 465
<br /><a name="memory_only_databases"></a>
<h2>Memory-Only Databases</h2>
466
<p>
467
For certain use cases (for example: rapid prototyping, testing, high performance
468
operations, read-only databases), it may not be required to persist (changes to) the data at all.
469
This database supports the memory-only mode, where the data is not persisted.
470
</p><p>
471 472 473 474
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.
475
</p><p>
476 477
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>.
478
Accessing the same database in this way only works within the same virtual machine and
479
class loader environment.
480
</p><p>
481
It is also possible to access a memory-only database remotely
482
(or from multiple processes in the same machine) using TCP/IP or SSL/TLS.
483 484
An example database URL is: <code>jdbc:h2:tcp://localhost/mem:db1</code>
(using private database remotely is also possible).
485
</p><p>
486 487 488
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
489
jdbc:h2:mem:test;DB_CLOSE_DELAY=-1
490
</p>
491

492
<br /><a name="file_encryption"></a>
493
<h2>Connecting to a Database with File Encryption</h2>
494
<p>
495
To use file encryption, it is required to specify the encryption algorithm (the 'cipher')
496 497
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,
498
before the user password. A single space needs to be added between the file password
499
and the user password; the file password itself may not contain spaces. File passwords
500 501
(as well as user passwords) are case sensitive. Here is an example to connect to a 
password-encrypted database:
502
</p>
503 504
<pre>
Class.forName("org.h2.Driver");
505
String url = "jdbc:h2:~/test;CIPHER=AES";
506 507 508 509 510 511
String user = "sa";
String pwds = "filepwd userpwd";
conn = DriverManager.
    getConnection(url, user, pwds);
</pre>

512
<br /><a name="database_file_locking"></a>
513
<h2>Database File Locking</h2>
514
<p>
515
Whenever a database is opened, a lock file is created to signal other processes
516
that the database is in use. If database is closed, or if the process that opened
517
the database terminates, this lock file is deleted.
518
</p><p>
519
The following file locking methods are implemented:
520
</p>
521 522
<ul>
<li>The default method is 'file' and uses a watchdog thread to
523 524
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
525 526
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.
527
</li><li>It is also possible to open the database without file locking;
528
in this case it is up to the application to protect the database files.
529
</li></ul>
530
<p>
531 532
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:
533
</p>
534
<pre>
535
String url = "jdbc:h2:~/test;FILE_LOCK=SOCKET";
536
</pre>
537
<p>
538
The following code forces the database to not create a lock file at all. Please note that
539
this is unsafe as another process is able to open the same database, possibly leading to
540
data corruption:
541
</p>
542
<pre>
543
String url = "jdbc:h2:~/test;FILE_LOCK=NO";
544
</pre>
545
<p>
546 547
For more information about the algorithms please see in Advanced Topics under
File Locking Protocol.
548
</p>
549

550
<br /><a name="database_only_if_exists"></a>
551
<h2>Opening a Database Only if it Already Exists</h2>
552
<p>
553
By default, when an application calls <code>DriverManager.getConnection(url,...)</code>
554 555 556
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>
557
to the URL. In this case, if the database does not already exist, an exception is thrown when
558 559
trying to connect. The connection only succeeds when the database already exists.
The complete URL may look like this:
560
</p>
561 562 563 564
<pre>
String url = "jdbc:h2:/data/sample;IFEXISTS=TRUE";
</pre>

565
<br /><a name="closing_the_database"></a>
566 567 568
<h2>Closing the Database</h2>

<h3>Delayed Database Closing</h3>
569
<p>
570 571
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.
572
The automatic closing of the database can be delayed or disabled with the SQL statement
573 574 575
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:
576
</p>
577 578 579
<pre>
SET DB_CLOSE_DELAY 10
</pre>
580
<p>
581 582 583
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.
584
It is possible to set the value in the database URL: <code>jdbc:h2:~/test;DB_CLOSE_DELAY=10</code>.
585
</p>
586 587

<h3>Don't Close the Database when the VM Exits</h3>
588
<p>
589 590 591 592
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).
593 594
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
595 596
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:
597
</p>
598
<pre>
599
String url = "jdbc:h2:~/test;DB_CLOSE_ON_EXIT=FALSE";
600 601
</pre>

602
<br /><a name="log_index_changes"></a>
603
<h2>Log Index Changes</h2>
604
<p>
605 606 607 608 609
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),
610
re-creating the index file takes very long.
611 612
In these situations it may be better to log changes to the index file,
so that recovery from a corrupted index file is fast.
613
To enable log index changes, add LOG=2 to the URL, as in jdbc:h2:~/test;LOG=2
614 615
This setting should be specified when connecting.
The update performance of the database will be reduced when using this option.
616
</p>
617 618

<h3>Ignore Unknown Settings</h3>
619
<p>
620
Some applications (for example OpenOffice.org Base) pass some additional parameters
621
when connecting to the database. Why those parameters are passed is unknown.
622
The parameters PREFERDOSLIKELINEENDS and IGNOREDRIVERPRIVILEGES are such examples;
623 624 625
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
626
;IGNORE_UNKNOWN_SETTINGS=TRUE to the database URL.
627
</p>
628 629

<h3>Changing Other Settings when Opening a Connection</h3>
630
<p>
631
In addition to the settings already described (cipher, file_lock, ifexists, user, password),
632 633 634 635 636
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.
637
</p>
638

639 640
<br /><a name="custom_access_mode"></a>
<h2>Custom File Access Mode</h2>
641
<p>
642 643
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).
644 645
To open a database in read-only mode if the files are not read-only, use
ACCESS_MODE_DATA=r.
646 647 648 649
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:
650
</p>
651
<pre>
652
String url = "jdbc:h2:~/test;ACCESS_MODE_LOG=rws;ACCESS_MODE_DATA=rws";
653
</pre>
654
<p>
655 656
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.
657
</p>
658

659
<br /><a name="multiple_connections"></a>
660 661 662
<h2>Multiple Connections</h2>

<h3>Opening Multiple Databases at the Same Time</h3>
663
<p>
664 665
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.
666
</p>
667 668

<h3>Multiple Connections to the Same Database: Client/Server</h3>
669 670 671 672 673 674
<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>
675

676
<h3>Multithreading Support</h3>
677 678
<p>
This database is multithreading-safe. That means, if an application is multi-threaded, it does not need
679
o worry about synchronizing the access to the database. Internally, most requests to the same database
680
are synchronized. That means an application can use multiple threads accessing the same database
681 682 683
at the same time, however if one thread executes a long running query, the other threads
need to wait.
</p>
684

685
<h3>Locking, Lock-Timeout, Deadlocks</h3>
686
<p>
687 688
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).
689
If a connection wants to reads from a table, and there is no write lock on the table,
690 691
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,
692
then a lock timeout exception is thrown.
693
</p><p>
694 695
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,
696 697 698
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.
699
The locks are also released when the autocommit mode changes, and for connections with
700 701
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:
702
</p>
703 704 705 706 707 708
<table><tr><th>Type of Lock</th><th>SQL Statement</th></tr>
<tr>
  <td>
    Read
  </td>
  <td>
709 710
    SELECT * FROM TEST<br />
    CALL SELECT MAX(ID) FROM TEST<br />
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
    SCRIPT
  </td>
</tr>
<tr>
  <td>
    Write
  </td>
  <td>
    SELECT * FROM TEST WHERE 1=0 FOR UPDATE
  </td>
</tr>
<tr>
  <td>
    Write
  </td>
  <td>
727 728 729
    INSERT INTO TEST VALUES(1, 'Hello')<br />
    INSERT INTO TEST SELECT * FROM TEST<br />
    UPDATE TEST SET NAME='Hi'<br />
730 731 732 733 734 735 736 737
    DELETE FROM TEST
  </td>
</tr>
<tr>
  <td>
    Write
  </td>
  <td>
738 739
    ALTER TABLE TEST ...<br />
    CREATE INDEX ... ON TEST ...<br />
740 741 742 743 744 745 746 747 748
    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.
749
</p>
750

751
<br /><a name="database_file_layout"></a>
752
<h2>Database File Layout</h2>
753
<p>
754
There are a number of files created for persistent databases. Other than some databases,
755 756
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).
757
In addition to that, a file is created for each large object (CLOB/BLOB), a file for each linear index,
758 759 760
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:
761
</p>
762 763 764 765
<table><tr><th>File Name</th><th>Description</th><th>Number of Files</th></tr>
<tr><td>
    test.data.db
</td><td>
766 767
    Data file<br />
    Contains the data for all tables<br />
768 769 770 771 772 773 774
    Format: &lt;database&gt;.data.db
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.index.db
</td><td>
775 776
    Index file<br />
    Contains the data for all (btree) indexes<br />
777 778 779 780 781 782 783
    Format: &lt;database&gt;.index.db
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.0.log.db
</td><td>
784 785
    Log file<br />
    The log file is used for recovery<br />
786 787 788 789 790 791 792
    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>
793 794
    Database lock file<br />
    Exists only if the database is open<br />
795 796 797 798 799 800 801
    Format: &lt;database&gt;.lock.db
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.trace.db
</td><td>
802 803 804
    Trace file<br />
    Contains trace information<br />
    Format: &lt;database&gt;.trace.db<br />
805 806 807 808 809 810 811
    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>
812 813
    Large object<br />
    Contains the data for BLOB or CLOB<br />
814 815 816 817 818 819 820
    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>
821 822
    Temporary file<br />
    Contains a temporary blob or a large result set<br />
823 824 825 826 827 828 829
    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>
830 831
    Hash index file<br />
    Contains the data for a linear hash index<br />
832 833 834 835 836 837 838 839
    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>
840 841
Database name and location are not stored inside the database names.
</p><p>
842
While a database is closed, the files can be moved to another directory, and they can be renamed
843
as well (as long as all files start with the same name).
844
</p><p>
845 846
As there is no platform specific data in the files, they can be moved to other operating systems
without problems.
847
</p>
848 849

<h3>Backup</h3>
850
<p>
851 852 853
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.
854
</p><p>
855
To backup data while the database is running, the SQL command SCRIPT can be used.
856
</p>
857

858
<br /><a name="logging_recovery"></a>
859
<h2>Logging and Recovery</h2>
860
<p>
861 862
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
863 864 865
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.
866
</p><p>
867 868
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.
869
</p><p>
870 871
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).
872
It is possible to force the log switching by using the CHECKPOINT command.
873
</p><p>
874 875 876 877
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
878
must contain RECOVER=1, as in jdbc:h2:~/test;RECOVER=1. Indexes are rebuilt in this case, and
879
the summary (object allocation table) is not read in this case, so opening the database takes longer.
880
</p>
881

882 883 884 885 886 887
<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>
888
<p>
889 890
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
891
IGNORECASE=TRUE to the database URL (example: jdbc:h2:~/test;IGNORECASE=TRUE).
892 893 894
</p>

<h3>Compatibility Modes</h3>
895
<p>
896
For certain features, this database can emulate the behavior of specific databases. Not all features or differences of those
897
databases are implemented. Currently, this feature is mainly used for randomized comparative testing
898 899
(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.
900
To use the HSQLDB mode, you can use the database URL <code>jdbc:h2:~/test;MODE=HSQLDB</code>
901
or the SQL statement <code>SET MODE HSQLDB</code>.
902
Here is the list of currently supported modes and the difference to the regular mode:
903
</p>
904 905 906 907 908
<table>
<tr><th>Mode</th><th>Differences</th></tr>
<tr><td>
  PostgreSQL
</td><td>
909
  Concatenation of a NULL with another value results in NULL.
910 911 912 913 914 915
  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>
916
  When inserting data, if a column is defined to be NOT NULL and NULL is inserted,
917 918 919 920 921 922 923 924 925 926 927 928
  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>

929
<br /><a name="trace_options"></a>
930
<h2>Using the Trace Options</h2>
931
<p>
932
To find problems in an application, it is sometimes good to see what database operations
933
where executed. This database offers the following trace features:
934
</p>
935 936
<ul>
<li>Trace to System.out and/or a file
937 938 939 940 941
</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>
942 943

<h3>Trace Options</h3>
944
<p>
945
The simplest way to enable the trace option is setting it in the database URL.
946 947
There are two settings, one for System.out (TRACE_LEVEL_SYSTEM_OUT) tracing,
and one for file tracing (TRACE_LEVEL_FILE).
948
The trace levels are 0 for OFF, 1 for ERROR (the default), 2 for INFO and 3 for DEBUG.
949
A database URL with both levels set to DEBUG is:
950
</p>
951
<pre>
952
jdbc:h2:~/test;TRACE_LEVEL_FILE=3;TRACE_LEVEL_SYSTEM_OUT=3
953
</pre>
954
<p>
955 956 957 958
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:
959
</p>
960 961 962 963 964
<pre>
SET TRACE_LEVEL_SYSTEM_OUT 3
</pre>

<h3>Setting the Maximum Size of the Trace File</h3>
965
<p>
966
When using a high trace level, the trace file can get very big quickly.
967
The size of the file can be limited by executing the SQL statement
968 969 970 971
<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:
972
</p>
973 974 975 976 977
<pre>
SET TRACE_MAX_FILE_SIZE 1
</pre>

<h3>Java Code Generation</h3>
978
<p>
979 980
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:
981
</p>
982 983
<pre>
...
984
12-20 20:58:09 jdbc[0]:
985
/**/dbMeta3.getURL();
986
12-20 20:58:09 jdbc[0]:
987 988 989
/**/dbMeta3.getTables(null, "", null, new String[]{"TABLE", "VIEW"});
...
</pre>
990
<p>
991 992
You need to filter out the lines without /**/ to get the Java source code.
In Windows, a simple way to do that is:
993
</p>
994 995 996
<pre>
find "**" test.trace.db > Trace.java
</pre>
997
<p>
998
Afterwards, you need to complete the file Trace.java before it can be compiled, for example with:
999
</p>
1000 1001 1002 1003 1004 1005 1006
<pre>
import java.sql.*;
public class Trace { public static void main(String[]a)throws Exception {
Class.forName("org.h2.Driver");
...
}}
</pre>
1007
<p>
1008
Also, the user name and password needs to be set, because they are not listed in the trace file.
1009
</p>
1010 1011

<h3>Enabling the Trace Option at Runtime by Manually Creating a File</h3>
1012
<p>
1013 1014
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
1015
the database connection is open). You only need to create a special file in the directory
1016 1017
where the database files are stored.
The database engine checks every 4 seconds if this file exists (only while executing a statement).
1018
The file name is the database name plus '.trace.db.start'.
1019
This feature is disabled if the database is encrypted.
1020
</p><p>
1021 1022 1023 1024 1025 1026
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.
1027
</p>
1028

1029
<br /><a name="read_only"></a>
1030
<h2>Read Only Databases</h2>
1031
<p>
1032 1033 1034
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.
1035
To create a read-only database, close the database so that the log file gets smaller. Do not delete the log file.
1036 1037 1038 1039
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().
1040
</p>
1041

1042 1043 1044 1045
<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.
1046
If you are using a database named 'test', an easy way to do that is using the Backup tool or the BACKUP SQL statement:
1047 1048 1049 1050 1051
</p>
<pre>
BACKUP TO 'data.zip'
</pre>
<p>
1052 1053 1054
The database must not have pending changes, that means you need to close all connections to the 
database, open one single connection, and then execute the statement. Afterwards, you can log out, 
and directly open the database in the zip file using the following database URL:
1055 1056
</p>
<pre>
1057
jdbc:h2:zip:~/data.zip!/test
1058 1059 1060 1061
</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
1062
affects the performance depends on the queries and the data. The database
1063
is not read in memory; so large databases are supported as well. The same indexes are used than when using
1064
a regular database.
1065 1066
</p>

1067
<br /><a name="storage_formats"></a>
1068
<h2>Binary and Text Storage Formats</h2>
1069
<p>
1070
This database engine supports both binary and text storage formats.
1071 1072 1073 1074 1075
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
1076
the parameter STORAGE=TEXT. Example URL: jdbc:h2:~/test;STORAGE=TEXT
1077
</p>
1078

1079
<br /><a name="low_disk_space"></a>
1080
<h2>Graceful Handling of Low Disk Space Situations</h2>
1081
<p>
1082 1083 1084 1085 1086 1087 1088 1089
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.
1090
</p><p>
1091 1092
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
1093
SET DATABASE_EVENT_LISTENER.
1094
The listener can also be set at connection time, using an URL of the form
1095
jdbc:h2:~/test;DATABASE_EVENT_LISTENER='com.acme.DbListener'
1096
(the quotes around the class name are required).
1097
See also the DatabaseEventListener API.
1098
</p>
1099 1100

<h3>Opening a Corrupted Database</h3>
1101
<p>
1102
If a database cannot be opened because the boot info (the SQL script that is run at startup)
1103
is corrupted, then the database can be opened by specifying a database event listener.
1104
The exceptions are logged, but opening the database will continue.
1105
</p>
1106

1107
<br /><a name="computed_columns"></a>
1108
<h2>Computed Columns / Function Based Index</h2>
1109
<p>
1110 1111 1112 1113
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:
1114
</p>
1115 1116
<pre>
CREATE TABLE ADDRESS(
1117 1118
  ID INT PRIMARY KEY,
  NAME VARCHAR,
1119 1120 1121 1122
  UPPER_NAME VARCHAR AS UPPER(NAME)
);
CREATE INDEX IDX_U_NAME ON ADDRESS(UPPER_NAME);
</pre>
1123
<p>
1124 1125 1126
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:
1127
</p>
1128 1129 1130 1131 1132
<pre>
INSERT INTO ADDRESS(ID, NAME) VALUES(1, 'Miller');
SELECT * FROM ADDRESS WHERE UPPER_NAME='MILLER';
</pre>

1133
<br /><a name="multi_dimensional"></a>
1134
<h2>Multi-Dimensional Indexes</h2>
1135
<p>
1136 1137 1138
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
1139
is converted (mapped) to a single dimensional (scalar) value.
1140
This value specifies the location on a space-filling curve.
1141
</p><p>
1142 1143 1144 1145
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).
1146
</p><p>
1147 1148
The method can result in a drastic performance improvement
over just using an index on the first column. Depending on the
1149 1150 1151 1152 1153
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.
1154
</p>
1155

1156
<br /><a name="passwords"></a>
1157 1158 1159
<h2>Using Passwords</h2>

<h3>Using Secure Passwords</h3>
1160
<p>
1161 1162 1163
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
1164
letters of a sentence, use upper and lower case characters, and creatively include special characters.
1165
Example:
1166
</p><p>
1167
i'sE2rtPiUKtT (it's easy to remember this password if you know the trick)
1168
</p>
1169 1170

<h3>Passwords: Using Char Arrays instead of Strings</h3>
1171
<p>
1172
Java Strings are immutable objects and cannot be safely 'destroyed' by the application.
1173
After creating a String, it will remain in the main memory of the computer at least
1174 1175 1176 1177
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).
1178
</p><p>
1179
An attacker might have access to the swap file of the operating system.
1180 1181 1182
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.
1183
</p><p>
1184 1185
This database supports using char arrays instead of String to pass user and file passwords.
The following code can be used to do that:
1186
</p>
1187 1188
<pre>
Class.forName("org.h2.Driver");
1189
String url = "jdbc:h2:~/simple";
1190
String user = "sam";
1191
char[] password =
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
{'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>
1204
<p>
1205
In this example, the password is hard code in the application, which is not secure of course.
1206
However, Java Swing supports a way to get passwords using a char array (JPasswordField).
1207
</p>
1208 1209

<h3>Passing the User Name and/or Password in the URL</h3>
1210
<p>
1211 1212 1213
Instead of passing the user name as a separate parameter as in
<code>
Connection conn = DriverManager.
1214
  getConnection("jdbc:h2:~/test", "sa", "123");
1215 1216 1217 1218
</code>
the user name (and/or password) can be supplied in the URL itself:
<code>
Connection conn = DriverManager.
1219
  getConnection("jdbc:h2:~/test;USER=sa;PASSWORD=123");
1220 1221
</code>
The settings in the URL override the settings passed as a separate parameter.
1222
</p>
1223

1224
<br /><a name="user_defined_functions"></a>
1225
<h2>User-Defined Functions and Stored Procedures</h2>
1226
<p>
1227
In addition to the built-in functions, this database supports user-defined Java functions.
1228 1229 1230 1231
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:
1232
</p>
1233 1234 1235 1236 1237 1238 1239 1240 1241
<pre>
package org.h2.samples;
...
public class Function {
    public static boolean isPrime(int value) {
        return new BigInteger(String.valueOf(value)).isProbablePrime(100);
    }
}
</pre>
1242
<p>
1243
The Java function must be registered in the database by calling CREATE ALIAS:
1244
</p>
1245
<pre>
1246
CREATE ALIAS IS_PRIME FOR "org.h2.samples.Function.isPrime"
1247
</pre>
1248
<p>
1249
For a complete sample application, see src/test/org/h2/samples/Function.java.
1250
</p>
1251 1252

<h3>Function Data Type Mapping</h3>
1253
<p>
1254 1255 1256
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'.
1257
</p>
1258 1259

<h3>Functions that require a Connection</h3>
1260
<p>
1261 1262
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.
1263
</p>
1264 1265

<h3>Functions throwing an Exception</h3>
1266
<p>
1267
If a function throws an Exception, then the current statement is rolled back
1268
and the exception is thrown to the application.
1269
</p>
1270 1271

<h3>Functions returning a Result Set</h3>
1272
<p>
1273
Functions may returns a result set. Such a function can be called with the CALL statement:
1274
</p>
1275 1276 1277 1278
<pre>
public static ResultSet query(Connection conn, String sql) throws SQLException {
    return conn.createStatement().executeQuery(sql);
}
1279

1280 1281 1282 1283 1284
CREATE ALIAS QUERY FOR "org.h2.samples.Function.query";
CALL QUERY('SELECT * FROM TEST');
</pre>

<h3>Using SimpleResultSet</h3>
1285
<p>
1286
A function that returns a result set can create this result set from scratch using the SimpleResultSet tool:
1287
</p>
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
<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;
1298
}
1299 1300 1301 1302 1303 1304

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

<h3>Using a Function as a Table</h3>
1305
<p>
1306 1307
A function returning a result set can be like a table.
However, in this case the function is called at least twice:
1308
First while parsing the statement to collect the column names
1309 1310 1311 1312
(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.
1313
</p>
1314 1315 1316 1317 1318 1319 1320 1321
<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;
    }
1322 1323
    for(int x = 0; x &lt; id.intValue(); x++) {
        for(int y = 0; y &lt; id.intValue(); y++) {
1324 1325 1326 1327
            rs.addRow(new Object[] { new Integer(x), new Integer(y) });
        }
      }
    return rs;
1328
}
1329 1330 1331 1332 1333

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

1334
<br /><a name="triggers"></a>
1335
<h2>Triggers</h2>
1336
<p>
1337 1338 1339 1340 1341
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:
1342
</p>
1343 1344 1345 1346 1347 1348
<pre>
import org.h2.api.Trigger;
...
public class TriggerSample implements Trigger {
    public void init(String triggerName, String tableName) {
    }
1349 1350
    public void fire(Connection conn,
            Object[] oldRow, Object[] newRow)
1351 1352 1353 1354
            throws SQLException {
    }
}
</pre>
1355
<p>
1356 1357
The connection can be used to query or update data in other tables.
The trigger then needs to be defined in the database:
1358
</p>
1359
<pre>
1360
CREATE TRIGGER INV_INS AFTER INSERT ON INVOICE
1361 1362
  FOR EACH ROW CALL "org.h2.samples.TriggerSample"
</pre>
1363
<p>
1364
The trigger can be used to veto a change, by throwing a SQL Exception.
1365
</p>
1366

1367
<br /><a name="compacting"></a>
1368
<h2>Compacting a Database</h2>
1369
<p>
1370
Empty space in the database file is re-used automatically.
1371
To re-build the indexes, the simplest way is to delete the .index.db file
1372 1373
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
1374
(compact a database). Here is a sample function to do this:
1375
</p>
1376
<pre>
1377
public static void compact(String dir, String dbName,
1378 1379
        String user, String password) throws Exception {
    String url = "jdbc:h2:" + dir + "/" + dbName;
1380 1381 1382 1383
    String file = "data/test.sql";
    Script.execute(url, user, password, file);
    DeleteDbFiles.execute(dir, dbName, true);
    RunScript.execute(url, user, password, file, null, false);
1384 1385
}
</pre>
1386
<p>
1387
See also the sample application org.h2.samples.Compact.
1388
The commands SCRIPT / RUNSCRIPT can be used as well to create a backup
1389
of a database and re-build the database from the script.
1390
</p>
1391

1392
<br /><a name="cache_settings"></a>
1393 1394 1395
<h2>Cache Settings</h2>
<p>
The database keeps most frequently used data and index pages in the main memory.
1396 1397
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
1398
(jdbc:h2:~/test;CACHE_SIZE=131072), or it can be changed at runtime using
1399
SET CACHE_SIZE size.
1400
</p><p>
1401 1402
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
1403
cache if it becomes full. The 2Q algorithm is a bit more complicated: basically two
1404
queues are used. The 2Q algorithm is more resistant to table scans, however the overhead
1405
is a bit higher compared to the LRU. To use the cache algorithm 2Q, use a database URL
1406
of the form jdbc:h2:~/test;CACHE_TYPE=TQ. The cache algorithm cannot be changed
1407
once the database is open.
1408
</p><p>
1409 1410 1411 1412 1413
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>

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