help.csv 139.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 7
SELECT [ TOP term [ WITH TIES ] ]
[ DISTINCT [ ON ( expression [,...] ) ] | ALL ]
8
selectExpression [,...]
9 10
FROM tableExpression [,...] [ WHERE expression ]
[ GROUP BY expression [,...] ] [ HAVING expression ]
11 12 13 14
[ { UNION [ ALL ] | MINUS | EXCEPT | INTERSECT } select ]
[ ORDER BY order [,...] ]
[ { LIMIT expression [ OFFSET expression ] [ SAMPLE_SIZE rowCountInt ] }
    | { [ OFFSET expression { ROW | ROWS } ]
15 16
    [ FETCH { FIRST | NEXT } expression { ROW | ROWS }
        { ONLY | WITH TIES } ] } ]
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
LIMIT and FETCH FIRST/NEXT ROW(S) ONLY limits the number of rows returned by the query (no limit if null or smaller than zero).
Thomas Mueller's avatar
Thomas Mueller committed
26
OFFSET specified how many rows to skip.
27
Please note using high offset values should be avoided because it can cause performance problems.
28
SAMPLE_SIZE limits the number of rows read for aggregate queries.
29

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

34 35
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
36
In this case, aggregate, GROUP BY, DISTINCT queries or joins
37
are not allowed in this case.
Thomas Mueller's avatar
Thomas Mueller committed
38 39
","
SELECT * FROM TEST;
40 41 42 43 44
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;
SELECT * FROM TEST LIMIT 1000;
Thomas Mueller's avatar
Thomas Mueller committed
45 46 47
SELECT * FROM (SELECT ID, COUNT(*) FROM TEST
    GROUP BY ID UNION SELECT NULL, COUNT(*) FROM TEST)
    ORDER BY 1 NULLS LAST;
48 49
SELECT DISTINCT C1, C2 FROM TEST;
SELECT DISTINCT ON(C1) C1, C2 FROM TEST ORDER BY C1;
Thomas Mueller's avatar
Thomas Mueller committed
50 51 52
"

"Commands (DML)","INSERT","
53
INSERT INTO tableName insertColumnsAndSource
Thomas Mueller's avatar
Thomas Mueller committed
54 55
","
Inserts a new row / new rows into a table.
56 57 58 59

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
60 61 62 63 64
","
INSERT INTO TEST VALUES(1, 'Hello')
"

"Commands (DML)","UPDATE","
65
UPDATE tableName [ [ AS ] newTableAlias ] SET setClauseList
66
[ WHERE expression ] [ ORDER BY order [,...] ] [ LIMIT expression ]
Thomas Mueller's avatar
Thomas Mueller committed
67 68
","
Updates data in a table.
69
ORDER BY is supported for MySQL compatibility, but it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
70
","
71 72
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
73 74 75
"

"Commands (DML)","DELETE","
76
DELETE [ TOP term ] FROM tableName deleteSearchCondition
Thomas Mueller's avatar
Thomas Mueller committed
77 78
","
Deletes rows form a table.
79
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
80 81 82 83 84 85 86
","
DELETE FROM TEST WHERE ID=2
"

"Commands (DML)","BACKUP","
BACKUP TO fileNameString
","
Thomas Mueller's avatar
Thomas Mueller committed
87 88
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
89
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
90 91 92 93 94 95 96
","
BACKUP TO 'backup.zip'
"

"Commands (DML)","CALL","
CALL expression
","
Thomas Mueller's avatar
Thomas Mueller committed
97 98 99
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
100 101 102 103 104
","
CALL 15*25
"

"Commands (DML)","EXPLAIN","
105 106
EXPLAIN { [ PLAN FOR ] | ANALYZE }
{ select | insert | update | delete | merge }
Thomas Mueller's avatar
Thomas Mueller committed
107 108
","
Shows the execution plan for a statement.
109 110
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
111 112 113 114 115
","
EXPLAIN SELECT * FROM TEST WHERE ID=1
"

"Commands (DML)","MERGE","
116 117
MERGE INTO tableName [ ( columnName [,...] ) ]
[ KEY ( columnName [,...] ) ]
118
{ VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | select }
Thomas Mueller's avatar
Thomas Mueller committed
119 120 121
","
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
122
row per new row is affected, an exception is thrown.
Thomas Mueller's avatar
Thomas Mueller committed
123 124 125 126
","
MERGE INTO TEST KEY(ID) VALUES(2, 'World')
"

Owner's avatar
Owner committed
127
"Commands (DML)","MERGE USING","
128 129
MERGE INTO targetTableName [ [AS] targetAlias]
USING { ( select ) | sourceTableName }[ [AS] sourceAlias ]
130
ON expression
131
[ WHEN MATCHED THEN
132
    [ UPDATE SET setClauseList ] [ DELETE deleteSearchCondition ] ]
133
[ WHEN NOT MATCHED THEN INSERT insertColumnsAndSource ]
134 135 136 137 138 139
","
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
140 141 142
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.
143
If statement doesn't need a source table a DUAL table can be substituted.
Owner's avatar
Owner committed
144
","
145
MERGE INTO TARGET_TABLE AS T USING SOURCE_TABLE AS S
146
    ON T.ID = S.ID
147 148 149 150 151 152
    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
153
    ON T.ID = S.ID
154 155 156 157 158
    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)
159
MERGE INTO TARGET_TABLE USING DUAL ON ID = 1
160 161
    WHEN NOT MATCHED THEN INSERT (ID, NAME) VALUES (1, 'Test')
    WHEN MATCHED THEN UPDATE SET NAME = 'Test'
Owner's avatar
Owner committed
162 163
"

Thomas Mueller's avatar
Thomas Mueller committed
164
"Commands (DML)","RUNSCRIPT","
165 166
RUNSCRIPT FROM fileNameString scriptCompressionEncryption
[ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
167 168 169 170 171 172
","
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.

173
Instead of a file name, an URL may be used.
174
To read a stream from the classpath, use the prefix 'classpath:'.
175
See the Pluggable File System section on the Advanced page.
176

177
The compression algorithm must match the one used when creating the script.
Thomas Mueller's avatar
Thomas Mueller committed
178 179 180
Instead of a file, an URL may be used.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
181
","
182
RUNSCRIPT FROM 'backup.sql'
183
RUNSCRIPT FROM 'classpath:/com/acme/test.sql'
Thomas Mueller's avatar
Thomas Mueller committed
184 185 186
"

"Commands (DML)","SCRIPT","
187 188
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
189
[ TO fileNameString scriptCompressionEncryption
190
    [ CHARSET charsetString ] ]
191 192
[ TABLE tableName [, ...] ]
[ SCHEMA schemaName [, ...] ]
Thomas Mueller's avatar
Thomas Mueller committed
193
","
194 195 196 197 198 199 200
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
201 202
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
203
out-of-line commands.
Thomas Mueller's avatar
Thomas Mueller committed
204
NOSETTINGS turns off dumping the database settings (the SET XXX commands)
205

206
If no 'TO fileName' clause is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
207 208 209 210
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.

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

Thomas Mueller's avatar
Thomas Mueller committed
215 216 217
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
218
Admin rights are required to execute this command.
219

220
When using the TABLE or SCHEMA option, only the selected table(s) / schema(s) are included.
Thomas Mueller's avatar
Thomas Mueller committed
221 222 223 224 225
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
226 227
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
228 229 230 231 232 233
","
Lists the schemas, tables, or the columns of a table.
","
SHOW TABLES
"

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

Example 2:
WITH cte1 AS (
255
        SELECT 1 AS FIRST_COLUMN
256 257
), cte2 AS (
        SELECT FIRST_COLUMN+1 AS FIRST_COLUMN FROM cte1
258
)
259
SELECT sum(FIRST_COLUMN) FROM cte2;
260 261
"

Thomas Mueller's avatar
Thomas Mueller committed
262
"Commands (DDL)","ALTER INDEX RENAME","
263
ALTER INDEX [ IF EXISTS ] indexName RENAME TO newIndexName
Thomas Mueller's avatar
Thomas Mueller committed
264
","
Thomas Mueller's avatar
Thomas Mueller committed
265
Renames an index.
Thomas Mueller's avatar
Thomas Mueller committed
266
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
267 268 269 270
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

271
"Commands (DDL)","ALTER SCHEMA RENAME","
272
ALTER SCHEMA [ IF EXISTS ] schema RENAME TO newSchemaName
273 274
","
Renames a schema.
Thomas Mueller's avatar
Thomas Mueller committed
275
This command commits an open transaction in this connection.
276 277 278 279
","
ALTER SCHEMA TEST RENAME TO PRODUCTION
"

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

"Commands (DDL)","ALTER TABLE ADD","
297
ALTER TABLE [ IF EXISTS ] tableName ADD [ COLUMN ]
298 299
{ [ IF NOT EXISTS ] columnName columnDefinition
    | ( { columnName columnDefinition | constraint } [,...] ) }
300
[ { { BEFORE | AFTER } columnName } | FIRST ]
Thomas Mueller's avatar
Thomas Mueller committed
301
","
Thomas Mueller's avatar
Thomas Mueller committed
302
Adds a new column to a table.
Thomas Mueller's avatar
Thomas Mueller committed
303
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
304 305 306 307 308
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
309
ALTER TABLE [ IF EXISTS ] tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
310 311 312
","
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
313
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
314
It is not possible to disable checking for unique constraints.
Thomas Mueller's avatar
Thomas Mueller committed
315
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
316 317 318 319
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

320
"Commands (DDL)","ALTER TABLE RENAME CONSTRAINT","
321 322
ALTER TABLE [ IF EXISTS ] tableName RENAME oldConstraintName
TO newConstraintName
323 324 325 326 327 328 329
","
Renames a constraint.
This command commits an open transaction in this connection.
","
ALTER TABLE TEST RENAME CONSTRAINT FOO TO BAR
"

330
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
331
ALTER TABLE [ IF EXISTS ] tableName ALTER COLUMN columnName
332
{ { columnDefinition }
333 334 335 336
    | { RENAME TO name }
    | { RESTART WITH long }
    | { SELECTIVITY int }
    | { SET DEFAULT expression }
337
    | { SET ON UPDATE expression }
338
    | { SET NULL }
339
    | { SET NOT NULL }
340 341
    | { SET { VISIBLE | INVISIBLE } }
    | { DROP { DEFAULT | ON UPDATE } } }
Thomas Mueller's avatar
Thomas Mueller committed
342
","
343 344
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
345

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

348 349 350
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
351

352 353 354 355
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
356

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

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

361
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
362
Single column indexes on this column are dropped.
363 364 365

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

366 367 368
SET INVISIBLE makes the column hidden, i.e. it will not appear in SELECT * results.
SET VISIBLE has the reverse effect.

369 370 371 372
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
373
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
374
","
375 376 377 378 379 380 381
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;
382 383
ALTER TABLE TEST ALTER COLUMN NAME SET VISIBLE;
ALTER TABLE TEST ALTER COLUMN NAME SET INVISIBLE;
Thomas Mueller's avatar
Thomas Mueller committed
384 385 386
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
387
ALTER TABLE [ IF EXISTS ] tableName DROP COLUMN [ IF EXISTS ]
388
columnName [,...] | ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
389
","
390
Removes column(s) from a table.
Thomas Mueller's avatar
Thomas Mueller committed
391
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
392 393
","
ALTER TABLE TEST DROP COLUMN NAME
394
ALTER TABLE TEST DROP COLUMN NAME1, NAME2
395
ALTER TABLE TEST DROP COLUMN (NAME1, NAME2)
Thomas Mueller's avatar
Thomas Mueller committed
396 397 398
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
399 400
ALTER TABLE [ IF EXISTS ] tableName DROP
{ CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
401 402
","
Removes a constraint or a primary key from a table.
Thomas Mueller's avatar
Thomas Mueller committed
403
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
404 405 406 407 408
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
409
ALTER TABLE [ IF EXISTS ] tableName SET REFERENTIAL_INTEGRITY
410
{ FALSE | TRUE } [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
411 412 413 414 415 416
","
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.
417

Thomas Mueller's avatar
Thomas Mueller committed
418
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
419 420 421 422 423
","
ALTER TABLE TEST SET REFERENTIAL_INTEGRITY FALSE
"

"Commands (DDL)","ALTER TABLE RENAME","
424
ALTER TABLE [ IF EXISTS ] tableName RENAME TO newName
Thomas Mueller's avatar
Thomas Mueller committed
425
","
Thomas Mueller's avatar
Thomas Mueller committed
426
Renames a table.
Thomas Mueller's avatar
Thomas Mueller committed
427
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
428 429 430 431 432
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
433
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
434
","
Thomas Mueller's avatar
Thomas Mueller committed
435 436 437 438
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
439
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
440 441 442 443 444 445 446
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
447 448 449 450
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
451
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
452
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
453 454 455 456 457
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
458
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
459
","
Thomas Mueller's avatar
Thomas Mueller committed
460 461 462 463 464 465
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
466
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
467 468 469 470
","
ALTER USER SA SET PASSWORD 'rioyxlgt'
"

471
"Commands (DDL)","ALTER VIEW RECOMPILE","
472
ALTER VIEW [ IF EXISTS ] viewName RECOMPILE
Thomas Mueller's avatar
Thomas Mueller committed
473 474
","
Recompiles a view after the underlying tables have been changed or created.
Thomas Mueller's avatar
Thomas Mueller committed
475
This command is used for views created using CREATE FORCE VIEW.
Thomas Mueller's avatar
Thomas Mueller committed
476
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
477 478 479 480
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

481 482 483 484 485 486 487 488 489
"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
490
"Commands (DDL)","ANALYZE","
491
ANALYZE [ TABLE tableName ] [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
492
","
493 494 495
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
496 497 498 499 500
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.
501

Thomas Mueller's avatar
Thomas Mueller committed
502
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
503 504 505 506 507
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
508 509 510 511 512
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
513
","
Thomas Mueller's avatar
Thomas Mueller committed
514 515 516
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
517
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
518 519 520 521 522
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
523
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
524 525 526
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
527
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
528 529

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
530
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
531
","
532
CREATE AGGREGATE SIMPLE_MEDIAN FOR ""com.acme.db.Median""
Thomas Mueller's avatar
Thomas Mueller committed
533 534 535
"

"Commands (DDL)","CREATE ALIAS","
Thomas Mueller's avatar
Thomas Mueller committed
536
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
Thomas Mueller's avatar
Thomas Mueller committed
537
[ NOBUFFER ] { FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
538
","
539 540 541 542 543 544
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.
545 546 547

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

553 554
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.
555 556
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
557 558
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
559

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

563
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
564 565 566
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.
567

Thomas Mueller's avatar
Thomas Mueller committed
568
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
569
This command commits an open transaction in this connection.
570 571

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
572 573 574 575 576
","
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');
577 578
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
579 580 581 582 583
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
584 585 586
"

"Commands (DDL)","CREATE CONSTANT","
587
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
588
","
Thomas Mueller's avatar
Thomas Mueller committed
589
Creates a new constant.
Thomas Mueller's avatar
Thomas Mueller committed
590
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
591 592 593 594 595
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
596 597 598
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
599 600
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
601
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
602
to the value being tested.
603

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

Thomas Mueller's avatar
Thomas Mueller committed
606
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
607 608 609 610 611
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
612
CREATE
Thomas Mueller's avatar
Thomas Mueller committed
613
{ [ UNIQUE ] [ HASH | SPATIAL] INDEX [ [ IF NOT EXISTS ] newIndexName ]
614 615
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
616
","
Thomas Mueller's avatar
Thomas Mueller committed
617
Creates a new index.
Thomas Mueller's avatar
Thomas Mueller committed
618
This command commits an open transaction in this connection.
619

Thomas Mueller's avatar
Thomas Mueller committed
620
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
621 622
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
623
Non-unique keys are supported.
624
Spatial indexes are supported only on Geometry columns.
Thomas Mueller's avatar
Thomas Mueller committed
625 626 627 628 629
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
630
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ]
Thomas Mueller's avatar
Thomas Mueller committed
631
LINKED TABLE [ IF NOT EXISTS ]
632 633
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
634 635 636 637 638
","
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.

639 640 641
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
642 643
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
644
work. Linked tables to the same database share one connection.
645

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

Thomas Mueller's avatar
Thomas Mueller committed
648 649 650
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).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
658
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
659
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
660
","
661 662
CREATE LINKED TABLE LINK('org.h2.Driver', 'jdbc:h2:test2',
    'sa', 'sa', 'TEST');
Thomas Mueller's avatar
Thomas Mueller committed
663 664 665
CREATE LINKED TABLE LINK('', 'jdbc:h2:test2', 'sa', 'sa',
    '(SELECT * FROM TEST WHERE ID>0)');
CREATE LINKED TABLE LINK('javax.naming.InitialContext',
666 667
    'java:comp/env/jdbc/Test', NULL, NULL,
    '(SELECT * FROM TEST WHERE ID>0)');
Thomas Mueller's avatar
Thomas Mueller committed
668 669 670
"

"Commands (DDL)","CREATE ROLE","
671
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
672
","
Thomas Mueller's avatar
Thomas Mueller committed
673
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
674
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
675 676 677 678 679
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
680 681
CREATE SCHEMA [ IF NOT EXISTS ] name
[ AUTHORIZATION ownerUserName ]
682
[ WITH tableEngineParamName [,...] ]
Thomas Mueller's avatar
Thomas Mueller committed
683 684 685
","
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
686
Specifying the owner currently has no effect.
687 688
Optional table engine parameters are used when CREATE TABLE command
is run on this schema without having its engine params set.
689

Thomas Mueller's avatar
Thomas Mueller committed
690
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
691 692 693 694 695
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
696 697
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName
[ START WITH long ]
698 699 700
[ INCREMENT BY long ]
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
701 702
[ CYCLE long | NOCYCLE | NO CYCLE ]
[ CACHE long | NOCACHE | NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
703
","
Thomas Mueller's avatar
Thomas Mueller committed
704 705 706
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
707 708 709 710 711

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
712

Thomas Mueller's avatar
Thomas Mueller committed
713
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
714 715 716 717 718
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
719 720
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
721
[ ( { columnName columnDefinition | constraint } [,...] ) ]
722 723
[ ENGINE tableEngineName ]
[ WITH tableEngineParamName [,...] ]
724
[ NOT PERSISTENT ] [ TRANSACTIONAL ]
725
[ AS select [ WITH [ NO ] DATA ] ]","
Thomas Mueller's avatar
Thomas Mueller committed
726 727
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
728 729 730 731
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
732
that means memory tables should not get too large.
733

Thomas Mueller's avatar
Thomas Mueller committed
734 735 736 737 738
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,
739
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
740

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

745 746 747
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.

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

751 752
The column definition is optional if a query is specified.
In that case the column list of the query is used.
753
If the query is specified its results are inserted into created table unless WITH NO DATA is specified.
754

Thomas Mueller's avatar
Thomas Mueller committed
755 756
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
757 758 759 760 761
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
762 763 764 765 766 767
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
768
","
Thomas Mueller's avatar
Thomas Mueller committed
769 770 771 772 773
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).
774

775 776
The sourceCodeString must define a single method with no parameters that returns ""org.h2.api.Trigger"".
See CREATE ALIAS for requirements regarding the compilation.
777 778 779
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"".
780

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

Thomas Mueller's avatar
Thomas Mueller committed
786
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
787
Only row based AFTER trigger can be called on ROLLBACK.
788
Exceptions that occur within such triggers are ignored.
789 790
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.
791

792
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
793
Only the first such trigger is called. Such triggers on views are supported.
794
They can be used to make views updatable.
795

Thomas Mueller's avatar
Thomas Mueller committed
796 797
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.
798 799
The trigger is called with both 'old' and 'new' set to null.

800 801 802 803
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
804 805
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
806 807 808
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.

809 810
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

Thomas Mueller's avatar
Thomas Mueller committed
811 812
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.
813

Thomas Mueller's avatar
Thomas Mueller committed
814
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
815
","
816
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger"";
Thomas Mueller's avatar
Thomas Mueller committed
817
CREATE TRIGGER TRIG_SRC BEFORE INSERT ON TEST AS $$org.h2.api.Trigger create() { return new MyTrigger(""constructorParam""); } $$;
818 819
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
820 821
"
"Commands (DDL)","CREATE USER","
822 823
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
824
","
Thomas Mueller's avatar
Thomas Mueller committed
825 826 827
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.
828

Thomas Mueller's avatar
Thomas Mueller committed
829
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
830
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
831 832 833 834 835
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
836
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
837
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
838 839
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
840
if the underlying table(s) don't exist.
841

Thomas Mueller's avatar
Thomas Mueller committed
842 843 844 845 846
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.

847 848
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
849
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
850
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
851 852 853 854 855
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
856
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
857
","
Thomas Mueller's avatar
Thomas Mueller committed
858 859 860
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
861
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
862
","
863
DROP AGGREGATE SIMPLE_MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
864 865 866
"

"Commands (DDL)","DROP ALIAS","
867
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
868
","
Thomas Mueller's avatar
Thomas Mueller committed
869 870 871
Drops an existing function alias.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
872
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
873
","
Thomas Mueller's avatar
Thomas Mueller committed
874
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
875 876 877
"

"Commands (DDL)","DROP ALL OBJECTS","
878
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
879 880 881 882 883
","
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
884 885 886
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
887 888 889 890 891
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
892
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
893
","
Thomas Mueller's avatar
Thomas Mueller committed
894
Drops a constant.
Thomas Mueller's avatar
Thomas Mueller committed
895
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
896 897 898 899 900
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
901
DROP DOMAIN [ IF EXISTS ] domainName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
902
","
Thomas Mueller's avatar
Thomas Mueller committed
903
Drops a data type (domain).
904 905
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
906
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
907 908 909 910 911
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
912
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
913
","
Thomas Mueller's avatar
Thomas Mueller committed
914
Drops an index.
Thomas Mueller's avatar
Thomas Mueller committed
915
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
916 917 918 919 920
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
921
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
922
","
Thomas Mueller's avatar
Thomas Mueller committed
923
Drops a role.
Thomas Mueller's avatar
Thomas Mueller committed
924
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
925 926 927 928 929
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
930
DROP SCHEMA [ IF EXISTS ] schemaName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
931
","
Thomas Mueller's avatar
Thomas Mueller committed
932
Drops a schema.
933 934
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
935
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
936 937 938 939 940
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
941
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
942
","
Thomas Mueller's avatar
Thomas Mueller committed
943
Drops a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
944
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
945 946 947 948 949
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
950
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
951
","
Thomas Mueller's avatar
Thomas Mueller committed
952
Drops an existing table, or a list of tables.
953 954
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
955
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
956 957 958 959 960
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
961
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
962
","
Thomas Mueller's avatar
Thomas Mueller committed
963
Drops an existing trigger.
Thomas Mueller's avatar
Thomas Mueller committed
964
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
965 966 967 968 969
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
970
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
971
","
Thomas Mueller's avatar
Thomas Mueller committed
972 973
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
974

Thomas Mueller's avatar
Thomas Mueller committed
975
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
976
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
977 978 979 980 981
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
982
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
983
","
Thomas Mueller's avatar
Thomas Mueller committed
984 985 986
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
987
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
988 989 990 991 992
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
993
TRUNCATE TABLE tableName [ [ CONTINUE | RESTART ] IDENTITY ]
Thomas Mueller's avatar
Thomas Mueller committed
994
","
995 996 997 998 999
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).
1000
Linked tables can't be truncated.
1001
If RESTART IDENTITY is specified next values for auto-incremented columns are restarted.
Thomas Mueller's avatar
Thomas Mueller committed
1002

Thomas Mueller's avatar
Thomas Mueller committed
1003
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1004 1005 1006 1007 1008 1009 1010
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
1011
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
1012 1013

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1014 1015 1016 1017 1018 1019 1020
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
1021
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
1022 1023 1024
to the underlying device.

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

"Commands (Other)","COMMIT","
1030
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
1031 1032 1033 1034 1035 1036 1037 1038 1039
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
1040 1041 1042 1043
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
1044 1045 1046 1047 1048
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
1049
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1050 1051
{ { SCHEMA schemaName } | { tableName [,...] } }
TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1052
","
Thomas Mueller's avatar
Thomas Mueller committed
1053 1054 1055
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
1056
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1057 1058 1059 1060
","
GRANT SELECT ON TEST TO READONLY
"

1061 1062 1063 1064 1065 1066
"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
1067
This command commits an open transaction in this connection.
1068 1069 1070 1071
","
GRANT ALTER ANY SCHEMA TO Bob
"

Thomas Mueller's avatar
Thomas Mueller committed
1072
"Commands (Other)","GRANT ROLE","
1073
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1074
","
Thomas Mueller's avatar
Thomas Mueller committed
1075 1076 1077
Grants a role to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1078
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1079 1080 1081 1082 1083
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
1084
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1085 1086 1087 1088 1089 1090 1091 1092 1093
","
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
1094 1095
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
1096 1097 1098 1099 1100
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
1101
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1102 1103
{ { SCHEMA schemaName } | { tableName [,...] } }
FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1104
","
Thomas Mueller's avatar
Thomas Mueller committed
1105 1106 1107
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
1108
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1109 1110 1111 1112 1113
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
1114
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1115
","
Thomas Mueller's avatar
Thomas Mueller committed
1116 1117 1118
Removes a role from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1119
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1120 1121 1122 1123 1124
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
1125
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
","
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
1136 1137 1138 1139
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
1140 1141 1142 1143 1144 1145 1146
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1147 1148
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
1149 1150 1151 1152 1153
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1154
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1155
","
Thomas Mueller's avatar
Thomas Mueller committed
1156
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1157
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
1158
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1159 1160 1161 1162 1163
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1164
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
","
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
1175 1176
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1177
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1178
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1179
This setting is persistent.
1180
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1181 1182 1183 1184 1185
","
SET ALLOW_LITERALS NONE
"

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

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
1201
Sets the size of the cache in KB (each KB being 1024 bytes) for the current database.
1202 1203
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
1204 1205
Depending on the virtual machine, the actual memory required may be higher.

Thomas Mueller's avatar
Thomas Mueller committed
1206
This setting is persistent and affects all connections as there is only one cache per database.
Thomas Mueller's avatar
Thomas Mueller committed
1207
Using a very small value (specially 0) will reduce performance a lot.
Thomas Mueller's avatar
Thomas Mueller committed
1208 1209
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
1210
It has no effect for in-memory databases.
1211

Thomas Mueller's avatar
Thomas Mueller committed
1212
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1213
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1214
This setting is persistent.
1215
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
","
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
1228 1229
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1230
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1231 1232 1233 1234
","
SET CLUSTER ''
"

1235 1236 1237 1238
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1239 1240
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.
1241 1242 1243
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
1244
This command commits an open transaction in this connection.
1245 1246 1247 1248 1249
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
"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
1263
"Commands (Other)","SET COLLATION","
1264
SET [ DATABASE ] COLLATION
1265 1266
{ OFF | collationName
    [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1267
","
Thomas Mueller's avatar
Thomas Mueller committed
1268 1269
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
1270 1271
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
1272
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1273

1274 1275 1276 1277 1278
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).
1279 1280
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.
1281

Thomas Mueller's avatar
Thomas Mueller committed
1282
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1283
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1284
This setting is persistent.
1285
This setting can be appended to the database URL: ""jdbc:h2:test;COLLATION='ENGLISH'""
Thomas Mueller's avatar
Thomas Mueller committed
1286 1287
","
SET COLLATION ENGLISH
1288
SET COLLATION CHARSET_CP500
Thomas Mueller's avatar
Thomas Mueller committed
1289 1290 1291
"

"Commands (Other)","SET COMPRESS_LOB","
1292
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1293
","
Thomas Mueller's avatar
Thomas Mueller committed
1294 1295 1296 1297
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
1298 1299
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
1300

Thomas Mueller's avatar
Thomas Mueller committed
1301
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1302
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1303
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1304 1305 1306 1307 1308 1309 1310 1311
","
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
1312 1313 1314 1315
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).
1316
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1317 1318 1319 1320 1321 1322 1323
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1324 1325
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
1326 1327 1328 1329
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
1330

Thomas Mueller's avatar
Thomas Mueller committed
1331
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1332
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1333
This setting is persistent.
1334
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1335 1336 1337 1338 1339 1340 1341 1342
","
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
1343 1344
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1345
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1346
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1347
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1348 1349 1350 1351 1352
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1353
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1354 1355 1356
","
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
1357
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1358
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1359

Thomas Mueller's avatar
Thomas Mueller committed
1360
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1361
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1362
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1363
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1364 1365 1366 1367 1368
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1369
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1370
","
Thomas Mueller's avatar
Thomas Mueller committed
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
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
1381 1382

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1383
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1384
","
Thomas Mueller's avatar
Thomas Mueller committed
1385
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1386 1387 1388
"

"Commands (Other)","SET IGNORECASE","
1389
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1390 1391 1392 1393 1394
","
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
1395
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1396

Thomas Mueller's avatar
Thomas Mueller committed
1397
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1398
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1399
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1400
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1401 1402 1403 1404
","
SET IGNORECASE TRUE
"

1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
"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
1417
This command commits an open transaction in this connection.
1418 1419 1420 1421 1422 1423 1424
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'
"


1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
"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
"

1442
"Commands (Other)","SET LOG","
1443
SET LOG int
1444 1445 1446 1447
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1448
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1449 1450 1451 1452
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.

1453 1454
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
1455 1456
against power failure is required, but the data must be protected against killing the process.

1457 1458
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
1459 1460
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1461
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1462
This command commits an open transaction in this connection.
1463
This setting is not persistent.
1464
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1465 1466 1467 1468
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1469 1470 1471 1472
"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
1473
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486

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
1487
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1488
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1489
This setting is persistent.
1490
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1491 1492 1493 1494 1495 1496 1497 1498
","
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
1499 1500 1501
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1502
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1503 1504 1505 1506 1507 1508 1509
","
SET LOCK_TIMEOUT 1000
"

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

1512
This is the maximum length of an LOB that is stored with the record itself,
1513 1514
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1515
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1516
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1517
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1518 1519 1520 1521 1522 1523 1524
","
SET MAX_LENGTH_INPLACE_LOB 128
"

"Commands (Other)","SET MAX_LOG_SIZE","
SET MAX_LOG_SIZE int
","
Thomas Mueller's avatar
Thomas Mueller committed
1525 1526
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
1527
If there is an open transaction, the transaction log will continue to grow however.
Thomas Mueller's avatar
Thomas Mueller committed
1528
The default max size is 16 MB.
Thomas Mueller's avatar
Thomas Mueller committed
1529
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1530

Thomas Mueller's avatar
Thomas Mueller committed
1531
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1532
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1533
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1534 1535 1536 1537 1538 1539 1540 1541
","
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
1542
are read, then the rows are buffered to disk.
1543
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1544

Thomas Mueller's avatar
Thomas Mueller committed
1545
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1546
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1547
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1548
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1549 1550 1551 1552 1553 1554 1555
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1562
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1563
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1564
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1565
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1566 1567 1568 1569 1570 1571 1572 1573 1574
","
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
1575 1576 1577
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1578
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1579
It has no effect for in-memory databases.
1580
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1581 1582 1583 1584 1585
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1586
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1587 1588
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1589 1590 1591
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1592
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1593
This command commits an open transaction in this connection.
1594
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1595 1596 1597 1598 1599
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1600
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1601
","
1602 1603 1604
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
1605 1606 1607 1608

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
1609
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1610
This command commits an open transaction in this connection.
1611
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1612 1613 1614 1615 1616
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1617
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1618 1619 1620
","
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
1621 1622
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1623
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1624
This command commits an open transaction in this connection.
1625
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1626 1627 1628 1629 1630 1631 1632 1633 1634
","
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
1635

Thomas Mueller's avatar
Thomas Mueller committed
1636
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1637 1638 1639 1640
","
SET PASSWORD 'abcstzri!.5'
"

1641 1642 1643 1644 1645 1646 1647
"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
1648
This command commits an open transaction in this connection.
1649 1650 1651 1652 1653
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666
"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
1667 1668 1669 1670 1671
"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
1672 1673 1674
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
1675 1676 1677 1678 1679
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1680
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1681 1682 1683
","
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
1684 1685 1686
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1687
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1688
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1689 1690 1691 1692
","
SET REFERENTIAL_INTEGRITY FALSE
"

1693 1694 1695 1696 1697 1698
"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.
1699 1700 1701
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,
1702 1703 1704 1705
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
1706
This command commits an open transaction in this connection.
1707 1708 1709 1710 1711 1712
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
1713 1714 1715 1716 1717
"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
1718

Thomas Mueller's avatar
Thomas Mueller committed
1719
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1720 1721 1722 1723 1724 1725 1726 1727 1728
","
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
1729 1730 1731
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1732
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1733 1734 1735 1736 1737 1738 1739 1740 1741
","
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
1742 1743 1744
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1745
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1746 1747 1748 1749 1750 1751 1752 1753 1754
","
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
1755 1756 1757
disabled).

This command does not commit a transaction, and rollback does not affect it.
1758
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1759 1760 1761 1762 1763
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1764
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1765 1766 1767
","
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.
1768
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1769

Thomas Mueller's avatar
Thomas Mueller committed
1770
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1771
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1772
This command does not commit a transaction, and rollback does not affect it.
1773
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
","
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
1785
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1786
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1787
This command commits an open transaction in this connection.
1788
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798
","
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
1799

Thomas Mueller's avatar
Thomas Mueller committed
1800
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1801 1802 1803 1804 1805 1806 1807 1808
","
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
1809 1810
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1811
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1812
This command commits an open transaction in this connection.
1813
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1814 1815 1816 1817 1818
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1819
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1820
","
1821 1822
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
1823
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1824

1825 1826
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
1827 1828 1829

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,
1830
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
1831 1832

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

1834 1835
SHUTDOWN DEFRAG re-orders the pages when closing the database so that table scans are faster.

Thomas Mueller's avatar
Thomas Mueller committed
1836
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1837
","
1838
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1839 1840
"

1841 1842 1843 1844 1845 1846 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
"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).
1973 1974
ISO definition is used when first week of year should have at least four days
and week is started with Monday.
1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
","
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
"

2006 2007
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
2008
","
2009
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
2010
","
2011
A
Thomas Mueller's avatar
Thomas Mueller committed
2012 2013
"

2014 2015
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2016
","
2017
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2018
","
2019
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2020 2021
"

2022
"Other Grammar","Array","
2023
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
2024
","
2025 2026
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
2027
","
2028
(1, 2)
2029 2030
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
2031 2032
"

2033 2034
"Other Grammar","Boolean","
TRUE | FALSE
2035
","
2036
A boolean value.
2037
","
2038
TRUE
2039 2040
"

2041 2042
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
2043
","
2044
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
2045
","
2046
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
2047 2048
"

2049 2050 2051
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
2052
","
2053 2054
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
2055
","
2056
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
2057 2058
"

2059 2060 2061
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
2062
","
2063 2064
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2065
","
2066 2067 2068 2069
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
2070
AES
2071
","
2072
Only the algorithm AES (""AES-128"") is supported currently.
2073 2074
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
2075 2076
"

2077
"Other Grammar","Column Definition","
2078
dataType [ VISIBLE | INVISIBLE ]
2079 2080
[ { DEFAULT expression | AS computedColumnExpression } ]
[ ON UPDATE expression ] [ [ NOT ] NULL ]
2081
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2082 2083
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
2084 2085
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
2086
The computed column expression is evaluated and assigned whenever the row changes.
2087 2088 2089
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.
2090 2091 2092 2093

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
2094

2095 2096 2097
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
2098 2099
The options PRIMARY KEY, UNIQUE, and CHECK are not supported for ALTER statements.

Thomas Mueller's avatar
Thomas Mueller committed
2100 2101
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
2102 2103
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
2104

2105
","
Thomas Mueller's avatar
Thomas Mueller committed
2106 2107 2108
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);
2109 2110
"

2111 2112
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
2113
","
2114 2115 2116
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
2117
","
2118
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
2119 2120
"

2121
"Other Grammar","Compare","
2122
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
2123
","
2124
Comparison operator. The operator != is the same as <>.
2125
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
2126
","
2127
<>
Thomas Mueller's avatar
Thomas Mueller committed
2128 2129 2130
"

"Other Grammar","Condition","
2131
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
2132 2133 2134 2135 2136 2137 2138
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
2139 2140
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
2141
    | IS [ NOT ] [ DISTINCT FROM ] operand
2142 2143
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
2144
    | [ NOT ] [ LIKE | ILIKE ] operand [ ESCAPE string ]
2145
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
2146
","
Thomas Mueller's avatar
Thomas Mueller committed
2147
The right hand side of a condition.
2148

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

Thomas Mueller's avatar
Thomas Mueller committed
2152 2153 2154 2155 2156
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).
2157 2158 2159
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.
2160

2161 2162
ILIKE does a case-insensitive compare.

Thomas Mueller's avatar
Thomas Mueller committed
2163
When comparing with REGEXP, regular expression matching is used.
2164
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
2165 2166 2167 2168
","
LIKE 'Jo%'
"

2169
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
2170 2171 2172 2173 2174
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
2175
","
Thomas Mueller's avatar
Thomas Mueller committed
2176 2177
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2178
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
2179 2180
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
2181
","
2182
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
2183 2184
"

2185 2186
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
2187
","
2188
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
2189
","
2190
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
2191 2192
"

2193 2194
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
2195
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
2196
","
2197
Optional parameters for CSVREAD and CSVWRITE.
2198 2199
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
2200 2201
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
2202
The following options are supported:
2203

2204
""caseSensitiveColumnNames"" (true or false; disabled by default),
2205

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

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

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

thomasmueller's avatar
thomasmueller committed
2212
""fieldSeparator"" (a comma by default),
2213

2214
""lineComment"" (disabled by default),
2215

2216
""lineSeparator"" (the line separator used for writing; ignored for reading),
2217

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

2221
""preserveWhitespace"" (true or false; disabled by default),
2222

2223
""writeColumnHeader"" (true or false; enabled by default).
2224

Thomas Mueller's avatar
Thomas Mueller committed
2225
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
2226
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
2227 2228 2229
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
2230
","
2231
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
2232 2233
"

2234 2235 2236
"Other Grammar","Data Type","
intType | booleanType | tinyintType | smallintType | bigintType | identityType
    | decimalType | doubleType | realType | dateType | timeType | timestampType
2237 2238 2239
    | timestampWithTimeZoneType | binaryType | otherType | varcharType
    | varcharIgnorecaseType | charType | blobType | clobType | uuidType
    | arrayType | enumType
Thomas Mueller's avatar
Thomas Mueller committed
2240
","
2241
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
2242
","
2243
INT
Thomas Mueller's avatar
Thomas Mueller committed
2244 2245
"

2246 2247
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
2248
","
2249
A date literal. The limitations are the same as for the Java data type
2250
""java.sql.Date"", but for compatibility with other databases the suggested minimum
2251
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
2252
","
2253
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
2254 2255
"

2256
"Other Grammar","Decimal","
2257 2258
[ + | - ] { { number [ . number ] } | { . number } }
[ E [ + | - ] expNumber [...] ] ]
2259
","
Thomas Mueller's avatar
Thomas Mueller committed
2260 2261 2262 2263 2264 2265
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)"".
2266
","
Thomas Mueller's avatar
Thomas Mueller committed
2267 2268 2269
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
2270 2271
"

2272 2273 2274 2275 2276 2277 2278 2279
"Other Grammar","Delete search condition","
[ WHERE expression ] [ LIMIT term ]
","
Search condition for DELETE statement.
","
WHERE ID = 2
"

2280 2281
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
2282
","
2283
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
2284
","
2285
0
Thomas Mueller's avatar
Thomas Mueller committed
2286 2287
"

2288 2289
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
2290
","
2291 2292 2293
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
2294
","
2295
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
2296 2297
"

2298 2299
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2300
","
2301
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2302
","
2303
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2304 2305
"

2306
"Other Grammar","Factor","
2307
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2308
","
2309
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
2310
","
2311
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
2312 2313
"

2314 2315
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
2316
","
2317 2318
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
2319
","
2320
cafe
Thomas Mueller's avatar
Thomas Mueller committed
2321 2322
"

2323 2324
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
2325
","
2326
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
2327
","
2328
0xff
Thomas Mueller's avatar
Thomas Mueller committed
2329 2330
"

2331 2332
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2333
","
2334 2335 2336
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
2337
","
2338
NAME
Thomas Mueller's avatar
Thomas Mueller committed
2339 2340
"

2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
"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
2352
"Other Grammar","Int","
2353
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2354 2355 2356 2357 2358 2359 2360
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2361
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2362 2363 2364 2365 2366 2367
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2368
"Other Grammar","Name","
2369
{ { A-Z|_ } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2370
","
2371
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2372
","
2373
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2374 2375
"

2376 2377
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2378
","
2379
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2380
","
2381
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2382 2383
"

2384 2385 2386 2387 2388 2389 2390 2391
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2392
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2393
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2394
","
Thomas Mueller's avatar
Thomas Mueller committed
2395
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2396 2397 2398 2399 2400 2401 2402
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
"

2403 2404
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2405
","
2406
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2407
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2408
","
2409
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2410 2411
"

2412 2413
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2414
","
2415 2416 2417
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
2418
","
2419
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2420 2421
"

2422 2423
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2424
","
2425 2426 2427
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
2428
","
2429
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2430 2431
"

2432 2433 2434
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2435
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2436
","
Thomas Mueller's avatar
Thomas Mueller committed
2437 2438 2439
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
2440 2441 2442
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
2443
","
2444
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2445 2446
"

Thomas Mueller's avatar
Thomas Mueller committed
2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457
"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
"

2458
"Other Grammar","Script Compression Encryption","
2459 2460
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ]
[ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2461
","
2462 2463
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
2464 2465 2466 2467 2468
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2469 2470
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2471
","
2472
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2473
","
2474
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2475 2476
"

2477 2478 2479 2480 2481 2482 2483 2484 2485
"Other Grammar","Set clause list","
{ { columnName = { DEFAULT | expression } } [,...] } |
    { ( columnName [,...] ) = ( select ) }
","
List of SET clauses.
","
NAME = 'Test', VALUE = 2
"

2486 2487
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2488
","
2489 2490
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
2491
","
2492
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2493 2494
"

2495 2496
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2497
","
Thomas Mueller's avatar
Thomas Mueller committed
2498
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2499

Thomas Mueller's avatar
Thomas Mueller committed
2500
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2501
","
2502
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2503 2504
"

2505
"Other Grammar","Table Expression","
2506 2507
{ [ schemaName. ] tableName | ( select ) | valuesExpression }
[ [ AS ] newTableAlias [ ( columnName [,...] ) ] ]
2508
[ USE INDEX ([ indexName [,...] ]) ]
2509 2510
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2511
","
2512 2513 2514
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
2515
","
2516
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2517 2518
"

2519 2520 2521 2522 2523 2524 2525 2526 2527
"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;
"

2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2540
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2541
","
2542
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2543
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2544
","
2545 2546 2547 2548
'Hello'
"

"Other Grammar","Time","
2549
TIME [ WITHOUT TIME ZONE ] 'hh:mm:ss[.nnnnnnnnn]'
2550
","
2551
A time literal. A value is between 0:00:00 and 23:59:59.999999999
2552
and has nanosecond resolution.
2553 2554 2555 2556 2557
","
TIME '23:59:59'
"

"Other Grammar","Timestamp","
2558
TIMESTAMP [ WITHOUT TIME ZONE ] 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]'
2559 2560
","
A timestamp literal. The limitations are the same as for the Java data type
2561
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2562 2563 2564 2565 2566
minimum and maximum years are 0001 and 9999.
","
TIMESTAMP '2005-12-31 23:59:59'
"

2567
"Other Grammar","Timestamp with time zone","
2568
TIMESTAMP WITH TIME ZONE 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]
2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
[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'
"

2580 2581 2582 2583 2584 2585 2586 2587
"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'
"

2588
"Other Grammar","Value","
2589
string | dollarQuotedString | numeric | dateAndTime | boolean | bytes | array | null
2590
","
Thomas Mueller's avatar
Thomas Mueller committed
2591
A literal value of any data type, or null.
2592 2593
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2594 2595 2596 2597 2598 2599 2600
"

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

2601
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2602 2603 2604 2605 2606 2607 2608 2609 2610
","
INT
"

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

2611
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2612 2613 2614 2615 2616 2617 2618 2619 2620
","
BOOLEAN
"

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

2621
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2622 2623 2624 2625 2626 2627 2628 2629 2630
","
TINYINT
"

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

2631
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2632 2633 2634 2635 2636 2637 2638 2639 2640
","
SMALLINT
"

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

2641
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652
","
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.

2653
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2654 2655 2656 2657 2658
","
IDENTITY
"

"Data Types","DECIMAL Type","
2659
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2660 2661 2662 2663
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2664
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2665 2666 2667 2668 2669
","
DECIMAL(20, 2)
"

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

2676
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2677 2678 2679 2680 2681
","
DOUBLE
"

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

2688
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2689 2690 2691 2692 2693
","
REAL
"

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

2699
Mapped to ""java.sql.Time"". When converted to a ""java.sql.Date"", the date is set to ""1970-01-01"".
2700
""java.time.LocalTime"" is also supported on Java 8 and later versions.
Evgenij Ryazanov's avatar
Evgenij Ryazanov committed
2701
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
2702 2703 2704 2705 2706 2707 2708
","
TIME
"

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

2711
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2712
(or to the next possible time if midnight doesn't exist for the given date and timezone due to a daylight saving change).
2713
""java.time.LocalDate"" is also supported on Java 8 and later versions.
Thomas Mueller's avatar
Thomas Mueller committed
2714 2715 2716 2717 2718
","
DATE
"

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

2727 2728
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
2729 2730 2731 2732
","
TIMESTAMP
"

2733
"Data Types","TIMESTAMP WITH TIME ZONE Type","
2734
TIMESTAMP [ ( precisionInt ) ] WITH TIME ZONE
2735
","
2736
The timestamp with time zone data type.
2737
Stored internally as a BCD-encoded date, nanoseconds since midnight, and time zone offset in minutes.
2738
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
2739

2740 2741 2742 2743 2744 2745 2746
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.
2747
","
2748
TIMESTAMP WITH TIME ZONE
2749 2750
"

Thomas Mueller's avatar
Thomas Mueller committed
2751
"Data Types","BINARY Type","
2752 2753
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA }
[ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2754
","
2755 2756 2757 2758 2759
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
2760 2761 2762 2763 2764 2765 2766 2767 2768

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2769 2770 2771 2772 2773
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
2774

2775
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2776 2777 2778 2779 2780
","
OTHER
"

"Data Types","VARCHAR Type","
2781
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
2782
    | NVARCHAR2 | VARCHAR_CASESENSITIVE} [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2783
","
Thomas Mueller's avatar
Thomas Mueller committed
2784
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2785 2786 2787 2788 2789 2790 2791
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
2792

2793
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2794 2795 2796 2797 2798
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2799
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2800
","
Thomas Mueller's avatar
Thomas Mueller committed
2801
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2802 2803 2804 2805 2806 2807 2808
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
2809

2810
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2811 2812 2813 2814 2815
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2816
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2817
","
Thomas Mueller's avatar
Thomas Mueller committed
2818 2819 2820
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
2821

Thomas Mueller's avatar
Thomas Mueller committed
2822 2823
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
2824

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

2828
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2829 2830 2831 2832 2833
","
CHAR(10)
"

"Data Types","BLOB Type","
2834 2835
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID }
[ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2836 2837 2838
","
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
2839
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2840 2841
Advanced / Large Objects.

2842
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2843 2844 2845 2846 2847
","
BLOB
"

"Data Types","CLOB Type","
2848 2849
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB }
[ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2850 2851 2852 2853 2854
","
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
2855
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2856 2857 2858 2859 2860

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.

2861
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2862 2863 2864 2865 2866 2867 2868
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2869 2870 2871 2872
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
2873

Thomas Mueller's avatar
Thomas Mueller committed
2874 2875 2876 2877 2878
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
2879
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2880 2881 2882 2883 2884 2885 2886
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2887
An array of values.
2888
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2889 2890 2891 2892


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
2893 2894 2895 2896
","
ARRAY
"

2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910
"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')
"
2911 2912 2913
"Data Types","GEOMETRY Type","
GEOMETRY
","
2914
A spatial geometry type, based on the ""org.locationtech.jts"" library.
2915 2916
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.
2917

2918
Use a quoted string containing a WKT/EWKT formatted string or ""PreparedStatement.setObject()"" to store values,
2919 2920
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2921
GEOMETRY
2922 2923
"

Thomas Mueller's avatar
Thomas Mueller committed
2924
"Functions (Aggregate)","AVG","
2925
AVG ( [ DISTINCT ] { numeric } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2926
","
2927 2928
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2929
Aggregates are only allowed in select statements.
2930
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2931 2932 2933 2934
","
AVG(X)
"

2935
"Functions (Aggregate)","BIT_AND","
2936
BIT_AND(expression) [ FILTER ( WHERE expression ) ]
2937 2938 2939 2940 2941 2942 2943 2944 2945
","
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","
2946
BIT_OR(expression) [ FILTER ( WHERE expression ) ]
2947 2948 2949 2950 2951 2952 2953 2954
","
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
2955
"Functions (Aggregate)","BOOL_AND","
2956
BOOL_AND(boolean) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2957
","
2958 2959 2960
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
2961 2962 2963 2964 2965
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2966
BOOL_OR(boolean) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2967
","
2968 2969 2970
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
2971 2972 2973 2974 2975
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2976
COUNT( { * | { [ DISTINCT ] expression } } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2977
","
2978 2979 2980 2981
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
2982 2983 2984 2985 2986
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2987 2988
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2989
[ SEPARATOR expression ] ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2990
","
2991 2992 2993 2994 2995
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
2996 2997 2998 2999
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012
"Functions (Aggregate)","ARRAY_AGG","
ARRAY_AGG ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ] )
[ FILTER ( WHERE expression ) ]
","
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
3013
"Functions (Aggregate)","MAX","
3014
MAX(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3015
","
3016 3017 3018 3019
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
3020 3021 3022 3023 3024
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
3025
MIN(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3026
","
3027 3028 3029 3030
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
3031 3032 3033 3034 3035
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
3036
SUM( [ DISTINCT ] { numeric } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3037
","
3038 3039 3040
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
3041
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
3042
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
3043 3044 3045 3046 3047
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
3048
SELECTIVITY(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3049
","
3050 3051 3052 3053 3054
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
3055 3056 3057 3058 3059
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
3060
STDDEV_POP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3061
","
3062 3063 3064
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
3065 3066 3067 3068 3069 3070
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
3071
STDDEV_SAMP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3072
","
3073 3074 3075
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
3076 3077 3078 3079 3080 3081
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
3082
VAR_POP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3083
","
3084 3085 3086 3087
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
3088 3089 3090 3091 3092
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
3093
VAR_SAMP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3094
","
3095 3096 3097 3098
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
3099 3100 3101 3102
","
VAR_SAMP(X)
"

3103
"Functions (Aggregate)","MEDIAN","
3104
MEDIAN( [ DISTINCT ] value ) [ FILTER ( WHERE expression ) ]
3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115
","
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.
Interpolation is only supported for numeric, date, and time data types.
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)
"

Thomas Mueller's avatar
Thomas Mueller committed
3116
"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
3117
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3118
","
3119 3120
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"".
3121
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3122 3123 3124 3125 3126
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
3127
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3128
","
Thomas Mueller's avatar
Thomas Mueller committed
3129 3130
Calculate the arc cosine.
See also Java ""Math.acos"".
3131
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3132 3133 3134 3135 3136
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
3137
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3138
","
Thomas Mueller's avatar
Thomas Mueller committed
3139 3140
Calculate the arc sine.
See also Java ""Math.asin"".
3141
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3142 3143 3144 3145 3146
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
3147
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3148
","
Thomas Mueller's avatar
Thomas Mueller committed
3149 3150
Calculate the arc tangent.
See also Java ""Math.atan"".
3151
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3152 3153 3154 3155 3156
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
3157
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3158
","
Thomas Mueller's avatar
Thomas Mueller committed
3159 3160
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
3161
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3162 3163 3164 3165
","
COS(ANGLE)
"

3166
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
3167
COSH(numeric)
3168 3169 3170 3171 3172 3173 3174 3175
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
3176
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
3177
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3178
","
Thomas Mueller's avatar
Thomas Mueller committed
3179
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
3180
See also Java ""Math.*"" functions.
3181
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3182 3183 3184 3185 3186
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
3187
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3188
","
Thomas Mueller's avatar
Thomas Mueller committed
3189 3190
Calculate the trigonometric sine.
See also Java ""Math.sin"".
3191
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3192 3193 3194 3195
","
SIN(ANGLE)
"

3196
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
3197
SINH(numeric)
3198 3199 3200 3201 3202 3203 3204 3205
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
3206
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
3207
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3208
","
Thomas Mueller's avatar
Thomas Mueller committed
3209 3210
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
3211
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3212 3213 3214 3215
","
TAN(ANGLE)
"

3216
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
3217
TANH(numeric)
3218 3219 3220 3221 3222 3223 3224 3225
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
3226
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
3227
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3228
","
Thomas Mueller's avatar
Thomas Mueller committed
3229
Calculate the angle when converting the rectangular coordinates to polar coordinates.
3230
See also Java ""Math.atan2"".
3231
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3232 3233 3234 3235 3236
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
3237
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3238
","
3239 3240
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3241 3242 3243 3244 3245
See also Java operator &.
","
BITAND(A, B)
"

3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256
"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
3257
"Functions (Numeric)","BITOR","
3258
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3259
","
3260 3261
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3262 3263 3264 3265 3266 3267
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
3268
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3269
","
3270 3271
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3272 3273 3274 3275 3276 3277
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
3278
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3279
","
3280 3281
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3282 3283 3284 3285 3286 3287
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
3288
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3289
","
3290
See also Java ""Math.ceil"".
3291
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3292
","
3293
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
3294 3295 3296
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
3297
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3298
","
3299
See also Java ""Math.toDegrees"".
3300
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3301 3302 3303 3304 3305
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
3306
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3307
","
3308
See also Java ""Math.exp"".
3309
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3310 3311 3312 3313 3314
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
3315
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3316
","
3317
See also Java ""Math.floor"".
3318
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3319 3320 3321 3322 3323
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
3324
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3325
","
3326
See also Java ""Math.log"".
3327
In the PostgreSQL mode, LOG(x) is base 10.
3328
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3329 3330 3331 3332 3333
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
3334
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3335
","
3336
See also Java ""Math.log10"".
3337
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3338 3339 3340 3341
","
LOG10(A)
"

3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354
"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
3355
"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
3356
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3357
","
3358
See also Java ""Math.toRadians"".
3359
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3360 3361 3362 3363 3364
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
3365
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3366
","
3367
See also Java ""Math.sqrt"".
3368
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3369 3370 3371 3372 3373
","
SQRT(A)
"

"Functions (Numeric)","PI","
3374
PI()
Thomas Mueller's avatar
Thomas Mueller committed
3375
","
3376
See also Java ""Math.PI"".
3377
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3378 3379 3380 3381 3382
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
3383
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3384
","
3385
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
3386
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3387 3388 3389 3390 3391
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
3392
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
3393 3394 3395
","
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
3396
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
3397 3398 3399 3400 3401
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
3402
{ RANDOM_UUID | UUID } ()
Thomas Mueller's avatar
Thomas Mueller committed
3403 3404
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
3405 3406 3407 3408 3409

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
3410 3411 3412 3413 3414
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
3415
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
3416
","
3417
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
3418
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
3419 3420 3421 3422 3423
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
3424
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3425
","
3426 3427 3428 3429 3430 3431
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
3432 3433 3434 3435 3436
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
3437
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
3438 3439
","
Generates a number of cryptographically secure random numbers.
3440
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3441 3442 3443 3444 3445
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
3446
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3447 3448 3449 3450 3451 3452 3453
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
3454
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3455
","
3456
Encrypts data using a key.
3457
The supported algorithm is AES.
3458 3459
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3460 3461 3462 3463 3464
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
3465
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3466
","
3467
Decrypts data using a key.
3468
The supported algorithm is AES.
3469 3470
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3471 3472 3473 3474 3475 3476
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3477
HASH(algorithmString, expression [, iterationInt])
Thomas Mueller's avatar
Thomas Mueller committed
3478
","
3479 3480 3481
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
3482 3483 3484 3485 3486
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3487 3488
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt}
    | timestamp | timestampWithTimeZone | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3489 3490
","
Truncates to a number of digits (to the next value closer to 0).
3491
This method returns a double.
3492
When used with a timestamp, truncates a timestamp to a date (day) value.
3493 3494
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
3495 3496 3497 3498 3499
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3500
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3501
","
3502 3503 3504 3505
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
3506 3507 3508 3509 3510
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3511
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3512 3513
","
Expands data that was compressed using the COMPRESS function.
3514
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3515 3516 3517 3518 3519
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3520
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3521 3522 3523 3524 3525 3526 3527
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3528
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3529 3530
","
Returns the ASCII value of the first character in the string.
3531
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3532 3533 3534 3535
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3536
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3537
","
3538 3539 3540
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
3541 3542 3543 3544 3545
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3546
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3547
","
3548 3549 3550
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
3551 3552 3553 3554 3555
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3556
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3557
","
3558 3559 3560 3561
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
3562 3563 3564 3565 3566
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3567
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3568 3569
","
Returns the character that represents the ASCII value.
3570
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3571 3572 3573 3574 3575
","
CHAR(65)
"

"Functions (String)","CONCAT","
3576
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3577 3578
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3579
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3580
and do not cause the result to become NULL.
3581
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3582 3583 3584 3585
","
CONCAT(NAME, '!')
"

3586 3587 3588 3589
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3590
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3591
and do not cause the result to become NULL.
3592 3593 3594 3595 3596
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3597
"Functions (String)","DIFFERENCE","
3598
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3599 3600
","
Returns the difference between the sounds of two strings.
3601
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3602 3603 3604 3605 3606
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3607
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3608
","
3609 3610
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
3611 3612 3613 3614 3615
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3616
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3617
","
3618 3619 3620
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
3621 3622 3623 3624 3625
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3626
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3627
","
3628
Returns the location of a search string in a string.
3629 3630 3631
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
3632
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3633 3634 3635 3636 3637
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3638
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3639
","
3640 3641 3642
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
3643 3644 3645 3646 3647
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3648
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3649 3650 3651 3652 3653 3654 3655
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3656
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3657 3658 3659 3660 3661 3662 3663
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3664
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3665 3666 3667 3668 3669 3670 3671
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3672
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3673 3674 3675 3676 3677 3678 3679
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3680
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3681
","
3682 3683 3684 3685
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
3686 3687 3688 3689 3690
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3691
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3692 3693 3694 3695 3696 3697 3698
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3699
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3700
","
3701 3702 3703
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
3704 3705 3706 3707 3708
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3709
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3710
","
3711 3712 3713
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
3714 3715 3716 3717 3718
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3719
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3720 3721 3722 3723 3724 3725 3726
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3727
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3728 3729 3730 3731 3732 3733 3734
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3735
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3736
","
3737 3738
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
3739 3740 3741 3742 3743
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3744
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
3745
","
3746
Replaces each substring that matches a regular expression.
3747
For details, see the Java ""String.replaceAll()"" method.
3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761
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
3762 3763
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
3764
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3765 3766
"

3767 3768 3769 3770
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785
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)

3786 3787
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3788 3789
"

3790

Thomas Mueller's avatar
Thomas Mueller committed
3791
"Functions (String)","REPEAT","
3792
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3793 3794 3795 3796 3797 3798 3799
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3800
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3801
","
3802 3803
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.
3804
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3805 3806 3807 3808 3809
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3810
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3811
","
3812 3813 3814
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
3815 3816 3817 3818 3819
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3820
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3821 3822 3823 3824 3825 3826 3827
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3828
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3829
","
3830 3831 3832
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
3833 3834 3835 3836 3837
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3838
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3839
","
3840 3841 3842
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
3843 3844 3845 3846 3847
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3848
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3849 3850
","
Encodes a string to a byte array using the UTF8 encoding format.
3851
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3852 3853 3854 3855 3856
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3857
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3858
","
3859
Returns a substring of a string starting at a position.
3860
If the start index is negative, then the start index is relative to the end of the string.
3861
The length is optional.
3862
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3863
","
3864 3865
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3866 3867 3868
"

"Functions (String)","UTF8TOSTRING","
3869
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3870 3871 3872 3873 3874 3875 3876
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3877
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3878
","
3879
Creates an XML attribute element of the form ""name=value"".
3880 3881
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3882 3883 3884 3885 3886
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3887
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3888 3889
","
Create an XML node element.
3890 3891 3892
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.
3893
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3894 3895 3896 3897 3898
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3899
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3900
","
3901
Creates an XML comment.
3902
Two dashes (""--"") are converted to ""- -"".
3903
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3904 3905 3906 3907 3908
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3909
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3910
","
3911
Creates an XML CDATA element.
3912
If the value contains ""]]>"", an XML text element is created instead.
3913
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3914 3915 3916 3917 3918
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3919
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3920
","
Thomas Mueller's avatar
Thomas Mueller committed
3921
Returns the XML declaration.
3922
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3923 3924 3925 3926 3927
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3928
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3929 3930
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3931
If enabled, newline and linefeed is converted to an XML entity (&#).
3932
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3933 3934 3935 3936
","
CALL XMLTEXT('test')
"

3937
"Functions (String)","TO_CHAR","
3938
TO_CHAR(value [, formatString[, nlsParamString]])
3939 3940 3941 3942 3943 3944
","
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')
"

3945
"Functions (String)","TRANSLATE","
3946
TRANSLATE(value, searchString, replacementString)
3947 3948 3949 3950 3951 3952
","
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
3953
"Functions (Time and Date)","CURRENT_DATE","
3954
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3955 3956
","
Returns the current date.
3957
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3958 3959 3960 3961 3962
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3963
{ CURRENT_TIME [ ( [ int ] ) ] | LOCALTIME [ ( [ int ] ) ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3964 3965
","
Returns the current time.
3966 3967 3968 3969 3970
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
3971 3972 3973 3974 3975
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3976 3977 3978 3979
CURRENT_TIMESTAMP [ ( [ int ] ) ]
","
Returns the current timestamp with time zone.
Time zone offset is set to a current time zone offset
3980
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
3981 3982 3983 3984 3985 3986 3987 3988 3989 3990
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
3991
","
3992
Returns the current timestamp.
3993
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
3994 3995 3996 3997
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
3998
","
3999
LOCALTIMESTAMP()
Thomas Mueller's avatar
Thomas Mueller committed
4000 4001 4002
"

"Functions (Time and Date)","DATEADD","
4003
{ DATEADD| TIMESTAMPADD } (datetimeField, addIntLong, dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4004
","
4005
Adds units to a date-time value. The datetimeField indicates the unit.
4006
Use negative values to subtract units.
4007
addIntLong may be a long value when manipulating milliseconds,
4008
microseconds, or nanoseconds otherwise its range is restricted to int.
4009
This method returns a value with the same type as specified value if unit is compatible with this value.
4010 4011 4012
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
4013 4014 4015 4016 4017
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
4018
{ DATEDIFF | TIMESTAMPDIFF } (datetimeField, aDateAndTime, bDateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4019
","
4020
Returns the the number of crossed unit boundaries between two date/time values.
4021
This method returns a long.
4022
The datetimeField indicates the unit.
4023 4024
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
4025 4026 4027 4028 4029
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
4030
DAYNAME(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4031 4032 4033 4034 4035 4036 4037
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
4038
DAY_OF_MONTH(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4039 4040 4041 4042 4043 4044 4045
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
4046
DAY_OF_WEEK(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4047 4048 4049 4050 4051 4052
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

4053 4054 4055 4056 4057 4058 4059 4060
"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
4061
"Functions (Time and Date)","DAY_OF_YEAR","
4062
DAY_OF_YEAR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4063 4064 4065 4066 4067 4068 4069
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
4070
EXTRACT ( datetimeField FROM dateAndTime )
Thomas Mueller's avatar
Thomas Mueller committed
4071
","
4072
Returns a value of the specific time unit from a date/time value.
4073 4074
This method returns a numeric value with EPOCH field and
an int for all other fields.
Thomas Mueller's avatar
Thomas Mueller committed
4075 4076 4077 4078 4079
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
4080
FORMATDATETIME ( dateAndTime, formatString
4081
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4082
","
4083 4084 4085
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.
4086
For details of the format, see ""java.text.SimpleDateFormat"".
4087 4088
timeZoneString may be specified if dateAndTime is a DATE, TIME or TIMESTAMP.
timeZoneString is ignored if dateAndTime is TIMESTAMP WITH TIME ZONE.
4089
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4090 4091 4092 4093 4094 4095
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
4096
HOUR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4097
","
4098
Returns the hour (0-23) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4099 4100 4101 4102 4103
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
4104
MINUTE(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4105
","
4106
Returns the minute (0-59) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4107 4108 4109 4110 4111
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
4112
MONTH(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4113
","
4114
Returns the month (1-12) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4115 4116 4117 4118 4119
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
4120
MONTHNAME(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4121 4122 4123 4124 4125 4126 4127
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
4128
PARSEDATETIME(string, formatString
4129
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
4130
","
4131 4132 4133
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.
4134
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
4135 4136 4137 4138 4139 4140
","
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","
4141
QUARTER(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4142
","
4143
Returns the quarter (1-4) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4144 4145 4146 4147 4148
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
4149
SECOND(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4150
","
4151
Returns the second (0-59) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4152 4153 4154 4155 4156
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
4157
WEEK(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4158
","
4159
Returns the week (1-53) from a date/time value.
4160
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
4161 4162 4163 4164
","
WEEK(CREATED)
"

4165
"Functions (Time and Date)","ISO_WEEK","
4166
ISO_WEEK(dateAndTime)
4167
","
4168
Returns the ISO week (1-53) from a date/time value.
4169
This function uses the ISO definition when
4170 4171 4172 4173 4174 4175
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
4176
"Functions (Time and Date)","YEAR","
4177
YEAR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4178
","
4179
Returns the year from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4180 4181 4182 4183
","
YEAR(CREATED)
"

4184
"Functions (Time and Date)","ISO_YEAR","
4185
ISO_YEAR(dateAndTime)
4186
","
4187
Returns the ISO week year from a date/time value.
4188 4189 4190 4191
","
ISO_YEAR(CREATED)
"

Thomas Mueller's avatar
Thomas Mueller committed
4192
"Functions (System)","ARRAY_GET","
4193
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
4194 4195
","
Returns one element of an array.
4196
Returns NULL if there is no such element or array is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
4197 4198 4199 4200 4201
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
4202
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
4203 4204
","
Returns the length of an array.
4205
Returns NULL if the specified array is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
4206 4207 4208 4209
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

4210 4211 4212
"Functions (System)","ARRAY_CONTAINS","
ARRAY_CONTAINS(arrayExpression, value)
","
4213 4214
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.
4215 4216 4217 4218
","
CALL ARRAY_CONTAINS(('Hello', 'World'), 'Hello')
"

Thomas Mueller's avatar
Thomas Mueller committed
4219
"Functions (System)","AUTOCOMMIT","
4220
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
4221 4222 4223 4224 4225 4226 4227
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
4228
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
4229
","
4230 4231 4232
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
4233 4234

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4235 4236 4237 4238 4239
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
4240
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4241 4242
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
4243
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
4244 4245 4246 4247 4248
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
4249
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
4250
","
4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262
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
4263 4264 4265
"

"Functions (System)","COALESCE","
4266
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4267 4268 4269 4270 4271 4272 4273
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
4274
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
4275 4276 4277 4278 4279 4280 4281
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
4282
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4283
","
4284 4285 4286 4287 4288
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
4289 4290 4291 4292 4293
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
4294
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4295
","
4296 4297
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
4298 4299

If the column names are specified (a list of column names separated with the
4300
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
4301 4302 4303 4304 4305
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
4306 4307 4308 4309 4310

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.

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

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

Thomas Mueller's avatar
Thomas Mueller committed
4315
Instead of a file, an URL may be used, for example
4316 4317
""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
4318
To read from HTTP, use the prefix ""http:"" (as in a browser).
4319

Thomas Mueller's avatar
Thomas Mueller committed
4320 4321 4322
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
4323 4324 4325 4326
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
4327 4328 4329 4330
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
4331
SELECT ""Last Name"" FROM CSVREAD('address.csv');
4332
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
4333 4334 4335
"

"Functions (System)","CSVWRITE","
4336
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4337
","
4338
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
4339
If only a file name is specified, it will be written to the current working directory.
4340
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
4341
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
4342 4343 4344 4345 4346

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
4347
system (system property ""line.separator"").
Thomas Mueller's avatar
Thomas Mueller committed
4348

Thomas Mueller's avatar
Thomas Mueller committed
4349 4350
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4351
","
Thomas Mueller's avatar
Thomas Mueller committed
4352 4353 4354 4355
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
4356 4357 4358
"

"Functions (System)","DATABASE","
4359
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
4360 4361 4362 4363 4364 4365 4366
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
4367
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
4368
","
Thomas Mueller's avatar
Thomas Mueller committed
4369 4370
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
4371 4372 4373 4374
","
CALL DATABASE_PATH();
"

4375
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
4376
DECODE(value, whenValue, thenValue [,...])
4377 4378 4379 4380 4381 4382 4383 4384
","
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');
"

4385
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
4386
DISK_SPACE_USED(tableNameString)
4387 4388 4389 4390 4391 4392 4393 4394
","
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');
"

4395
"Functions (System)","SIGNAL","
4396
SIGNAL(sqlStateString, messageString)
4397 4398 4399 4400 4401 4402
","
Throw an SQLException with the passed SQLState and reason.
","
CALL SIGNAL('23505', 'Duplicate user ID: ' || user_id);
"

Thomas Mueller's avatar
Thomas Mueller committed
4403
"Functions (System)","FILE_READ","
4404
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
4405 4406 4407 4408
","
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
4409
default character set for this system.
4410 4411 4412 4413

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

Thomas Mueller's avatar
Thomas Mueller committed
4414
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4415 4416 4417 4418 4419
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

4420
"Functions (System)","FILE_WRITE","
4421
FILE_WRITE(blobValue, fileNameString)
4422 4423 4424 4425 4426 4427 4428 4429
","
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
4430
"Functions (System)","GREATEST","
4431
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4432 4433 4434 4435 4436 4437 4438
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
4439
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
4440 4441
","
Returns the last inserted identity value for this session.
4442
This value changes whenever a new sequence number was generated,
4443
even within a trigger or Java function. See also SCOPE_IDENTITY.
4444
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4445 4446 4447 4448 4449
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
4450
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4451 4452 4453 4454 4455 4456 4457
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
4458
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4459 4460 4461 4462 4463 4464 4465
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
4466
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
4467 4468
","
Returns the current lock mode. See SET LOCK_MODE.
4469
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4470 4471 4472 4473 4474
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
4475
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
4476 4477 4478 4479 4480 4481 4482 4483
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
4484
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
4485
","
4486 4487 4488 4489 4490
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
4491
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4492 4493 4494 4495 4496
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
4497
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
4498
","
Thomas Mueller's avatar
Thomas Mueller committed
4499
Returns the free memory in KB (where 1024 bytes is a KB).
4500
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4501 4502
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4503 4504 4505 4506 4507
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
4508
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
4509
","
Thomas Mueller's avatar
Thomas Mueller committed
4510
Returns the used memory in KB (where 1024 bytes is a KB).
4511
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4512 4513
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4514 4515 4516 4517 4518
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
4519
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4520
","
4521 4522 4523 4524
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
4525 4526 4527 4528 4529
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
4530
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4531 4532 4533 4534 4535 4536
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4537 4538 4539 4540
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4541
The data type of the returned value is the data type of 'a' if this is a text type.
4542 4543 4544 4545
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4546
"Functions (System)","READONLY","
4547
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4548 4549 4550 4551 4552 4553 4554
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
4555
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
4556
","
4557
Returns the number of the current row.
4558 4559
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4560
The first row has the row number 1, and is calculated before ordering and grouping the result set,
4561
but after evaluating index conditions (even when the index conditions are specified in an outer query).
4562
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
4563
","
4564 4565
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4566
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4567 4568 4569
"

"Functions (System)","SCHEMA","
4570
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4571
","
4572
Returns the name of the default schema for this session.
Thomas Mueller's avatar
Thomas Mueller committed
4573 4574 4575 4576
","
CALL SCHEMA()
"

4577 4578 4579
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4580
Returns the last inserted identity value for this session for the current scope
4581
(the current statement).
4582 4583 4584 4585 4586 4587
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
4588
"Functions (System)","SESSION_ID","
4589
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4590
","
4591 4592 4593 4594
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
4595 4596 4597 4598 4599
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4600
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4601
","
4602 4603 4604
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
4605
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4606
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4607 4608 4609 4610 4611
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4612
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4613 4614 4615 4616 4617 4618 4619
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4620
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4621
","
4622 4623
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
4624
Otherwise a value of the following form is returned:
4625
""logFileId-position-sessionId"".
4626 4627
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4628 4629 4630 4631
","
CALL TRANSACTION_ID()
"

4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643
"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
4644
"Functions (System)","USER","
4645
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4646 4647 4648 4649 4650 4651
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4652 4653 4654 4655 4656 4657 4658 4659
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674
"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
4675