faq.html 13.9 KB
Newer Older
1 2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<!--
Thomas Mueller's avatar
Thomas Mueller committed
3
Copyright 2004-2013 H2 Group. Multiple-Licensed under the H2 License, Version 1.0,
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
and under the Eclipse Public License, Version 1.0
(http://h2database.com/html/license.html).
Initial Developer: H2 Group
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head><meta http-equiv="Content-Type" content="text/html;charset=utf-8" /><title>
Frequently Asked Questions
</title><link rel="stylesheet" type="text/css" href="stylesheet.css" />
<!-- [search] { -->
<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>Frequently Asked Questions</h1>

20 21
<a href="#support">
    I Have a Problem or Feature Request</a><br />
22 23 24 25
<a href="#known_bugs">
    Are there Known Bugs? When is the Next Release?</a><br />
<a href="#open_source">
    Is this Database Engine Open Source?</a><br />
Thomas Mueller's avatar
Thomas Mueller committed
26 27
<a href="#commercial_support">
    Is Commercial Support Available?</a><br />
28 29 30 31 32 33 34 35 36 37 38 39
<a href="#create_database">
    How to Create a New Database?</a><br />
<a href="#connect">
    How to Connect to a Database?</a><br />
<a href="#database_files">
    Where are the Database Files Stored?</a><br />
<a href="#size_limit">
    What is the Size Limit (Maximum Size) of a Database?</a><br />
<a href="#reliable">
    Is it Reliable?</a><br />
<a href="#slow_open">
    Why is Opening my Database Slow?</a><br />
Thomas Mueller's avatar
Thomas Mueller committed
40 41 42 43
<a href="#query_slow">
    My Query is Slow</a><br />
<a href="#database_slow">
    H2 is Very Slow</a><br />
44 45
<a href="#column_names_incorrect">
    Column Names are Incorrect?</a><br />
Thomas Mueller's avatar
Thomas Mueller committed
46 47
<a href="#float_is_double">
    Float is Double?</a><br />
48 49
<a href="#gcj">
    Is the GCJ Version Stable? Faster?</a><br />
Thomas Mueller's avatar
Thomas Mueller committed
50
<a href="#how_to_translate">
51
    How to Translate this Project?</a><br />
Thomas Mueller's avatar
Thomas Mueller committed
52 53
<a href="#how_to_contribute">
    How to Contribute to this Project?</a><br />
54

55 56 57 58
<h3 id="support">I Have a Problem or Feature Request</h3>
<p>
Please read the <a href="build.html#support">support checklist</a>.
</p>
59

Thomas Mueller's avatar
Thomas Mueller committed
60
<h3 id="known_bugs">Are there Known Bugs? When is the Next Release?</h3>
61 62 63 64
<p>
Usually, bugs get fixes as they are found. There is a release every few weeks.
Here is the list of known and confirmed issues:
</p>
65 66 67 68 69 70 71 72
<ul><li>When opening a database file in a timezone that has different
    daylight saving rules: the time part of dates where the daylight saving doesn't match
    will differ. This is not a problem within regions that use the same rules (such as, within
    USA, or within Europe), even if the timezone itself is different. As a workaround, export the
    database to a SQL script using the old timezone, and create a new database in the new
    timezone. This problem does not occur when using the system property "h2.storeLocalTime"
    (however such database files are not compatible with older versions of H2).
</li><li>Apache Harmony: there seems to be a bug in Harmony that affects H2.
Thomas Mueller's avatar
Thomas Mueller committed
73 74
    See <a href="https://issues.apache.org/jira/browse/HARMONY-6505">HARMONY-6505</a>.
</li><li>Tomcat and Glassfish 3 set most static fields (final or non-final) to <code>null</code> when
75
    unloading a web application. This can cause a <code>NullPointerException</code> in H2 versions
76
    1.1.107 and older, and may still not work in newer versions. Please report it if you
Thomas Mueller's avatar
Thomas Mueller committed
77
    run into this issue. In Tomcat &gt;= 6.0 this behavior can be disabled by setting the
78 79 80
    system property <code>org.apache.catalina.loader.WebappClassLoader.ENABLE_CLEAR_REFERENCES=false</code>,
    however Tomcat may then run out of memory. A known workaround is to
    put the <code>h2*.jar</code> file in a shared <code>lib</code> directory
81
    (<code>common/lib</code>).
82 83
</li><li>Some problems have been found with right outer join. Internally, it is converted
    to left outer join, which does not always produce the same results as other databases
Thomas Mueller's avatar
Thomas Mueller committed
84
    when used in combination with other joins. This problem is fixed in H2 version 1.3.
85 86 87 88
</li><li>When using Install4j before 4.1.4 on Linux and enabling <code>pack200</code>,
    the <code>h2*.jar</code> becomes corrupted by the install process, causing application failure.
    A workaround is to add an empty file <code>h2*.jar.nopack</code>
    next to the <code>h2*.jar</code> file.
89 90
    This problem is solved in Install4j 4.1.4.
</li></ul>
Thomas Mueller's avatar
Thomas Mueller committed
91 92 93
<p>
For a complete list, see <a href="http://code.google.com/p/h2database/issues/list">Open Issues</a>.
</p>
94

Thomas Mueller's avatar
Thomas Mueller committed
95
<h3 id="open_source">Is this Database Engine Open Source?</h3>
96 97 98 99 100
<p>
Yes. It is free to use and distribute, and the source code is included.
See also under license.
</p>

Thomas Mueller's avatar
Thomas Mueller committed
101 102 103 104 105 106
<h3 id="commercial_support">Is Commercial Support Available?</h3>
<p>
Yes, commercial support is available,
see <a href="links.html#commercial_support">Commercial Support</a>.
</p>

Thomas Mueller's avatar
Thomas Mueller committed
107
<h3 id="create_database">How to Create a New Database?</h3>
108 109
<p>
By default, a new database is automatically created if it does not yet exist.
110
See <a href="tutorial.html#creating_new_databases">Creating New Databases</a>.
111 112
</p>

Thomas Mueller's avatar
Thomas Mueller committed
113
<h3 id="connect">How to Connect to a Database?</h3>
114
<p>
115 116
The database driver is <code>org.h2.Driver</code>,
and the database URL starts with <code>jdbc:h2:</code>.
117 118
To connect to a database using JDBC, use the following code:
</p>
119
<pre>
120 121 122 123
Class.forName("org.h2.Driver");
Connection conn = DriverManager.getConnection("jdbc:h2:~/test", "sa", "");
</pre>

Thomas Mueller's avatar
Thomas Mueller committed
124
<h3 id="database_files">Where are the Database Files Stored?</h3>
125
<p>
126
When using database URLs like <code>jdbc:h2:~/test</code>,
127
the database is stored in the user directory.
Thomas Mueller's avatar
Thomas Mueller committed
128
For Windows, this is usually
Thomas Mueller's avatar
Thomas Mueller committed
129 130
<code>C:\Documents and Settings\&lt;userName&gt;</code> or
<code>C:\Users\&lt;userName&gt;</code>.
131
If the base directory is not set (as in <code>jdbc:h2:test</code>),
132 133
the database files are stored in the directory where the application is started
(the current working directory). When using the H2 Console application from the start menu,
134
this is <code>&lt;Installation Directory&gt;/bin</code>.
135
The base directory can be set in the database URL. A fixed or relative path can be used. When using the URL
136 137
<code>jdbc:h2:file:data/sample</code>, the database is stored in the directory
<code>data</code> (relative to the current working directory).
138 139
The directory is created automatically if it does not yet exist. It is also possible to use the
fully qualified directory name (and for Windows, drive name).
140
Example: <code>jdbc:h2:file:C:/data/test</code>
141 142
</p>

Thomas Mueller's avatar
Thomas Mueller committed
143
<h3 id="size_limit">What is the Size Limit (Maximum Size) of a Database?</h3>
144
<p>
Thomas Mueller's avatar
Thomas Mueller committed
145
See <a href="advanced.html#limits_limitations">Limits and Limitations</a>.
146 147
</p>

Thomas Mueller's avatar
Thomas Mueller committed
148
<h3 id="reliable">Is it Reliable?</h3>
149 150
<p>
That is not easy to say. It is still a quite new product. A lot of tests have been written,
Thomas Mueller's avatar
Thomas Mueller committed
151
and the code coverage of these tests is higher than 80% for each package.
Thomas Mueller's avatar
Thomas Mueller committed
152
Randomized stress tests are run regularly. But there are probably still
153
bugs that have not yet been found (as with most software). Some features are known
154 155
to be dangerous, they are only supported for situations where performance is more important
than reliability. Those dangerous features are:
156
</p>
157 158
<ul><li>Disabling the transaction log or FileDescriptor.sync() using LOG=0 or LOG=1.
</li><li>Using the transaction isolation level <code>READ_UNCOMMITTED</code>
159
    (<code>LOCK_MODE 0</code>) while at the same time using multiple
160
    connections.
161 162
</li><li>Disabling database file protection using (setting <code>FILE_LOCK</code> to
    <code>NO</code> in the database URL).
163
</li><li>Disabling referential integrity using <code>SET REFERENTIAL_INTEGRITY FALSE</code>.
164 165 166
</li></ul>
<p>
In addition to that, running out of memory should be avoided.
167
In older versions, OutOfMemory errors while using the database could corrupt a databases.
168 169
</p>
<p>
Thomas Mueller's avatar
Thomas Mueller committed
170 171 172 173
This database is well tested using automated test cases. The tests run every night
and run for more than one hour. But not all areas of this database are equally well tested.
When using one of the following features for production, please ensure your use case
is well tested (if possible with automated test cases). The areas that are not well tested are:
174 175
</p>
<ul>
176
<li>Platforms other than Windows XP, Linux, Mac OS X, or JVMs other than Sun 1.6 or 1.7
177 178 179 180 181 182 183 184
</li><li>The features <code>AUTO_SERVER</code> and <code>AUTO_RECONNECT</code>.
</li><li>The file locking method 'Serialized'.
</li><li>Cluster mode, 2-phase commit, savepoints.
</li><li>24/7 operation.
</li><li>Fulltext search.
</li><li>Operations on LOBs over 2 GB.
</li><li>The optimizer may not always select the best plan.
</li><li>Using the ICU4J collator.
185 186
</li></ul>
<p>
187
Areas considered experimental are:
188 189 190
</p>
<ul>
<li>The PostgreSQL server
Thomas Mueller's avatar
Thomas Mueller committed
191 192
</li><li>Clustering (there are cases were transaction isolation can be broken
    due to timing issues, for example one session overtaking another session).
193 194
</li><li>Multi-threading within the engine using <code>SET MULTI_THREADED=1</code>.
</li><li>Compatibility modes for other databases (only some features are implemented).
Thomas Mueller's avatar
Thomas Mueller committed
195
</li><li>The soft reference cache (<code>CACHE_TYPE=SOFT_LRU</code>). It might not improve performance,
196
    and out of memory issues have been reported.
197
</li></ul>
198
<p>
Thomas Mueller's avatar
Thomas Mueller committed
199 200 201
Some users have reported that after a power failure, the database cannot be opened sometimes.
In this case, use a backup of the database or the Recover tool. Please report such problems.
The plan is that the database automatically recovers in all situations.
202
</p>
203

Thomas Mueller's avatar
Thomas Mueller committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
<h3 id="slow_open">Why is Opening my Database Slow?</h3>
<p>
To find out what the problem is, use the H2 Console and click on "Test Connection"
instead of "Login". After the "Login Successful" appears, click on it (it's a link).
This will list the top stack traces. Then either analyze this yourself, or
post those stack traces in the Google Group.
</p>
<p>
Other possible reasons are: the database is very big (many GB), or contains linked tables
that are slow to open.
</p>

<h3 id="query_slow">My Query is Slow</h3>
<p>
Slow <code>SELECT</code> (or <code>DELETE, UPDATE, MERGE</code>)
statement can have multiple reasons. Follow this checklist:
</p>
<ul>
<li>Run <code>ANALYZE</code> (see documentation for details).
</li><li>Run the query with <code>EXPLAIN</code> and check if indexes are used
    (see documentation for details).
</li><li>If required, create additional indexes and try again using
    <code>ANALYZE</code> and <code>EXPLAIN</code>.
</li><li>If it doesn't help please report the problem.
</li>
</ul>


<h3 id="database_slow">H2 is Very Slow</h3>
<p>
By default, H2 closes the database when the last connection is closed.
If your application closes the only connection after each operation,
the database is opened and closed a lot, which is quite slow.
Thomas Mueller's avatar
Thomas Mueller committed
237
There are multiple ways to solve this problem, see
Thomas Mueller's avatar
Thomas Mueller committed
238 239 240
<a href="performance.html#database_performance_tuning">Database Performance Tuning</a>.
</p>

241 242 243 244 245 246 247 248 249
<h3 id="column_names_incorrect">Column Names are Incorrect?</h3>
<p>
For the query <code>SELECT ID AS X FROM TEST</code> the method
<code>ResultSetMetaData.getColumnName()</code> returns <code>ID</code>, I expect it to
return <code>X</code>. What's wrong?
</p>
<p>
This is not a bug. According the the JDBC specification, the method
<code>ResultSetMetaData.getColumnName()</code> should return the name of the column
250
and not the alias name. If you need the alias name, use
251
<a href="http://java.sun.com/javase/6/docs/api/java/sql/ResultSetMetaData.html#getColumnLabel(int)"><code>ResultSetMetaData.getColumnLabel()</code></a>.
Thomas Mueller's avatar
Thomas Mueller committed
252
Some other database don't work like this yet (they don't follow the JDBC specification).
253
If you need compatibility with those databases, use the <a href="features.html#compatibility">Compatibility Mode</a>,
Thomas Mueller's avatar
Thomas Mueller committed
254
or append <a href="../javadoc/org/h2/constant/DbSettings.html#ALIAS_COLUMN_NAME"><code>;ALIAS_COLUMN_NAME=TRUE</code></a> to the database URL.
255
</p>
Thomas Mueller's avatar
Thomas Mueller committed
256 257 258 259
<p>
This also applies to DatabaseMetaData calls that return a result set.
The columns in the JDBC API are column labels, not column names.
</p>
260

Thomas Mueller's avatar
Thomas Mueller committed
261 262 263 264 265 266 267
<h3 id="float_is_double">Float is Double?</h3>
<p>
For a table defined as <code>CREATE TABLE TEST(X FLOAT)</code> the method
<code>ResultSet.getObject()</code> returns a <code>java.lang.Double</code>, I expect it to
return a <code>java.lang.Float</code>. What's wrong?
</p>
<p>
268
This is not a bug. According the the JDBC specification, the JDBC data type <code>FLOAT</code>
Thomas Mueller's avatar
Thomas Mueller committed
269
is equivalent to <code>DOUBLE</code>, and both are mapped to <code>java.lang.Double</code>.
270
See also
Thomas Mueller's avatar
Thomas Mueller committed
271 272 273
<a href="http://java.sun.com/j2se/1.5.0/docs/guide/jdbc/getstart/mapping.html#1055162">
Mapping SQL and Java Types - 8.3.10 FLOAT</a>.</p>

Thomas Mueller's avatar
Thomas Mueller committed
274
<h3 id="gcj">Is the GCJ Version Stable? Faster?</h3>
275 276 277 278 279 280 281 282
<p>
The GCJ version is not as stable as the Java version.
When running the regression test with the GCJ version, sometimes the application just stops
at what seems to be a random point without error message.
Currently, the GCJ version is also slower than when using the Sun VM.
However, the startup of the GCJ version is faster than when using a VM.
</p>

Thomas Mueller's avatar
Thomas Mueller committed
283
<h3 id="how_to_translate">How to Translate this Project?</h3>
284 285 286 287 288
<p>
For more information, see
<a href="build.html#translating">Build/Translating</a>.
</p>

Thomas Mueller's avatar
Thomas Mueller committed
289 290
<h3 id="how_to_contribute">How to Contribute to this Project?</h3>
<p>
Thomas Mueller's avatar
Thomas Mueller committed
291
There are various way to help develop an open source project like H2. The first step could be to
Thomas Mueller's avatar
Thomas Mueller committed
292
<a href="build.html#translating">translate</a> the error messages and the GUI to your native language.
Thomas Mueller's avatar
Thomas Mueller committed
293
Then, you could
Thomas Mueller's avatar
Thomas Mueller committed
294
<a href="build.html#providing_patches">provide patches</a>.
Thomas Mueller's avatar
Thomas Mueller committed
295
Please start with small patches. That could be adding a test case to improve the
Thomas Mueller's avatar
Thomas Mueller committed
296 297
<a href="build.html#automated">code coverage</a> (the target code coverage for this project is 90%, higher is better).
You will have to <a href="build.html">develop, build and run the tests</a>.
Thomas Mueller's avatar
Thomas Mueller committed
298
Once you are familiar with the code, you could implement missing features from the
Thomas Mueller's avatar
Thomas Mueller committed
299 300 301 302 303
<a href="roadmap.html">feature request list</a>.
I suggest to start with very small features that are easy to implement.
Keep in mind to provide test cases as well.
</p>

304
<!-- [close] { --></div></td></tr></table><!-- } --><!-- analytics --></body></html>