help.csv 154.6 KB
Newer Older
1
# Copyright 2004-2018 H2 Group. Multiple-Licensed under the MPL 2.0,
2
# and the EPL 1.0 (http://h2database.com/html/license.html).
Thomas Mueller's avatar
Thomas Mueller committed
3 4 5
# Initial Developer: H2 Group
"SECTION","TOPIC","SYNTAX","TEXT","EXAMPLE"
"Commands (DML)","SELECT","
6
SELECT [ TOP term [ PERCENT ] [ WITH TIES ] ]
7
[ DISTINCT [ ON ( expression [,...] ) ] | ALL ]
8
selectExpression [,...]
9 10
FROM tableExpression [,...] [ WHERE expression ]
[ GROUP BY expression [,...] ] [ HAVING expression ]
11 12
[ { UNION [ ALL ] | MINUS | EXCEPT | INTERSECT } select ]
[ ORDER BY order [,...] ]
13 14
[ LIMIT expression [ OFFSET expression ] [ SAMPLE_SIZE rowCountInt ] ]
[ [ OFFSET expression { ROW | ROWS } ]
15
    [ FETCH { FIRST | NEXT } [ expression [ PERCENT ] ] { ROW | ROWS }
16
        { ONLY | WITH TIES } ] [ SAMPLE_SIZE rowCountInt ] ]
17
[ FOR UPDATE ]
Thomas Mueller's avatar
Thomas Mueller committed
18 19
","
Selects data from a table or multiple tables.
20 21 22 23
GROUP BY groups the the result by the given expression(s).
HAVING filter rows after grouping.
ORDER BY sorts the result by the given column(s) or expression(s).
UNION combines the result of this query with the results of another query.
Thomas Mueller's avatar
Thomas Mueller committed
24

25 26 27
Number of rows in output can be limited either with standard OFFSET / FETCH,
with non-standard LIMIT / OFFSET, or with non-standard TOP clauses.
Different clauses cannot be used together.
28
FETCH FIRST/NEXT, LIMIT or TOP limits the number of rows returned by the query (no limit if null or smaller than zero).
29 30 31 32 33 34
If PERCENT is specified number of rows is specified as a percent of the total number of rows
and should be an integer value between 0 and 100 inclusive.
WITH TIES can be used only together with ORDER BY and means that all additional rows that have the same sorting position
as the last row will be also returned.
OFFSET specifies how many rows to skip.
Please note that queries with high offset values can be slow.
35
SAMPLE_SIZE limits the number of rows read for aggregate queries.
36

Owner's avatar
Owner committed
37
Multiple set operators (UNION, INTERSECT, MINUS, EXCEPT) are evaluated
38 39 40
from left to right. For compatibility with other databases and future versions
of H2 please use parentheses.

41 42
If FOR UPDATE is specified, the tables are locked for writing. When using
MVCC, only the selected rows are locked as in an UPDATE statement.
Thomas Mueller's avatar
Thomas Mueller committed
43
In this case, aggregate, GROUP BY, DISTINCT queries or joins
44
are not allowed in this case.
Thomas Mueller's avatar
Thomas Mueller committed
45 46
","
SELECT * FROM TEST;
47 48 49 50
SELECT * FROM TEST ORDER BY NAME;
SELECT ID, COUNT(*) FROM TEST GROUP BY ID;
SELECT NAME, COUNT(*) FROM TEST GROUP BY NAME HAVING COUNT(*) > 2;
SELECT 'ID' COL, MAX(ID) AS MAX FROM TEST UNION SELECT 'NAME', MAX(NAME) FROM TEST;
51 52
SELECT * FROM TEST OFFSET 1000 ROWS FETCH FIRST 1000 ROWS ONLY;
SELECT A, B FROM TEST ORDER BY A FETCH FIRST 10 ROWS WITH TIES;
Thomas Mueller's avatar
Thomas Mueller committed
53 54 55
SELECT * FROM (SELECT ID, COUNT(*) FROM TEST
    GROUP BY ID UNION SELECT NULL, COUNT(*) FROM TEST)
    ORDER BY 1 NULLS LAST;
56 57
SELECT DISTINCT C1, C2 FROM TEST;
SELECT DISTINCT ON(C1) C1, C2 FROM TEST ORDER BY C1;
Thomas Mueller's avatar
Thomas Mueller committed
58 59 60
"

"Commands (DML)","INSERT","
61
INSERT INTO tableName insertColumnsAndSource
Thomas Mueller's avatar
Thomas Mueller committed
62 63
","
Inserts a new row / new rows into a table.
64 65 66 67

When using DIRECT, then the results from the query are directly applied in the target table without any intermediate step.

When using SORTED, b-tree pages are split at the insertion point. This can improve performance and reduce disk usage.
Thomas Mueller's avatar
Thomas Mueller committed
68 69 70 71 72
","
INSERT INTO TEST VALUES(1, 'Hello')
"

"Commands (DML)","UPDATE","
73
UPDATE tableName [ [ AS ] newTableAlias ] SET setClauseList
74
[ WHERE expression ] [ ORDER BY order [,...] ] [ LIMIT expression ]
Thomas Mueller's avatar
Thomas Mueller committed
75 76
","
Updates data in a table.
77
ORDER BY is supported for MySQL compatibility, but it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
78
","
79 80
UPDATE TEST SET NAME='Hi' WHERE ID=1;
UPDATE PERSON P SET NAME=(SELECT A.NAME FROM ADDRESS A WHERE A.ID=P.ID);
Thomas Mueller's avatar
Thomas Mueller committed
81 82 83
"

"Commands (DML)","DELETE","
84
DELETE [ TOP term ] FROM tableName deleteSearchCondition
Thomas Mueller's avatar
Thomas Mueller committed
85 86
","
Deletes rows form a table.
87
If TOP or LIMIT is specified, at most the specified number of rows are deleted (no limit if null or smaller than zero).
Thomas Mueller's avatar
Thomas Mueller committed
88 89 90 91 92 93 94
","
DELETE FROM TEST WHERE ID=2
"

"Commands (DML)","BACKUP","
BACKUP TO fileNameString
","
Thomas Mueller's avatar
Thomas Mueller committed
95 96
Backs up the database files to a .zip file. Objects are not locked, but
the backup is transactionally consistent because the transaction log is also copied.
Thomas Mueller's avatar
Thomas Mueller committed
97
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
98 99 100 101 102 103 104
","
BACKUP TO 'backup.zip'
"

"Commands (DML)","CALL","
CALL expression
","
Thomas Mueller's avatar
Thomas Mueller committed
105 106 107
Calculates a simple expression. This statement returns a result set with one row,
except if the called function returns a result set itself.
If the called function returns an array, then each element in this array is returned as a column.
Thomas Mueller's avatar
Thomas Mueller committed
108 109 110 111 112
","
CALL 15*25
"

"Commands (DML)","EXPLAIN","
113 114
EXPLAIN { [ PLAN FOR ] | ANALYZE }
{ select | insert | update | delete | merge }
Thomas Mueller's avatar
Thomas Mueller committed
115 116
","
Shows the execution plan for a statement.
117 118
When using EXPLAIN ANALYZE, the statement is actually executed, and the query plan
will include the actual row scan count for each table.
Thomas Mueller's avatar
Thomas Mueller committed
119 120 121 122 123
","
EXPLAIN SELECT * FROM TEST WHERE ID=1
"

"Commands (DML)","MERGE","
124 125
MERGE INTO tableName [ ( columnName [,...] ) ]
[ KEY ( columnName [,...] ) ]
126
{ VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | select }
Thomas Mueller's avatar
Thomas Mueller committed
127 128 129
","
Updates existing rows, and insert rows that don't exist. If no key column is
specified, the primary key columns are used to find the row. If more than one
130
row per new row is affected, an exception is thrown.
Thomas Mueller's avatar
Thomas Mueller committed
131 132 133 134
","
MERGE INTO TEST KEY(ID) VALUES(2, 'World')
"

Owner's avatar
Owner committed
135
"Commands (DML)","MERGE USING","
136 137
MERGE INTO targetTableName [ [AS] targetAlias]
USING { ( select ) | sourceTableName }[ [AS] sourceAlias ]
138
ON expression
139
[ WHEN MATCHED THEN
140
    [ UPDATE SET setClauseList ] [ DELETE deleteSearchCondition ] ]
141
[ WHEN NOT MATCHED THEN INSERT insertColumnsAndSource ]
142 143 144 145 146 147
","
Updates or deletes existing rows, and insert rows that don't exist. The ON clause
specifies the matching column expression and must be specified. If more than one row
is updated per input row, an exception is thrown.
If the source data contains duplicate rows (specifically those columns used in the
row matching ON clause), then an exception is thrown to prevent two updates applying
148 149 150
to the same target row.
WHEN MATCHED THEN or WHEN NOT MATCHED THEN clauses or both of them in any order should be specified.
If WHEN MATCHED THEN is specified it should contain UPDATE or DELETE clauses of both of them.
151
If statement doesn't need a source table a DUAL table can be substituted.
Owner's avatar
Owner committed
152
","
153
MERGE INTO TARGET_TABLE AS T USING SOURCE_TABLE AS S
154
    ON T.ID = S.ID
155 156 157 158 159 160
    WHEN MATCHED THEN
        UPDATE SET T.COL1 = S.COL1 WHERE T.COL2<>'FINAL'
        DELETE WHERE T.COL2='FINAL'
    WHEN NOT MATCHED THEN
        INSERT (ID,COL1,COL2) VALUES(S.ID,S.COL1,S.COL2)
MERGE INTO TARGET_TABLE AS T USING (SELECT * FROM SOURCE_TABLE) AS S
161
    ON T.ID = S.ID
162 163 164 165 166
    WHEN MATCHED THEN
        UPDATE SET T.COL1 = S.COL1 WHERE T.COL2<>'FINAL'
        DELETE WHERE T.COL2='FINAL'
    WHEN NOT MATCHED THEN
        INSERT (ID,COL1,COL2) VALUES(S.ID,S.COL1,S.COL2)
167
MERGE INTO TARGET_TABLE USING DUAL ON ID = 1
168 169
    WHEN NOT MATCHED THEN INSERT (ID, NAME) VALUES (1, 'Test')
    WHEN MATCHED THEN UPDATE SET NAME = 'Test'
Owner's avatar
Owner committed
170 171
"

Thomas Mueller's avatar
Thomas Mueller committed
172
"Commands (DML)","RUNSCRIPT","
173 174
RUNSCRIPT FROM fileNameString scriptCompressionEncryption
[ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
175 176 177 178 179 180
","
Runs a SQL script from a file. The script is a text file containing SQL
statements; each statement must end with ';'. This command can be used to
restore a database from a backup. The password must be in single quotes; it is
case sensitive and can contain spaces.

181
Instead of a file name, an URL may be used.
182
To read a stream from the classpath, use the prefix 'classpath:'.
183
See the Pluggable File System section on the Advanced page.
184

185
The compression algorithm must match the one used when creating the script.
Thomas Mueller's avatar
Thomas Mueller committed
186 187 188
Instead of a file, an URL may be used.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
189
","
190
RUNSCRIPT FROM 'backup.sql'
191
RUNSCRIPT FROM 'classpath:/com/acme/test.sql'
Thomas Mueller's avatar
Thomas Mueller committed
192 193 194
"

"Commands (DML)","SCRIPT","
195 196
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
197
[ TO fileNameString scriptCompressionEncryption
198
    [ CHARSET charsetString ] ]
199 200
[ TABLE tableName [, ...] ]
[ SCHEMA schemaName [, ...] ]
Thomas Mueller's avatar
Thomas Mueller committed
201
","
202 203 204 205 206 207 208
Creates a SQL script from the database.

SIMPLE does not use multi-row insert statements.
NODATA will not emit INSERT statements.
If the DROP option is specified, drop statements are created for tables, views,
and sequences. If the block size is set, CLOB and BLOB values larger than this
size are split into separate blocks.
Thomas Mueller's avatar
Thomas Mueller committed
209 210
BLOCKSIZE is used when writing out LOB data, and specifies the point at the
values transition from being inserted as inline values, to be inserted using
211
out-of-line commands.
Thomas Mueller's avatar
Thomas Mueller committed
212
NOSETTINGS turns off dumping the database settings (the SET XXX commands)
213

214
If no 'TO fileName' clause is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
215 216 217 218
script is returned as a result set. This command can be used to create a backup
of the database. For long term storage, it is more portable than copying the
database files.

219
If a 'TO fileName' clause is specified, then the whole
Thomas Mueller's avatar
Thomas Mueller committed
220
script (including insert statements) is written to this file, and a result set
221
without the insert statements is returned.
Thomas Mueller's avatar
Thomas Mueller committed
222

Thomas Mueller's avatar
Thomas Mueller committed
223 224 225
The password must be in single quotes; it is case sensitive and can contain spaces.

This command locks objects while it is running.
Thomas Mueller's avatar
Thomas Mueller committed
226
Admin rights are required to execute this command.
227

228
When using the TABLE or SCHEMA option, only the selected table(s) / schema(s) are included.
Thomas Mueller's avatar
Thomas Mueller committed
229 230 231 232 233
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
234 235
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
236 237 238 239 240 241
","
Lists the schemas, tables, or the columns of a table.
","
SHOW TABLES
"

242
"Commands (DML)","WITH","
243 244
WITH [ RECURSIVE ] { name [( columnName [,...] )] AS ( select ) [,...] }
{ select | insert | update | merge | delete | createTable }
245
","
246
Can be used to create a recursive or non-recursive query (common table expression).
247
For recursive queries the first select has to be a UNION.
248
One or more common table entries can be referred to by name.
249
Column name declarations are now optional - the column names will be inferred from the named select queries.
250
The final action in a WITH statement can be a select, insert, update, merge, delete or create table.
251
","
252
WITH RECURSIVE cte(n) AS (
253 254 255
        SELECT 1
    UNION ALL
        SELECT n + 1
256
        FROM cte
257 258
        WHERE n < 100
)
259 260 261 262
SELECT sum(n) FROM cte;

Example 2:
WITH cte1 AS (
263
        SELECT 1 AS FIRST_COLUMN
264 265
), cte2 AS (
        SELECT FIRST_COLUMN+1 AS FIRST_COLUMN FROM cte1
266
)
267
SELECT sum(FIRST_COLUMN) FROM cte2;
268 269
"

Thomas Mueller's avatar
Thomas Mueller committed
270
"Commands (DDL)","ALTER INDEX RENAME","
271
ALTER INDEX [ IF EXISTS ] indexName RENAME TO newIndexName
Thomas Mueller's avatar
Thomas Mueller committed
272
","
Thomas Mueller's avatar
Thomas Mueller committed
273
Renames an index.
Thomas Mueller's avatar
Thomas Mueller committed
274
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
275 276 277 278
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

279
"Commands (DDL)","ALTER SCHEMA RENAME","
280
ALTER SCHEMA [ IF EXISTS ] schema RENAME TO newSchemaName
281 282
","
Renames a schema.
Thomas Mueller's avatar
Thomas Mueller committed
283
This command commits an open transaction in this connection.
284 285 286 287
","
ALTER SCHEMA TEST RENAME TO PRODUCTION
"

Thomas Mueller's avatar
Thomas Mueller committed
288
"Commands (DDL)","ALTER SEQUENCE","
289 290 291
ALTER SEQUENCE [ IF EXISTS ] sequenceName
[ RESTART WITH long ]
[ INCREMENT BY long ]
292 293
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
294 295
[ CYCLE long | NOCYCLE | NO CYCLE ]
[ CACHE long | NOCACHE | NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
296
","
297
Changes the parameters of a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
298
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
299 300 301 302 303 304
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

"Commands (DDL)","ALTER TABLE ADD","
305
ALTER TABLE [ IF EXISTS ] tableName ADD [ COLUMN ]
306 307
{ [ IF NOT EXISTS ] columnName columnDefinition
    | ( { columnName columnDefinition | constraint } [,...] ) }
308
[ { { BEFORE | AFTER } columnName } | FIRST ]
Thomas Mueller's avatar
Thomas Mueller committed
309
","
Thomas Mueller's avatar
Thomas Mueller committed
310
Adds a new column to a table.
Thomas Mueller's avatar
Thomas Mueller committed
311
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
312 313 314 315 316
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
317
ALTER TABLE [ IF EXISTS ] tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
318 319 320
","
Adds a constraint to a table. If NOCHECK is specified, existing rows are not
checked for consistency (the default is to check consistency for existing rows).
Thomas Mueller's avatar
Thomas Mueller committed
321
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
322
It is not possible to disable checking for unique constraints.
Thomas Mueller's avatar
Thomas Mueller committed
323
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
324 325 326 327
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

328
"Commands (DDL)","ALTER TABLE RENAME CONSTRAINT","
329 330
ALTER TABLE [ IF EXISTS ] tableName RENAME oldConstraintName
TO newConstraintName
331 332 333 334 335 336 337
","
Renames a constraint.
This command commits an open transaction in this connection.
","
ALTER TABLE TEST RENAME CONSTRAINT FOO TO BAR
"

338
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
339
ALTER TABLE [ IF EXISTS ] tableName ALTER COLUMN columnName
340
{ { columnDefinition }
341 342 343 344
    | { RENAME TO name }
    | { RESTART WITH long }
    | { SELECTIVITY int }
    | { SET DEFAULT expression }
345
    | { SET ON UPDATE expression }
346
    | { SET NULL }
347
    | { SET NOT NULL }
348 349
    | { SET { VISIBLE | INVISIBLE } }
    | { DROP { DEFAULT | ON UPDATE } } }
Thomas Mueller's avatar
Thomas Mueller committed
350
","
351 352
Changes the data type of a column, rename a column,
change the identity value, or change the selectivity.
Thomas Mueller's avatar
Thomas Mueller committed
353

354
Changing the data type fails if the data can not be converted.
Thomas Mueller's avatar
Thomas Mueller committed
355

356 357 358
RESTART changes the next value of an auto increment column.
The column must already be an auto increment column.
For RESTART, the same transactional rules as for ALTER SEQUENCE apply.
Thomas Mueller's avatar
Thomas Mueller committed
359

360 361 362 363
SELECTIVITY sets the selectivity (1-100) for a column.
Setting the selectivity to 0 means the default value.
Selectivity is used by the cost based optimizer to calculate the estimated cost of an index.
Selectivity 100 means values are unique, 10 means every distinct value appears 10 times on average.
Thomas Mueller's avatar
Thomas Mueller committed
364

365
SET DEFAULT changes the default value of a column.
Thomas Mueller's avatar
Thomas Mueller committed
366

367 368
SET ON UPDATE changes the value that is set on update if value for this column is not specified in update statement.

369
SET NULL sets a column to allow NULL. The row may not be part of a primary key.
Thomas Mueller's avatar
Thomas Mueller committed
370
Single column indexes on this column are dropped.
371 372 373

SET NOT NULL sets a column to not allow NULL. Rows may not contains NULL in this column.

374 375 376
SET INVISIBLE makes the column hidden, i.e. it will not appear in SELECT * results.
SET VISIBLE has the reverse effect.

377 378 379 380
DROP DEFAULT removes the default value of a column.

DROP ON UPDATE removes the value that is set on update of a column.

Thomas Mueller's avatar
Thomas Mueller committed
381
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
382
","
383 384 385 386 387 388 389
ALTER TABLE TEST ALTER COLUMN NAME CLOB;
ALTER TABLE TEST ALTER COLUMN NAME RENAME TO TEXT;
ALTER TABLE TEST ALTER COLUMN ID RESTART WITH 10000;
ALTER TABLE TEST ALTER COLUMN NAME SELECTIVITY 100;
ALTER TABLE TEST ALTER COLUMN NAME SET DEFAULT '';
ALTER TABLE TEST ALTER COLUMN NAME SET NOT NULL;
ALTER TABLE TEST ALTER COLUMN NAME SET NULL;
390 391
ALTER TABLE TEST ALTER COLUMN NAME SET VISIBLE;
ALTER TABLE TEST ALTER COLUMN NAME SET INVISIBLE;
Thomas Mueller's avatar
Thomas Mueller committed
392 393 394
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
395
ALTER TABLE [ IF EXISTS ] tableName DROP COLUMN [ IF EXISTS ]
396
columnName [,...] | ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
397
","
398
Removes column(s) from a table.
Thomas Mueller's avatar
Thomas Mueller committed
399
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
400 401
","
ALTER TABLE TEST DROP COLUMN NAME
402
ALTER TABLE TEST DROP COLUMN NAME1, NAME2
403
ALTER TABLE TEST DROP COLUMN (NAME1, NAME2)
Thomas Mueller's avatar
Thomas Mueller committed
404 405 406
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
407 408
ALTER TABLE [ IF EXISTS ] tableName DROP
{ CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
409 410
","
Removes a constraint or a primary key from a table.
Thomas Mueller's avatar
Thomas Mueller committed
411
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
412 413 414 415 416
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
417
ALTER TABLE [ IF EXISTS ] tableName SET REFERENTIAL_INTEGRITY
418
{ FALSE | TRUE } [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
419 420 421 422 423 424
","
Disables or enables referential integrity checking for a table. This command can
be used inside a transaction. Enabling referential integrity does not check
existing data, except if CHECK is specified. Use SET REFERENTIAL_INTEGRITY to
disable it for all tables; the global flag and the flag for each table are
independent.
425

Thomas Mueller's avatar
Thomas Mueller committed
426
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
427 428 429 430 431
","
ALTER TABLE TEST SET REFERENTIAL_INTEGRITY FALSE
"

"Commands (DDL)","ALTER TABLE RENAME","
432
ALTER TABLE [ IF EXISTS ] tableName RENAME TO newName
Thomas Mueller's avatar
Thomas Mueller committed
433
","
Thomas Mueller's avatar
Thomas Mueller committed
434
Renames a table.
Thomas Mueller's avatar
Thomas Mueller committed
435
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
436 437 438 439 440
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
441
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
442
","
Thomas Mueller's avatar
Thomas Mueller committed
443 444 445 446
Switches the admin flag of a user on or off.

Only unquoted or uppercase user names are allowed.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
447
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
448 449 450 451 452 453 454
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
455 456 457 458
Renames a user.
After renaming a user, the password becomes invalid and needs to be changed as well.

Only unquoted or uppercase user names are allowed.
Thomas Mueller's avatar
Thomas Mueller committed
459
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
460
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
461 462 463 464 465
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
466
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
467
","
Thomas Mueller's avatar
Thomas Mueller committed
468 469 470 471 472 473
Changes the password of a user.
Only unquoted or uppercase user names are allowed.
The password must be enclosed in single quotes. It is case sensitive
and can contain spaces. The salt and hash values are hex strings.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
474
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
475 476 477 478
","
ALTER USER SA SET PASSWORD 'rioyxlgt'
"

479
"Commands (DDL)","ALTER VIEW RECOMPILE","
480
ALTER VIEW [ IF EXISTS ] viewName RECOMPILE
Thomas Mueller's avatar
Thomas Mueller committed
481 482
","
Recompiles a view after the underlying tables have been changed or created.
Thomas Mueller's avatar
Thomas Mueller committed
483
This command is used for views created using CREATE FORCE VIEW.
Thomas Mueller's avatar
Thomas Mueller committed
484
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
485 486 487 488
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

489 490 491 492 493 494 495 496 497
"Commands (DDL)","ALTER VIEW RENAME","
ALTER VIEW [ IF EXISTS ] viewName RENAME TO newName
","
Renames a view.
This command commits an open transaction in this connection.
","
ALTER VIEW TEST RENAME TO MY_VIEW
"

Thomas Mueller's avatar
Thomas Mueller committed
498
"Commands (DDL)","ANALYZE","
499
ANALYZE [ TABLE tableName ] [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
500
","
501 502 503
Updates the selectivity statistics of tables.
If no table name is given, all tables are analyzed.
The selectivity is used by the
Thomas Mueller's avatar
Thomas Mueller committed
504 505 506 507 508
cost based optimizer to select the best index for a given query. If no sample
size is set, up to 10000 rows per table are read. The value 0 means all rows are
read. The selectivity can be set manually using ALTER TABLE ALTER COLUMN
SELECTIVITY. Manual values are overwritten by this statement. The selectivity is
available in the INFORMATION_SCHEMA.COLUMNS table.
509

Thomas Mueller's avatar
Thomas Mueller committed
510
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
511 512 513 514 515
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
516 517 518 519 520
COMMENT ON
{ { COLUMN [ schemaName. ] tableName.columnName }
    | { { TABLE | VIEW | CONSTANT | CONSTRAINT | ALIAS | INDEX | ROLE
    | SCHEMA | SEQUENCE | TRIGGER | USER | DOMAIN } [ schemaName. ] objectName } }
IS expression
Thomas Mueller's avatar
Thomas Mueller committed
521
","
Thomas Mueller's avatar
Thomas Mueller committed
522 523 524
Sets the comment of a database object. Use NULL to remove the comment.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
525
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
526 527 528 529 530
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
531
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
532 533 534
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
535
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
536 537

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
538
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
539
","
540
CREATE AGGREGATE SIMPLE_MEDIAN FOR ""com.acme.db.Median""
Thomas Mueller's avatar
Thomas Mueller committed
541 542 543
"

"Commands (DDL)","CREATE ALIAS","
Thomas Mueller's avatar
Thomas Mueller committed
544
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
Thomas Mueller's avatar
Thomas Mueller committed
545
[ NOBUFFER ] { FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
546
","
547 548 549 550 551 552
Creates a new function alias. If this is a ResultSet returning function,
by default the return value is cached in a local temporary file.

NOBUFFER - disables caching of ResultSet return value to temporary file.

DETERMINISTIC - Deterministic functions must always return the same value for the same parameters.
553 554 555

The method name must be the full qualified class and method name,
and may optionally include the parameter classes as in
556
""java.lang.Integer.parseInt(java.lang.String, int)"". The class and the method
557
must both be public, and the method must be static. The class must be available
558
in the classpath of the database engine (when using the server mode,
559
it must be in the classpath of the server).
Thomas Mueller's avatar
Thomas Mueller committed
560

561 562
When defining a function alias with source code, the Sun ""javac"" is compiler
is used if the file ""tools.jar"" is in the classpath. If not, ""javac"" is run as a separate process.
563 564
Only the source code is stored in the database; the class is compiled each time
the database is re-opened. Source code is usually passed
565 566
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
567

568
If the method throws an SQLException, it is directly re-thrown to the calling application;
Thomas Mueller's avatar
Thomas Mueller committed
569 570
all other exceptions are first converted to a SQLException.

571
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
572 573 574
connection to the database is provided. This connection must not be closed.
If the class contains multiple methods with the given name but different
parameter count, all methods are mapped.
575

Thomas Mueller's avatar
Thomas Mueller committed
576
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
577
This command commits an open transaction in this connection.
578 579

If you have the Groovy jar in your classpath, it is also possible to write methods using Groovy.
Thomas Mueller's avatar
Thomas Mueller committed
580 581 582 583 584
","
CREATE ALIAS MY_SQRT FOR ""java.lang.Math.sqrt"";
CREATE ALIAS GET_SYSTEM_PROPERTY FOR ""java.lang.System.getProperty"";
CALL GET_SYSTEM_PROPERTY('java.class.path');
CALL GET_SYSTEM_PROPERTY('com.acme.test', 'true');
585 586
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
587 588 589 590 591
CREATE ALIAS tr AS $$@groovy.transform.CompileStatic
    static String tr(String str, String sourceSet, String replacementSet){
        return str.tr(sourceSet, replacementSet);
    }
$$
Thomas Mueller's avatar
Thomas Mueller committed
592 593 594
"

"Commands (DDL)","CREATE CONSTANT","
595
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
596
","
Thomas Mueller's avatar
Thomas Mueller committed
597
Creates a new constant.
Thomas Mueller's avatar
Thomas Mueller committed
598
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
599 600 601 602 603
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
604 605 606
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
607 608
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
609
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
610
to the value being tested.
611

Thomas Mueller's avatar
Thomas Mueller committed
612 613
Domains are usable within the whole database. They can not be created in a specific schema.

Thomas Mueller's avatar
Thomas Mueller committed
614
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
615 616 617 618 619
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
620
CREATE
Thomas Mueller's avatar
Thomas Mueller committed
621
{ [ UNIQUE ] [ HASH | SPATIAL] INDEX [ [ IF NOT EXISTS ] newIndexName ]
622 623
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
624
","
Thomas Mueller's avatar
Thomas Mueller committed
625
Creates a new index.
Thomas Mueller's avatar
Thomas Mueller committed
626
This command commits an open transaction in this connection.
627

Thomas Mueller's avatar
Thomas Mueller committed
628
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
629 630
For other tables, or if the index contains multiple columns, the HASH keyword is ignored.
Hash indexes can only test for equality, and do not support range queries (similar to a hash table).
Thomas Mueller's avatar
Thomas Mueller committed
631
Non-unique keys are supported.
632
Spatial indexes are supported only on Geometry columns.
Thomas Mueller's avatar
Thomas Mueller committed
633 634 635 636 637
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
638
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ]
Thomas Mueller's avatar
Thomas Mueller committed
639
LINKED TABLE [ IF NOT EXISTS ]
640 641
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
642 643 644 645 646
","
Creates a table link to an external table. The driver name may be empty if the
driver is already loaded. If the schema name is not set, only one table with
that name may exist in the target database.

647 648 649
FORCE - Create the LINKED TABLE even if the remote database/table does not exist.

EMIT UPDATES - Usually, for update statements, the old rows are deleted first and then the new
Thomas Mueller's avatar
Thomas Mueller committed
650 651
rows are inserted. It is possible to emit update statements (except on
rollback), however in this case multi-row unique key updates may not always
652
work. Linked tables to the same database share one connection.
653

654 655
READONLY - is set, the remote table may not be updated. This is enforced by H2.

Thomas Mueller's avatar
Thomas Mueller committed
656 657 658
If the connection to the source database is lost, the connection is re-opened
(this is a workaround for MySQL that disconnects after 8 hours of inactivity by default).

659
If a query is used instead of the original table name, the table is read only.
660
Queries must be enclosed in parenthesis: ""(SELECT * FROM ORDERS)"".
Thomas Mueller's avatar
Thomas Mueller committed
661 662

To use JNDI to get the connection, the driver class must be a
663 664
javax.naming.Context (for example ""javax.naming.InitialContext""), and the URL must
be the resource name (for example ""java:comp/env/jdbc/Test"").
665

Thomas Mueller's avatar
Thomas Mueller committed
666
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
667
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
668
","
669 670
CREATE LINKED TABLE LINK('org.h2.Driver', 'jdbc:h2:test2',
    'sa', 'sa', 'TEST');
Thomas Mueller's avatar
Thomas Mueller committed
671 672 673
CREATE LINKED TABLE LINK('', 'jdbc:h2:test2', 'sa', 'sa',
    '(SELECT * FROM TEST WHERE ID>0)');
CREATE LINKED TABLE LINK('javax.naming.InitialContext',
674 675
    'java:comp/env/jdbc/Test', NULL, NULL,
    '(SELECT * FROM TEST WHERE ID>0)');
Thomas Mueller's avatar
Thomas Mueller committed
676 677 678
"

"Commands (DDL)","CREATE ROLE","
679
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
680
","
Thomas Mueller's avatar
Thomas Mueller committed
681
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
682
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
683 684 685 686 687
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
688 689
CREATE SCHEMA [ IF NOT EXISTS ] name
[ AUTHORIZATION ownerUserName ]
690
[ WITH tableEngineParamName [,...] ]
Thomas Mueller's avatar
Thomas Mueller committed
691 692 693
","
Creates a new schema. If no owner is specified, the current user is used. The
user that executes the command must have admin rights, as well as the owner.
Thomas Mueller's avatar
Thomas Mueller committed
694
Specifying the owner currently has no effect.
695 696
Optional table engine parameters are used when CREATE TABLE command
is run on this schema without having its engine params set.
697

Thomas Mueller's avatar
Thomas Mueller committed
698
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
699 700 701 702 703
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
704 705
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName
[ START WITH long ]
706 707 708
[ INCREMENT BY long ]
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
709 710
[ CYCLE long | NOCYCLE | NO CYCLE ]
[ CACHE long | NOCACHE | NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
711
","
Thomas Mueller's avatar
Thomas Mueller committed
712 713 714
Creates a new sequence.
The data type of a sequence is BIGINT.
Used values are never re-used, even when the transaction is rolled back.
Thomas Mueller's avatar
Thomas Mueller committed
715 716 717 718 719

The cache is the number of pre-allocated numbers.
If the system crashes without closing the database, at most this many numbers are lost.
The default cache size is 32.
To disable caching, use the cache size 1 or lower.
Thomas Mueller's avatar
Thomas Mueller committed
720

Thomas Mueller's avatar
Thomas Mueller committed
721
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
722 723 724 725 726
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
727 728
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
729
[ ( { columnName columnDefinition | constraint } [,...] ) ]
730 731
[ ENGINE tableEngineName ]
[ WITH tableEngineParamName [,...] ]
732
[ NOT PERSISTENT ] [ TRANSACTIONAL ]
733
[ AS select [ WITH [ NO ] DATA ] ]","
Thomas Mueller's avatar
Thomas Mueller committed
734 735
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
736 737 738 739
Cached tables (the default for regular tables) are persistent,
and the number of rows is not limited by the main memory.
Memory tables (the default for temporary tables) are persistent,
but the index data is kept in main memory,
Thomas Mueller's avatar
Thomas Mueller committed
740
that means memory tables should not get too large.
741

Thomas Mueller's avatar
Thomas Mueller committed
742 743 744 745 746
Temporary tables are deleted when closing or opening a database.
Temporary tables can be global (accessible by all connections)
or local (only accessible by the current connection).
The default for temporary tables is global.
Indexes of temporary tables are kept fully in main memory,
747
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
748

749
The ENGINE option is only required when custom table implementations are used.
750
The table engine class must implement the interface ""org.h2.api.TableEngine"".
751
Any table engine parameters are passed down in the tableEngineParams field of the CreateTableData object.
752

753 754 755
Either ENGINE, or WITH (table engine params), or both may be specified. If ENGINE is not specified
in CREATE TABLE, then the engine specified by DEFAULT_TABLE_ENGINE option of database params is used.

756
Tables with the NOT PERSISTENT modifier are kept fully in memory, and all
757
rows are lost when the database is closed.
Thomas Mueller's avatar
Thomas Mueller committed
758

759 760
The column definition is optional if a query is specified.
In that case the column list of the query is used.
761
If the query is specified its results are inserted into created table unless WITH NO DATA is specified.
762

Thomas Mueller's avatar
Thomas Mueller committed
763 764
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
765 766 767 768 769
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
770 771 772 773 774 775
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName
{ BEFORE | AFTER | INSTEAD OF }
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK }
[,...] ON tableName [ FOR EACH ROW ]
[ QUEUE int ] [ NOWAIT ]
{ CALL triggeredClassName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
776
","
Thomas Mueller's avatar
Thomas Mueller committed
777 778 779 780 781
Creates a new trigger.
The trigger class must be public and implement ""org.h2.api.Trigger"".
Inner classes are not supported.
The class must be available in the classpath of the database engine
(when using the server mode, it must be in the classpath of the server).
782

783 784
The sourceCodeString must define a single method with no parameters that returns ""org.h2.api.Trigger"".
See CREATE ALIAS for requirements regarding the compilation.
785 786 787
Alternatively, javax.script.ScriptEngineManager can be used to create an instance of ""org.h2.api.Trigger"".
Currently javascript (included in every JRE) and ruby (with JRuby) are supported.
In that case the source must begin respectively with ""//javascript"" or ""#ruby"".
788

789
BEFORE triggers are called after data conversion is made, default values are set,
790
null and length constraint checks have been made;
791
but before other constraints have been checked.
Thomas Mueller's avatar
Thomas Mueller committed
792
If there are multiple triggers, the order in which they are called is undefined.
793

Thomas Mueller's avatar
Thomas Mueller committed
794
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
795
Only row based AFTER trigger can be called on ROLLBACK.
796
Exceptions that occur within such triggers are ignored.
797 798
As the operations that occur within a trigger are part of the transaction,
ROLLBACK triggers are only required if an operation communicates outside of the database.
799

800
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
801
Only the first such trigger is called. Such triggers on views are supported.
802
They can be used to make views updatable.
803

Thomas Mueller's avatar
Thomas Mueller committed
804 805
A BEFORE SELECT trigger is fired just before the database engine tries to read from the table.
The trigger can be used to update a table on demand.
806 807
The trigger is called with both 'old' and 'new' set to null.

808 809 810 811
The MERGE statement will call both INSERT and UPDATE triggers.
Not supported are SELECT triggers with the option FOR EACH ROW,
and AFTER SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
812 813
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
814 815 816
By default a trigger is called once for each statement, without the old and new rows.
FOR EACH ROW triggers are called once for each inserted, updated, or deleted row.

817 818
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

Thomas Mueller's avatar
Thomas Mueller committed
819 820
The trigger need to be created in the same schema as the table.
The schema name does not need to be specified when creating the trigger.
821

Thomas Mueller's avatar
Thomas Mueller committed
822
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
823
","
824
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger"";
Thomas Mueller's avatar
Thomas Mueller committed
825
CREATE TRIGGER TRIG_SRC BEFORE INSERT ON TEST AS $$org.h2.api.Trigger create() { return new MyTrigger(""constructorParam""); } $$;
826 827
CREATE TRIGGER TRIG_JS BEFORE INSERT ON TEST AS $$//javascript\nreturn new Packages.MyTrigger(""constructorParam""); $$;
CREATE TRIGGER TRIG_RUBY BEFORE INSERT ON TEST AS $$#ruby\nJava::MyPackage::MyTrigger.new(""constructorParam"") $$;
Thomas Mueller's avatar
Thomas Mueller committed
828 829
"
"Commands (DDL)","CREATE USER","
830 831
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
832
","
Thomas Mueller's avatar
Thomas Mueller committed
833 834 835
Creates a new user. For compatibility, only unquoted or uppercase user names are allowed.
The password must be in single quotes. It is case sensitive and can contain spaces.
The salt and hash values are hex strings.
836

Thomas Mueller's avatar
Thomas Mueller committed
837
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
838
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
839 840 841 842 843
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
844
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
845
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
846 847
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
848
if the underlying table(s) don't exist.
849

Thomas Mueller's avatar
Thomas Mueller committed
850 851 852 853 854
If the OR REPLACE clause is used an existing view will be replaced, and any
dependent views will not need to be recreated. If dependent views will become
invalid as a result of the change an error will be generated, but this error
can be ignored if the FORCE clause is also used.

855 856
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
857
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
858
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
859 860 861 862 863
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
864
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
865
","
Thomas Mueller's avatar
Thomas Mueller committed
866 867 868
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
869
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
870
","
871
DROP AGGREGATE SIMPLE_MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
872 873 874
"

"Commands (DDL)","DROP ALIAS","
875
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
876
","
Thomas Mueller's avatar
Thomas Mueller committed
877 878 879
Drops an existing function alias.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
880
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
881
","
Thomas Mueller's avatar
Thomas Mueller committed
882
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
883 884 885
"

"Commands (DDL)","DROP ALL OBJECTS","
886
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
887 888 889 890 891
","
Drops all existing views, tables, sequences, schemas, function aliases, roles,
user-defined aggregate functions, domains, and users (except the current user).
If DELETE FILES is specified, the database files will be removed when the last
user disconnects from the database. Warning: this command can not be rolled
Thomas Mueller's avatar
Thomas Mueller committed
892 893 894
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
895 896 897 898 899
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
900
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
901
","
Thomas Mueller's avatar
Thomas Mueller committed
902
Drops a constant.
Thomas Mueller's avatar
Thomas Mueller committed
903
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
904 905 906 907 908
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
909
DROP DOMAIN [ IF EXISTS ] domainName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
910
","
Thomas Mueller's avatar
Thomas Mueller committed
911
Drops a data type (domain).
912 913
The command will fail if it is referenced by a column (the default).
Column descriptors are replaced with original definition of specified domain if the CASCADE clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
914
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
915 916 917 918 919
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
920
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
921
","
Thomas Mueller's avatar
Thomas Mueller committed
922
Drops an index.
Thomas Mueller's avatar
Thomas Mueller committed
923
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
924 925 926 927 928
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
929
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
930
","
Thomas Mueller's avatar
Thomas Mueller committed
931
Drops a role.
Thomas Mueller's avatar
Thomas Mueller committed
932
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
933 934 935 936 937
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
938
DROP SCHEMA [ IF EXISTS ] schemaName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
939
","
Thomas Mueller's avatar
Thomas Mueller committed
940
Drops a schema.
941 942
The command will fail if objects in this schema exist and the RESTRICT clause is used (the default).
All objects in this schema are dropped as well if the CASCADE clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
943
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
944 945 946 947 948
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
949
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
950
","
Thomas Mueller's avatar
Thomas Mueller committed
951
Drops a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
952
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
953 954 955 956 957
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
958
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
959
","
Thomas Mueller's avatar
Thomas Mueller committed
960
Drops an existing table, or a list of tables.
961 962
The command will fail if dependent objects exist and the RESTRICT clause is used (the default).
All dependent views and constraints are dropped as well if the CASCADE clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
963
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
964 965 966 967 968
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
969
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
970
","
Thomas Mueller's avatar
Thomas Mueller committed
971
Drops an existing trigger.
Thomas Mueller's avatar
Thomas Mueller committed
972
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
973 974 975 976 977
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
978
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
979
","
Thomas Mueller's avatar
Thomas Mueller committed
980 981
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
982

Thomas Mueller's avatar
Thomas Mueller committed
983
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
984
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
985 986 987 988 989
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
990
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
991
","
Thomas Mueller's avatar
Thomas Mueller committed
992 993 994
Drops an existing view.
All dependent views are dropped as well if the CASCADE clause is used (the default).
The command will fail if dependent views exist and the RESTRICT clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
995
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
996 997 998 999 1000
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
1001
TRUNCATE TABLE tableName [ [ CONTINUE | RESTART ] IDENTITY ]
Thomas Mueller's avatar
Thomas Mueller committed
1002
","
1003 1004 1005 1006 1007
Removes all rows from a table.
Unlike DELETE FROM without where clause, this command can not be rolled back.
This command is faster than DELETE without where clause.
Only regular data tables without foreign key constraints can be truncated
(except if referential integrity is disabled for this database or for this table).
1008
Linked tables can't be truncated.
1009
If RESTART IDENTITY is specified next values for auto-incremented columns are restarted.
Thomas Mueller's avatar
Thomas Mueller committed
1010

Thomas Mueller's avatar
Thomas Mueller committed
1011
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1012 1013 1014 1015 1016 1017 1018
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
1019
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
1020 1021

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1022 1023 1024 1025 1026 1027 1028
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
1029
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
1030 1031 1032
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1033 1034 1035 1036 1037
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
1038
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
1039 1040 1041 1042 1043 1044 1045 1046 1047
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
1048 1049 1050 1051
Sets the resolution of an in-doubt transaction to 'commit'.

Admin rights are required to execute this command.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
1052 1053 1054 1055 1056
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
1057
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1058 1059
{ { SCHEMA schemaName } | { tableName [,...] } }
TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1060
","
Thomas Mueller's avatar
Thomas Mueller committed
1061 1062 1063
Grants rights for a table to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1064
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1065 1066 1067 1068
","
GRANT SELECT ON TEST TO READONLY
"

1069 1070 1071 1072 1073 1074
"Commands (Other)","GRANT ALTER ANY SCHEMA","
GRANT ALTER ANY SCHEMA TO userName
","
Grant schema altering rights to a user.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1075
This command commits an open transaction in this connection.
1076 1077 1078 1079
","
GRANT ALTER ANY SCHEMA TO Bob
"

Thomas Mueller's avatar
Thomas Mueller committed
1080
"Commands (Other)","GRANT ROLE","
1081
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1082
","
Thomas Mueller's avatar
Thomas Mueller committed
1083 1084 1085
Grants a role to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1086
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1087 1088 1089 1090 1091
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
1092
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1093 1094 1095 1096 1097 1098 1099 1100 1101
","
Displays the help pages of SQL commands or keywords.
","
HELP SELECT
"

"Commands (Other)","PREPARE COMMIT","
PREPARE COMMIT newTransactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
1102 1103
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
1104 1105 1106 1107 1108
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
1109
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1110 1111
{ { SCHEMA schemaName } | { tableName [,...] } }
FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1112
","
Thomas Mueller's avatar
Thomas Mueller committed
1113 1114 1115
Removes rights for a table from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1116
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1117 1118 1119 1120 1121
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
1122
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1123
","
Thomas Mueller's avatar
Thomas Mueller committed
1124 1125 1126
Removes a role from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1127
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1128 1129 1130 1131 1132
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
1133
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
","
Rolls back a transaction. If a savepoint name is used, the transaction is only
rolled back to the specified savepoint.
","
ROLLBACK
"

"Commands (Other)","ROLLBACK TRANSACTION","
ROLLBACK TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
1144 1145 1146 1147
Sets the resolution of an in-doubt transaction to 'rollback'.

Admin rights are required to execute this command.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
1148 1149 1150 1151 1152 1153 1154
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1155 1156
Create a new savepoint. See also ROLLBACK.
Savepoints are only valid until the transaction is committed or rolled back.
Thomas Mueller's avatar
Thomas Mueller committed
1157 1158 1159 1160 1161
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1162
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1163
","
Thomas Mueller's avatar
Thomas Mueller committed
1164
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1165
Variables are not persisted and session scoped, that means only visible from within the session in which they are defined.
Thomas Mueller's avatar
Thomas Mueller committed
1166
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1167 1168 1169 1170 1171
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1172
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
","
This setting can help solve the SQL injection problem. By default, text and
number literals are allowed in SQL statements. However, this enables SQL
injection if the application dynamically builds SQL statements. SQL injection is
not possible if user data is set using parameters ('?').

NONE means literals of any kind are not allowed, only parameters and constants
are allowed. NUMBERS mean only numerical and boolean literals are allowed. ALL
means all literals are allowed (default).

Thomas Mueller's avatar
Thomas Mueller committed
1183 1184
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1185
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1186
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1187
This setting is persistent.
1188
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1189 1190 1191 1192 1193
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
1194
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
1195 1196
","
Switches auto commit on or off.
1197
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
1198
however this will not work as expected when using a connection pool
1199 1200
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
1201
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
1202 1203 1204 1205 1206 1207 1208
","
SET AUTOCOMMIT OFF
"

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
1209
Sets the size of the cache in KB (each KB being 1024 bytes) for the current database.
1210 1211
The default is 65536 per available GB of RAM, i.e. 64 MB per GB.
The value is rounded to the next higher power of two.
Thomas Mueller's avatar
Thomas Mueller committed
1212 1213
Depending on the virtual machine, the actual memory required may be higher.

Thomas Mueller's avatar
Thomas Mueller committed
1214
This setting is persistent and affects all connections as there is only one cache per database.
Thomas Mueller's avatar
Thomas Mueller committed
1215
Using a very small value (specially 0) will reduce performance a lot.
Thomas Mueller's avatar
Thomas Mueller committed
1216 1217
This setting only affects the database engine (the server in a client/server environment;
in embedded mode, the database engine is in the same process as the application).
Thomas Mueller's avatar
Thomas Mueller committed
1218
It has no effect for in-memory databases.
1219

Thomas Mueller's avatar
Thomas Mueller committed
1220
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1221
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1222
This setting is persistent.
1223
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
","
SET CACHE_SIZE 8192
"

"Commands (Other)","SET CLUSTER","
SET CLUSTER serverListString
","
This command should not be used directly by an application, the statement is
executed automatically by the system. The behavior may change in future
releases. Sets the cluster server list. An empty string switches off the cluster
mode. Switching on the cluster mode requires admin rights, but any user can
switch it off (this is automatically done when the client detects the other
Thomas Mueller's avatar
Thomas Mueller committed
1236 1237
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1238
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1239 1240 1241 1242
","
SET CLUSTER ''
"

1243 1244 1245 1246
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1247 1248
Sets the collation used for comparing BINARY columns, the default is SIGNED
for version 1.3 and older, and UNSIGNED for version 1.4 and newer.
1249 1250 1251
This command can only be executed if there are no tables defined.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1252
This command commits an open transaction in this connection.
1253 1254 1255 1256 1257
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
"Commands (Other)","SET BUILTIN_ALIAS_OVERRIDE","
SET BUILTIN_ALIAS_OVERRIDE
{ TRUE | FALSE } ] }
","
Allows the overriding of the builtin system date/time functions
for unit testing purposes.

Admin rights are required to execute this command.
This command commits an open transaction in this connection.
","
SET BUILTIN_ALIAS_OVERRIDE TRUE
"

Thomas Mueller's avatar
Thomas Mueller committed
1271
"Commands (Other)","SET COLLATION","
1272
SET [ DATABASE ] COLLATION
1273 1274
{ OFF | collationName
    [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1275
","
Thomas Mueller's avatar
Thomas Mueller committed
1276 1277
Sets the collation used for comparing strings.
This command can only be executed if there are no tables defined.
Thomas Mueller's avatar
Thomas Mueller committed
1278 1279
See ""java.text.Collator"" for details about the supported collations and the STRENGTH
(PRIMARY is usually case- and umlaut-insensitive; SECONDARY is case-insensitive but umlaut-sensitive;
Thomas Mueller's avatar
Thomas Mueller committed
1280
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1281

1282 1283 1284 1285 1286
The ICU4J collator is used if it is in the classpath.
It is also used if the collation name starts with ICU4J_
(in that case, the ICU4J must be in the classpath, otherwise an exception is thrown).
The default collator is used if the collation name starts with DEFAULT_
(even if ICU4J is in the classpath).
1287 1288
The charset collator is used if the collation name starts with CHARSET_ (e.g. CHARSET_CP500). This collator sorts
strings according to the binary representation in the given charset.
1289

Thomas Mueller's avatar
Thomas Mueller committed
1290
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1291
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1292
This setting is persistent.
1293
This setting can be appended to the database URL: ""jdbc:h2:test;COLLATION='ENGLISH'""
Thomas Mueller's avatar
Thomas Mueller committed
1294 1295
","
SET COLLATION ENGLISH
1296
SET COLLATION CHARSET_CP500
Thomas Mueller's avatar
Thomas Mueller committed
1297 1298 1299
"

"Commands (Other)","SET COMPRESS_LOB","
1300
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1301
","
Thomas Mueller's avatar
Thomas Mueller committed
1302 1303 1304 1305
This feature is only available for the PageStore storage engine.
For the MVStore engine (the default for H2 version 1.4.x),
append "";COMPRESS=TRUE"" to the database URL instead.

Thomas Mueller's avatar
Thomas Mueller committed
1306 1307
Sets the compression algorithm for BLOB and CLOB data. Compression is usually
slower, but needs less disk space. LZF is faster but uses more space.
Thomas Mueller's avatar
Thomas Mueller committed
1308

Thomas Mueller's avatar
Thomas Mueller committed
1309
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1310
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1311
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1312 1313 1314 1315 1316 1317 1318 1319
","
SET COMPRESS_LOB LZF
"

"Commands (Other)","SET DATABASE_EVENT_LISTENER","
SET DATABASE_EVENT_LISTENER classNameString
","
Sets the event listener class. An empty string ('') means no listener should be
Thomas Mueller's avatar
Thomas Mueller committed
1320 1321 1322 1323
used. This setting is not persistent.

Admin rights are required to execute this command, except if it is set when
opening the database (in this case it is reset just after opening the database).
1324
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1325 1326 1327 1328 1329 1330 1331
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1332 1333
Sets the delay for closing a database if all connections are closed.
The value -1 means the database is never closed until the close delay is set to some other value or SHUTDOWN is called.
Thomas Mueller's avatar
Thomas Mueller committed
1334 1335 1336 1337
The value 0 means no delay (default; the database is closed if the last connection to it is closed).
Values 1 and larger mean the number of seconds the database is left open after closing the last connection.

If the application exits normally or System.exit is called, the database is closed immediately, even if a delay is set.
Thomas Mueller's avatar
Thomas Mueller committed
1338

Thomas Mueller's avatar
Thomas Mueller committed
1339
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1340
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1341
This setting is persistent.
1342
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1343 1344 1345 1346 1347 1348 1349 1350
","
SET DB_CLOSE_DELAY -1
"

"Commands (Other)","SET DEFAULT_LOCK_TIMEOUT","
SET DEFAULT LOCK_TIMEOUT int
","
Sets the default lock timeout (in milliseconds) in this database that is used
Thomas Mueller's avatar
Thomas Mueller committed
1351 1352
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1353
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1354
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1355
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1356 1357 1358 1359 1360
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1361
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1362 1363 1364
","
Sets the default table storage type that is used when creating new tables.
Memory tables are kept fully in the main memory (including indexes), however
Thomas Mueller's avatar
Thomas Mueller committed
1365
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1366
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1367

Thomas Mueller's avatar
Thomas Mueller committed
1368
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1369
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1370
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1371
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1372 1373 1374 1375 1376
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1377
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1378
","
Thomas Mueller's avatar
Thomas Mueller committed
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
Switched the database to exclusive mode (1, 2) and back to normal mode (0).

In exclusive mode, new connections are rejected, and operations by
other connections are paused until the exclusive mode is disabled.
When using the value 1, existing connections stay open.
When using the value 2, all existing connections are closed
(and current transactions are rolled back) except the connection
that executes SET EXCLUSIVE.
Only the connection that set the exclusive mode can disable it.
When the connection is closed, it is automatically disabled.
Thomas Mueller's avatar
Thomas Mueller committed
1389 1390

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1391
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1392
","
Thomas Mueller's avatar
Thomas Mueller committed
1393
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1394 1395 1396
"

"Commands (Other)","SET IGNORECASE","
1397
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1398 1399 1400 1401 1402
","
If IGNORECASE is enabled, text columns in newly created tables will be
case-insensitive. Already existing tables are not affected. The effect of
case-insensitive columns is similar to using a collation with strength PRIMARY.
Case-insensitive columns are compared faster than when using a collation.
Thomas Mueller's avatar
Thomas Mueller committed
1403
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1404

Thomas Mueller's avatar
Thomas Mueller committed
1405
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1406
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1407
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1408
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1409 1410 1411 1412
","
SET IGNORECASE TRUE
"

1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
"Commands (Other)","SET JAVA_OBJECT_SERIALIZER","
SET JAVA_OBJECT_SERIALIZER
{ null | className }
","
Sets the object used to serialize and deserialize java objects being stored in column of type OTHER.
The serializer class must be public and implement ""org.h2.api.JavaObjectSerializer"".
Inner classes are not supported.
The class must be available in the classpath of the database engine
(when using the server mode, it must be both in the classpath of the server and the client).
This command can only be executed if there are no tables defined.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1425
This command commits an open transaction in this connection.
1426 1427 1428 1429 1430 1431 1432
This setting is persistent.
This setting can be appended to the database URL: ""jdbc:h2:test;JAVA_OBJECT_SERIALIZER='com.acme.SerializerClassName'""
","
SET JAVA_OBJECT_SERIALIZER 'com.acme.SerializerClassName'
"


1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
"Commands (Other)","SET LAZY_QUERY_EXECUTION","
SET LAZY_QUERY_EXECUTION int
","
Sets the lazy query execution mode. The values 0, 1 are supported.

If true, then large results are retrieved in chunks.

Note that not all queries support this feature, queries which do not are processed normally.

Admin rights are required to execute this command, as it affects all connections.
This command commits an open transaction in this connection.
This setting is not persistent.
This setting can be appended to the database URL: ""jdbc:h2:test;LAZY_QUERY_EXECUTION=1""
","
SET LAZY_QUERY_EXECUTION 1
"

1450
"Commands (Other)","SET LOG","
1451
SET LOG int
1452 1453 1454 1455
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1456
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1457 1458 1459 1460
but also the most dangerous: if the process is killed while the database is open in this mode,
the data might be lost. It must only be used if this is not a problem, for example when
initially loading a database, or when running tests.

1461 1462
LOG 1 means the transaction log is enabled, but FileDescriptor.sync is disabled.
This setting is about half as fast as with LOG 0. This setting is useful if no protection
1463 1464
against power failure is required, but the data must be protected against killing the process.

1465 1466
LOG 2 (the default) means the transaction log is enabled, and FileDescriptor.sync is called
for each checkpoint. This setting is about half as fast as LOG 1. Depending on the
1467 1468
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1469
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1470
This command commits an open transaction in this connection.
1471
This setting is not persistent.
1472
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1473 1474 1475 1476
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1477 1478 1479 1480
"Commands (Other)","SET LOCK_MODE","
SET LOCK_MODE int
","
Sets the lock mode. The values 0, 1, 2, and 3 are supported. The default is 3
1481
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494

The value 0 means no locking (should only be used for testing; also known as
READ_UNCOMMITTED). Please note that using SET LOCK_MODE 0 while at the same time
using multiple connections may result in inconsistent transactions.

The value 1 means table level locking (also known as SERIALIZABLE).

The value 2 means table level locking with garbage collection (if the
application does not close all connections).

The value 3 means table level locking, but read locks are released immediately
(default; also known as READ_COMMITTED).

Thomas Mueller's avatar
Thomas Mueller committed
1495
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1496
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1497
This setting is persistent.
1498
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1499 1500 1501 1502 1503 1504 1505 1506
","
SET LOCK_MODE 1
"

"Commands (Other)","SET LOCK_TIMEOUT","
SET LOCK_TIMEOUT int
","
Sets the lock timeout (in milliseconds) for the current session. The default
Thomas Mueller's avatar
Thomas Mueller committed
1507 1508 1509
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1510
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1511 1512 1513 1514 1515 1516 1517
","
SET LOCK_TIMEOUT 1000
"

"Commands (Other)","SET MAX_LENGTH_INPLACE_LOB","
SET MAX_LENGTH_INPLACE_LOB int
","
Thomas Mueller's avatar
Thomas Mueller committed
1518
Sets the maximum size of an in-place LOB object.
1519

1520
This is the maximum length of an LOB that is stored with the record itself,
1521 1522
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1523
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1524
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1525
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1526 1527 1528 1529 1530 1531 1532
","
SET MAX_LENGTH_INPLACE_LOB 128
"

"Commands (Other)","SET MAX_LOG_SIZE","
SET MAX_LOG_SIZE int
","
Thomas Mueller's avatar
Thomas Mueller committed
1533 1534
Sets the maximum size of the transaction log, in megabytes.
If the log is larger, and if there is no open transaction, the transaction log is truncated.
noelgrandin's avatar
noelgrandin committed
1535
If there is an open transaction, the transaction log will continue to grow however.
Thomas Mueller's avatar
Thomas Mueller committed
1536
The default max size is 16 MB.
Thomas Mueller's avatar
Thomas Mueller committed
1537
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1538

Thomas Mueller's avatar
Thomas Mueller committed
1539
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1540
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1541
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1542 1543 1544 1545 1546 1547 1548 1549
","
SET MAX_LOG_SIZE 2
"

"Commands (Other)","SET MAX_MEMORY_ROWS","
SET MAX_MEMORY_ROWS int
","
The maximum number of rows in a result set that are kept in-memory. If more rows
1550
are read, then the rows are buffered to disk.
1551
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1552

Thomas Mueller's avatar
Thomas Mueller committed
1553
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1554
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1555
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1556
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1557 1558 1559 1560 1561 1562 1563
","
SET MAX_MEMORY_ROWS 1000
"

"Commands (Other)","SET MAX_MEMORY_UNDO","
SET MAX_MEMORY_UNDO int
","
1564
The maximum number of undo records per a session that are kept in-memory.
Thomas Mueller's avatar
Thomas Mueller committed
1565 1566
If a transaction is larger, the records are buffered to disk.
The default value is 50000.
Thomas Mueller's avatar
Thomas Mueller committed
1567
Changes to tables without a primary key can not be buffered to disk.
Thomas Mueller's avatar
Thomas Mueller committed
1568 1569
This setting is not supported when using multi-version concurrency.

Thomas Mueller's avatar
Thomas Mueller committed
1570
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1571
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1572
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1573
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1574 1575 1576 1577 1578 1579 1580 1581 1582
","
SET MAX_MEMORY_UNDO 1000
"

"Commands (Other)","SET MAX_OPERATION_MEMORY","
SET MAX_OPERATION_MEMORY int
","
Sets the maximum memory used for large operations (delete and insert), in bytes.
Operations that use more memory are buffered to disk, slowing down the
Thomas Mueller's avatar
Thomas Mueller committed
1583 1584 1585
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1586
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1587
It has no effect for in-memory databases.
1588
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1589 1590 1591 1592 1593
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1594
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1595 1596
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1597 1598 1599
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1600
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1601
This command commits an open transaction in this connection.
1602
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1603 1604 1605 1606 1607
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1608
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1609
","
1610 1611 1612
Enabled (1) or disabled (0) multi-threading inside the database engine.
MULTI_THREADED is enabled by default with default MVStore storage engine.
MULTI_THREADED is disabled by default when using PageStore storage engine, enabling this with PageStore is experimental only.
Thomas Mueller's avatar
Thomas Mueller committed
1613 1614 1615 1616

This is a global setting, which means it is not possible to open multiple databases with different modes at the same time in the same virtual machine.
This setting is not persistent, however the value is kept until the virtual machine exits or it is changed.

Thomas Mueller's avatar
Thomas Mueller committed
1617
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1618
This command commits an open transaction in this connection.
1619
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1620 1621 1622 1623 1624
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1625
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1626 1627 1628
","
Enabled (1) or disabled (0) the result reuse optimization. If enabled,
subqueries and views used as subqueries are only re-run if the data in one of
Thomas Mueller's avatar
Thomas Mueller committed
1629 1630
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1631
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1632
This command commits an open transaction in this connection.
1633
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1634 1635 1636 1637 1638 1639 1640 1641 1642
","
SET OPTIMIZE_REUSE_RESULTS 0
"

"Commands (Other)","SET PASSWORD","
SET PASSWORD string
","
Changes the password of the current user. The password must be in single quotes.
It is case sensitive and can contain spaces.
Thomas Mueller's avatar
Thomas Mueller committed
1643

Thomas Mueller's avatar
Thomas Mueller committed
1644
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1645 1646 1647 1648
","
SET PASSWORD 'abcstzri!.5'
"

1649 1650 1651 1652 1653 1654 1655
"Commands (Other)","SET QUERY_STATISTICS","
SET QUERY_STATISTICS { TRUE | FALSE }
","
Disabled or enables query statistics gathering for the whole database.
The statistics are reflected in the INFORMATION_SCHEMA.QUERY_STATISTICS meta-table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1656
This command commits an open transaction in this connection.
1657 1658 1659 1660 1661
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
"Commands (Other)","SET QUERY_STATISTICS_MAX_ENTRIES","
SET QUERY_STATISTICS int
","
Set the maximum number of entries in query statistics meta-table.
Default value is 100.

This setting is not persistent.
This command commits an open transaction in this connection.
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS_MAX_ENTRIES 500
"

Thomas Mueller's avatar
Thomas Mueller committed
1675 1676 1677 1678 1679
"Commands (Other)","SET QUERY_TIMEOUT","
SET QUERY_TIMEOUT int
","
Set the query timeout of the current session to the given value. The timeout is
in milliseconds. All kinds of statements will throw an exception if they take
Thomas Mueller's avatar
Thomas Mueller committed
1680 1681 1682
longer than the given value. The default timeout is 0, meaning no timeout.

This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1683 1684 1685 1686 1687
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1688
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1689 1690 1691
","
Disabled or enables referential integrity checking for the whole database.
Enabling it does not check existing data. Use ALTER TABLE SET to disable it only
Thomas Mueller's avatar
Thomas Mueller committed
1692 1693 1694
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1695
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1696
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1697 1698 1699 1700
","
SET REFERENTIAL_INTEGRITY FALSE
"

1701 1702 1703 1704 1705 1706
"Commands (Other)","SET RETENTION_TIME","
SET RETENTION_TIME int
","
This property is only used when using the MVStore storage engine.
How long to retain old, persisted data, in milliseconds.
The default is 45000 (45 seconds), 0 means overwrite data as early as possible.
1707 1708 1709
It is assumed that a file system and hard disk will flush all write buffers within this time.
Using a lower value might be dangerous, unless the file system and hard disk flush the buffers earlier.
To manually flush the buffers, use CHECKPOINT SYNC,
1710 1711 1712 1713
however please note that according to various tests this does not always work as expected
depending on the operating system and hardware.

Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1714
This command commits an open transaction in this connection.
1715 1716 1717 1718 1719 1720
This setting is persistent.
This setting can be appended to the database URL: ""jdbc:h2:test;RETENTION_TIME=0""
","
SET RETENTION_TIME 0
"

Thomas Mueller's avatar
Thomas Mueller committed
1721 1722 1723 1724 1725
"Commands (Other)","SET SALT HASH","
SET SALT bytes HASH bytes
","
Sets the password salt and hash for the current user. The password must be in
single quotes. It is case sensitive and can contain spaces.
Thomas Mueller's avatar
Thomas Mueller committed
1726

Thomas Mueller's avatar
Thomas Mueller committed
1727
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1728 1729 1730 1731 1732 1733 1734 1735 1736
","
SET SALT '00' HASH '1122'
"

"Commands (Other)","SET SCHEMA","
SET SCHEMA schemaName
","
Changes the default schema of the current connection. The default schema is used
in statements where no schema is set explicitly. The default schema for new
Thomas Mueller's avatar
Thomas Mueller committed
1737 1738 1739
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1740
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1741 1742 1743 1744 1745 1746 1747 1748 1749
","
SET SCHEMA INFORMATION_SCHEMA
"

"Commands (Other)","SET SCHEMA_SEARCH_PATH","
SET SCHEMA_SEARCH_PATH schemaName [,...]
","
Changes the schema search path of the current connection. The default schema is
used in statements where no schema is set explicitly. The default schema for new
Thomas Mueller's avatar
Thomas Mueller committed
1750 1751 1752
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1753
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1754 1755 1756 1757 1758 1759 1760 1761 1762
","
SET SCHEMA_SEARCH_PATH INFORMATION_SCHEMA, PUBLIC
"

"Commands (Other)","SET THROTTLE","
SET THROTTLE int
","
Sets the throttle for the current connection. The value is the number of
milliseconds delay after each 50 ms. The default value is 0 (throttling
Thomas Mueller's avatar
Thomas Mueller committed
1763 1764 1765
disabled).

This command does not commit a transaction, and rollback does not affect it.
1766
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1767 1768 1769 1770 1771
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1772
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1773 1774 1775
","
Sets the trace level for file the file or system out stream. Levels are: 0=off,
1=error, 2=info, 3=debug. The default level is 1 for file and 0 for system out.
1776
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1777

Thomas Mueller's avatar
Thomas Mueller committed
1778
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1779
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1780
This command does not commit a transaction, and rollback does not affect it.
1781
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
","
SET TRACE_LEVEL_SYSTEM_OUT 3
"

"Commands (Other)","SET TRACE_MAX_FILE_SIZE","
SET TRACE_MAX_FILE_SIZE int
","
Sets the maximum trace file size. If the 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 max size is 16 MB.

Thomas Mueller's avatar
Thomas Mueller committed
1793
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1794
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1795
This command commits an open transaction in this connection.
1796
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
","
SET TRACE_MAX_FILE_SIZE 10
"

"Commands (Other)","SET UNDO_LOG","
SET UNDO_LOG int
","
Enables (1) or disables (0) the per session undo log. The undo log is enabled by
default. When disabled, transactions can not be rolled back. This setting should
only be used for bulk operations that don't need to be atomic.
Thomas Mueller's avatar
Thomas Mueller committed
1807

Thomas Mueller's avatar
Thomas Mueller committed
1808
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1809 1810 1811 1812 1813 1814 1815 1816
","
SET UNDO_LOG 0
"

"Commands (Other)","SET WRITE_DELAY","
SET WRITE_DELAY int
","
Set the maximum delay between a commit and flushing the log, in milliseconds.
Thomas Mueller's avatar
Thomas Mueller committed
1817 1818
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1819
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1820
This command commits an open transaction in this connection.
1821
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1822 1823 1824 1825 1826
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1827
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1828
","
1829 1830
This statement closes all open connections to the database and closes the
database. This command is usually not required, as the database is
Thomas Mueller's avatar
Thomas Mueller committed
1831
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1832

1833 1834
If no option is used, then the database is closed normally.
All connections are closed, open transactions are rolled back.
Thomas Mueller's avatar
Thomas Mueller committed
1835 1836 1837

SHUTDOWN COMPACT fully compacts the database (re-creating the database may further reduce the database size).
If the database is closed normally (using SHUTDOWN or by closing all connections), then the database is also compacted,
1838
but only for at most the time defined by the database setting ""h2.maxCompactTime"" in milliseconds (see there).
Thomas Mueller's avatar
Thomas Mueller committed
1839 1840

SHUTDOWN IMMEDIATELY closes the database files without any cleanup and without compacting.
Thomas Mueller's avatar
Thomas Mueller committed
1841

1842
SHUTDOWN DEFRAG re-orders the pages when closing the database so that table scans are faster. In case of MVStore it is currently equivalent to COMPACT.
1843

Thomas Mueller's avatar
Thomas Mueller committed
1844
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1845
","
1846
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1847 1848
"

1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980
"Datetime fields","Datetime field","
yearField | monthField | dayOfMonthField
    | hourField | minuteField | secondField
    | millisecondField | microsecondField | nanosecondField
    | timezoneHourField | timezoneMinuteField
    | dayOfWeekField | isoDayOfWeekField
    | weekOfYearField | isoWeekOfYearField
    | quarterField | dayOfYearField | epochField
","
Fields for EXTRACT, DATEADD, and DATEDIFF functions.
","
YEAR
"

"Datetime fields","Year field","
YEAR | YYYY | YY | SQL_TSI_YEAR
","
Year.
","
YEAR
"

"Datetime fields","Month field","
MONTH | MM | M | SQL_TSI_MONTH
","
Month (1-12).
","
MONTH
"

"Datetime fields","Day of month field","
DAY | DD | D | SQL_TSI_DAY
","
Day of month (1-31).
","
DAY
"

"Datetime fields","Hour field","
HOUR | HH | SQL_TSI_HOUR
","
Hour (0-23).
","
HOUR
"

"Datetime fields","Minute field","
MINUTE | MI | N | SQL_TSI_MINUTE
","
Minute (0-59).
","
MINUTE
"

"Datetime fields","Second field","
SECOND | SS | S | SQL_TSI_SECOND
","
Second (0-59).
","
SECOND
"

"Datetime fields","Millisecond field","
MILLISECOND | MS
","
Millisecond (0-999).
","
MILLISECOND
"

"Datetime fields","Microsecond field","
MICROSECOND | MCS
","
Microsecond (0-999999).
","
MICROSECOND
"

"Datetime fields","Nanosecond field","
NANOSECOND | NS
","
Nanosecond (0-999999999).
","
NANOSECOND
"

"Datetime fields","Timezone hour field","
TIMEZONE_HOUR
","
Timezone hour (from -18 to +18).
","
TIMEZONE_HOUR
"

"Datetime fields","Timezone minute field","
TIMEZONE_MINUTE
","
Timezone minute (from -59 to +59).
","
TIMEZONE_MINUTE
"

"Datetime fields","Day of week field","
DAY_OF_WEEK | DAYOFWEEK | DOW
","
Day of week (1-7). Sunday is 1.
","
DAY_OF_WEEK
"

"Datetime fields","ISO day of week field","
ISO_DAY_OF_WEEK
","
ISO day of week (1-7). Monday is 1.
","
ISO_DAY_OF_WEEK
"

"Datetime fields","Week of year field","
WEEK | WW | W | SQL_TSI_WEEK
","
Week of year (1-53).
EXTRACT function uses local rules to get number of week in year.
DATEDIFF function uses Sunday as a first day of week.
","
WEEK
"

"Datetime fields","ISO week of year field","
ISO_WEEK
","
ISO week of year (1-53).
1981 1982
ISO definition is used when first week of year should have at least four days
and week is started with Monday.
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
","
ISO_WEEK
"

"Datetime fields","Quarter field","
QUARTER
","
Quarter (1-4).
","
QUARTER
"

"Datetime fields","Day of year field","
DAYOFYEAR | DAY_OF_YEAR | DOY | DY
","
Day of year (1-366).
","
DAYOFYEAR
"

"Datetime fields","Epoch field","
EPOCH
","
For TIMESTAMP values number of seconds since 1970-01-01 00:00:00 in local time zone.
For TIMESTAMP WITH TIME ZONE values number of seconds since 1970-01-01 00:00:00 in UTC time zone.
For DATE values number of seconds since 1970-01-01.
For TIME values number of seconds since midnight.
","
EPOCH
"

2014 2015
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
2016
","
2017
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
2018
","
2019
A
Thomas Mueller's avatar
Thomas Mueller committed
2020 2021
"

2022 2023
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2024
","
2025
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2026
","
2027
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2028 2029
"

2030
"Other Grammar","Array","
2031
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
2032
","
2033 2034
An array of values. An empty array is '()'. Trailing commas are ignored.
An array with one element must contain a comma to be parsed as an array.
Thomas Mueller's avatar
Thomas Mueller committed
2035
","
2036
(1, 2)
2037 2038
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
2039 2040
"

2041 2042
"Other Grammar","Boolean","
TRUE | FALSE
2043
","
2044
A boolean value.
2045
","
2046
TRUE
2047 2048
"

2049 2050
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
2051
","
2052
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
2053
","
2054
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
2055 2056
"

2057 2058 2059
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
2060
","
2061 2062
Returns the first expression where the value is equal to the test expression. If
no else part is specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2063
","
2064
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
2065 2066
"

2067 2068 2069
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
2070
","
2071 2072
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2073
","
2074 2075 2076 2077
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
2078
AES
2079
","
2080
Only the algorithm AES (""AES-128"") is supported currently.
2081 2082
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
2083 2084
"

2085
"Other Grammar","Column Definition","
2086
dataType [ VISIBLE | INVISIBLE ]
2087 2088
[ { DEFAULT expression | AS computedColumnExpression } ]
[ ON UPDATE expression ] [ [ NOT ] NULL ]
2089
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2090 2091
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
2092 2093
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
2094
The computed column expression is evaluated and assigned whenever the row changes.
2095 2096 2097
On update column expression is used if row is updated,
at least one column have a new value that is different from its previous value
and value for this column is not set explicitly in update statement.
2098 2099 2100 2101

Identity and auto-increment columns are columns with a sequence as the
default. The column declared as the identity columns is implicitly the
primary key column of this table (unlike auto-increment columns).
Thomas Mueller's avatar
Thomas Mueller committed
2102

2103 2104 2105
The invisible column will not be displayed as a result of SELECT * query.
Otherwise, it works as normal column.

Thomas Mueller's avatar
Thomas Mueller committed
2106 2107
The options PRIMARY KEY, UNIQUE, and CHECK are not supported for ALTER statements.

Thomas Mueller's avatar
Thomas Mueller committed
2108 2109
Check constraints can reference columns of the table,
and they can reference objects that exist while the statement is executed.
Thomas Mueller's avatar
Thomas Mueller committed
2110 2111
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
2112

2113
","
Thomas Mueller's avatar
Thomas Mueller committed
2114 2115 2116
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255) DEFAULT '');
CREATE TABLE TEST(ID BIGINT IDENTITY);
CREATE TABLE TEST(QUANTITY INT, PRICE DECIMAL, AMOUNT DECIMAL AS QUANTITY*PRICE);
2117 2118
"

2119 2120
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
2121
","
2122 2123 2124
Comments can be used anywhere in a command and are ignored by the database. Line
comments end with a newline. Block comments cannot be nested, but can be
multiple lines long.
Thomas Mueller's avatar
Thomas Mueller committed
2125
","
2126
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
2127 2128
"

2129
"Other Grammar","Compare","
2130
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
2131
","
2132
Comparison operator. The operator != is the same as <>.
2133
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
2134
","
2135
<>
Thomas Mueller's avatar
Thomas Mueller committed
2136 2137 2138
"

"Other Grammar","Condition","
2139
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
2140 2141 2142 2143 2144 2145 2146
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
2147 2148
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
2149
    | IS [ NOT ] [ DISTINCT FROM ] operand
2150 2151
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
2152
    | [ NOT ] [ LIKE | ILIKE ] operand [ ESCAPE string ]
2153
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
2154
","
Thomas Mueller's avatar
Thomas Mueller committed
2155
The right hand side of a condition.
2156

Thomas Mueller's avatar
Thomas Mueller committed
2157
The conditions ""IS [ NOT ]"" and ""IS [ NOT ] DISTINCT FROM"" are null-safe, meaning
2158 2159
NULL is considered the same as NULL, and the condition never evaluates to NULL.

Thomas Mueller's avatar
Thomas Mueller committed
2160 2161 2162 2163 2164
When comparing with LIKE, the wildcards characters are ""_"" (any one character)
and ""%"" (any characters). The database uses an index when comparing with LIKE
except if the operand starts with a wildcard. To search for the characters ""%"" and
""_"", the characters need to be escaped. The default escape character is "" \ "" (backslash).
To select no escape character, use ""ESCAPE ''"" (empty string).
2165 2166 2167
At most one escape character is allowed.
Each character that follows the escape character in the pattern needs to match exactly.
Patterns that end with an escape character are invalid and the expression returns NULL.
2168

2169 2170
ILIKE does a case-insensitive compare.

Thomas Mueller's avatar
Thomas Mueller committed
2171
When comparing with REGEXP, regular expression matching is used.
2172
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
2173 2174 2175 2176
","
LIKE 'Jo%'
"

2177
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
2178 2179 2180 2181 2182
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
2183
","
Thomas Mueller's avatar
Thomas Mueller committed
2184 2185
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2186
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
2187 2188
and FALSE means the operation is to be rejected.
To prevent NULL in a column, use NOT NULL instead of a check constraint.
Thomas Mueller's avatar
Thomas Mueller committed
2189
","
2190
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
2191 2192
"

2193 2194
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
2195
","
2196
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
2197
","
2198
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
2199 2200
"

2201 2202
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
2203
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
2204
","
2205
Optional parameters for CSVREAD and CSVWRITE.
2206 2207
Instead of setting the options one by one, all options can be
combined into a space separated key-value pairs, as follows:
Thomas Mueller's avatar
Thomas Mueller committed
2208 2209
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
2210
The following options are supported:
2211

2212
""caseSensitiveColumnNames"" (true or false; disabled by default),
2213

Thomas Mueller's avatar
Thomas Mueller committed
2214
""charset"" (for example 'UTF-8'),
2215

Thomas Mueller's avatar
Thomas Mueller committed
2216
""escape"" (the character that escapes the field delimiter),
2217

Thomas Mueller's avatar
Thomas Mueller committed
2218
""fieldDelimiter"" (a double quote by default),
2219

thomasmueller's avatar
thomasmueller committed
2220
""fieldSeparator"" (a comma by default),
2221

2222
""lineComment"" (disabled by default),
2223

2224
""lineSeparator"" (the line separator used for writing; ignored for reading),
2225

Thomas Mueller's avatar
Thomas Mueller committed
2226 2227
""null"", Support reading existing CSV files that contain explicit ""null"" delimiters.
Note that an empty, unquoted values are also treated as null.
2228

2229
""preserveWhitespace"" (true or false; disabled by default),
2230

2231
""writeColumnHeader"" (true or false; enabled by default).
2232

Thomas Mueller's avatar
Thomas Mueller committed
2233
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
2234
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
2235 2236 2237
a backslash needs to be escaped with another backslash (""'\\'"").
All other characters are not to be escaped, that means
newline and tab characters are written as such.
Thomas Mueller's avatar
Thomas Mueller committed
2238
","
2239
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
2240 2241
"

2242 2243 2244
"Other Grammar","Data Type","
intType | booleanType | tinyintType | smallintType | bigintType | identityType
    | decimalType | doubleType | realType | dateType | timeType | timestampType
2245 2246
    | timestampWithTimeZoneType | binaryType | otherType | varcharType
    | varcharIgnorecaseType | charType | blobType | clobType | uuidType
2247
    | arrayType | enumType | intervalType
Thomas Mueller's avatar
Thomas Mueller committed
2248
","
2249
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
2250
","
2251
INT
Thomas Mueller's avatar
Thomas Mueller committed
2252 2253
"

2254 2255
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
2256
","
2257
A date literal. The limitations are the same as for the Java data type
2258
""java.sql.Date"", but for compatibility with other databases the suggested minimum
2259
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
2260
","
2261
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
2262 2263
"

2264
"Other Grammar","Decimal","
2265 2266
[ + | - ] { { number [ . number ] } | { . number } }
[ E [ + | - ] expNumber [...] ] ]
2267
","
Thomas Mueller's avatar
Thomas Mueller committed
2268 2269 2270 2271 2272 2273
A decimal number with fixed precision and scale.
Internally, ""java.lang.BigDecimal"" is used.
To ensure the floating point representation is used, use CAST(X AS DOUBLE).
There are some special decimal values: to represent positive infinity, use ""POWER(0, -1)"";
for negative infinity, use ""(-POWER(0, -1))""; for -0.0, use ""(-CAST(0 AS DOUBLE))"";
for ""NaN"" (not a number), use ""SQRT(-1)"".
2274
","
Thomas Mueller's avatar
Thomas Mueller committed
2275 2276 2277
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
2278 2279
"

2280 2281 2282 2283 2284 2285 2286 2287
"Other Grammar","Delete search condition","
[ WHERE expression ] [ LIMIT term ]
","
Search condition for DELETE statement.
","
WHERE ID = 2
"

2288 2289
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
2290
","
2291
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
2292
","
2293
0
Thomas Mueller's avatar
Thomas Mueller committed
2294 2295
"

2296 2297
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
2298
","
2299 2300 2301
A string starts and ends with two dollar signs. Two dollar signs are not allowed
within the text. A whitespace is required before the first set of dollar signs.
No escaping is required within the text.
Thomas Mueller's avatar
Thomas Mueller committed
2302
","
2303
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
2304 2305
"

2306 2307
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2308
","
2309
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2310
","
2311
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2312 2313
"

2314
"Other Grammar","Factor","
2315
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2316
","
2317
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
2318
","
2319
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
2320 2321
"

2322 2323
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
2324
","
2325 2326
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
2327
","
2328
cafe
Thomas Mueller's avatar
Thomas Mueller committed
2329 2330
"

2331 2332
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
2333
","
2334
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
2335
","
2336
0xff
Thomas Mueller's avatar
Thomas Mueller committed
2337 2338
"

2339 2340
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2341
","
2342 2343 2344
Indexes this column in ascending or descending order. Usually it is not required
to specify the order; however doing so will speed up large queries that order
the column in the same way.
Thomas Mueller's avatar
Thomas Mueller committed
2345
","
2346
NAME
Thomas Mueller's avatar
Thomas Mueller committed
2347 2348
"

2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359
"Other Grammar","Insert columns and source","
{ [ ( columnName [,...] ) ]
    { VALUES { ( { DEFAULT | expression } [,...] ) } [,...]
        | [ DIRECT ] [ SORTED ] select } } |
    { SET { columnName = { DEFAULT | expression } } [,...] }
","
Names of columns and their values for INSERT statement.
","
(ID, NAME) VALUES (1, 'Test')
"

Thomas Mueller's avatar
Thomas Mueller committed
2360
"Other Grammar","Int","
2361
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2362 2363 2364 2365 2366 2367 2368
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2369
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2370 2371 2372 2373 2374 2375
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2376
"Other Grammar","Name","
2377
{ { A-Z|_ } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2378
","
2379
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2380
","
2381
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2382 2383
"

2384 2385
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2386
","
2387
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2388
","
2389
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2390 2391
"

2392 2393 2394 2395 2396 2397 2398 2399
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2400
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2401
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2402
","
Thomas Mueller's avatar
Thomas Mueller committed
2403
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2404 2405 2406 2407 2408 2409 2410
If the number contains a dot this is decimal; otherwise it is int, long, or decimal (depending on the value).
","
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
"

2411 2412
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2413
","
2414
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2415
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2416
","
2417
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2418 2419
"

2420 2421
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2422
","
2423 2424 2425
Sorts the result by the given column number, or by an expression. If the
expression is a single parameter, then the value is interpreted as a column
number. Negative column numbers reverse the sort order.
Thomas Mueller's avatar
Thomas Mueller committed
2426
","
2427
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2428 2429
"

2430 2431
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2432
","
2433 2434 2435
Quoted names are case sensitive, and can contain spaces. There is no maximum
name length. Two double quotes can be used to create a single double quote
inside an identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2436
","
2437
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2438 2439
"

2440 2441 2442
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2443
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2444
","
Thomas Mueller's avatar
Thomas Mueller committed
2445 2446 2447
Defines a referential constraint.
If the table name is not specified, then the same table is referenced.
RESTRICT is the default action.
Thomas Mueller's avatar
Thomas Mueller committed
2448 2449 2450
If the referenced columns are not specified, then the primary key columns are used.
The required indexes are automatically created if required.
Some tables may not be referenced, such as metadata tables.
Thomas Mueller's avatar
Thomas Mueller committed
2451
","
2452
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2453 2454
"

Thomas Mueller's avatar
Thomas Mueller committed
2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465
"Other Grammar","Referential Action","
CASCADE | RESTRICT | NO ACTION | SET { DEFAULT | NULL }
","
The action CASCADE will cause conflicting rows in the referencing (child) table to be deleted or updated.
RESTRICT is the default action.
As this database does not support deferred checking, RESTRICT and NO ACTION will both throw an exception if the constraint is violated.
The action SET DEFAULT will set the column in the referencing (child) table to the default value, while SET NULL will set it to NULL.
","
FOREIGN KEY(ID) REFERENCES TEST(ID) ON UPDATE CASCADE
"

2466
"Other Grammar","Script Compression Encryption","
2467 2468
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ]
[ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2469
","
2470 2471
The compression and encryption algorithm to use for script files.
When using encryption, only DEFLATE and LZF are supported.
Thomas Mueller's avatar
Thomas Mueller committed
2472 2473 2474 2475 2476
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2477 2478
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2479
","
2480
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2481
","
2482
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2483 2484
"

2485 2486 2487 2488 2489 2490 2491 2492 2493
"Other Grammar","Set clause list","
{ { columnName = { DEFAULT | expression } } [,...] } |
    { ( columnName [,...] ) = ( select ) }
","
List of SET clauses.
","
NAME = 'Test', VALUE = 2
"

2494 2495
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2496
","
2497 2498
A string starts and ends with a single quote. Two single quotes can be used to
create a single quote inside a string.
Thomas Mueller's avatar
Thomas Mueller committed
2499
","
2500
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2501 2502
"

2503 2504
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2505
","
Thomas Mueller's avatar
Thomas Mueller committed
2506
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2507

Thomas Mueller's avatar
Thomas Mueller committed
2508
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2509
","
2510
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2511 2512
"

2513
"Other Grammar","Table Expression","
2514 2515
{ [ schemaName. ] tableName | ( select ) | valuesExpression }
[ [ AS ] newTableAlias [ ( columnName [,...] ) ] ]
2516
[ USE INDEX ([ indexName [,...] ]) ]
2517 2518
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2519
","
2520 2521 2522
Joins a table. The join expression is not supported for cross and natural joins.
A natural join is an inner join, where the condition is automatically on the
columns with the same name.
Thomas Mueller's avatar
Thomas Mueller committed
2523
","
2524
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2525 2526
"

2527 2528 2529 2530 2531 2532 2533 2534 2535
"Other Grammar","Values Expression","
VALUES { ( expression [,...] ) } [,...]
","
A list of rows that can be used like a table.
The column list of the resulting table is C1, C2, and so on.
","
SELECT * FROM (VALUES(1, 'Hello'), (2, 'World')) AS V;
"

2536
"Other Grammar","Window specification","
2537
([PARTITION BY expression [,...]] [ORDER BY order [,...]])
2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548
","
A window specification for a window function or aggregate.
Window functions are currently experimental in H2 and should be used with caution.
They also may require a lot of memory for large queries.
","
()
(ORDER BY ID)
(PARTITION BY CATEGORY)
(PARTITION BY CATEGORY ORDER BY NAME, ID)
"

2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2561
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2562
","
2563
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2564
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2565
","
2566 2567 2568 2569
'Hello'
"

"Other Grammar","Time","
2570
TIME [ WITHOUT TIME ZONE ] 'hh:mm:ss[.nnnnnnnnn]'
2571
","
2572
A time literal. A value is between 0:00:00 and 23:59:59.999999999
2573
and has nanosecond resolution.
2574 2575 2576 2577 2578
","
TIME '23:59:59'
"

"Other Grammar","Timestamp","
2579
TIMESTAMP [ WITHOUT TIME ZONE ] 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]'
2580 2581
","
A timestamp literal. The limitations are the same as for the Java data type
2582
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2583 2584 2585 2586 2587
minimum and maximum years are 0001 and 9999.
","
TIMESTAMP '2005-12-31 23:59:59'
"

2588
"Other Grammar","Timestamp with time zone","
2589
TIMESTAMP WITH TIME ZONE 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]
2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600
[Z | { - | + } timeZoneOffsetString | timeZoneNameString ]'
","
A timestamp with time zone literal.
If name of time zone is specified it will be converted to time zone offset.
","
TIMESTAMP WITH TIME ZONE '2005-12-31 23:59:59Z'
TIMESTAMP WITH TIME ZONE '2005-12-31 23:59:59-10:00'
TIMESTAMP WITH TIME ZONE '2005-12-31 23:59:59.123+05'
TIMESTAMP WITH TIME ZONE '2005-12-31 23:59:59.123456789 Europe/London'
"

2601 2602 2603 2604 2605 2606 2607 2608
"Other Grammar","Date and time","
date | time | timestamp | timestampWithTimeZone
","
A literal value of any date-time data type.
","
TIMESTAMP '1999-01-31 10:00:00'
"

2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669
"Other Grammar","INTERVAL YEAR","
INTERVAL [-|+] '[-|+]yearInt' YEAR
","
An INTERVAL YEAR literal.
","
INTERVAL '10' YEAR
"

"Other Grammar","INTERVAL MONTH","
INTERVAL [-|+] '[-|+]monthInt' MONTH
","
An INTERVAL MONTH literal.
","
INTERVAL '10' MONTH
"

"Other Grammar","INTERVAL DAY","
INTERVAL [-|+] '[-|+]dayInt' DAY
","
An INTERVAL DAY literal.
","
INTERVAL '10' DAY
"

"Other Grammar","INTERVAL HOUR","
INTERVAL [-|+] '[-|+]hourInt' HOUR
","
An INTERVAL HOUR literal.
","
INTERVAL '10' HOUR
"

"Other Grammar","INTERVAL MINUTE","
INTERVAL [-|+] '[-|+]minuteInt' MINUTE
","
An INTERVAL MINUTE literal.
","
INTERVAL '10' MINUTE
"

"Other Grammar","INTERVAL SECOND","
INTERVAL [-|+] '[-|+]secondInt[.nnnnnnnnn]' SECOND
","
An INTERVAL SECOND literal.
","
INTERVAL '10.123' SECOND
"

"Other Grammar","INTERVAL YEAR TO MONTH","
INTERVAL [-|+] '[-|+]yearInt-monthInt' YEAR TO MONTH
","
An INTERVAL YEAR TO MONTH literal.
","
INTERVAL '1-6' YEAR TO MONTH
"

"Other Grammar","INTERVAL DAY TO HOUR","
INTERVAL [-|+] '[-|+]dayInt hoursInt' DAY TO HOUR
","
An INTERVAL DAY TO HOUR literal.
","
2670
INTERVAL '10 11' DAY TO HOUR
2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723
"

"Other Grammar","INTERVAL DAY TO MINUTE","
INTERVAL [-|+] '[-|+]dayInt hh:mm' DAY TO MINUTE
","
An INTERVAL DAY TO MINUTE literal.
","
INTERVAL '10 11:12' DAY TO MINUTE
"

"Other Grammar","INTERVAL DAY TO SECOND","
INTERVAL [-|+] '[-|+]dayInt hh:mm:ss[.nnnnnnnnn]' DAY TO SECOND
","
An INTERVAL DAY TO SECOND literal.
","
INTERVAL '10 11:12:13.123' DAY TO SECOND
"

"Other Grammar","INTERVAL HOUR TO MINUTE","
INTERVAL [-|+] '[-|+]hh:mm' HOUR TO MINUTE
","
An INTERVAL HOUR TO MINUTE literal.
","
INTERVAL '10:11' HOUR TO MINUTE
"

"Other Grammar","INTERVAL HOUR TO SECOND","
INTERVAL [-|+] '[-|+]hh:mm:ss[.nnnnnnnnn]' HOUR TO SECOND
","
An INTERVAL HOUR TO SECOND literal.
","
INTERVAL '10:11:12.123' HOUR TO SECOND
"

"Other Grammar","INTERVAL MINUTE TO SECOND","
INTERVAL [-|+] '[-|+]mm:ss[.nnnnnnnnn]' MINUTE TO SECOND
","
An INTERVAL MINUTE TO SECOND literal.
","
INTERVAL '11:12.123' MINUTE TO SECOND
"

"Other Grammar","Interval","
intervalYear | intervalMonth | intervalDay | intervalHour | intervalMinute
| intervalSecond | intervalYearToMonth | intervalDayToHour
| intervalDayToMinute | intervalDayToSecond | intervalHourToMinute
| intervalHourToSecond | intervalMinuteToSecond
","
An interval literal.
","
INTERVAL '1-2' YEAR TO MONTH
"

2724
"Other Grammar","Value","
2725 2726
string | dollarQuotedString | numeric | dateAndTime | boolean | bytes
| interval | array | null
2727
","
Thomas Mueller's avatar
Thomas Mueller committed
2728
A literal value of any data type, or null.
2729 2730
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2731 2732 2733 2734 2735 2736 2737
"

"Data Types","INT Type","
INT | INTEGER | MEDIUMINT | INT4 | SIGNED
","
Possible values: -2147483648 to 2147483647.

2738
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2739 2740 2741 2742 2743 2744 2745 2746 2747
","
INT
"

"Data Types","BOOLEAN Type","
BOOLEAN | BIT | BOOL
","
Possible values: TRUE and FALSE.

2748
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2749 2750 2751 2752 2753 2754 2755 2756 2757
","
BOOLEAN
"

"Data Types","TINYINT Type","
TINYINT
","
Possible values are: -128 to 127.

2758
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2759 2760 2761 2762 2763 2764 2765 2766 2767
","
TINYINT
"

"Data Types","SMALLINT Type","
SMALLINT | INT2 | YEAR
","
Possible values: -32768 to 32767.

2768
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2769 2770 2771 2772 2773 2774 2775 2776 2777
","
SMALLINT
"

"Data Types","BIGINT Type","
BIGINT | INT8
","
Possible values: -9223372036854775808 to 9223372036854775807.

2778
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789
","
BIGINT
"

"Data Types","IDENTITY Type","
IDENTITY
","
Auto-Increment value. Possible values: -9223372036854775808 to
9223372036854775807. Used values are never re-used, even when the transaction is
rolled back.

2790
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2791 2792 2793 2794 2795
","
IDENTITY
"

"Data Types","DECIMAL Type","
2796
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2797 2798 2799 2800
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2801
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2802 2803 2804 2805 2806
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2807
{ DOUBLE [ PRECISION ] | FLOAT [ ( precisionInt ) ] | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2808
","
Thomas Mueller's avatar
Thomas Mueller committed
2809
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2810
of rounding problems.
2811
If precision value is specified for FLOAT type name, it should be from 25 to 53.
Thomas Mueller's avatar
Thomas Mueller committed
2812

2813
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2814 2815 2816 2817 2818
","
DOUBLE
"

"Data Types","REAL Type","
2819
{ REAL | FLOAT ( precisionInt ) | FLOAT4 }
Thomas Mueller's avatar
Thomas Mueller committed
2820
","
Thomas Mueller's avatar
Thomas Mueller committed
2821
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2822
values, because of rounding problems.
2823
Precision value for FLOAT type name should be from 0 to 24.
Thomas Mueller's avatar
Thomas Mueller committed
2824

2825
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2826 2827 2828 2829 2830
","
REAL
"

"Data Types","TIME Type","
2831
TIME [ ( precisionInt ) ] [ WITHOUT TIME ZONE ]
Thomas Mueller's avatar
Thomas Mueller committed
2832
","
2833
The time data type. The format is hh:mm:ss[.nnnnnnnnn].
2834
If fractional seconds precision is specified it should be from 0 to 9, 0 is default.
Thomas Mueller's avatar
Thomas Mueller committed
2835

2836
Mapped to ""java.sql.Time"". When converted to a ""java.sql.Date"", the date is set to ""1970-01-01"".
2837
""java.time.LocalTime"" is also supported on Java 8 and later versions.
Evgenij Ryazanov's avatar
Evgenij Ryazanov committed
2838
Resolution of ""java.sql.Time"" is limited to milliseconds, use ""String"" or ""java.time.LocalTime"" if you need nanosecond resolution.
Thomas Mueller's avatar
Thomas Mueller committed
2839 2840 2841 2842 2843 2844 2845
","
TIME
"

"Data Types","DATE Type","
DATE
","
Thomas Mueller's avatar
Thomas Mueller committed
2846
The date data type. The format is yyyy-MM-dd.
Thomas Mueller's avatar
Thomas Mueller committed
2847

2848
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2849
(or to the next possible time if midnight doesn't exist for the given date and timezone due to a daylight saving change).
2850
""java.time.LocalDate"" is also supported on Java 8 and later versions.
Thomas Mueller's avatar
Thomas Mueller committed
2851 2852 2853 2854 2855
","
DATE
"

"Data Types","TIMESTAMP Type","
2856
{ TIMESTAMP [ ( precisionInt ) ] [ WITHOUT TIME ZONE ]
2857
    | DATETIME [ ( precisionInt ) ] | SMALLDATETIME }
Thomas Mueller's avatar
Thomas Mueller committed
2858
","
Thomas Mueller's avatar
Thomas Mueller committed
2859
The timestamp data type. The format is yyyy-MM-dd hh:mm:ss[.nnnnnnnnn].
2860
Stored internally as a BCD-encoded date, and nanoseconds since midnight.
2861
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
2862
Fractional seconds precision of SMALLDATETIME is always 0 and cannot be specified.
Thomas Mueller's avatar
Thomas Mueller committed
2863

2864 2865
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" may be used too).
""java.time.LocalDateTime"" is also supported on Java 8 and later versions.
Thomas Mueller's avatar
Thomas Mueller committed
2866 2867 2868 2869
","
TIMESTAMP
"

2870
"Data Types","TIMESTAMP WITH TIME ZONE Type","
2871
TIMESTAMP [ ( precisionInt ) ] WITH TIME ZONE
2872
","
2873
The timestamp with time zone data type.
2874
Stored internally as a BCD-encoded date, nanoseconds since midnight, and time zone offset in minutes.
2875
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
2876

2877 2878 2879 2880 2881 2882 2883
Mapped to ""org.h2.api.TimestampWithTimeZone"".
""java.time.OffsetDateTime"" and ""java.time.Instant"" are also supported on Java 8 and later versions.

Values of this data type are compared by UTC values. It means that ""2010-01-01 10:00:00+01"" is greater than ""2010-01-01 11:00:00+03"".

Conversion to ""TIMESTAMP"" uses time zone offset to get UTC time and converts it to local time using the system time zone.
Conversion from ""TIMESTAMP"" does the same operations in reverse and sets time zone offset to offset of the system time zone.
2884
","
2885
TIMESTAMP WITH TIME ZONE
2886 2887
"

Thomas Mueller's avatar
Thomas Mueller committed
2888
"Data Types","BINARY Type","
2889 2890
{ BINARY | VARBINARY | BINARY VARYING
    | LONGVARBINARY | RAW | BYTEA }
2891
[ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2892
","
2893 2894 2895 2896 2897
Represents a byte array. For very long arrays, use BLOB.
The maximum size is 2 GB, but the whole object is kept in
memory when using this data type. The precision is a size constraint;
only the actual data is persisted. For large text data BLOB or CLOB
should be used.
Thomas Mueller's avatar
Thomas Mueller committed
2898 2899 2900 2901 2902 2903 2904 2905 2906

Mapped to byte[].
","
BINARY(1000)
"

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2907 2908 2909 2910 2911
This type allows storing serialized Java objects. Internally, a byte array is used.
Serialization and deserialization is done on the client side only.
Deserialization is only done when ""getObject"" is called.
Java operations cannot be executed inside the database engine for security reasons.
Use ""PreparedStatement.setObject"" to store values.
Thomas Mueller's avatar
Thomas Mueller committed
2912

2913
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2914 2915 2916 2917 2918
","
OTHER
"

"Data Types","VARCHAR Type","
2919
{ VARCHAR | CHARACTER VARYING | LONGVARCHAR | VARCHAR2 | NVARCHAR
2920
    | NVARCHAR2 | VARCHAR_CASESENSITIVE} [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2921
","
Thomas Mueller's avatar
Thomas Mueller committed
2922
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2923 2924 2925 2926 2927 2928 2929
Use two single quotes ('') to create a quote.

The maximum precision is ""Integer.MAX_VALUE"".
The precision is a size constraint; only the actual data is persisted.

The whole text is loaded into memory when using this data type.
For large text data CLOB should be used; see there for details.
Thomas Mueller's avatar
Thomas Mueller committed
2930

2931
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2932 2933 2934 2935 2936
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2937
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2938
","
Thomas Mueller's avatar
Thomas Mueller committed
2939
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2940 2941 2942 2943 2944 2945 2946
Stored in mixed case.

The maximum precision is ""Integer.MAX_VALUE"".
The precision is a size constraint; only the actual data is persisted.

The whole text is loaded into memory when using this data type.
For large text data CLOB should be used; see there for details.
Thomas Mueller's avatar
Thomas Mueller committed
2947

2948
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2949 2950 2951 2952 2953
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2954
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2955
","
Thomas Mueller's avatar
Thomas Mueller committed
2956 2957 2958
A Unicode String.
This type is supported for compatibility with other databases and older applications.
The difference to VARCHAR is that trailing spaces are ignored and not persisted.
Thomas Mueller's avatar
Thomas Mueller committed
2959

Thomas Mueller's avatar
Thomas Mueller committed
2960 2961
The maximum precision is ""Integer.MAX_VALUE"".
The precision is a size constraint; only the actual data is persisted.
Thomas Mueller's avatar
Thomas Mueller committed
2962

Thomas Mueller's avatar
Thomas Mueller committed
2963
The whole text is kept in memory when using this data type.
Thomas Mueller's avatar
Thomas Mueller committed
2964
For large text data CLOB should be used; see there for details.
Thomas Mueller's avatar
Thomas Mueller committed
2965

2966
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2967 2968 2969 2970 2971
","
CHAR(10)
"

"Data Types","BLOB Type","
2972 2973
{ BLOB | BINARY LARGE OBJECT
    | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID }
2974
[ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2975 2976 2977
","
Like BINARY, but intended for very large values such as files or images. Unlike
when using BINARY, large objects are not kept fully in-memory. Use
2978
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2979 2980
Advanced / Large Objects.

2981
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2982 2983 2984 2985 2986
","
BLOB
"

"Data Types","CLOB Type","
2987 2988
{ CLOB | CHARACTER LARGE OBJECT
    | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB }
2989
[ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2990 2991 2992 2993 2994
","
CLOB is like VARCHAR, but intended for very large values. Unlike when using
VARCHAR, large CLOB objects are not kept fully in-memory; instead, they are streamed.
CLOB should be used for documents and texts with arbitrary size such as XML or
HTML documents, text files, or memo fields of unlimited size. Use
2995
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2996 2997 2998 2999 3000

VARCHAR should be used for text with relatively short average size (for example
shorter than 200 characters). Short CLOB values are stored inline, but there is
an overhead compared to VARCHAR.

3001
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
3002 3003 3004 3005 3006 3007 3008
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
3009 3010 3011 3012
Universally unique identifier. This is a 128 bit value.
To store values, use ""PreparedStatement.setBytes"",
""setString"", or ""setObject(uuid)"" (where ""uuid"" is a ""java.util.UUID"").
""ResultSet.getObject"" will return a ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
3013

Thomas Mueller's avatar
Thomas Mueller committed
3014 3015 3016 3017 3018
Please note that using an index on randomly generated data will
result on poor performance once there are millions of rows in a table.
The reason is that the cache behavior is very bad with randomly distributed data.
This is a problem for any database system.

Thomas Mueller's avatar
Thomas Mueller committed
3019
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
3020 3021 3022 3023 3024 3025 3026
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
3027
An array of values.
3028
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
3029 3030 3031 3032


Use a value list (1, 2) or ""PreparedStatement.setObject(.., new Object[] {..})"" to store values,
and ""ResultSet.getObject(..)"" or ""ResultSet.getArray(..)"" to retrieve the values.
Thomas Mueller's avatar
Thomas Mueller committed
3033 3034 3035 3036
","
ARRAY
"

3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050
"Data Types","ENUM Type","
{ ENUM (string [, ... ]) }
","
A type with enumerated values.
Mapped to ""java.lang.Integer"".

The first provided value is mapped to 0, the
second mapped to 1, and so on.

Duplicate and empty values are not permitted.
","

ENUM('clubs', 'diamonds', 'hearts', 'spades')
"
3051 3052
"Data Types","GEOMETRY Type","
GEOMETRY
3053 3054 3055 3056 3057 3058 3059 3060 3061
    [({ GEOMETRY |
    { POINT
    | LINESTRING
    | POLYGON
    | MULTIPOINT
    | MULTILINESTRING
    | MULTIPOLYGON
    | GEOMETRYCOLLECTION } [Z|M|ZM]}
    [, sridInt] )]
3062
","
3063
A spatial geometry type.
3064 3065 3066 3067 3068
If additional constraints are not specified this type accepts all supported types of geometries.
A constraint with required geometry type and dimension system can be set by specifying name of the type and
dimension system. A whitespace between them is optional.
2D dimension system does not have a name and assumed if only a geometry type name is specified.
POINT means 2D point, POINT Z or POINTZ means 3D point.
3069
GEOMETRY constraint means no restrictions on type or dimension system of geometry.
3070 3071 3072
A constraint with required spatial reference system identifier (SRID) can be set by specifying this identifier.

Mapped to ""org.locationtech.jts.geom.Geometry"" if JTS library is in classpath and to ""java.lang.String"" otherwise.
3073 3074
May be represented in textual format using the WKT (well-known text) or EWKT (extended well-known text) format.
Values are stored internally in EWKB (extended well-known binary) format.
3075 3076
Only a subset of EWKB and EWKT features is supported.
Supported objects are POINT, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, and GEOMETRYCOLLECTION.
3077
Supported dimension systems are 2D (XY), Z (XYZ), M (XYM), and ZM (XYZM).
3078
SRID (spatial reference system identifier) is supported.
3079

3080
Use a quoted string containing a WKT/EWKT formatted string or ""PreparedStatement.setObject()"" to store values,
3081 3082
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
3083
GEOMETRY
3084 3085 3086
GEOMETRY(POINT)
GEOMETRY(POINT Z)
GEOMETRY(POINT Z, 4326)
3087
GEOMETRY(GEOMETRY, 4326)
3088 3089
"

3090
"Data Types","INTERVAL Type","
3091 3092 3093 3094 3095 3096 3097
intervalYearType | intervalMonthType | intervalDayType
    | intervalHourType| intervalMinuteType | intervalSecondType
    | intervalYearToMonthType | intervalDayToHourType
    | intervalDayToMinuteType | intervalDayToSecondType
    | intervalHourToMinuteType | intervalHourToSecondType
    | intervalMinuteToSecondType
","
3098 3099
Interval data type.
There are two classes of intervals. Year-month intervals can store years and months.
3100 3101 3102 3103 3104 3105 3106 3107 3108 3109
Day-time intervals can store days, hours, minutes, and seconds.
Year-month intervals are comparable only with another year-month intervals.
Day-time intervals are comparable only with another day-time intervals.

Mapped to ""org.h2.api.Interval"".
","
INTERVAL DAY TO SECOND
"

"Interval Data Types","INTERVAL YEAR Type","
3110 3111 3112 3113 3114 3115 3116 3117 3118 3119
INTERVAL YEAR [ ( precisionInt ) ]
","
Interval data type.
If precision is specified it should be from 1 to 18, 2 is default.

Mapped to ""org.h2.api.Interval"".
","
INTERVAL YEAR
"

3120
"Interval Data Types","INTERVAL MONTH Type","
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130
INTERVAL MONTH [ ( precisionInt ) ]
","
Interval data type.
If precision is specified it should be from 1 to 18, 2 is default.

Mapped to ""org.h2.api.Interval"".
","
INTERVAL MONTH
"

3131
"Interval Data Types","INTERVAL DAY Type","
3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142
INTERVAL DAY [ ( precisionInt ) ]
","
Interval data type.
If precision is specified it should be from 1 to 18, 2 is default.

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL DAY
"

3143
"Interval Data Types","INTERVAL HOUR Type","
3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154
INTERVAL HOUR [ ( precisionInt ) ]
","
Interval data type.
If precision is specified it should be from 1 to 18, 2 is default.

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL HOUR
"

3155
"Interval Data Types","INTERVAL MINUTE Type","
3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166
INTERVAL MINUTE [ ( precisionInt ) ]
","
Interval data type.
If precision is specified it should be from 1 to 18, 2 is default.

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL MINUTE
"

3167
"Interval Data Types","INTERVAL SECOND Type","
3168
INTERVAL SECOND [ ( precisionInt [, fractionalPrecisionInt ] ) ]
3169 3170 3171
","
Interval data type.
If precision is specified it should be from 1 to 18, 2 is default.
3172
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
3173 3174 3175 3176 3177 3178 3179

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL SECOND
"

3180
"Interval Data Types","INTERVAL YEAR TO MONTH Type","
3181 3182 3183
INTERVAL YEAR [ ( precisionInt ) ] TO MONTH
","
Interval data type.
3184
If leading field precision is specified it should be from 1 to 18, 2 is default.
3185 3186 3187 3188 3189 3190

Mapped to ""org.h2.api.Interval"".
","
INTERVAL YEAR TO MONTH
"

3191
"Interval Data Types","INTERVAL DAY TO HOUR Type","
3192 3193 3194
INTERVAL DAY [ ( precisionInt ) ] TO HOUR
","
Interval data type.
3195
If leading field precision is specified it should be from 1 to 18, 2 is default.
3196 3197 3198 3199 3200 3201 3202

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL DAY TO HOUR
"

3203
"Interval Data Types","INTERVAL DAY TO MINUTE Type","
3204 3205 3206
INTERVAL DAY [ ( precisionInt ) ] TO MINUTE
","
Interval data type.
3207
If leading field precision is specified it should be from 1 to 18, 2 is default.
3208 3209 3210 3211 3212 3213 3214

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL DAY TO MINUTE
"

3215
"Interval Data Types","INTERVAL DAY TO SECOND Type","
3216
INTERVAL DAY [ ( precisionInt ) ] TO SECOND [ ( fractionalPrecisionInt ) ]
3217 3218
","
Interval data type.
3219 3220
If leading field precision is specified it should be from 1 to 18, 2 is default.
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
3221 3222 3223 3224 3225 3226 3227

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL DAY TO SECOND
"

3228
"Interval Data Types","INTERVAL HOUR TO MINUTE Type","
3229 3230 3231
INTERVAL HOUR [ ( precisionInt ) ] TO MINUTE
","
Interval data type.
3232
If leading field precision is specified it should be from 1 to 18, 2 is default.
3233 3234 3235 3236 3237 3238 3239

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL HOUR TO MINUTE
"

3240
"Interval Data Types","INTERVAL HOUR TO SECOND Type","
3241
INTERVAL HOUR [ ( precisionInt ) ] TO SECOND [ ( fractionalPrecisionInt ) ]
3242 3243
","
Interval data type.
3244 3245
If leading field precision is specified it should be from 1 to 18, 2 is default.
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
3246 3247 3248 3249 3250 3251 3252

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL HOUR TO SECOND
"

3253
"Interval Data Types","INTERVAL MINUTE TO SECOND Type","
3254
INTERVAL MINUTE [ ( precisionInt ) ] TO SECOND [ ( fractionalPrecisionInt ) ]
3255 3256
","
Interval data type.
3257 3258
If leading field precision is specified it should be from 1 to 18, 2 is default.
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
3259 3260 3261 3262 3263 3264 3265

Mapped to ""org.h2.api.Interval"".
""java.time.Duration"" is also supported on Java 8 and later versions.
","
INTERVAL MINUTE TO SECOND
"

Thomas Mueller's avatar
Thomas Mueller committed
3266
"Functions (Aggregate)","AVG","
3267 3268
AVG ( [ DISTINCT ] { numeric } )
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3269
","
3270 3271
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
3272
Aggregates are only allowed in select statements.
3273
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3274 3275 3276 3277
","
AVG(X)
"

3278
"Functions (Aggregate)","BIT_AND","
3279 3280
BIT_AND(expression)
[FILTER (WHERE expression)] [OVER windowSpecification]
3281 3282 3283 3284 3285 3286 3287 3288 3289
","
The bitwise AND of all non-null values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
BIT_AND(ID)
"

"Functions (Aggregate)","BIT_OR","
3290 3291
BIT_OR(expression)
[FILTER (WHERE expression)] [OVER windowSpecification]
3292 3293 3294 3295 3296 3297 3298 3299
","
The bitwise OR of all non-null values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
BIT_OR(ID)
"

Thomas Mueller's avatar
Thomas Mueller committed
3300
"Functions (Aggregate)","BOOL_AND","
3301 3302
BOOL_AND(boolean)
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3303
","
3304 3305 3306
Returns true if all expressions are true.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
Thomas Mueller's avatar
Thomas Mueller committed
3307 3308 3309 3310 3311
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
3312 3313
BOOL_OR(boolean)
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3314
","
3315 3316 3317
Returns true if any expression is true.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
Thomas Mueller's avatar
Thomas Mueller committed
3318 3319 3320 3321 3322
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
3323 3324
COUNT( { * | { [ DISTINCT ] expression } } )
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3325
","
3326 3327 3328 3329
The count of all row, or of the non-null values.
This method returns a long.
If no rows are selected, the result is 0.
Aggregates are only allowed in select statements.
Thomas Mueller's avatar
Thomas Mueller committed
3330 3331 3332 3333 3334
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
3335 3336
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
3337 3338
[ SEPARATOR expression ] )
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3339
","
3340 3341 3342 3343 3344
Concatenates strings with a separator.
The default separator is a ',' (without space).
This method returns a string.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
Thomas Mueller's avatar
Thomas Mueller committed
3345 3346 3347 3348
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

3349 3350 3351
"Functions (Aggregate)","ARRAY_AGG","
ARRAY_AGG ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ] )
3352
[FILTER (WHERE expression)] [OVER windowSpecification]
3353 3354 3355 3356 3357 3358 3359 3360 3361
","
Aggregate the value into an array.
This method returns an array.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
ARRAY_AGG(NAME ORDER BY ID)
"

Thomas Mueller's avatar
Thomas Mueller committed
3362
"Functions (Aggregate)","MAX","
3363 3364
MAX(value)
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3365
","
3366 3367 3368 3369
The highest value.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3370 3371 3372 3373 3374
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
3375 3376
MIN(value)
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3377
","
3378 3379 3380 3381
The lowest value.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3382 3383 3384 3385 3386
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
3387 3388
SUM( [ DISTINCT ] { numeric } )
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3389
","
3390 3391 3392
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
3393
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
3394
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
3395 3396 3397 3398 3399
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
3400 3401
SELECTIVITY(value)
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3402
","
3403 3404 3405 3406 3407
Estimates the selectivity (0-100) of a value.
The value is defined as (100 * distinctCount / rowCount).
The selectivity of 0 rows is 0 (unknown).
Up to 10000 values are kept in memory.
Aggregates are only allowed in select statements.
Thomas Mueller's avatar
Thomas Mueller committed
3408 3409 3410 3411 3412
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
3413 3414
STDDEV_POP( [ DISTINCT ] numeric )
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3415
","
3416 3417 3418
The population standard deviation.
This method returns a double.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
3419 3420 3421 3422 3423 3424
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
3425 3426
STDDEV_SAMP( [ DISTINCT ] numeric )
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3427
","
3428 3429 3430
The sample standard deviation.
This method returns a double.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
3431 3432 3433 3434 3435 3436
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
3437 3438
VAR_POP( [ DISTINCT ] numeric )
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3439
","
3440 3441 3442 3443
The population variance (square of the population standard deviation).
This method returns a double.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
Thomas Mueller's avatar
Thomas Mueller committed
3444 3445 3446 3447 3448
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
3449 3450
VAR_SAMP( [ DISTINCT ] numeric )
[FILTER (WHERE expression)] [OVER windowSpecification]
Thomas Mueller's avatar
Thomas Mueller committed
3451
","
3452 3453 3454 3455
The sample variance (square of the sample standard deviation).
This method returns a double.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
Thomas Mueller's avatar
Thomas Mueller committed
3456 3457 3458 3459
","
VAR_SAMP(X)
"

3460
"Functions (Aggregate)","MEDIAN","
3461 3462
MEDIAN( [ DISTINCT ] value )
[FILTER (WHERE expression)] [OVER windowSpecification]
3463 3464 3465
","
The value separating the higher half of a values from the lower half.
Returns the middle value or an interpolated value between two middle values if number of values is even.
3466
Interpolation is only supported for numeric, date-time, and interval data types.
3467 3468 3469 3470 3471 3472 3473
NULL values are ignored in the calculation.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
MEDIAN(X)
"

3474
"Functions (Aggregate)","MODE","
3475 3476
{ MODE( value ) [ ORDER BY expression [ ASC | DESC ] ] }
    | { MODE() WITHIN GROUP(ORDER BY expression [ ASC | DESC ]) }
3477
[FILTER (WHERE expression)] [OVER windowSpecification]
3478 3479 3480
","
Returns the value that occurs with the greatest frequency.
If there are multiple values with the same frequency only one value will be returned.
3481 3482 3483 3484 3485
In this situation value will be chosen based on optional ORDER BY clause
that should specify exactly the same expression as argument of this function.
Use ascending order to get smallest value or descending order to get largest value
from multiple values with the same frequency.
If this clause is not specified the exact chosen value is not determined in this situation.
3486 3487 3488 3489 3490
NULL values are ignored in the calculation.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
MODE(X)
3491
MODE(X ORDER BY X)
3492
MODE() WITHIN GROUP(ORDER BY X)
3493 3494
"

3495
"Functions (Aggregate)","ENVELOPE","
3496 3497
ENVELOPE( value )
[FILTER (WHERE expression)] [OVER windowSpecification]
3498 3499 3500 3501 3502 3503 3504
","
Returns the minimum bounding box that encloses all specified GEOMETRY values.
Only 2D coordinate plane is supported.
NULL values are ignored in the calculation.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
3505
ENVELOPE(X)
3506 3507
"

Thomas Mueller's avatar
Thomas Mueller committed
3508
"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
3509
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3510
","
3511 3512
See also Java ""Math.abs"".
Please note that ""Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE"" and ""Math.abs(Long.MIN_VALUE) == Long.MIN_VALUE"".
3513
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3514 3515 3516 3517 3518
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
3519
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3520
","
Thomas Mueller's avatar
Thomas Mueller committed
3521 3522
Calculate the arc cosine.
See also Java ""Math.acos"".
3523
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3524 3525 3526 3527 3528
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
3529
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3530
","
Thomas Mueller's avatar
Thomas Mueller committed
3531 3532
Calculate the arc sine.
See also Java ""Math.asin"".
3533
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3534 3535 3536 3537 3538
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
3539
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3540
","
Thomas Mueller's avatar
Thomas Mueller committed
3541 3542
Calculate the arc tangent.
See also Java ""Math.atan"".
3543
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3544 3545 3546 3547 3548
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
3549
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3550
","
Thomas Mueller's avatar
Thomas Mueller committed
3551 3552
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
3553
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3554 3555 3556 3557
","
COS(ANGLE)
"

3558
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
3559
COSH(numeric)
3560 3561 3562 3563 3564 3565 3566 3567
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
3568
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
3569
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3570
","
Thomas Mueller's avatar
Thomas Mueller committed
3571
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
3572
See also Java ""Math.*"" functions.
3573
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3574 3575 3576 3577 3578
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
3579
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3580
","
Thomas Mueller's avatar
Thomas Mueller committed
3581 3582
Calculate the trigonometric sine.
See also Java ""Math.sin"".
3583
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3584 3585 3586 3587
","
SIN(ANGLE)
"

3588
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
3589
SINH(numeric)
3590 3591 3592 3593 3594 3595 3596 3597
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
3598
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
3599
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3600
","
Thomas Mueller's avatar
Thomas Mueller committed
3601 3602
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
3603
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3604 3605 3606 3607
","
TAN(ANGLE)
"

3608
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
3609
TANH(numeric)
3610 3611 3612 3613 3614 3615 3616 3617
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
3618
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
3619
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3620
","
Thomas Mueller's avatar
Thomas Mueller committed
3621
Calculate the angle when converting the rectangular coordinates to polar coordinates.
3622
See also Java ""Math.atan2"".
3623
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3624 3625 3626 3627 3628
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
3629
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3630
","
3631 3632
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3633 3634 3635 3636 3637
See also Java operator &.
","
BITAND(A, B)
"

3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648
"Functions (Numeric)","BITGET","
BITGET(long, int)
","
Returns true if and only if the first parameter has a bit set in the
position specified by the second parameter.
This method returns a boolean.
The second parameter is zero-indexed; the least significant bit has position 0.
","
BITGET(A, 1)
"

Thomas Mueller's avatar
Thomas Mueller committed
3649
"Functions (Numeric)","BITOR","
3650
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3651
","
3652 3653
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3654 3655 3656 3657 3658 3659
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
3660
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3661
","
3662 3663
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3664 3665 3666 3667 3668 3669
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
3670
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3671
","
3672 3673
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3674 3675 3676 3677 3678 3679
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
3680
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3681
","
3682
See also Java ""Math.ceil"".
3683
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3684
","
3685
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
3686 3687 3688
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
3689
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3690
","
3691
See also Java ""Math.toDegrees"".
3692
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3693 3694 3695 3696 3697
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
3698
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3699
","
3700
See also Java ""Math.exp"".
3701
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3702 3703 3704 3705 3706
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
3707
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3708
","
3709
See also Java ""Math.floor"".
3710
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3711 3712 3713 3714 3715
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
3716
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3717
","
3718
See also Java ""Math.log"".
3719
In the PostgreSQL mode, LOG(x) is base 10.
3720
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3721 3722 3723 3724 3725
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
3726
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3727
","
3728
See also Java ""Math.log10"".
3729
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3730 3731 3732 3733
","
LOG10(A)
"

3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746
"Functions (Numeric)","ORA_HASH","
ORA_HASH(expression [, bucketLong [, seedLong]])
","
Computes a hash value.
Optional bucket argument determines the maximum returned value.
This argument should be between 0 and 4294967295, default is 4294967295.
Optional seed argument is combined with the given expression to return the different values for the same expression.
This argument should be between 0 and 4294967295, default is 0.
This method returns a long value between 0 and the specified or default bucket value inclusive.
","
ORA_HASH(A)
"

Thomas Mueller's avatar
Thomas Mueller committed
3747
"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
3748
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3749
","
3750
See also Java ""Math.toRadians"".
3751
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3752 3753 3754 3755 3756
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
3757
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3758
","
3759
See also Java ""Math.sqrt"".
3760
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3761 3762 3763 3764 3765
","
SQRT(A)
"

"Functions (Numeric)","PI","
3766
PI()
Thomas Mueller's avatar
Thomas Mueller committed
3767
","
3768
See also Java ""Math.PI"".
3769
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3770 3771 3772 3773 3774
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
3775
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3776
","
3777
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
3778
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3779 3780 3781 3782 3783
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
3784
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
3785 3786 3787
","
Calling the function without parameter returns the next a pseudo random number.
Calling it with an parameter seeds the session's random number generator.
Thomas Mueller's avatar
Thomas Mueller committed
3788
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
3789 3790 3791 3792 3793
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
3794
{ RANDOM_UUID | UUID } ()
Thomas Mueller's avatar
Thomas Mueller committed
3795 3796
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
3797 3798 3799 3800 3801

Please note that using an index on randomly generated data will
result on poor performance once there are millions of rows in a table.
The reason is that the cache behavior is very bad with randomly distributed data.
This is a problem for any database system.
Thomas Mueller's avatar
Thomas Mueller committed
3802 3803 3804 3805 3806
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
3807
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
3808
","
3809
Rounds to a number of digits, or to the nearest long if the number of digits if not set.
Thomas Mueller's avatar
Thomas Mueller committed
3810
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
3811 3812 3813 3814 3815
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
3816
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3817
","
3818 3819 3820 3821 3822 3823
This function rounds numbers in a good way, but it is slow.
It has a special handling for numbers around 0.
Only numbers smaller or equal +/-1000000000000 are supported.
The value is converted to a String internally, and then the last last 4 characters are checked.
'000x' becomes '0000' and '999x' becomes '999999', which is rounded automatically.
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3824 3825 3826 3827 3828
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
3829
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
3830 3831
","
Generates a number of cryptographically secure random numbers.
3832
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3833 3834 3835 3836 3837
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
3838
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3839 3840 3841 3842 3843 3844 3845
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
3846
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3847
","
3848
Encrypts data using a key.
3849
The supported algorithm is AES.
3850 3851
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3852 3853 3854 3855 3856
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
3857
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3858
","
3859
Decrypts data using a key.
3860
The supported algorithm is AES.
3861 3862
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3863 3864 3865 3866 3867 3868
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3869
HASH(algorithmString, expression [, iterationInt])
Thomas Mueller's avatar
Thomas Mueller committed
3870
","
3871 3872 3873
Calculate the hash value using an algorithm, and repeat this process for a number of iterations.
Currently, the only algorithm supported is SHA256.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3874 3875 3876 3877 3878
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3879 3880
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt}
    | timestamp | timestampWithTimeZone | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3881 3882
","
Truncates to a number of digits (to the next value closer to 0).
3883
This method returns a double.
3884
When used with a timestamp, truncates a timestamp to a date (day) value.
3885 3886
When used with a date, truncates a date to a date (day) value less time part.
When used with a timestamp as string, truncates a timestamp to a date (day) value.
Thomas Mueller's avatar
Thomas Mueller committed
3887 3888 3889 3890 3891
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3892
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3893
","
3894 3895 3896 3897
Compresses the data using the specified compression algorithm.
Supported algorithms are: LZF (faster but lower compression; default), and DEFLATE (higher compression).
Compression does not always reduce size. Very small objects and objects with little redundancy may get larger.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3898 3899 3900 3901 3902
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3903
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3904 3905
","
Expands data that was compressed using the COMPRESS function.
3906
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3907 3908 3909 3910 3911
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3912
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3913 3914 3915 3916 3917 3918 3919
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3920
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3921 3922
","
Returns the ASCII value of the first character in the string.
3923
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3924 3925 3926 3927
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3928
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3929
","
3930 3931 3932
Returns the number of bits in a string.
This method returns a long.
For BLOB, CLOB, BYTES and JAVA_OBJECT, the precision is used. Each character needs 16 bits.
Thomas Mueller's avatar
Thomas Mueller committed
3933 3934 3935 3936 3937
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3938
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3939
","
3940 3941 3942
Returns the number of characters in a string.
This method returns a long.
For BLOB, CLOB, BYTES and JAVA_OBJECT, the precision is used.
Thomas Mueller's avatar
Thomas Mueller committed
3943 3944 3945 3946 3947
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3948
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3949
","
3950 3951 3952 3953
Returns the number of bytes in a string.
This method returns a long.
For BLOB, CLOB, BYTES and JAVA_OBJECT, the precision is used.
Each character needs 2 bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3954 3955 3956 3957 3958
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3959
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3960 3961
","
Returns the character that represents the ASCII value.
3962
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3963 3964 3965 3966 3967
","
CHAR(65)
"

"Functions (String)","CONCAT","
3968
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3969 3970
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3971
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3972
and do not cause the result to become NULL.
3973
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3974 3975 3976 3977
","
CONCAT(NAME, '!')
"

3978 3979 3980 3981
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3982
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3983
and do not cause the result to become NULL.
3984 3985 3986 3987 3988
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3989
"Functions (String)","DIFFERENCE","
3990
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3991 3992
","
Returns the difference between the sounds of two strings.
3993
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3994 3995 3996 3997 3998
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3999
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
4000
","
4001 4002
Converts a hex representation of a string to a string.
4 hex characters per string character are used.
Thomas Mueller's avatar
Thomas Mueller committed
4003 4004 4005 4006 4007
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
4008
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
4009
","
4010 4011 4012
Converts a string to the hex representation.
4 hex characters per string character are used.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4013 4014 4015 4016 4017
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
4018
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
4019
","
4020
Returns the location of a search string in a string.
4021 4022 4023
If a start position is used, the characters before it are ignored.
If position is negative, the rightmost location is returned.
0 is returned if the search string is not found.
Thomas Mueller's avatar
Thomas Mueller committed
4024
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
4025 4026 4027 4028 4029
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
4030
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
4031
","
4032 4033 4034
Inserts a additional string into the original string at a specified start position.
The length specifies the number of characters that are removed at the start position in the original string.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4035 4036 4037 4038 4039
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
4040
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
4041 4042 4043 4044 4045 4046 4047
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
4048
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
4049 4050 4051 4052 4053 4054 4055
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
4056
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
4057 4058 4059 4060 4061 4062 4063
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
4064
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
4065 4066 4067 4068 4069 4070 4071
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
4072
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
4073
","
4074 4075 4076 4077
Returns the location of a search string in a string.
If a start position is used, the characters before it are ignored.
If position is negative, the rightmost location is returned.
0 is returned if the search string is not found.
Thomas Mueller's avatar
Thomas Mueller committed
4078 4079 4080 4081 4082
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
4083
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
4084 4085 4086 4087 4088 4089 4090
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
4091
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
4092
","
4093 4094 4095
Left pad the string to the specified length.
If the length is shorter than the string, it will be truncated at the end.
If the padding string is not set, spaces will be used.
Thomas Mueller's avatar
Thomas Mueller committed
4096 4097 4098 4099 4100
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
4101
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
4102
","
4103 4104 4105
Right pad the string to the specified length.
If the length is shorter than the string, it will be truncated.
If the padding string is not set, spaces will be used.
Thomas Mueller's avatar
Thomas Mueller committed
4106 4107 4108 4109 4110
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
4111
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
4112 4113 4114 4115 4116 4117 4118
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
4119
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
4120 4121 4122 4123 4124 4125 4126
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
4127
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
4128
","
4129 4130
Removes all leading spaces, trailing spaces, or spaces at both ends, from a string.
Other characters can be removed as well.
Thomas Mueller's avatar
Thomas Mueller committed
4131 4132 4133 4134 4135
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
4136
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
4137
","
4138
Replaces each substring that matches a regular expression.
4139
For details, see the Java ""String.replaceAll()"" method.
4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153
If any parameter is null (except optional flagsString parameter), the result is null.

Flags values limited to 'i', 'c', 'n', 'm'. Other symbols causes exception.
Multiple symbols could be uses in one flagsString parameter (like 'im').
Later flags overrides first ones, for example 'ic' equivalent to case sensitive matching 'c'.

'i' enables case insensitive matching (Pattern.CASE_INSENSITIVE)

'c' disables case insensitive matching (Pattern.CASE_INSENSITIVE)

'n' allows the period to match the newline character (Pattern.DOTALL)

'm' enables multiline mode (Pattern.MULTILINE)

Thomas Mueller's avatar
Thomas Mueller committed
4154 4155
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
4156
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
4157 4158
"

4159 4160 4161 4162
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177
For details, see the Java ""Matcher.find()"" method.
If any parameter is null (except optional flagsString parameter), the result is null.

Flags values limited to 'i', 'c', 'n', 'm'. Other symbols causes exception.
Multiple symbols could be uses in one flagsString parameter (like 'im').
Later flags overrides first ones, for example 'ic' equivalent to case sensitive matching 'c'.

'i' enables case insensitive matching (Pattern.CASE_INSENSITIVE)

'c' disables case insensitive matching (Pattern.CASE_INSENSITIVE)

'n' allows the period to match the newline character (Pattern.DOTALL)

'm' enables multiline mode (Pattern.MULTILINE)

4178 4179
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
4180 4181
"

4182

Thomas Mueller's avatar
Thomas Mueller committed
4183
"Functions (String)","REPEAT","
4184
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
4185 4186 4187 4188 4189 4190 4191
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
4192
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
4193
","
4194 4195
Replaces all occurrences of a search string in a text with another string.
If no replacement is specified, the search string is removed from the original string.
4196
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
4197 4198 4199 4200 4201
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
4202
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
4203
","
4204 4205 4206
Returns a four character code representing the sound of a string.
See also http://www.archives.gov/genealogy/census/soundex.html .
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4207 4208 4209 4210 4211
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
4212
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
4213 4214 4215 4216 4217 4218 4219
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
4220
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
4221
","
4222 4223 4224
Converts a encoded string using the Java string literal encoding format.
Special characters are \b, \t, \n, \f, \r, \"", \\, \<octal>, \u<unicode>.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4225 4226 4227 4228 4229
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
4230
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
4231
","
4232 4233 4234
Encodes special characters in a string using the Java string literal encoding format.
Special characters are \b, \t, \n, \f, \r, \"", \\, \<octal>, \u<unicode>.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4235 4236 4237 4238 4239
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
4240
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
4241 4242
","
Encodes a string to a byte array using the UTF8 encoding format.
4243
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
4244 4245 4246 4247 4248
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
4249
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
4250
","
4251
Returns a substring of a string starting at a position.
4252
If the start index is negative, then the start index is relative to the end of the string.
4253
The length is optional.
4254
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
4255
","
4256 4257
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
4258 4259 4260
"

"Functions (String)","UTF8TOSTRING","
4261
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
4262 4263 4264 4265 4266 4267 4268
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
4269
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
4270
","
4271
Creates an XML attribute element of the form ""name=value"".
4272 4273
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4274 4275 4276 4277 4278
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
4279
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
4280 4281
","
Create an XML node element.
4282 4283 4284
An empty or null attribute string means no attributes are set.
An empty or null content string means the node is empty.
The content is indented by default if it contains a newline.
4285
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4286 4287 4288 4289 4290
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
4291
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
4292
","
4293
Creates an XML comment.
4294
Two dashes (""--"") are converted to ""- -"".
4295
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4296 4297 4298 4299 4300
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
4301
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
4302
","
4303
Creates an XML CDATA element.
4304
If the value contains ""]]>"", an XML text element is created instead.
4305
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4306 4307 4308 4309 4310
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
4311
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
4312
","
Thomas Mueller's avatar
Thomas Mueller committed
4313
Returns the XML declaration.
4314
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
4315 4316 4317 4318 4319
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
4320
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
4321 4322
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
4323
If enabled, newline and linefeed is converted to an XML entity (&#).
4324
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4325 4326 4327 4328
","
CALL XMLTEXT('test')
"

4329
"Functions (String)","TO_CHAR","
4330
TO_CHAR(value [, formatString[, nlsParamString]])
4331 4332 4333 4334 4335 4336
","
Oracle-compatible TO_CHAR function that can format a timestamp, a number, or text.
","
CALL TO_CHAR(TIMESTAMP '2010-01-01 00:00:00', 'DD MON, YYYY')
"

4337
"Functions (String)","TRANSLATE","
4338
TRANSLATE(value, searchString, replacementString)
4339 4340 4341 4342 4343 4344
","
Oracle-compatible TRANSLATE function that replaces a sequence of characters in a string with another set of characters.
","
CALL TRANSLATE('Hello world', 'eo', 'EO')
"

Thomas Mueller's avatar
Thomas Mueller committed
4345
"Functions (Time and Date)","CURRENT_DATE","
4346
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
4347 4348
","
Returns the current date.
4349
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
4350 4351 4352 4353 4354
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
4355
{ CURRENT_TIME [ ( [ int ] ) ] | LOCALTIME [ ( [ int ] ) ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
4356 4357
","
Returns the current time.
4358 4359 4360 4361 4362
If fractional seconds precision is specified it should be from 0 to 9, 0 is default.
The specified value can be used only to limit precision of a result.
The actual maximum available precision depends on operating system and JVM and can be 3 (milliseconds) or higher.
Higher precision is not available before Java 9.
These methods always return the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
4363 4364 4365 4366 4367
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
4368 4369 4370 4371
CURRENT_TIMESTAMP [ ( [ int ] ) ]
","
Returns the current timestamp with time zone.
Time zone offset is set to a current time zone offset
4372
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
4373 4374 4375 4376 4377 4378 4379 4380 4381 4382
The specified value can be used only to limit precision of a result.
The actual maximum available precision depends on operating system and JVM and can be 3 (milliseconds) or higher.
Higher precision is not available before Java 9.
This method always returns the same value within a transaction.
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","LOCALTIMESTAMP","
{ LOCALTIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
4383
","
4384
Returns the current timestamp.
4385
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
4386 4387 4388 4389
The specified value can be used only to limit precision of a result.
The actual maximum available precision depends on operating system and JVM and can be 3 (milliseconds) or higher.
Higher precision is not available before Java 9.
These methods always return the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
4390
","
4391
LOCALTIMESTAMP()
Thomas Mueller's avatar
Thomas Mueller committed
4392 4393 4394
"

"Functions (Time and Date)","DATEADD","
4395
{ DATEADD| TIMESTAMPADD } (datetimeField, addIntLong, dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4396
","
4397
Adds units to a date-time value. The datetimeField indicates the unit.
4398
Use negative values to subtract units.
4399
addIntLong may be a long value when manipulating milliseconds,
4400
microseconds, or nanoseconds otherwise its range is restricted to int.
4401
This method returns a value with the same type as specified value if unit is compatible with this value.
4402 4403 4404
If specified field is a HOUR, MINUTE, SECOND, MILLISECOND, etc and value is a DATE value DATEADD returns combined TIMESTAMP.
Fields DAY, MONTH, YEAR, WEEK, etc are not allowed for TIME values.
Fields TIMEZONE_HOUR and TIMEZONE_MINUTE are only allowed for TIMESTAMP WITH TIME ZONE values.
Thomas Mueller's avatar
Thomas Mueller committed
4405 4406 4407 4408 4409
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
4410
{ DATEDIFF | TIMESTAMPDIFF } (datetimeField, aDateAndTime, bDateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4411
","
4412
Returns the the number of crossed unit boundaries between two date/time values.
4413
This method returns a long.
4414
The datetimeField indicates the unit.
4415 4416
Only TIMEZONE_HOUR and TIMEZONE_MINUTE fields use the time zone offset component.
With all other fields if date/time values have time zone offset component it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
4417 4418 4419 4420 4421
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
4422
DAYNAME(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4423 4424 4425 4426 4427 4428 4429
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
4430
DAY_OF_MONTH(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4431 4432 4433 4434 4435 4436 4437
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
4438
DAY_OF_WEEK(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4439 4440 4441 4442 4443 4444
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

4445 4446 4447 4448 4449 4450 4451 4452
"Functions (Time and Date)","ISO_DAY_OF_WEEK","
ISO_DAY_OF_WEEK(dateAndTime)
","
Returns the ISO day of the week (1 means Monday).
","
ISO_DAY_OF_WEEK(CREATED)
"

Thomas Mueller's avatar
Thomas Mueller committed
4453
"Functions (Time and Date)","DAY_OF_YEAR","
4454
DAY_OF_YEAR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4455 4456 4457 4458 4459 4460 4461
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
4462
EXTRACT ( datetimeField FROM { dateAndTime | interval })
Thomas Mueller's avatar
Thomas Mueller committed
4463
","
4464
Returns a value of the specific time unit from a date/time value.
4465 4466
This method returns a numeric value with EPOCH field and
an int for all other fields.
Thomas Mueller's avatar
Thomas Mueller committed
4467 4468 4469 4470 4471
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
4472
FORMATDATETIME ( dateAndTime, formatString
4473
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4474
","
4475 4476 4477
Formats a date, time or timestamp as a string.
The most important format characters are:
y year, M month, d day, H hour, m minute, s second.
4478
For details of the format, see ""java.text.SimpleDateFormat"".
4479 4480
timeZoneString may be specified if dateAndTime is a DATE, TIME or TIMESTAMP.
timeZoneString is ignored if dateAndTime is TIMESTAMP WITH TIME ZONE.
4481
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4482 4483 4484 4485 4486 4487
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
4488
HOUR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4489
","
4490
Returns the hour (0-23) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4491 4492 4493 4494 4495
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
4496
MINUTE(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4497
","
4498
Returns the minute (0-59) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4499 4500 4501 4502 4503
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
4504
MONTH(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4505
","
4506
Returns the month (1-12) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4507 4508 4509 4510 4511
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
4512
MONTHNAME(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4513 4514 4515 4516 4517 4518 4519
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
4520
PARSEDATETIME(string, formatString
4521
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
4522
","
4523 4524 4525
Parses a string and returns a timestamp.
The most important format characters are:
y year, M month, d day, H hour, m minute, s second.
4526
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
4527 4528 4529 4530 4531 4532
","
CALL PARSEDATETIME('Sat, 3 Feb 2001 03:05:06 GMT',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","QUARTER","
4533
QUARTER(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4534
","
4535
Returns the quarter (1-4) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4536 4537 4538 4539 4540
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
4541
SECOND(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4542
","
4543
Returns the second (0-59) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4544 4545 4546 4547 4548
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
4549
WEEK(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4550
","
4551
Returns the week (1-53) from a date/time value.
4552
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
4553 4554 4555 4556
","
WEEK(CREATED)
"

4557
"Functions (Time and Date)","ISO_WEEK","
4558
ISO_WEEK(dateAndTime)
4559
","
4560
Returns the ISO week (1-53) from a date/time value.
4561
This function uses the ISO definition when
4562 4563 4564 4565 4566 4567
first week of year should have at least four days
and week is started with Monday.
","
ISO_WEEK(CREATED)
"

Thomas Mueller's avatar
Thomas Mueller committed
4568
"Functions (Time and Date)","YEAR","
4569
YEAR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4570
","
4571
Returns the year from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4572 4573 4574 4575
","
YEAR(CREATED)
"

4576
"Functions (Time and Date)","ISO_YEAR","
4577
ISO_YEAR(dateAndTime)
4578
","
4579
Returns the ISO week year from a date/time value.
4580 4581 4582 4583
","
ISO_YEAR(CREATED)
"

Thomas Mueller's avatar
Thomas Mueller committed
4584
"Functions (System)","ARRAY_GET","
4585
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
4586 4587
","
Returns one element of an array.
4588
Returns NULL if there is no such element or array is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
4589 4590 4591 4592 4593
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
4594
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
4595 4596
","
Returns the length of an array.
4597
Returns NULL if the specified array is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
4598 4599 4600 4601
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

4602 4603 4604
"Functions (System)","ARRAY_CONTAINS","
ARRAY_CONTAINS(arrayExpression, value)
","
4605 4606
Returns a boolean TRUE if the array contains the value or FALSE if it does not contain it.
Returns NULL if the specified array is NULL.
4607 4608 4609 4610
","
CALL ARRAY_CONTAINS(('Hello', 'World'), 'Hello')
"

Thomas Mueller's avatar
Thomas Mueller committed
4611
"Functions (System)","AUTOCOMMIT","
4612
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
4613 4614 4615 4616 4617 4618 4619
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
4620
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
4621
","
4622 4623 4624
Cancels the currently executing statement of another session.
The method only works if the multithreaded kernel is enabled (see SET MULTI_THREADED).
Returns true if the statement was canceled, false if the session is closed or no statement is currently executing.
Thomas Mueller's avatar
Thomas Mueller committed
4625 4626

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4627 4628 4629 4630 4631
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
4632
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4633 4634
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
4635
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
4636 4637 4638 4639 4640
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
4641
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
4642
","
4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654
Converts a value to another data type. The following conversion rules are used:
When converting a number to a boolean, 0 is false and every other value is true.
When converting a boolean to a number, false is 0 and true is 1.
When converting a number to a number of another type, the value is checked for overflow.
When converting a number to binary, the number of bytes matches the precision.
When converting a string to binary, it is hex encoded (every byte two characters);
a hex string can be converted to a number by first converting it to binary.
If a direct conversion is not possible, the value is first converted to a string.
","
CAST(NAME AS INT);
CAST(65535 AS BINARY);
CAST(CAST('FFFF' AS BINARY) AS INT);
Thomas Mueller's avatar
Thomas Mueller committed
4655 4656 4657
"

"Functions (System)","COALESCE","
4658
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4659 4660 4661 4662 4663 4664 4665
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
4666
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
4667 4668 4669 4670 4671 4672 4673
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
4674
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4675
","
4676 4677 4678 4679 4680
Returns the current (last) value of the sequence, independent of the session.
If the sequence was just created, the method returns (start - interval).
If the schema name is not set, the current schema is used.
If the schema name is not set, the sequence name is converted to uppercase (for compatibility).
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4681 4682 4683 4684 4685
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
4686
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4687
","
4688 4689
Returns the result set of reading the CSV (comma separated values) file.
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
4690 4691

If the column names are specified (a list of column names separated with the
4692
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
4693 4694 4695 4696 4697
the file is interpreted as the column names.
In that case, column names that contain no special characters (only letters, '_',
and digits; similar to the rule for Java identifiers) are considered case insensitive.
Other column names are case sensitive, that means you need to use quoted identifiers
(see below).
Thomas Mueller's avatar
Thomas Mueller committed
4698 4699 4700 4701 4702

The default charset is the default value for this system, and the default field separator
is a comma. Missing unquoted values as well as data that matches nullString is
parsed as NULL. All columns of type VARCHAR.

4703 4704
The BOM (the byte-order-mark) character 0xfeff at the beginning of the file is ignored.

4705
This function can be used like a table: ""SELECT * FROM CSVREAD(...)"".
4706

Thomas Mueller's avatar
Thomas Mueller committed
4707
Instead of a file, an URL may be used, for example
4708 4709
""jar:file:///c:/temp/example.zip!/org/example/nested.csv"".
To read a stream from the classpath, use the prefix ""classpath:"".
Thomas Mueller's avatar
Thomas Mueller committed
4710
To read from HTTP, use the prefix ""http:"" (as in a browser).
4711

Thomas Mueller's avatar
Thomas Mueller committed
4712 4713 4714
For performance reason, CSVREAD should not be used inside a join.
Instead, import the data first (possibly into a temporary table) and then use the table.

Thomas Mueller's avatar
Thomas Mueller committed
4715 4716 4717 4718
Admin rights are required to execute this command.
","
CALL CSVREAD('test.csv');
-- Read a file containing the columns ID, NAME with
Thomas Mueller's avatar
Thomas Mueller committed
4719 4720 4721 4722
CALL CSVREAD('test2.csv', 'ID|NAME', 'charset=UTF-8 fieldSeparator=|');
SELECT * FROM CSVREAD('data/test.csv', null, 'rowSeparator=;');
-- Read a tab-separated file
SELECT * FROM CSVREAD('data/test.tsv', null, 'rowSeparator=' || CHAR(9));
Thomas Mueller's avatar
Thomas Mueller committed
4723
SELECT ""Last Name"" FROM CSVREAD('address.csv');
4724
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
4725 4726 4727
"

"Functions (System)","CSVWRITE","
4728
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4729
","
4730
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
4731
If only a file name is specified, it will be written to the current working directory.
4732
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
4733
The default charset is the default value for this system, and the default field separator is a comma.
Thomas Mueller's avatar
Thomas Mueller committed
4734 4735 4736 4737 4738

The values are converted to text using the default string representation;
if another conversion is required you need to change the select statement accordingly.
The parameter nullString is used when writing NULL (by default nothing is written
when NULL appears). The default line separator is the default value for this
4739
system (system property ""line.separator"").
Thomas Mueller's avatar
Thomas Mueller committed
4740

Thomas Mueller's avatar
Thomas Mueller committed
4741 4742
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4743
","
Thomas Mueller's avatar
Thomas Mueller committed
4744 4745 4746 4747
CALL CSVWRITE('data/test.csv', 'SELECT * FROM TEST');
CALL CSVWRITE('data/test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
-- Write a tab-separated file
CALL CSVWRITE('data/test.tsv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=' || CHAR(9));
Thomas Mueller's avatar
Thomas Mueller committed
4748 4749 4750
"

"Functions (System)","DATABASE","
4751
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
4752 4753 4754 4755 4756 4757 4758
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
4759
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
4760
","
Thomas Mueller's avatar
Thomas Mueller committed
4761 4762
Returns the directory of the database files and the database name, if it is file based.
Returns NULL otherwise.
Thomas Mueller's avatar
Thomas Mueller committed
4763 4764 4765 4766
","
CALL DATABASE_PATH();
"

4767
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
4768
DECODE(value, whenValue, thenValue [,...])
4769 4770 4771 4772 4773 4774 4775 4776
","
Returns the first matching value. NULL is considered to match NULL.
If no match was found, then NULL or the last parameter (if the parameter count is even) is returned.
This function is provided for Oracle compatibility (see there for details).
","
CALL DECODE(RAND()>0.5, 0, 'Red', 1, 'Black');
"

4777
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
4778
DISK_SPACE_USED(tableNameString)
4779 4780 4781 4782 4783 4784 4785 4786
","
Returns the approximate amount of space used by the table specified.
Does not currently take into account indexes or LOB's.
This function may be expensive since it has to load every page in the table.
","
CALL DISK_SPACE_USED('my_table');
"

4787
"Functions (System)","SIGNAL","
4788
SIGNAL(sqlStateString, messageString)
4789 4790 4791 4792 4793 4794
","
Throw an SQLException with the passed SQLState and reason.
","
CALL SIGNAL('23505', 'Duplicate user ID: ' || user_id);
"

4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811
"Functions (System)","ESTIMATED_ENVELOPE","
ESTIMATED_ENVELOPE(tableNameString, columnNameString)
","
Returns the estimated minimum bounding box that encloses all specified GEOMETRY values.
Only 2D coordinate plane is supported.
NULL values are ignored.
This function is only supported by MVStore engine.
Column must have a spatial index.
This function is fast, but estimation may include uncommitted data (including data from other transactions),
may return approximate bounds, or be different with actual value due to other reasons.
Use with caution.
If estimation is not available this function returns NULL.
For accurate and reliable result use ESTIMATE aggregate function instead.
","
CALL ESTIMATED_ENVELOPE('MY_TABLE', 'GEOMETRY_COLUMN');
"

Thomas Mueller's avatar
Thomas Mueller committed
4812
"Functions (System)","FILE_READ","
4813
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
4814 4815 4816 4817
","
Returns the contents of a file. If only one parameter is supplied, the data are
returned as a BLOB. If two parameters are used, the data is returned as a CLOB
(text). The second parameter is the character set to use, NULL meaning the
4818
default character set for this system.
4819 4820 4821 4822

File names and URLs are supported.
To read a stream from the classpath, use the prefix ""classpath:"".

Thomas Mueller's avatar
Thomas Mueller committed
4823
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4824 4825 4826 4827 4828
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

4829
"Functions (System)","FILE_WRITE","
4830
FILE_WRITE(blobValue, fileNameString)
4831 4832 4833 4834 4835 4836 4837 4838
","
Write the supplied parameter into a file. Return the number of bytes written.

Write access to folder, and admin rights are required to execute this command.
","
SELECT FILE_WRITE('Hello world', '/tmp/hello.txt')) LEN;
"

Thomas Mueller's avatar
Thomas Mueller committed
4839
"Functions (System)","GREATEST","
4840
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4841 4842 4843 4844 4845 4846 4847
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
4848
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
4849 4850
","
Returns the last inserted identity value for this session.
4851
This value changes whenever a new sequence number was generated,
4852
even within a trigger or Java function. See also SCOPE_IDENTITY.
4853
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4854 4855 4856 4857 4858
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
4859
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4860 4861 4862 4863 4864 4865 4866
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
4867
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4868 4869 4870 4871 4872 4873 4874
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
4875
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
4876 4877
","
Returns the current lock mode. See SET LOCK_MODE.
4878
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4879 4880 4881 4882 4883
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
4884
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
4885 4886 4887 4888 4889 4890 4891 4892
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
4893
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
4894
","
4895 4896 4897 4898 4899
Creates table links for all tables in a schema.
If tables with the same name already exist, they are dropped first.
The target schema is created automatically if it does not yet exist.
The driver name may be empty if the driver is already loaded.
The list of tables linked is returned in the form of a result set.
Thomas Mueller's avatar
Thomas Mueller committed
4900
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4901 4902 4903 4904 4905
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
4906
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
4907
","
Thomas Mueller's avatar
Thomas Mueller committed
4908
Returns the free memory in KB (where 1024 bytes is a KB).
4909
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4910 4911
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4912 4913 4914 4915 4916
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
4917
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
4918
","
Thomas Mueller's avatar
Thomas Mueller committed
4919
Returns the used memory in KB (where 1024 bytes is a KB).
4920
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4921 4922
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4923 4924 4925 4926 4927
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
4928
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4929
","
4930 4931 4932 4933
Returns the next value of the sequence.
Used values are never re-used, even when the transaction is rolled back.
If the schema name is not set, the current schema is used, and the sequence name is converted to uppercase (for compatibility).
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4934 4935 4936 4937 4938
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
4939
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4940 4941 4942 4943 4944 4945
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4946 4947 4948 4949
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4950
The data type of the returned value is the data type of 'a' if this is a text type.
4951 4952 4953 4954
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4955
"Functions (System)","READONLY","
4956
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4957 4958 4959 4960 4961 4962 4963
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
4964
ROWNUM()
Thomas Mueller's avatar
Thomas Mueller committed
4965
","
4966
Returns the number of the current row.
4967
This method returns an integer value.
4968
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4969
The first row has the row number 1, and is calculated before ordering and grouping the result set,
4970
but after evaluating index conditions (even when the index conditions are specified in an outer query).
4971
Use the ROW_NUMBER() OVER () function to get row numbers after grouping or in specified order.
Thomas Mueller's avatar
Thomas Mueller committed
4972
","
4973 4974
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4975
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4976 4977 4978
"

"Functions (System)","SCHEMA","
4979
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4980
","
4981
Returns the name of the default schema for this session.
Thomas Mueller's avatar
Thomas Mueller committed
4982 4983 4984 4985
","
CALL SCHEMA()
"

4986 4987 4988
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4989
Returns the last inserted identity value for this session for the current scope
4990
(the current statement).
4991 4992 4993 4994 4995 4996
Changes within triggers and Java functions are ignored. See also IDENTITY().
This method returns a long.
","
CALL SCOPE_IDENTITY();
"

Thomas Mueller's avatar
Thomas Mueller committed
4997
"Functions (System)","SESSION_ID","
4998
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4999
","
5000 5001 5002 5003
Returns the unique session id number for the current database connection.
This id stays the same while the connection is open.
This method returns an int.
The database engine may re-use a session id after the connection is closed.
Thomas Mueller's avatar
Thomas Mueller committed
5004 5005 5006 5007 5008
","
CALL SESSION_ID()
"

"Functions (System)","SET","
5009
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
5010
","
5011 5012 5013
Updates a variable with the given value.
The new value is returned.
When used in a query, the value is updated in the order the rows are read.
Thomas Mueller's avatar
Thomas Mueller committed
5014
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
5015
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
5016 5017 5018 5019 5020
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
5021
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
5022 5023 5024 5025 5026 5027 5028
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
5029
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
5030
","
5031 5032
Returns the current transaction id for this session.
This method returns NULL if there is no uncommitted change, or if the the database is not persisted.
Thomas Mueller's avatar
Thomas Mueller committed
5033
Otherwise a value of the following form is returned:
5034
""logFileId-position-sessionId"".
5035 5036
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
5037 5038 5039 5040
","
CALL TRANSACTION_ID()
"

5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052
"Functions (System)","TRUNCATE_VALUE","
TRUNCATE_VALUE(value, precisionInt, forceBoolean)
","
Truncate a value to the required precision.
The precision of the returned value may be a bit larger than requested,
because fixed precision values are not truncated (unlike the numeric TRUNCATE method).
Unlike CAST, the truncating a decimal value may lose precision if the force flag is set to true.
The method returns a value with the same data type as the first parameter.
","
CALL TRUNCATE_VALUE(X, 10, TRUE);
"

Thomas Mueller's avatar
Thomas Mueller committed
5053
"Functions (System)","USER","
5054
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
5055 5056 5057 5058 5059 5060
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

5061 5062 5063 5064 5065 5066 5067 5068
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107
"Functions (Window)","ROW_NUMBER","
ROW_NUMBER() OVER windowSpecification
","
Returns the number of the current row starting with 1.

Window functions are currently experimental in H2 and should be used with caution.
They also may require a lot of memory for large queries.
","
SELECT ROW_NUMBER() OVER (), * FROM TEST;
SELECT ROW_NUMBER() OVER (ORDER BY ID), * FROM TEST;
SELECT ROW_NUMBER() OVER (PARTITION BY CATEGORY ORDER BY ID), * FROM TEST;
"

"Functions (Window)","RANK","
RANK() OVER windowSpecification
","
Returns the rank of the current row.
The rank of a row is the number of rows that precede this row plus 1.
If two or more rows have the same values in ORDER BY columns, these rows get the same rank from the first row with the same values.
It means that gaps in ranks are possible.

Window functions are currently experimental in H2 and should be used with caution.
They also may require a lot of memory for large queries.
","
SELECT RANK() OVER (ORDER BY ID), * FROM TEST;
SELECT RANK() OVER (PARTITION BY CATEGORY ORDER BY ID), * FROM TEST;
"

"Functions (Window)","DENSE_RANK","
DENSE_RANK() OVER windowSpecification
","
Returns the dense rank of the current row.
The rank of a row is the number of groups of rows with the same values in ORDER BY columns that precede group with this row plus 1.
If two or more rows have the same values in ORDER BY columns, these rows get the same rank.
Gaps in ranks are not possible.

Window functions are currently experimental in H2 and should be used with caution.
They also may require a lot of memory for large queries.
","
5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138
SELECT DENSE_RANK() OVER (ORDER BY ID), * FROM TEST;
SELECT DENSE_RANK() OVER (PARTITION BY CATEGORY ORDER BY ID), * FROM TEST;
"

"Functions (Window)","PERCENT_RANK","
PERCENT_RANK() OVER windowSpecification
","
Returns the relative rank of the current row.
The relative rank is calculated as (RANK - 1) / (NR - 1),
where RANK is a rank of the row and NR is a number of rows in window partition with this row.

Window functions are currently experimental in H2 and should be used with caution.
They also may require a lot of memory for large queries.
","
SELECT PERCENT_RANK() OVER (ORDER BY ID), * FROM TEST;
SELECT PERCENT_RANK() OVER (PARTITION BY CATEGORY ORDER BY ID), * FROM TEST;
"

"Functions (Window)","CUME_DIST","
CUME_DIST() OVER windowSpecification
","
Returns the relative rank of the current row.
The relative rank is calculated as NP / NR
where NP is a number of rows that precede the current row or have the same values in ORDER BY columns
and NR is a number of rows in window partition with this row.

Window functions are currently experimental in H2 and should be used with caution.
They also may require a lot of memory for large queries.
","
SELECT CUME_DIST() OVER (ORDER BY ID), * FROM TEST;
SELECT CUME_DIST() OVER (PARTITION BY CATEGORY ORDER BY ID), * FROM TEST;
5139 5140
"

Thomas Mueller's avatar
Thomas Mueller committed
5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155
"System Tables","Information Schema","
INFORMATION_SCHEMA
","
To get the list of system tables, execute the statement SELECT * FROM
INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = 'INFORMATION_SCHEMA'
","

"
"System Tables","Range Table","
SYSTEM_RANGE(start, end)
","
Contains all values from start to end (this is a dynamic table).
","
SYSTEM_RANGE(0, 100)
"
Thomas Mueller's avatar
Thomas Mueller committed
5156