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

71
<br /><a name="feature_list"></a>
72 73 74 75
<h2>Feature List</h2>
<h3>Main Features</h3>
<ul>
<li>Very fast database engine
76 77 78 79 80 81 82
</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>
83 84 85 86

<h3>Additional Features</h3>
<ul>
<li>Disk based or in-memory databases and tables, read-only database support, temporary tables
87
</li><li>Transaction support (read committed and serializable transaction isolation), 2-phase-commit
88 89 90 91 92
</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>
93 94 95

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

<h3>Security Features</h3>
<ul>
110 111
<li>Includes a solution for the SQL injection problem
</li><li>User password authenticated uses SHA-256 and salt
112 113 114 115 116 117
</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>
118 119 120 121

<h3>Other Features and Tools</h3>
<ul>
<li>Small footprint (smaller than 1 MB), low memory requirements
122 123
</li><li>Multiple index types (b-tree, tree, hash, linear hash)
</li><li>Support for multi-dimensional indexes
124
</li><li>CSV (comma separated values) file support
125 126 127 128 129 130 131 132 133 134 135 136 137
</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
</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>

<br /><a name="comparison"></a>
138 139 140 141 142 143
<h2>Comparison to Other Database Engines</h2>

<table><tr>
<th>Feature</th>
<th>H2</th>
<th>Derby</th>
144
<th>HSQLDB</th>
145 146 147 148 149 150 151
<th>MySQL</th>
<th>PostgreSQL</th>
</tr><tr>
<td>Embedded Mode (Java)</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
152 153 154 155 156 157
<td class="compareN">No</td>
<td class="compareN">No</td>
</tr><tr>
<td>Pure Java</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
158 159 160 161 162 163 164
<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>
165
<td class="compareY">Fast</td>
166 167 168 169 170 171
<td class="compareN">N/A</td>
<td class="compareN">N/A</td>
</tr><tr>
<td>Transaction Isolation</td>
<td class="compareY">Yes</td>
<td class="compareY">Yes</td>
172
<td class="compareN">No</td>
173 174 175 176 177 178
<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>
179
<td class="compareN">No</td>
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
<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>
<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>
205 206 207 208 209
<td>~ 1 MB</td>
<td>~ 2 MB</td>
<td>~ 600 KB</td>
<td>~ 4 MB</td>
<td>~ 6 MB</td>
210 211 212
</tr>
</table>

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

221
<h3>DaffodilDb and One$Db</h3>
222
<p>
223
It looks like the development of this database has stopped. The last release was February 2006.
224
</p>
225 226

<h3>McKoi</h3>
227
<p>
228
It looks like the development of this database has stopped. The last release was August 2004
229
</p>
230

231
<br /><a name="products_work_with"></a>
232 233 234 235
<h2>Products that Work with H2</h2>
<table>
<tr><th>Product</th><th>Description</th></tr>
    <tr>
236 237 238 239
        <td><a href="http://jackrabbit.apache.org">Apache Jackrabbit</a></td>
        <td>Open source implementation of the Java Content Repository API (JCR).</td>     
    </tr><tr>
        <td><a href="http://incubator.apache.org/openjpa">Apache OpenJPA</a></td>
240
        <td>Open source implementation of the Java Persistence API (JPA).</td>     
241 242 243
    </tr><tr>
        <td><a href="http://appfuse.org">AppFuse</a></td>
        <td>Helps building web applications.</td>     
244 245 246
    </tr><tr>
        <td><a href="http://bmarks-portlet.sourceforge.net">Bookmarks Portlet</a></td>
        <td>JSR168 compliant bookmarks management portlet application.</td>
247 248 249
    </tr><tr>
        <td><a href="http://www.dbsolo.com">DB Solo</a></td>
        <td>SQL query tool.</td>
250 251 252 253 254 255 256 257 258 259
    </tr><tr>
        <td><a href="http://www.minq.se/products/dbvis">DbVisualizer</a></td>
        <td>Database tool.</td>
    </tr><tr>
        <td><a href="http://executequery.org">Execute Query</a></td>
        <td>Database utility written in Java.</td>     
    </tr><tr>
        <td><a href="http://www.goldenstudios.or.id">Golden T Studios</a></td>
        <td>Fun-to-play games with a simple interface.</td>
    </tr><tr>
260
        <td><a href="http://hibernate.org">Hibernate</a></td>
261
        <td>Relational persistence for idiomatic Java (O-R mapping tool).</td>
262 263
    </tr><tr>
        <td><a href="http://geosysin.iict.ch/irstv-trac/wiki/H2spatial/Why">H2 Spatial</a></td>
264
        <td>A project to add spatial functions to H2 database.</td>
265 266 267
    </tr><tr>
        <td><a href="http://jamwiki.org">JAMWiki</a></td>
        <td>Java-based Wiki engine.</td>
268 269
    </tr><tr>
        <td><a href="http://mywebpage.netscape.com/davidlbarron/javaplayer.html">JavaPlayer</a></td>
270
        <td>Pure Java MP3 player.</td>
271 272
    </tr><tr>
        <td><a href="http://www.jpox.org">JPOX</a></td>
273 274 275 276
        <td>Java persistent objects.</td>
    </tr><tr>
        <td><a href="http://liquibase.sourceforge.net">LiquiBase</a></td>
        <td>A tool to manage database changes and refactorings.</td>
277 278
    </tr><tr>
        <td><a href="http://luntbuild.javaforge.com">Luntbuild</a></td>
279
        <td>Build automation and management tool.</td>
280
    </tr><tr>
281
        <td><a href="http://www.jenkov.com/mrpersister/introduction.tmpl">Mr. Persister</a></td>
282
        <td>Simple, small and fast object relational mapping.</td>
283 284 285
    </tr><tr>
        <td><a href="http://docs.codewave.de/mytunesrss3/">MyTunesRss</a></td>
        <td>MyTunesRSS lets you listen to your music whereever you are.</td>
286 287 288
    </tr><tr>
        <td><a href="http://www.polepos.org">PolePosition</a></td>
        <td>Open source database benchmark.</td>
289 290 291 292 293 294
    </tr><tr>
        <td><a href="http://scriptella.javaforge.com">Scriptella</a></td>
        <td>ETL (Extract-Transform-Load) and script execution tool.</td>
    </tr><tr>
        <td><a href="http://semmle.com">SemmleCode</a></td>
        <td>Eclipse plugin to help you improve software quality.</td>
295 296
    </tr><tr>
        <td><a href="http://www.shellbook.com">Shellbook</a></td>
297
        <td>Desktop publishing application.</td>
298 299 300
    </tr><tr>
        <td><a href="http://www.intellibo.com">Signsoft intelliBO</a></td>
        <td>Persistence middleware supporting the JDO specification.</td>     
301 302
    </tr><tr>
        <td><a href="http://sql-workbench.net">SQL Workbench/J</a></td>
303
        <td>Free DBMS-independent SQL tool.</td>     
304
    </tr><tr>
305
        <td><a href="http://www.squirrelsql.org">SQuirreL SQL Client</a></td>
306 307 308 309
        <td>Graphical tool to view the structure of a database, browse the data, issue SQL commands etc.</td>
    </tr><tr>
        <td><a href="http://dbcopyplugin.sf.net">SQuirreL DB Copy Plugin</a></td>
        <td>Tool to copy data from one database to another.</td>
310 311
    </tr><tr>
        <td><a href="http://www.streamcruncher.com">StreamCruncher</a></td>
312
        <td>Event (stream) processing kernel.</td>     
313 314 315
    </tr><tr>
        <td><a href="http://www.tamava.com">Tamava</a></td>
        <td>Newsgroups Reader.</td>     
316 317 318
    </tr><tr>
        <td><a href="http://www.webofweb.net">Web of Web</a></td>
        <td>Collaborative and realtime interactive media platform for the web.</td>
319 320 321
    </tr>
</table>

322
<br /><a name="connection_modes"></a>
323
<h2>Connection Modes</h2>
324
<p>
325
The following connection modes are supported:
326
</p>
327 328
<ul>
<li>Local connections using JDBC (embedded) 
329 330 331 332
</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>
333

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

<h3>Connecting to an Embedded (Local) Database</h3>
448
<p>
449 450 451 452
The database URL for connecting to a local database is <code>jdbc:h2:[file:][&lt;path&gt;]&lt;databaseName&gt;</code>.
The prefix <code>file:</code> is optional. If no or only a relative path is used, then the current working 
directory is used as a starting point. The case sensitivity of the path and database name depend on the 
operating system, however it is suggested to use lowercase letters only.
453
The database name must be at least three characters long (a limitation of File.createTempFile).
454
To point to the user home directory, use ~/, as in: jdbc:h2:~/test.
455
</p>
456 457

<h3>Memory-Only Databases</h3>
458
<p>
459 460 461
For certain use cases (for example: rapid prototyping, testing, high performance
operations, read-only databases), it may not be required to persist (changes to) the data at all. 
This database supports the memory-only mode, where the data is not persisted.
462
</p><p>
463 464 465 466
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.
467
</p><p>
468 469 470 471
Sometimes multiple connections to the same memory-only database are required.
In this case, the database URL must include a name. Example: <code>jdbc:h2:mem:db1</code>.
Accessing the same database in this way only works within the same virtual machine and 
class loader environment.
472
</p><p>
473 474
It is also possible to access a memory-only database remotely 
(or from multiple processes in the same machine) using TCP/IP or SSL/TLS.
475 476
An example database URL is: <code>jdbc:h2:tcp://localhost/mem:db1</code>
(using private database remotely is also possible).
477
</p>
478

479
<br /><a name="file_encryption"></a>
480
<h2>Connecting to a Database with File Encryption</h2>
481
<p>
482 483 484 485 486 487 488
To use file encryption, it is required to specify the encryption algorithm (the 'cipher') 
and the file password. The algorithm needs to be specified using the connection parameter.
Two algorithms are supported: XTEA and AES. The file password is specified in the password field,
before the user password. A single space needs to be added between the file password 
and the user password; the file password itself may not contain spaces. File passwords
(as well as user passwords) are case sensitive. Here is an example to connect to a password
encrypted database:
489
</p>
490 491
<pre>
Class.forName("org.h2.Driver");
492
String url = "jdbc:h2:~/test;CIPHER=AES";
493 494 495 496 497 498
String user = "sa";
String pwds = "filepwd userpwd";
conn = DriverManager.
    getConnection(url, user, pwds);
</pre>

499
<br /><a name="database_file_locking"></a>
500
<h2>Database File Locking</h2>
501
<p>
502 503 504
Whenever a database is opened, a lock file is created to signal other processes 
that the database is in use. If database is closed, or if the process that opened
the database terminates, this lock file is deleted. 
505
</p><p>
506
The following file locking methods are implemented:
507
</p>
508 509 510
<ul>
<li>The default method is 'file' and uses a watchdog thread to
protect the database file. The watchdog reads the lock file each second. 
511
</li><li>The second method is 'socket' and opens a server socket. The socket method does 
512 513
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.
514
</li><li>It is also possible to open the database without file locking;
515
in this case it is up to the application to protect the database files. 
516
</li></ul>
517
<p>
518 519 520
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>
521
String url = "jdbc:h2:~/test;FILE_LOCK=SOCKET";
522 523 524 525 526
</pre>
The following code forces the database to not create a lock file at all. Please note that
this is unsafe as another process is able to open the same database, possibly leading to 
data corruption:
<pre>
527
String url = "jdbc:h2:~/test;FILE_LOCK=NO";
528 529 530
</pre>
For more information about the algorithms please see in Advanced Topics under 
File Locking Protocol.  
531
</p>
532

533
<br /><a name="database_only_if_exists"></a>
534
<h2>Opening a Database Only if it Already Exists</h2>
535
<p>
536 537 538 539 540 541 542
By default, when an application calls <code>DriverManager.getConnection(url,...)</code> 
and the database specified in the URL does not yet exist, a new (empty) database is created.
In some situations, it is better to restrict creating new database, and only open
the database if it already exists. This can be done by adding <code>;ifexists=true</code>
to the URL. In this case, if the database does not already exist, an exception is thrown when 
trying to connect. The connection only succeeds when the database already exists.
The complete URL may look like this:
543
</p>
544 545 546 547
<pre>
String url = "jdbc:h2:/data/sample;IFEXISTS=TRUE";
</pre>

548
<br /><a name="closing_the_database"></a>
549 550 551
<h2>Closing the Database</h2>

<h3>Delayed Database Closing</h3>
552
<p>
553 554 555 556 557 558 559 560 561 562 563 564
Usually, the database is closed when the last connection to it is closed. In some situations
this slows down the application, for example when it is not possible leave the connection open.
The automatic closing of the database can be delayed or disabled with the SQL statement 
SET DB_CLOSE_DELAY &lt;seconds&gt;. The seconds specifies the number of seconds to keep
a database open after the last connection to it was closed. For example the following statement
will keep the database open for 10 seconds:
<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.
565
It is possible to set the value in the database URL: <code>jdbc:h2:~/test;DB_CLOSE_DELAY=10</code>.
566
</p>
567 568

<h3>Don't Close the Database when the VM Exits</h3>
569
<p>
570 571 572 573
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).
574 575
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 
576 577
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:
578
</p>
579
<pre>
580
String url = "jdbc:h2:~/test;DB_CLOSE_ON_EXIT=FALSE";
581 582
</pre>

583
<br /><a name="log_index_changes"></a>
584
<h2>Log Index Changes</h2>
585
<p>
586 587 588 589 590 591 592 593
Usually, changes to the index file are not logged for performance.
If the index file is corrupt or missing when opening a database, it is re-created from the data.
The index file can get corrupt when the database is not shut down correctly,
because of power failure or abnormal program termination.
In some situations, for example when using very large databases (over a few hundred MB),
re-creating the index file takes very long. 
In these situations it may be better to log changes to the index file,
so that recovery from a corrupted index file is fast.
594
To enable log index changes, add LOG=2 to the URL, as in jdbc:h2:~/test;LOG=2
595 596
This setting should be specified when connecting.
The update performance of the database will be reduced when using this option.
597
</p>
598 599

<h3>Ignore Unknown Settings</h3>
600
<p>
601 602 603 604 605 606 607
Some applications (for example OpenOffice.org Base) pass some additional parameters 
when connecting to the database. Why those parameters are passed is unknown.
The parameters PREFERDOSLIKELINEENDS and IGNOREDRIVERPRIVILEGES are such examples,
they are simply ignored to improve the compatibility with OpenOffice.org. If an application
passes other parameters when connecting to the database, usually the database throws an exception
saying the parameter is not supported. It is possible to ignored such parameters by adding
;IGNORE_UNKNOWN_SETTINGS=TRUE to the database URL. 
608
</p>
609 610

<h3>Changing Other Settings when Opening a Connection</h3>
611
<p>
612 613 614 615 616 617
In addition to the settings already described (cipher, file_lock, ifexists, user, password), 
other database settings can be passed in the database URL.
Adding <code>setting=value</code> at the end of an URL is the
same as executing the statement <code>SET setting value</code> just after
connecting. For a list of settings supported by this database please see the
SQL grammar documentation.
618
</p>
619

620 621
<br /><a name="custom_access_mode"></a>
<h2>Custom File Access Mode</h2>
622
<p>
623 624 625 626 627 628 629
Usually, the database opens log, data and index files with the access mode 'rw', meaning
read-write (except for read only databases, where the mode 'r' is used).
Also supported are 'rws' and 'rwd'.
The access mode used for log files is set via ACCESS_MODE_LOG; for
data and index files use ACCESS_MODE_DATA.
These settings must be specified in the database URL:
<pre>
630
String url = "jdbc:h2:~/test;ACCESS_MODE_LOG=rws;ACCESS_MODE_DATA=rws";
631 632 633
</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.
634
</p>
635

636
<br /><a name="multiple_connections"></a>
637 638 639
<h2>Multiple Connections</h2>

<h3>Opening Multiple Databases at the Same Time</h3>
640
<p>
641 642
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.
643
</p>
644 645

<h3>Multiple Connections to the Same Database: Client/Server</h3>
646 647 648 649 650 651
<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>
652 653
 
<h3>Multithreading Support</h3>
654 655 656 657 658 659 660
<p>
This database is multithreading-safe. That means, if an application is multi-threaded, it does not need
o worry about synchronizing the access to the database. Internally, most requests to the same database 
are synchronized. That means an application can use multiple threads all accessing the same database
at the same time, however if one thread executes a long running query, the other threads
need to wait.
</p>
661 662
 
<h3>Locking, Lock-Timeout, Deadlocks</h3>
663
<p>
664 665 666 667 668 669
The database uses table level locks to give each connection a consistent state of the data.
There are two kinds of locks: read locks (shared locks) and write locks (exclusive locks).
If a connection wants to reads from a table, and there is no write lock on the table, 
then a read lock is added to the table. If there is a write lock, then this connection waits
for the other connection to release the lock. If connection cannot get a lock for a specified time,
then a lock timeout exception is thrown. 
670
</p><p>
671 672 673 674 675 676 677 678
Usually, SELECT statement will generate read locks. This includes subqueries. 
Statements that modify data use write locks. It is also possible to lock a table exclusively without modifying data, 
using the statement SELECT ... FOR UPDATE.
The statements COMMIT and ROLLBACK releases all open locks.
The commands SAVEPOINT and ROLLBACK TO SAVEPOINT don't affect locks.
The locks are also released when the autocommit mode changes, and for connections with 
autocommit set to true (this is the default), locks are released after each statement.
Here is an overview on what statements generate what type of lock:
679
</p>
680 681 682 683 684 685
<table><tr><th>Type of Lock</th><th>SQL Statement</th></tr>
<tr>
  <td>
    Read
  </td>
  <td>
686 687
    SELECT * FROM TEST<br />
    CALL SELECT MAX(ID) FROM TEST<br />
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
    SCRIPT
  </td>
</tr>
<tr>
  <td>
    Write
  </td>
  <td>
    SELECT * FROM TEST WHERE 1=0 FOR UPDATE
  </td>
</tr>
<tr>
  <td>
    Write
  </td>
  <td>
704 705 706
    INSERT INTO TEST VALUES(1, 'Hello')<br />
    INSERT INTO TEST SELECT * FROM TEST<br />
    UPDATE TEST SET NAME='Hi'<br />
707 708 709 710 711 712 713 714
    DELETE FROM TEST
  </td>
</tr>
<tr>
  <td>
    Write
  </td>
  <td>
715 716
    ALTER TABLE TEST ...<br />
    CREATE INDEX ... ON TEST ...<br />
717 718 719 720 721 722 723 724 725
    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.
726
</p>
727

728
<br /><a name="database_file_layout"></a>
729
<h2>Database File Layout</h2>
730
<p>
731 732 733 734 735 736 737
There are a number of files created for persistent databases. Other than some databases, 
not every table and/or index is stored in its own file. Instead, usually only the following files are created:
A data file, an index file, a log file, and a database lock file (exists only while the database is in use).
In addition to that, a file is created for each large object (CLOB/BLOB), a file for each linear index, 
and temporary files for large result sets. Then the command SCRIPT can create script files.
If the database trace option is enabled, trace files are created.
The following files can be created by the database:
738
</p>
739 740 741 742
<table><tr><th>File Name</th><th>Description</th><th>Number of Files</th></tr>
<tr><td>
    test.data.db
</td><td>
743 744
    Data file<br />
    Contains the data for all tables<br />
745 746 747 748 749 750 751
    Format: &lt;database&gt;.data.db
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.index.db
</td><td>
752 753
    Index file<br />
    Contains the data for all (btree) indexes<br />
754 755 756 757 758 759 760
    Format: &lt;database&gt;.index.db
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.0.log.db
</td><td>
761 762
    Log file<br />
    The log file is used for recovery<br />
763 764 765 766 767 768 769
    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>
770 771
    Database lock file<br />
    Exists only if the database is open<br />
772 773 774 775 776 777 778
    Format: &lt;database&gt;.lock.db
</td><td>
    1 per database
</td></tr>
<tr><td>
    test.trace.db
</td><td>
779 780 781
    Trace file<br />
    Contains trace information<br />
    Format: &lt;database&gt;.trace.db<br />
782 783 784 785 786 787 788
    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>
789 790
    Large object<br />
    Contains the data for BLOB or CLOB<br />
791 792 793 794 795 796 797
    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>
798 799
    Temporary file<br />
    Contains a temporary blob or a large result set<br />
800 801 802 803 804 805 806
    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>
807 808
    Hash index file<br />
    Contains the data for a linear hash index<br />
809 810 811 812 813 814 815 816
    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>
817 818
Database name and location are not stored inside the database names.
</p><p>
819 820
While a database is closed, the files can be moved to another directory, and they can be renamed 
as well (as long as all files start with the same name).
821
</p><p>
822 823
As there is no platform specific data in the files, they can be moved to other operating systems
without problems.
824
</p>
825 826

<h3>Backup</h3>
827
<p>
828 829 830
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.
831
</p><p>
832
To backup data while the database is running, the SQL command SCRIPT can be used.
833
</p>
834

835
<br /><a name="logging_recovery"></a>
836
<h2>Logging and Recovery</h2>
837
<p>
838 839 840 841 842
Whenever data is modified in the database and those changes are committed, the changes are logged 
to disk (except for in-memory objects). The changes to the data file itself are usually written 
later on, to optimize disk access. If there is a power failure, the data and index files are not up-to-date.
But because the changes are in the log file, the next time the database is opened, the changes that are
in the log file are re-applied automatically.
843
</p><p>
844 845
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.
846
</p><p>
847 848 849
There is usually only one log file per database. This file grows until the database is closed successfully, 
and is then deleted. Or, if the file gets too big, the database switches to another log file (with a higher id). 
It is possible to force the log switching by using the CHECKPOINT command.
850
</p><p>
851 852 853 854
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
855
must contain RECOVER=1, as in jdbc:h2:~/test;RECOVER=1. Indexes are rebuilt in this case, and
856
the summary (object allocation table) is not read in this case, so opening the database takes longer.
857
</p>
858

859
<br /><a name="compatibility_modes"></a>
860
<h2>Compatibility Modes</h2>
861
<p>
862 863 864 865 866
All database engines behave a little bit different. For certain features, 
this database can emulate the behavior of specific databases. Not all features or differences of those
databases are implemented. Currently, this feature is mainly used for randomized comparative testing 
(where random statements are executed against multiple databases and the results are compared).
The mode can be changed by specifying the mode in the database URL, or using the SQL statement SET MODE.
867
To use the HSQLDB mode, you can use the database URL <code>jdbc:h2:~/test;MODE=HSQLDB</code>
868 869
or the SQL statement <code>SET MODE HSQLDB</code>. 
Here is the list of currently supported modes and the difference to the regular mode:
870
</p>
871 872 873 874 875
<table>
<tr><th>Mode</th><th>Differences</th></tr>
<tr><td>
  PostgreSQL
</td><td>
876
  Concatenation of a NULL with another value results in NULL.
877 878 879 880 881 882
  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>
883
  When inserting data, if a column is defined to be NOT NULL and NULL is inserted,
884 885 886 887 888 889 890 891 892 893 894 895
  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>

896
<br /><a name="trace_options"></a>
897
<h2>Using the Trace Options</h2>
898
<p>
899 900
To find problems in an application, it is sometimes good to see what database operations 
where executed. This database offers the following trace features:
901
</p>
902 903
<ul>
<li>Trace to System.out and/or a file
904 905 906 907 908
</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>
909 910

<h3>Trace Options</h3>
911
<p>
912 913 914
The simplest way to enable the trace option is setting it in the database URL.
There are two settings, one for System.out (TRACE_LEVEL_SYSTEM_OUT) tracing, 
and one for file tracing (TRACE_LEVEL_FILE). 
915
The trace levels are 0 for OFF, 1 for ERROR (the default), 2 for INFO and 3 for DEBUG.
916 917
A database URL with both levels set to DEBUG is:
<pre>
918
jdbc:h2:~/test;TRACE_LEVEL_FILE=3;TRACE_LEVEL_SYSTEM_OUT=3
919 920 921 922 923 924 925 926
</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>
927
</p>
928 929

<h3>Setting the Maximum Size of the Trace File</h3>
930
<p>
931 932 933 934 935 936
When using a high trace level, the trace file can get very big quickly.
The size of the file can be limited by executing the SQL statement 
<code>SET TRACE_MAX_FILE_SIZE maximumFileSizeInMB</code>.
If the log file exceeds the limit, the file is renamed to .old and a new file is created.
If another .old file exists, it is deleted.
The default setting is 16 MB. Example:
937
</p>
938 939 940 941 942
<pre>
SET TRACE_MAX_FILE_SIZE 1
</pre>

<h3>Java Code Generation</h3>
943
<p>
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
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>
...
12-20 20:58:09 jdbc[0]: 
/**/dbMeta3.getURL();
12-20 20:58:09 jdbc[0]: 
/**/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.
968
</p>
969 970

<h3>Enabling the Trace Option at Runtime by Manually Creating a File</h3>
971
<p>
972 973 974 975 976 977
Sometimes, you can't or don't want to change the application or database URL.
There is still a way to enable the trace mode in these cases, even at runtime (while
the database connection is open). You only need to create a special file in the directory 
where the database files are stored.
The database engine checks every 4 seconds if this file exists (only while executing a statement).
The file name is the database name plus '.trace.db.start'. 
978
This feature is disabled if the database is encrypted.
979
</p><p>
980 981 982 983 984 985
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.
986
</p>
987

988
<br /><a name="read_only"></a>
989
<h2>Read Only Databases</h2>
990
<p>
991 992 993 994 995 996 997 998
If the database files are read-only, then the database is read-only as well.
It is not possible to create new tables, add or modify data in this database.
Only SELECT statements are allowed.
To create a read-only database, close the database so that the log file is deleted.
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().
999
</p>
1000

1001
<br /><a name="storage_formats"></a>
1002
<h2>Binary and Text Storage Formats</h2>
1003
<p>
1004 1005 1006 1007 1008 1009
This database engine supports both binary and text storage formats. 
The binary format is faster, but the text storage format can be useful as well,
for example to debug the database engine.
If a database already exists, the storage format is recognized automatically.
New databases are created in the binary storage format by default.
To create a new database in the text storage format, the database URL must contain
1010
the parameter STORAGE=TEXT. Example URL: jdbc:h2:~/test;STORAGE=TEXT
1011
</p>
1012

1013
<br /><a name="low_disk_space"></a>
1014
<h2>Graceful Handling of Low Disk Space Situations</h2>
1015
<p>
1016 1017 1018 1019 1020 1021 1022 1023
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.
1024
</p><p>
1025 1026 1027 1028
It is possible to install a database event listener to detect low disk space situations early on
(when only 1 MB if space is available). To do this, use the SQL statement
SET DATABASE_EVENT_LISTENER. 
The listener can also be set at connection time, using an URL of the form
1029
jdbc:h2:~/test;DATABASE_EVENT_LISTENER='com.acme.DbListener'
1030 1031
(the quotes around the class name are required).
See also the DatabaseEventListener API. 
1032
</p>
1033 1034

<h3>Opening a Corrupted Database</h3>
1035
<p>
1036 1037 1038
If a database can not be opened because the boot info (the SQL script that is run at startup)
is corrupted, then the database can be opened by specifying a database event listener. 
The exceptions are logged, but opening the database will continue.
1039
</p>
1040

1041
<br /><a name="computed_columns"></a>
1042
<h2>Computed Columns / Function Based Index</h2>
1043
<p>
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
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(
  ID INT PRIMARY KEY, 
  NAME VARCHAR, 
  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>
1063
</p>
1064

1065
<br /><a name="multi_dimensional"></a>
1066
<h2>Multi-Dimensional Indexes</h2>
1067
<p>
1068 1069 1070 1071 1072
A tool is provided to execute efficient multi-dimension (spatial) range queries.
This database does not support a specialized spatial index (R-Tree or similar).
Instead, the B-Tree index is used. For each record, the multi-dimensional key
is converted (mapped) to a single dimensional (scalar) value. 
This value specifies the location on a space-filling curve.
1073
</p><p>
1074 1075 1076 1077
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).    
1078
</p><p>
1079 1080 1081 1082 1083 1084 1085
The method can result in a drastic performance improvement 
over just using an index on the first column. Depending on the 
data and number of dimensions, the improvement is usually higher than factor 5.
The tool generates a SQL query from a specified multi-dimensional range.
The method used is not database dependent, and the tool can easily be ported to other databases.
For an example how to use the tool, please have a look at the sample code provided
in TestMultiDimension.java.
1086
</p>
1087

1088
<br /><a name="passwords"></a>
1089 1090 1091
<h2>Using Passwords</h2>

<h3>Using Secure Passwords</h3>
1092
<p>
1093 1094 1095 1096 1097
Remember that weak passwords can be broken no matter of the encryption and security protocol.
Don't use passwords that can be found in a dictionary. Also appending numbers does not make them
secure. A way to create good passwords that can be remembered is, take the first
letters of a sentence, use upper and lower case characters, and creatively include special characters. 
Example:
1098
</p><p>
1099
i'sE2rtPiUKtT (it's easy to remember this password if you know the trick)
1100
</p>
1101 1102

<h3>Passwords: Using Char Arrays instead of Strings</h3>
1103
<p>
1104 1105 1106 1107 1108 1109
Java Strings are immutable objects and cannot be safely 'destroyed' by the application.
After creating a String, it will remain in the main memory of the computer at least 
until it is garbage collected. The garbage collection cannot be controlled by the application,
and even if it is garbage collected the data may still remain in memory.
It might also be possible that the part of memory containing the password
is swapped to disk (because not enough main memory is available).
1110
</p><p>
1111 1112 1113 1114
An attacker might have access to the swap file of the operating system. 
It is therefore a good idea to use char arrays instead of Strings to store passwords.
Char arrays can be cleared (filled with zeros) after use, and therefore the
password will not be stored in the swap file.
1115
</p><p>
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
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");
String url = "jdbc:h2:simple";
String user = "sam";
char[] password = 
{'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>
In this example, the password is hard code in the application, which is not secure of course. 
However, Java Swing supports a way to get passwords using a char array (JPasswordField).
1137
</p>
1138 1139

<h3>Passing the User Name and/or Password in the URL</h3>
1140
<p>
1141 1142 1143
Instead of passing the user name as a separate parameter as in
<code>
Connection conn = DriverManager.
1144
  getConnection("jdbc:h2:~/test", "sa", "123");
1145 1146 1147 1148
</code>
the user name (and/or password) can be supplied in the URL itself:
<code>
Connection conn = DriverManager.
1149
  getConnection("jdbc:h2:~/test;USER=sa;PASSWORD=123");
1150 1151
</code>
The settings in the URL override the settings passed as a separate parameter.
1152
</p>
1153

1154
<br /><a name="user_defined_functions"></a>
1155
<h2>User Defined Functions and Stored Procedures</h2>
1156
<p>
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
In addition to the built-in functions, this database supports user defined Java functions.
In this database, Java functions can be used as stored procedures as well.
A function must be declared (registered) before it can be used.
Only static Java methods are supported; both the class and the method must be public.
Example Java method:
<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>
1173
CREATE ALIAS IS_PRIME FOR "org.h2.samples.Function.isPrime"
1174 1175
</pre>
For a complete sample application, see src/test/org/h2/samples/Function.java.
1176
</p>
1177 1178

<h3>Function Data Type Mapping</h3>
1179
<p>
1180 1181 1182
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'.
1183
</p>
1184 1185

<h3>Functions that require a Connection</h3>
1186
<p>
1187 1188
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.
1189
</p>
1190 1191

<h3>Functions throwing an Exception</h3>
1192
<p>
1193 1194
If a function throws an Exception, then the current statement is rolled back 
and the exception is thrown to the application.
1195
</p>
1196 1197

<h3>Functions returning a Result Set</h3>
1198
<p>
1199 1200 1201 1202 1203 1204 1205 1206 1207
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);
}
    
CREATE ALIAS QUERY FOR "org.h2.samples.Function.query";
CALL QUERY('SELECT * FROM TEST');
</pre>
1208
</p>
1209 1210

<h3>Using SimpleResultSet</h3>
1211
<p>
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
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;
}    

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

<h3>Using a Function as a Table</h3>
1231
<p>
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
A function returning a result set can be like a table.
However, in this case the function is called at least twice:
First while parsing the statement to collect the column names 
(with parameters set to null where not known at compile time).
And then, while executing the statement to get the data (may be repeatedly if this is a join).
If the function is called just to get the column list, the URL of the connection passed to the function is
jdbc:columnlist:connection. Otherwise, the URL of the connection is jdbc:default:connection.
<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;
    }
1247 1248
    for(int x = 0; x &lt; id.intValue(); x++) {
        for(int y = 0; y &lt; id.intValue(); y++) {
1249 1250 1251 1252 1253 1254 1255 1256 1257
            rs.addRow(new Object[] { new Integer(x), new Integer(y) });
        }
      }
    return rs;
}    

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

1260
<br /><a name="triggers"></a>
1261
<h2>Triggers</h2>
1262
<p>
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
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) {
    }
    public void fire(Connection conn, 
            Object[] oldRow, Object[] newRow) 
            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>
CREATE TRIGGER INV_INS AFTER INSERT ON INVOICE 
  FOR EACH ROW CALL "org.h2.samples.TriggerSample"
</pre>
The trigger can be used to veto a change, by throwing a SQL Exception.
1287
</p>
1288

1289
<br /><a name="compacting"></a>
1290
<h2>Compacting a Database</h2>
1291
<p>
1292 1293 1294 1295 1296 1297
Empty space in the database file is re-used automatically. 
To re-build the indexes, the most simple way is to delete the .index.db file
while the database is closed. However in some situations (for example after deleting 
a lot of data in a database), one sometimes wants to shrink the size of the database 
(compact a database). Here is a sample function to do this:
<pre>
1298
public static void compact(String dir, String dbName, 
1299 1300
        String user, String password) throws Exception {
    String url = "jdbc:h2:" + dir + "/" + dbName;
1301 1302 1303 1304
    String file = "data/test.sql";
    Script.execute(url, user, password, file);
    DeleteDbFiles.execute(dir, dbName, true);
    RunScript.execute(url, user, password, file, null, false);
1305 1306 1307 1308 1309
}
</pre>
See also the sample application org.h2.samples.Compact.
The commands SCRIPT / RUNSCRIPT can be used as well to create the a backup
of a database and re-build the database from the script.
1310
</p>
1311

1312
<br /><a name="cache_settings"></a>
1313 1314 1315 1316 1317
<h2>Cache Settings</h2>
<p>
The database keeps most frequently used data and index pages in the main memory.
The amount of memory used for caching can be changed using the setting 
CACHE_SIZE. This setting can be set in the database connection URL 
1318
(jdbc:h2:~/test;CACHE_SIZE=131072), or it can be changed at runtime using
1319
SET CACHE_SIZE size.
1320
</p><p>
1321 1322 1323
This database supports two cache page replacement algorithms: LRU (the default) and
2Q. For LRU, the pages that were least frequently used are removed from the
cache if it becomes full. The 2Q algorithm is a bit more complicated, basically two 
1324
queues are used. The 2Q algorithm is more resistant to table scans, however the overhead
1325
is a bit higher compared to the LRU. To use the cache algorithm 2Q, use a database URL
1326
of the form jdbc:h2:~/test;CACHE_TYPE=TQ. The cache algorithm can not be changed
1327
once the database is open.
1328
</p><p>
1329 1330 1331 1332 1333
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>

1334 1335
<br /><a name="why_java"></a>
<h2>Why Java</h2>
1336
<p>
1337
A few reasons using a Java database are:
1338
</p>
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
<ul>
<li>Very simple to integrate in Java applications
</li><li>Support for many different platforms
</li><li>More secure than native applications (no buffer overflows)
</li><li>User defined functions (or triggers) run very fast
</li><li>Unicode support
</li></ul>
<p>
Some people think that Java is still too slow for low level operations, 
but this is not the case (not any more). In general, the code can be written a lot faster 
than using C or C++. Like that, it is possible to concentrate on improving the algorithms 
(that make the application faster) rather than porting the code and dealing with low 
level stuff (such as memory management or dealing with threads). 
Garbage collection is now probably faster than manual memory management.
</p><p>
A lot of features are already built in (for example Unicode, network libraries). 
It is very easy to write secure code because buffer overflows and such
problems can be detected very easily. Some features such as the reflection 
mechanism can be used for randomized testing.
</p><p>
Java is also future proof: A lot of companies support Java, 
and it is now open source.
</p><p>
This software does not rely on many Java libraries or other software, to
increase the portability and ease of use, and for performance reasons. For example, 
the encryption algorithms and many library functions are implemented in the database
instead of using the existing libraries. Libraries that are not available in open source
Java implementations (such as Swing) are not used or only used for specific features.
</p>

1369
</div></td></tr></table></body></html>