help.csv 134.9 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 8 9
SELECT [ TOP term ] [ DISTINCT | ALL ] selectExpression [,...]
FROM tableExpression [,...] [ WHERE expression ]
[ GROUP BY expression [,...] ] [ HAVING expression ]
[ { UNION [ ALL ] | MINUS | EXCEPT | INTERSECT } select ] [ ORDER BY order [,...] ]
10
[ { LIMIT expression [ OFFSET expression ] [ SAMPLE_SIZE rowCountInt ] } | { [ OFFSET expression { ROW | ROWS } ] [ { FETCH { FIRST | NEXT } expression { ROW | ROWS } ONLY } ] } ]
11
[ FOR UPDATE ]
Thomas Mueller's avatar
Thomas Mueller committed
12 13
","
Selects data from a table or multiple tables.
14 15 16 17
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
18

19
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
20
OFFSET specified how many rows to skip.
21
Please note using high offset values should be avoided because it can cause performance problems.
22
SAMPLE_SIZE limits the number of rows read for aggregate queries.
23

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

28 29
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
30
In this case, aggregate, GROUP BY, DISTINCT queries or joins
31
are not allowed in this case.
Thomas Mueller's avatar
Thomas Mueller committed
32 33
","
SELECT * FROM TEST;
34 35 36 37 38
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
39 40 41 42 43 44
SELECT * FROM (SELECT ID, COUNT(*) FROM TEST
    GROUP BY ID UNION SELECT NULL, COUNT(*) FROM TEST)
    ORDER BY 1 NULLS LAST;
"

"Commands (DML)","INSERT","
45 46 47 48
INSERT INTO tableName
{ [ ( columnName [,...] ) ]
    { VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | [ DIRECT ] [ SORTED ] select } } |
    { SET { columnName = { DEFAULT | expression } } [,...] }
Thomas Mueller's avatar
Thomas Mueller committed
49 50
","
Inserts a new row / new rows into a table.
51 52 53 54

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
55 56 57 58 59
","
INSERT INTO TEST VALUES(1, 'Hello')
"

"Commands (DML)","UPDATE","
60 61 62
UPDATE tableName [ [ AS ] newTableAlias ] SET
{ { columnName = { DEFAULT | expression } } [,...] } |
    { ( columnName [,...] ) = ( select ) }
63
[ WHERE expression ] [ ORDER BY order [,...] ] [ LIMIT expression ]
Thomas Mueller's avatar
Thomas Mueller committed
64 65
","
Updates data in a table.
66
ORDER BY is supported for MySQL compatibility, but it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
67
","
68 69
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
70 71 72
"

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

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

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

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

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

Owner's avatar
Owner committed
123
"Commands (DML)","MERGE USING","
124 125 126 127
MERGE INTO targetTableName [ [AS] targetAlias]
USING { ( select ) | sourceTableName }[ [AS] sourceAlias ]
ON ( expression )
[ WHEN MATCHED THEN [ update ] [ delete] ]
128
[ WHEN NOT MATCHED THEN insert ]
129 130 131 132 133 134 135
","
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
to the same target row. The embedded update, delete or insert statements can not re-specify
Owner's avatar
Owner committed
136 137
the target table name.
","
138 139 140 141 142 143 144 145 146 147 148 149 150 151
MERGE INTO TARGET_TABLE AS T USING SOURCE_TABLE AS S
    ON (T.ID = S.ID)
    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
    ON (T.ID = S.ID)
    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)
Owner's avatar
Owner committed
152 153
"

Thomas Mueller's avatar
Thomas Mueller committed
154
"Commands (DML)","RUNSCRIPT","
155 156
RUNSCRIPT FROM fileNameString scriptCompressionEncryption
[ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
157 158 159 160 161 162
","
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.

163
Instead of a file name, an URL may be used.
164
To read a stream from the classpath, use the prefix 'classpath:'.
165
See the Pluggable File System section on the Advanced page.
166

167
The compression algorithm must match the one used when creating the script.
Thomas Mueller's avatar
Thomas Mueller committed
168 169 170
Instead of a file, an URL may be used.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
171
","
172
RUNSCRIPT FROM 'backup.sql'
173
RUNSCRIPT FROM 'classpath:/com/acme/test.sql'
Thomas Mueller's avatar
Thomas Mueller committed
174 175 176
"

"Commands (DML)","SCRIPT","
177 178
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
179
[ TO fileNameString scriptCompressionEncryption
180
    [ CHARSET charsetString ] ]
181 182
[ TABLE tableName [, ...] ]
[ SCHEMA schemaName [, ...] ]
Thomas Mueller's avatar
Thomas Mueller committed
183
","
184 185 186 187 188 189 190
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
191 192
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
193
out-of-line commands.
Thomas Mueller's avatar
Thomas Mueller committed
194
NOSETTINGS turns off dumping the database settings (the SET XXX commands)
195

196
If no 'TO fileName' clause is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
197 198 199 200
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.

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

Thomas Mueller's avatar
Thomas Mueller committed
205 206 207
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
208
Admin rights are required to execute this command.
209

210
When using the TABLE or SCHEMA option, only the selected table(s) / schema(s) are included.
Thomas Mueller's avatar
Thomas Mueller committed
211 212 213 214 215
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
216 217
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
218 219 220 221 222 223
","
Lists the schemas, tables, or the columns of a table.
","
SHOW TABLES
"

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

Example 2:
WITH cte1 AS (
246
        SELECT 1 AS FIRST_COLUMN
247 248
), cte2 AS (
        SELECT FIRST_COLUMN+1 AS FIRST_COLUMN FROM cte1
249
)
250
SELECT sum(FIRST_COLUMN) FROM cte2;
251 252
"

Thomas Mueller's avatar
Thomas Mueller committed
253
"Commands (DDL)","ALTER INDEX RENAME","
254
ALTER INDEX [ IF EXISTS ] indexName RENAME TO newIndexName
Thomas Mueller's avatar
Thomas Mueller committed
255
","
Thomas Mueller's avatar
Thomas Mueller committed
256
Renames an index.
Thomas Mueller's avatar
Thomas Mueller committed
257
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
258 259 260 261
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

262
"Commands (DDL)","ALTER SCHEMA RENAME","
263
ALTER SCHEMA [ IF EXISTS ] schema RENAME TO newSchemaName
264 265
","
Renames a schema.
Thomas Mueller's avatar
Thomas Mueller committed
266
This command commits an open transaction in this connection.
267 268 269 270
","
ALTER SCHEMA TEST RENAME TO PRODUCTION
"

Thomas Mueller's avatar
Thomas Mueller committed
271
"Commands (DDL)","ALTER SEQUENCE","
272
ALTER SEQUENCE [ IF EXISTS ] sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
273 274
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
275 276
[ CYCLE long | NOCYCLE | NO CYCLE ]
[ CACHE long | NOCACHE | NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
277
","
278
Changes the parameters of a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
279
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
280 281 282 283 284 285
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

"Commands (DDL)","ALTER TABLE ADD","
286
ALTER TABLE [ IF EXISTS ] tableName ADD [ COLUMN ]
287 288
{ [ IF NOT EXISTS ] columnName columnDefinition
    | ( { columnName columnDefinition | constraint } [,...] ) }
289
[ { { BEFORE | AFTER } columnName } | FIRST ]
Thomas Mueller's avatar
Thomas Mueller committed
290
","
Thomas Mueller's avatar
Thomas Mueller committed
291
Adds a new column to a table.
Thomas Mueller's avatar
Thomas Mueller committed
292
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
293 294 295 296 297
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
298
ALTER TABLE [ IF EXISTS ] tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
299 300 301
","
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
302
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
303
It is not possible to disable checking for unique constraints.
Thomas Mueller's avatar
Thomas Mueller committed
304
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
305 306 307 308
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

309
"Commands (DDL)","ALTER TABLE RENAME CONSTRAINT","
310
ALTER TABLE [ IF EXISTS ] tableName RENAME oldConstraintName TO newConstraintName
311 312 313 314 315 316 317
","
Renames a constraint.
This command commits an open transaction in this connection.
","
ALTER TABLE TEST RENAME CONSTRAINT FOO TO BAR
"

318
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
319
ALTER TABLE [ IF EXISTS ] tableName ALTER COLUMN columnName
320
{ { columnDefinition }
321 322 323 324 325
    | { RENAME TO name }
    | { RESTART WITH long }
    | { SELECTIVITY int }
    | { SET DEFAULT expression }
    | { SET NULL }
326 327
    | { SET NOT NULL }
    | { SET { VISIBLE | INVISIBLE } } }
Thomas Mueller's avatar
Thomas Mueller committed
328
","
329 330
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
331

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

334 335 336
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
337

338 339 340 341
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
342

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

345
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
346
Single column indexes on this column are dropped.
347 348 349

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

350 351 352
SET INVISIBLE makes the column hidden, i.e. it will not appear in SELECT * results.
SET VISIBLE has the reverse effect.

Thomas Mueller's avatar
Thomas Mueller committed
353
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
354
","
355 356 357 358 359 360 361
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;
362 363
ALTER TABLE TEST ALTER COLUMN NAME SET VISIBLE;
ALTER TABLE TEST ALTER COLUMN NAME SET INVISIBLE;
Thomas Mueller's avatar
Thomas Mueller committed
364 365 366
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
367
ALTER TABLE [ IF EXISTS ] tableName DROP COLUMN [ IF EXISTS ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
368
","
369
Removes column(s) from a table.
Thomas Mueller's avatar
Thomas Mueller committed
370
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
371 372
","
ALTER TABLE TEST DROP COLUMN NAME
373
ALTER TABLE TEST DROP COLUMN NAME1, NAME2
Thomas Mueller's avatar
Thomas Mueller committed
374 375 376
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
377
ALTER TABLE [ IF EXISTS ] tableName DROP { CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
378 379
","
Removes a constraint or a primary key from a table.
Thomas Mueller's avatar
Thomas Mueller committed
380
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
381 382 383 384 385
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
386
ALTER TABLE [ IF EXISTS ] tableName SET REFERENTIAL_INTEGRITY
387
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
388 389 390 391 392 393
","
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.
394

Thomas Mueller's avatar
Thomas Mueller committed
395
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
396 397 398 399 400
","
ALTER TABLE TEST SET REFERENTIAL_INTEGRITY FALSE
"

"Commands (DDL)","ALTER TABLE RENAME","
401
ALTER TABLE [ IF EXISTS ] tableName RENAME TO newName
Thomas Mueller's avatar
Thomas Mueller committed
402
","
Thomas Mueller's avatar
Thomas Mueller committed
403
Renames a table.
Thomas Mueller's avatar
Thomas Mueller committed
404
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
405 406 407 408 409
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
410
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
411
","
Thomas Mueller's avatar
Thomas Mueller committed
412 413 414 415
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
416
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
417 418 419 420 421 422 423
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
424 425 426 427
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
428
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
429
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
430 431 432 433 434
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
435
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
436
","
Thomas Mueller's avatar
Thomas Mueller committed
437 438 439 440 441 442
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
443
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
444 445 446 447 448
","
ALTER USER SA SET PASSWORD 'rioyxlgt'
"

"Commands (DDL)","ALTER VIEW","
449
ALTER VIEW [ IF EXISTS ] viewName RECOMPILE
Thomas Mueller's avatar
Thomas Mueller committed
450 451
","
Recompiles a view after the underlying tables have been changed or created.
Thomas Mueller's avatar
Thomas Mueller committed
452
This command is used for views created using CREATE FORCE VIEW.
Thomas Mueller's avatar
Thomas Mueller committed
453
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
454 455 456 457 458
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
459
ANALYZE [ TABLE tableName ] [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
460
","
461 462 463
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
464 465 466 467 468
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.
469

Thomas Mueller's avatar
Thomas Mueller committed
470
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
471 472 473 474 475
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
476 477 478 479 480
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
481
","
Thomas Mueller's avatar
Thomas Mueller committed
482 483 484
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
485
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
486 487 488 489 490
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
491
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
492 493 494
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
495
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
496 497

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
498
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
499
","
500
CREATE AGGREGATE SIMPLE_MEDIAN FOR ""com.acme.db.Median""
Thomas Mueller's avatar
Thomas Mueller committed
501 502 503
"

"Commands (DDL)","CREATE ALIAS","
Thomas Mueller's avatar
Thomas Mueller committed
504
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
Thomas Mueller's avatar
Thomas Mueller committed
505
[ NOBUFFER ] { FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
506
","
507 508 509 510 511 512
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.
513 514 515

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

521 522
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.
523 524
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
525 526
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
527

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

531
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
532 533 534
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.
535

Thomas Mueller's avatar
Thomas Mueller committed
536
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
537
This command commits an open transaction in this connection.
538 539

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
540 541 542 543 544
","
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');
545 546
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
547 548 549 550 551
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
552 553 554
"

"Commands (DDL)","CREATE CONSTANT","
555
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
556
","
Thomas Mueller's avatar
Thomas Mueller committed
557
Creates a new constant.
Thomas Mueller's avatar
Thomas Mueller committed
558
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
559 560 561 562 563
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
564 565 566
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
567 568
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
569
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
570
to the value being tested.
571

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

Thomas Mueller's avatar
Thomas Mueller committed
574
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
575 576 577 578 579
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
580
CREATE
Thomas Mueller's avatar
Thomas Mueller committed
581
{ [ UNIQUE ] [ HASH | SPATIAL] INDEX [ [ IF NOT EXISTS ] newIndexName ]
582 583
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
584
","
Thomas Mueller's avatar
Thomas Mueller committed
585
Creates a new index.
Thomas Mueller's avatar
Thomas Mueller committed
586
This command commits an open transaction in this connection.
587

Thomas Mueller's avatar
Thomas Mueller committed
588
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
589 590
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
591
Non-unique keys are supported.
592
Spatial indexes are supported only on Geometry columns.
Thomas Mueller's avatar
Thomas Mueller committed
593 594 595 596 597
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
598
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ]
Thomas Mueller's avatar
Thomas Mueller committed
599
LINKED TABLE [ IF NOT EXISTS ]
600 601
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
602 603 604 605 606
","
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.

607 608 609
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
610 611
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
612
work. Linked tables to the same database share one connection.
613

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

Thomas Mueller's avatar
Thomas Mueller committed
616 617 618
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).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
626
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
627
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
628 629 630 631 632 633 634 635 636
","
CREATE LINKED TABLE LINK('org.h2.Driver', 'jdbc:h2:test2', 'sa', 'sa', 'TEST');
CREATE LINKED TABLE LINK('', 'jdbc:h2:test2', 'sa', 'sa',
    '(SELECT * FROM TEST WHERE ID>0)');
CREATE LINKED TABLE LINK('javax.naming.InitialContext',
    'java:comp/env/jdbc/Test', NULL, NULL, '(SELECT * FROM TEST WHERE ID>0)');
"

"Commands (DDL)","CREATE ROLE","
637
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
638
","
Thomas Mueller's avatar
Thomas Mueller committed
639
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
640
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
641 642 643 644 645
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
646
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
647
[ WITH tableEngineParamName [,...] ]
Thomas Mueller's avatar
Thomas Mueller committed
648 649 650
","
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
651
Specifying the owner currently has no effect.
652 653
Optional table engine parameters are used when CREATE TABLE command
is run on this schema without having its engine params set.
654

Thomas Mueller's avatar
Thomas Mueller committed
655
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
656 657 658 659 660
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
661
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
662 663 664
[ INCREMENT BY long ]
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
665 666
[ CYCLE long | NOCYCLE | NO CYCLE ]
[ CACHE long | NOCACHE | NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
667
","
Thomas Mueller's avatar
Thomas Mueller committed
668 669 670
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
671 672 673 674 675

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
676

Thomas Mueller's avatar
Thomas Mueller committed
677
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
678 679 680 681 682
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
683 684
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
685
[ ( { columnName columnDefinition | constraint } [,...] ) ]
686 687
[ ENGINE tableEngineName ]
[ WITH tableEngineParamName [,...] ]
688
[ NOT PERSISTENT ] [ TRANSACTIONAL ]
689
[ AS select ]","
Thomas Mueller's avatar
Thomas Mueller committed
690 691
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
692 693 694 695
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
696
that means memory tables should not get too large.
697

Thomas Mueller's avatar
Thomas Mueller committed
698 699 700 701 702
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,
703
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
704

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

709 710 711
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.

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

715 716 717
The column definition is optional if a query is specified.
In that case the column list of the query is used.

Thomas Mueller's avatar
Thomas Mueller committed
718 719
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
720 721 722 723 724
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
725
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
726
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
727
[ QUEUE int ] [ NOWAIT ] { CALL triggeredClassName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
728
","
Thomas Mueller's avatar
Thomas Mueller committed
729 730 731 732 733
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).
734

735 736
The sourceCodeString must define a single method with no parameters that returns ""org.h2.api.Trigger"".
See CREATE ALIAS for requirements regarding the compilation.
737 738 739
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"".
740

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

Thomas Mueller's avatar
Thomas Mueller committed
746
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
747
Only row based AFTER trigger can be called on ROLLBACK.
748
Exceptions that occur within such triggers are ignored.
749 750
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.
751

752
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
753
Only the first such trigger is called. Such triggers on views are supported.
754
They can be used to make views updatable.
755

Thomas Mueller's avatar
Thomas Mueller committed
756 757
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.
758 759
The trigger is called with both 'old' and 'new' set to null.

760 761 762 763
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
764 765
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
766 767 768
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.

769 770
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

Thomas Mueller's avatar
Thomas Mueller committed
771 772
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.
773

Thomas Mueller's avatar
Thomas Mueller committed
774
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
775
","
776
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger"";
Thomas Mueller's avatar
Thomas Mueller committed
777
CREATE TRIGGER TRIG_SRC BEFORE INSERT ON TEST AS $$org.h2.api.Trigger create() { return new MyTrigger(""constructorParam""); } $$;
778 779
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
780 781
"
"Commands (DDL)","CREATE USER","
782 783
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
784
","
Thomas Mueller's avatar
Thomas Mueller committed
785 786 787
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.
788

Thomas Mueller's avatar
Thomas Mueller committed
789
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
790
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
791 792 793 794 795
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
796
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
797
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
798 799
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
800
if the underlying table(s) don't exist.
801

Thomas Mueller's avatar
Thomas Mueller committed
802 803 804 805 806
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.

807 808
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
809
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
810
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
811 812 813 814 815
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
816
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
817
","
Thomas Mueller's avatar
Thomas Mueller committed
818 819 820
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
821
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
822
","
823
DROP AGGREGATE SIMPLE_MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
824 825 826
"

"Commands (DDL)","DROP ALIAS","
827
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
828
","
Thomas Mueller's avatar
Thomas Mueller committed
829 830 831
Drops an existing function alias.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
832
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
833
","
Thomas Mueller's avatar
Thomas Mueller committed
834
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
835 836 837
"

"Commands (DDL)","DROP ALL OBJECTS","
838
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
839 840 841 842 843
","
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
844 845 846
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
847 848 849 850 851
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
852
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
853
","
Thomas Mueller's avatar
Thomas Mueller committed
854
Drops a constant.
Thomas Mueller's avatar
Thomas Mueller committed
855
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
856 857 858 859 860
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
861
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
862
","
Thomas Mueller's avatar
Thomas Mueller committed
863
Drops a data type (domain).
Thomas Mueller's avatar
Thomas Mueller committed
864
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
865 866 867 868 869
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
870
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
871
","
Thomas Mueller's avatar
Thomas Mueller committed
872
Drops an index.
Thomas Mueller's avatar
Thomas Mueller committed
873
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
874 875 876 877 878
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
879
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
880
","
Thomas Mueller's avatar
Thomas Mueller committed
881
Drops a role.
Thomas Mueller's avatar
Thomas Mueller committed
882
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
883 884 885 886 887
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
888
DROP SCHEMA [ IF EXISTS ] schemaName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
889
","
Thomas Mueller's avatar
Thomas Mueller committed
890
Drops a schema.
891 892
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
893
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
894 895 896 897 898
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
899
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
900
","
Thomas Mueller's avatar
Thomas Mueller committed
901
Drops a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
902
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
903 904 905 906 907
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
908
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
909
","
Thomas Mueller's avatar
Thomas Mueller committed
910
Drops an existing table, or a list of tables.
911 912
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
913
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
914 915 916 917 918
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
919
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
920
","
Thomas Mueller's avatar
Thomas Mueller committed
921
Drops an existing trigger.
Thomas Mueller's avatar
Thomas Mueller committed
922
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
923 924 925 926 927
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
928
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
929
","
Thomas Mueller's avatar
Thomas Mueller committed
930 931
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
932

Thomas Mueller's avatar
Thomas Mueller committed
933
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
934
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
935 936 937 938 939
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
940
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
941
","
Thomas Mueller's avatar
Thomas Mueller committed
942 943 944
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
945
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
946 947 948 949 950 951 952
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
953 954 955 956 957
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).
958
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
959

Thomas Mueller's avatar
Thomas Mueller committed
960
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
961 962 963 964 965 966 967
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
968
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
969 970

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
971 972 973 974 975 976 977
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
978
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
979 980 981
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
982 983 984 985 986
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
987
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
988 989 990 991 992 993 994 995 996
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
997 998 999 1000
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
1001 1002 1003 1004 1005
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
1006
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1007 1008
{ { SCHEMA schemaName } | { tableName [,...] } }
TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1009
","
Thomas Mueller's avatar
Thomas Mueller committed
1010 1011 1012
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
1013
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1014 1015 1016 1017
","
GRANT SELECT ON TEST TO READONLY
"

1018 1019 1020 1021 1022 1023
"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
1024
This command commits an open transaction in this connection.
1025 1026 1027 1028
","
GRANT ALTER ANY SCHEMA TO Bob
"

Thomas Mueller's avatar
Thomas Mueller committed
1029
"Commands (Other)","GRANT ROLE","
1030
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1031
","
Thomas Mueller's avatar
Thomas Mueller committed
1032 1033 1034
Grants a role to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1035
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1036 1037 1038 1039 1040
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
1041
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1042 1043 1044 1045 1046 1047 1048 1049 1050
","
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
1051 1052
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
1053 1054 1055 1056 1057
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
1058
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1059 1060
{ { SCHEMA schemaName } | { tableName [,...] } }
FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1061
","
Thomas Mueller's avatar
Thomas Mueller committed
1062 1063 1064
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
1065
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1066 1067 1068 1069 1070
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
1071
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1072
","
Thomas Mueller's avatar
Thomas Mueller committed
1073 1074 1075
Removes a role from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1076
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1077 1078 1079 1080 1081
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
1082
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
","
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
1093 1094 1095 1096
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
1097 1098 1099 1100 1101 1102 1103
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1104 1105
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
1106 1107 1108 1109 1110
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1111
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1112
","
Thomas Mueller's avatar
Thomas Mueller committed
1113
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1114
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
1115
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1116 1117 1118 1119 1120
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1121
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
","
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
1132 1133
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1134
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1135
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1136
This setting is persistent.
1137
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1138 1139 1140 1141 1142
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
1143
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
1144 1145
","
Switches auto commit on or off.
1146
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
1147
however this will not work as expected when using a connection pool
1148 1149
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
1150
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
1151 1152 1153 1154 1155 1156 1157
","
SET AUTOCOMMIT OFF
"

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1169
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1170
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1171
This setting is persistent.
1172
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
","
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
1185 1186
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1187
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1188 1189 1190 1191
","
SET CLUSTER ''
"

1192 1193 1194 1195
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1196 1197
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.
1198 1199 1200
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
1201
This command commits an open transaction in this connection.
1202 1203 1204 1205 1206
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
"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
1220
"Commands (Other)","SET COLLATION","
1221 1222
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1223
","
Thomas Mueller's avatar
Thomas Mueller committed
1224 1225
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
1226 1227
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
1228
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1229

1230 1231 1232 1233 1234
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).
1235 1236
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.
1237

Thomas Mueller's avatar
Thomas Mueller committed
1238
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1239
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1240
This setting is persistent.
1241
This setting can be appended to the database URL: ""jdbc:h2:test;COLLATION='ENGLISH'""
Thomas Mueller's avatar
Thomas Mueller committed
1242 1243
","
SET COLLATION ENGLISH
1244
SET COLLATION CHARSET_CP500
Thomas Mueller's avatar
Thomas Mueller committed
1245 1246 1247
"

"Commands (Other)","SET COMPRESS_LOB","
1248
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1249
","
Thomas Mueller's avatar
Thomas Mueller committed
1250 1251 1252 1253
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
1254 1255
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
1256

Thomas Mueller's avatar
Thomas Mueller committed
1257
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1258
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1259
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1260 1261 1262 1263 1264 1265 1266 1267
","
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
1268 1269 1270 1271
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).
1272
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1273 1274 1275 1276 1277 1278 1279
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1280 1281
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
1282 1283 1284 1285
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
1286

Thomas Mueller's avatar
Thomas Mueller committed
1287
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1288
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1289
This setting is persistent.
1290
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1291 1292 1293 1294 1295 1296 1297 1298
","
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
1299 1300
for the new sessions. The default value for this setting is 1000 (one second).

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
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1309
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1310 1311 1312
","
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
1313
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1314
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1315

Thomas Mueller's avatar
Thomas Mueller committed
1316
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1317
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1318
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1319
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1320 1321 1322 1323 1324
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1325
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1326
","
Thomas Mueller's avatar
Thomas Mueller committed
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
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
1337 1338

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1339
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1340
","
Thomas Mueller's avatar
Thomas Mueller committed
1341
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1342 1343 1344
"

"Commands (Other)","SET IGNORECASE","
1345
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1346 1347 1348 1349 1350
","
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
1351
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1352

Thomas Mueller's avatar
Thomas Mueller committed
1353
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1354
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1355
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1356
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1357 1358 1359 1360
","
SET IGNORECASE TRUE
"

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
"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
1373
This command commits an open transaction in this connection.
1374 1375 1376 1377 1378 1379 1380
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'
"


1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
"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
"

1398
"Commands (Other)","SET LOG","
1399
SET LOG int
1400 1401 1402 1403
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1404
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1405 1406 1407 1408
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.

1409 1410
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
1411 1412
against power failure is required, but the data must be protected against killing the process.

1413 1414
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
1415 1416
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1417
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1418
This command commits an open transaction in this connection.
1419
This setting is not persistent.
1420
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1421 1422 1423 1424
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1425 1426 1427 1428
"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
1429
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442

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
1443
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1444
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1445
This setting is persistent.
1446
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1447 1448 1449 1450 1451 1452 1453 1454
","
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
1455 1456 1457
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1458
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1459 1460 1461 1462 1463 1464 1465
","
SET LOCK_TIMEOUT 1000
"

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

1468
This is the maximum length of an LOB that is stored with the record itself,
1469 1470
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1471
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1472
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1473
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1474 1475 1476 1477 1478 1479 1480
","
SET MAX_LENGTH_INPLACE_LOB 128
"

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

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.
Thomas Mueller's avatar
Thomas Mueller committed
1490 1491 1492 1493 1494 1495 1496 1497
","
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
1498
are read, then the rows are buffered to disk.
1499
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1500

Thomas Mueller's avatar
Thomas Mueller committed
1501
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1502
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1503
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1504
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1505 1506 1507 1508 1509 1510 1511
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1518
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1519
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1520
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1521
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1522 1523 1524 1525 1526 1527 1528 1529 1530
","
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
1531 1532 1533
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1534
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1535
It has no effect for in-memory databases.
1536
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1537 1538 1539 1540 1541
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1542
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1543 1544
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1545 1546 1547
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1548
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1549
This command commits an open transaction in this connection.
1550
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1551 1552 1553 1554 1555
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1556
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1557 1558 1559
","
Enabled (1) or disabled (0) multi-threading inside the database engine. By
default, this setting is disabled. Currently, enabling this is experimental
Thomas Mueller's avatar
Thomas Mueller committed
1560 1561 1562 1563 1564
only.

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
1565
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1566
This command commits an open transaction in this connection.
1567
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1568 1569 1570 1571 1572
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1573
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1574 1575 1576
","
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
1577 1578
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1579
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1580
This command commits an open transaction in this connection.
1581
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1582 1583 1584 1585 1586 1587 1588 1589 1590
","
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
1591

Thomas Mueller's avatar
Thomas Mueller committed
1592
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1593 1594 1595 1596
","
SET PASSWORD 'abcstzri!.5'
"

1597 1598 1599 1600 1601 1602 1603
"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
1604
This command commits an open transaction in this connection.
1605 1606 1607 1608 1609
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
"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
1623 1624 1625 1626 1627
"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
1628 1629 1630
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
1631 1632 1633 1634 1635
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1636
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1637 1638 1639
","
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
1640 1641 1642
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1643
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1644
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1645 1646 1647 1648
","
SET REFERENTIAL_INTEGRITY FALSE
"

1649 1650 1651 1652 1653 1654
"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.
1655 1656 1657
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,
1658 1659 1660 1661
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
1662
This command commits an open transaction in this connection.
1663 1664 1665 1666 1667 1668
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
1669 1670 1671 1672 1673
"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
1674

Thomas Mueller's avatar
Thomas Mueller committed
1675
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1676 1677 1678 1679 1680 1681 1682 1683 1684
","
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
1685 1686 1687
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1688
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1689 1690 1691 1692 1693 1694 1695 1696 1697
","
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
1698 1699 1700
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1701
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1702 1703 1704 1705 1706 1707 1708 1709 1710
","
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
1711 1712 1713
disabled).

This command does not commit a transaction, and rollback does not affect it.
1714
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1715 1716 1717 1718 1719
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1720
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1721 1722 1723
","
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.
1724
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1725

Thomas Mueller's avatar
Thomas Mueller committed
1726
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1727
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1728
This command does not commit a transaction, and rollback does not affect it.
1729
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
","
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
1741
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1742
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1743
This command commits an open transaction in this connection.
1744
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
","
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
1755

Thomas Mueller's avatar
Thomas Mueller committed
1756
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1757 1758 1759 1760 1761 1762 1763 1764
","
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
1765 1766
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1767
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1768
This command commits an open transaction in this connection.
1769
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1770 1771 1772 1773 1774
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1775
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1776
","
1777 1778
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
1779
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1780

1781 1782
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
1783 1784 1785

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,
1786
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
1787 1788

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1792
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1793
","
1794
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1795 1796
"

1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 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
"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).
1929 1930
ISO definition is used when first week of year should have at least four days
and week is started with Monday.
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
","
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
"

1962 1963
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1964
","
1965
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1966
","
1967
A
Thomas Mueller's avatar
Thomas Mueller committed
1968 1969
"

1970 1971
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1972
","
1973
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1974
","
1975
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1976 1977
"

1978
"Other Grammar","Array","
1979
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1980
","
1981 1982
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
1983
","
1984
(1, 2)
1985 1986
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1987 1988
"

1989 1990
"Other Grammar","Boolean","
TRUE | FALSE
1991
","
1992
A boolean value.
1993
","
1994
TRUE
1995 1996
"

1997 1998
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1999
","
2000
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
2001
","
2002
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
2003 2004
"

2005 2006 2007
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
2008
","
2009 2010
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
2011
","
2012
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
2013 2014
"

2015 2016 2017
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
2018
","
2019 2020
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2021
","
2022 2023 2024 2025
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
2026
AES
2027
","
2028
Only the algorithm AES (""AES-128"") is supported currently.
2029 2030
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
2031 2032
"

2033
"Other Grammar","Column Definition","
2034
dataType [ VISIBLE | INVISIBLE ]
Thomas Mueller's avatar
Thomas Mueller committed
2035
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
2036
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2037 2038
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
2039 2040
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
2041
The computed column expression is evaluated and assigned whenever the row changes.
2042 2043 2044 2045

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
2046

2047 2048 2049
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
2050 2051
The options PRIMARY KEY, UNIQUE, and CHECK are not supported for ALTER statements.

Thomas Mueller's avatar
Thomas Mueller committed
2052 2053
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
2054 2055
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
2056

2057
","
Thomas Mueller's avatar
Thomas Mueller committed
2058 2059 2060
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);
2061 2062
"

2063 2064
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
2065
","
2066 2067 2068
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
2069
","
2070
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
2071 2072
"

2073
"Other Grammar","Compare","
2074
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
2075
","
2076
Comparison operator. The operator != is the same as <>.
2077
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
2078
","
2079
<>
Thomas Mueller's avatar
Thomas Mueller committed
2080 2081 2082
"

"Other Grammar","Condition","
2083
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
2084 2085 2086 2087 2088 2089 2090
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
2091 2092
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
2093
    | IS [ NOT ] [ DISTINCT FROM ] operand
2094 2095
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
2096
    | [ NOT ] [ LIKE | ILIKE ] operand [ ESCAPE string ]
2097
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
2098
","
Thomas Mueller's avatar
Thomas Mueller committed
2099
The right hand side of a condition.
2100

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

Thomas Mueller's avatar
Thomas Mueller committed
2104 2105 2106 2107 2108
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).
2109 2110 2111
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.
2112

2113 2114
ILIKE does a case-insensitive compare.

Thomas Mueller's avatar
Thomas Mueller committed
2115
When comparing with REGEXP, regular expression matching is used.
2116
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
2117 2118 2119 2120
","
LIKE 'Jo%'
"

2121
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
2122 2123 2124 2125 2126
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
2127
","
Thomas Mueller's avatar
Thomas Mueller committed
2128 2129
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2130
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
2131 2132
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
2133
","
2134
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
2135 2136
"

2137 2138
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
2139
","
2140
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
2141
","
2142
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
2143 2144
"

2145 2146
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
2147
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
2148
","
2149
Optional parameters for CSVREAD and CSVWRITE.
2150 2151
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
2152 2153
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
2154
The following options are supported:
2155

2156
""caseSensitiveColumnNames"" (true or false; disabled by default),
2157

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

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

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

thomasmueller's avatar
thomasmueller committed
2164
""fieldSeparator"" (a comma by default),
2165

2166
""lineComment"" (disabled by default),
2167

2168
""lineSeparator"" (the line separator used for writing; ignored for reading),
2169

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

2173
""preserveWhitespace"" (true or false; disabled by default),
2174

2175
""writeColumnHeader"" (true or false; enabled by default).
2176

Thomas Mueller's avatar
Thomas Mueller committed
2177
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
2178
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
2179 2180 2181
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
2182
","
2183
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
2184 2185
"

2186 2187 2188
"Other Grammar","Data Type","
intType | booleanType | tinyintType | smallintType | bigintType | identityType
    | decimalType | doubleType | realType | dateType | timeType | timestampType
2189 2190 2191
    | timestampWithTimeZoneType | binaryType | otherType | varcharType
    | varcharIgnorecaseType | charType | blobType | clobType | uuidType
    | arrayType | enumType
Thomas Mueller's avatar
Thomas Mueller committed
2192
","
2193
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
2194
","
2195
INT
Thomas Mueller's avatar
Thomas Mueller committed
2196 2197
"

2198 2199
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
2200
","
2201
A date literal. The limitations are the same as for the Java data type
2202
""java.sql.Date"", but for compatibility with other databases the suggested minimum
2203
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
2204
","
2205
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
2206 2207
"

2208
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
2209
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
2210
","
Thomas Mueller's avatar
Thomas Mueller committed
2211 2212 2213 2214 2215 2216
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)"".
2217
","
Thomas Mueller's avatar
Thomas Mueller committed
2218 2219 2220
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
2221 2222
"

2223 2224
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
2225
","
2226
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
2227
","
2228
0
Thomas Mueller's avatar
Thomas Mueller committed
2229 2230
"

2231 2232
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
2233
","
2234 2235 2236
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
2237
","
2238
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
2239 2240
"

2241 2242
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2243
","
2244
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2245
","
2246
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2247 2248
"

2249
"Other Grammar","Factor","
2250
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2251
","
2252
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
2253
","
2254
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
2255 2256
"

2257 2258
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
2259
","
2260 2261
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
2262
","
2263
cafe
Thomas Mueller's avatar
Thomas Mueller committed
2264 2265
"

2266 2267
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
2268
","
2269
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
2270
","
2271
0xff
Thomas Mueller's avatar
Thomas Mueller committed
2272 2273
"

2274 2275
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2276
","
2277 2278 2279
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
2280
","
2281
NAME
Thomas Mueller's avatar
Thomas Mueller committed
2282 2283 2284
"

"Other Grammar","Int","
2285
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2286 2287 2288 2289 2290 2291 2292
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2293
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2294 2295 2296 2297 2298 2299
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2300
"Other Grammar","Name","
2301
{ { A-Z|_ } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2302
","
2303
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2304
","
2305
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2306 2307
"

2308 2309
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2310
","
2311
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2312
","
2313
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2314 2315
"

2316 2317 2318 2319 2320 2321 2322 2323
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2324
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2325
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2326
","
Thomas Mueller's avatar
Thomas Mueller committed
2327
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2328 2329 2330 2331 2332 2333 2334
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
"

2335 2336
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2337
","
2338
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2339
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2340
","
2341
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2342 2343
"

2344 2345
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2346
","
2347 2348 2349
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
2350
","
2351
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2352 2353
"

2354 2355
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2356
","
2357 2358 2359
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
2360
","
2361
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2362 2363
"

2364 2365 2366
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2367
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2368
","
Thomas Mueller's avatar
Thomas Mueller committed
2369 2370 2371
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
2372 2373 2374
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
2375
","
2376
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2377 2378
"

Thomas Mueller's avatar
Thomas Mueller committed
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389
"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
"

2390 2391
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2392
","
2393 2394
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
2395 2396 2397 2398 2399
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2400 2401
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2402
","
2403
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2404
","
2405
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2406 2407
"

2408 2409
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2410
","
2411 2412
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
2413
","
2414
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2415 2416
"

2417 2418
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2419
","
Thomas Mueller's avatar
Thomas Mueller committed
2420
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2421

Thomas Mueller's avatar
Thomas Mueller committed
2422
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2423
","
2424
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2425 2426
"

2427
"Other Grammar","Table Expression","
2428 2429
{ [ schemaName. ] tableName | ( select ) | valuesExpression }
[ [ AS ] newTableAlias [ ( columnName [,...] ) ] ]
2430
[ USE INDEX ([ indexName [,...] ]) ]
2431 2432
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2433
","
2434 2435 2436
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
2437
","
2438
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2439 2440
"

2441 2442 2443 2444 2445 2446 2447 2448 2449
"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;
"

2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2462
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2463
","
2464
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2465
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2466
","
2467 2468 2469 2470
'Hello'
"

"Other Grammar","Time","
2471
TIME [ WITHOUT TIME ZONE ] 'hh:mm:ss[.nnnnnnnnn]'
2472
","
2473
A time literal. A value is between 0:00:00 and 23:59:59.999999999
2474
and has nanosecond resolution.
2475 2476 2477 2478 2479
","
TIME '23:59:59'
"

"Other Grammar","Timestamp","
2480
TIMESTAMP [ WITHOUT TIME ZONE ] 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]'
2481 2482
","
A timestamp literal. The limitations are the same as for the Java data type
2483
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2484 2485 2486 2487 2488
minimum and maximum years are 0001 and 9999.
","
TIMESTAMP '2005-12-31 23:59:59'
"

2489
"Other Grammar","Timestamp with time zone","
2490
TIMESTAMP WITH TIME ZONE 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]
2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501
[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'
"

2502 2503 2504 2505 2506 2507 2508 2509
"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'
"

2510
"Other Grammar","Value","
2511
string | dollarQuotedString | numeric | dateAndTime | boolean | bytes | array | null
2512
","
Thomas Mueller's avatar
Thomas Mueller committed
2513
A literal value of any data type, or null.
2514 2515
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2516 2517 2518 2519 2520 2521 2522
"

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

2523
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2524 2525 2526 2527 2528 2529 2530 2531 2532
","
INT
"

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

2533
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2534 2535 2536 2537 2538 2539 2540 2541 2542
","
BOOLEAN
"

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

2543
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2544 2545 2546 2547 2548 2549 2550 2551 2552
","
TINYINT
"

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

2553
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2554 2555 2556 2557 2558 2559 2560 2561 2562
","
SMALLINT
"

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

2563
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574
","
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.

2575
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2576 2577 2578 2579 2580
","
IDENTITY
"

"Data Types","DECIMAL Type","
2581
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2582 2583 2584 2585
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2586
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2587 2588 2589 2590 2591
","
DECIMAL(20, 2)
"

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

2598
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2599 2600 2601 2602 2603
","
DOUBLE
"

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

2610
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2611 2612 2613 2614 2615
","
REAL
"

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

2621
Mapped to ""java.sql.Time"". When converted to a ""java.sql.Date"", the date is set to ""1970-01-01"".
2622
""java.time.LocalTime"" is also supported on Java 8 and later versions.
Evgenij Ryazanov's avatar
Evgenij Ryazanov committed
2623
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
2624 2625 2626 2627 2628 2629 2630
","
TIME
"

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

2633
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2634
(or to the next possible time if midnight doesn't exist for the given date and timezone due to a daylight saving change).
2635
""java.time.LocalDate"" is also supported on Java 8 and later versions.
Thomas Mueller's avatar
Thomas Mueller committed
2636 2637 2638 2639 2640
","
DATE
"

"Data Types","TIMESTAMP Type","
2641
{ TIMESTAMP [ ( precisionInt ) ] [ WITHOUT TIME ZONE ] | DATETIME | SMALLDATETIME }
Thomas Mueller's avatar
Thomas Mueller committed
2642
","
Thomas Mueller's avatar
Thomas Mueller committed
2643
The timestamp data type. The format is yyyy-MM-dd hh:mm:ss[.nnnnnnnnn].
2644
Stored internally as a BCD-encoded date, and nanoseconds since midnight.
2645
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
Thomas Mueller's avatar
Thomas Mueller committed
2646

2647 2648
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
2649 2650 2651 2652
","
TIMESTAMP
"

2653
"Data Types","TIMESTAMP WITH TIME ZONE Type","
2654
TIMESTAMP [ ( precisionInt ) ] WITH TIME ZONE
2655
","
2656
The timestamp with time zone data type.
2657
Stored internally as a BCD-encoded date, nanoseconds since midnight, and time zone offset in minutes.
2658
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
2659

2660 2661 2662 2663 2664 2665 2666
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.
2667
","
2668
TIMESTAMP WITH TIME ZONE
2669 2670
"

Thomas Mueller's avatar
Thomas Mueller committed
2671
"Data Types","BINARY Type","
2672
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2673
","
2674 2675 2676 2677 2678
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
2679 2680 2681 2682 2683 2684 2685 2686 2687

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2688 2689 2690 2691 2692
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
2693

2694
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2695 2696 2697 2698 2699
","
OTHER
"

"Data Types","VARCHAR Type","
2700
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
2701
    | NVARCHAR2 | VARCHAR_CASESENSITIVE} [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2702
","
Thomas Mueller's avatar
Thomas Mueller committed
2703
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2704 2705 2706 2707 2708 2709 2710
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
2711

2712
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2713 2714 2715 2716 2717
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2718
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2719
","
Thomas Mueller's avatar
Thomas Mueller committed
2720
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2721 2722 2723 2724 2725 2726 2727
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
2728

2729
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2730 2731 2732 2733 2734
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2735
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2736
","
Thomas Mueller's avatar
Thomas Mueller committed
2737 2738 2739
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
2740

Thomas Mueller's avatar
Thomas Mueller committed
2741 2742
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
2743

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

2747
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2748 2749 2750 2751 2752
","
CHAR(10)
"

"Data Types","BLOB Type","
2753
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2754 2755 2756
","
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
2757
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2758 2759
Advanced / Large Objects.

2760
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2761 2762 2763 2764 2765
","
BLOB
"

"Data Types","CLOB Type","
2766
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2767 2768 2769 2770 2771
","
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
2772
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2773 2774 2775 2776 2777

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.

2778
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2779 2780 2781 2782 2783 2784 2785
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2786 2787 2788 2789
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
2790

Thomas Mueller's avatar
Thomas Mueller committed
2791 2792 2793 2794 2795
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
2796
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2797 2798 2799 2800 2801 2802 2803
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2804
An array of values.
2805
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2806 2807 2808 2809


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
2810 2811 2812 2813
","
ARRAY
"

2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827
"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')
"
2828 2829 2830
"Data Types","GEOMETRY Type","
GEOMETRY
","
2831
A spatial geometry type, based on the ""org.locationtech.jts"" library.
2832
Normally represented in textual format using the WKT (well known text) format.
2833

Thomas Mueller's avatar
Thomas Mueller committed
2834
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2835 2836
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2837
GEOMETRY
2838 2839
"

Thomas Mueller's avatar
Thomas Mueller committed
2840
"Functions (Aggregate)","AVG","
2841
AVG ( [ DISTINCT ] { numeric } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2842
","
2843 2844
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2845
Aggregates are only allowed in select statements.
2846
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2847 2848 2849 2850
","
AVG(X)
"

2851
"Functions (Aggregate)","BIT_AND","
2852
BIT_AND(expression) [ FILTER ( WHERE expression ) ]
2853 2854 2855 2856 2857 2858 2859 2860 2861
","
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","
2862
BIT_OR(expression) [ FILTER ( WHERE expression ) ]
2863 2864 2865 2866 2867 2868 2869 2870
","
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
2871
"Functions (Aggregate)","BOOL_AND","
2872
BOOL_AND(boolean) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2873
","
2874 2875 2876
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
2877 2878 2879 2880 2881
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2882
BOOL_OR(boolean) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2883
","
2884 2885 2886
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
2887 2888 2889 2890 2891
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2892
COUNT( { * | { [ DISTINCT ] expression } } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2893
","
2894 2895 2896 2897
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
2898 2899 2900 2901 2902
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2903 2904
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2905
[ SEPARATOR expression ] ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2906
","
2907 2908 2909 2910 2911
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
2912 2913 2914 2915 2916
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2917
MAX(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2918
","
2919 2920 2921 2922
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
2923 2924 2925 2926 2927
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2928
MIN(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2929
","
2930 2931 2932 2933
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
2934 2935 2936 2937 2938
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
2939
SUM( [ DISTINCT ] { numeric } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2940
","
2941 2942 2943
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2944
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2945
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2946 2947 2948 2949 2950
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2951
SELECTIVITY(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2952
","
2953 2954 2955 2956 2957
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
2958 2959 2960 2961 2962
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
2963
STDDEV_POP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2964
","
2965 2966 2967
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
2968 2969 2970 2971 2972 2973
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
2974
STDDEV_SAMP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2975
","
2976 2977 2978
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
2979 2980 2981 2982 2983 2984
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
2985
VAR_POP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2986
","
2987 2988 2989 2990
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
2991 2992 2993 2994 2995
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
2996
VAR_SAMP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2997
","
2998 2999 3000 3001
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
3002 3003 3004 3005
","
VAR_SAMP(X)
"

3006
"Functions (Aggregate)","MEDIAN","
3007
MEDIAN( [ DISTINCT ] value ) [ FILTER ( WHERE expression ) ]
3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018
","
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
3019
"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
3020
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3021
","
3022 3023
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"".
3024
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3025 3026 3027 3028 3029
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
3030
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3031
","
Thomas Mueller's avatar
Thomas Mueller committed
3032 3033
Calculate the arc cosine.
See also Java ""Math.acos"".
3034
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3035 3036 3037 3038 3039
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
3040
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3041
","
Thomas Mueller's avatar
Thomas Mueller committed
3042 3043
Calculate the arc sine.
See also Java ""Math.asin"".
3044
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3045 3046 3047 3048 3049
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
3050
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3051
","
Thomas Mueller's avatar
Thomas Mueller committed
3052 3053
Calculate the arc tangent.
See also Java ""Math.atan"".
3054
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3055 3056 3057 3058 3059
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
3060
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3061
","
Thomas Mueller's avatar
Thomas Mueller committed
3062 3063
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
3064
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3065 3066 3067 3068
","
COS(ANGLE)
"

3069
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
3070
COSH(numeric)
3071 3072 3073 3074 3075 3076 3077 3078
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
3079
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
3080
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3081
","
Thomas Mueller's avatar
Thomas Mueller committed
3082
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
3083
See also Java ""Math.*"" functions.
3084
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3085 3086 3087 3088 3089
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
3090
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3091
","
Thomas Mueller's avatar
Thomas Mueller committed
3092 3093
Calculate the trigonometric sine.
See also Java ""Math.sin"".
3094
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3095 3096 3097 3098
","
SIN(ANGLE)
"

3099
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
3100
SINH(numeric)
3101 3102 3103 3104 3105 3106 3107 3108
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
3109
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
3110
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3111
","
Thomas Mueller's avatar
Thomas Mueller committed
3112 3113
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
3114
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3115 3116 3117 3118
","
TAN(ANGLE)
"

3119
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
3120
TANH(numeric)
3121 3122 3123 3124 3125 3126 3127 3128
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
3129
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
3130
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3131
","
Thomas Mueller's avatar
Thomas Mueller committed
3132
Calculate the angle when converting the rectangular coordinates to polar coordinates.
3133
See also Java ""Math.atan2"".
3134
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3135 3136 3137 3138 3139
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
3140
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3141
","
3142 3143
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3144 3145 3146 3147 3148
See also Java operator &.
","
BITAND(A, B)
"

3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159
"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
3160
"Functions (Numeric)","BITOR","
3161
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3162
","
3163 3164
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3165 3166 3167 3168 3169 3170
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
3171
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3172
","
3173 3174
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3175 3176 3177 3178 3179 3180
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
3181
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3182
","
3183 3184
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3185 3186 3187 3188 3189 3190
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
3191
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3192
","
3193
See also Java ""Math.ceil"".
3194
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3195
","
3196
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
3197 3198 3199
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
3200
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3201
","
3202
See also Java ""Math.toDegrees"".
3203
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3204 3205 3206 3207 3208
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
3209
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3210
","
3211
See also Java ""Math.exp"".
3212
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3213 3214 3215 3216 3217
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
3218
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3219
","
3220
See also Java ""Math.floor"".
3221
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3222 3223 3224 3225 3226
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
3227
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3228
","
3229
See also Java ""Math.log"".
3230
In the PostgreSQL mode, LOG(x) is base 10.
3231
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3232 3233 3234 3235 3236
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
3237
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3238
","
3239
See also Java ""Math.log10"" (in Java 5).
3240
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3241 3242 3243 3244 3245
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
3246
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3247
","
3248
See also Java ""Math.toRadians"".
3249
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3250 3251 3252 3253 3254
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
3255
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3256
","
3257
See also Java ""Math.sqrt"".
3258
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3259 3260 3261 3262 3263
","
SQRT(A)
"

"Functions (Numeric)","PI","
3264
PI()
Thomas Mueller's avatar
Thomas Mueller committed
3265
","
3266
See also Java ""Math.PI"".
3267
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3268 3269 3270 3271 3272
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
3273
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3274
","
3275
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
3276
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3277 3278 3279 3280 3281
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
3282
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
3283 3284 3285
","
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
3286
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
3287 3288 3289 3290 3291
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
3292
{ RANDOM_UUID | UUID } ()
Thomas Mueller's avatar
Thomas Mueller committed
3293 3294
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
3295 3296 3297 3298 3299

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
3300 3301 3302 3303 3304
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
3305
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
3306
","
3307
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
3308
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
3309 3310 3311 3312 3313
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
3314
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3315
","
3316 3317 3318 3319 3320 3321
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
3322 3323 3324 3325 3326
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
3327
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
3328 3329
","
Generates a number of cryptographically secure random numbers.
3330
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3331 3332 3333 3334 3335
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
3336
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3337 3338 3339 3340 3341 3342 3343
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
3344
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3345
","
3346
Encrypts data using a key.
3347
The supported algorithm is AES.
3348 3349
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3350 3351 3352 3353 3354
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
3355
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3356
","
3357
Decrypts data using a key.
3358
The supported algorithm is AES.
3359 3360
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3361 3362 3363 3364 3365 3366
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3367
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
3368
","
3369 3370 3371
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
3372 3373 3374 3375 3376
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3377 3378
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt}
    | timestamp | timestampWithTimeZone | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3379 3380
","
Truncates to a number of digits (to the next value closer to 0).
3381
This method returns a double.
3382
When used with a timestamp, truncates a timestamp to a date (day) value.
3383 3384
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
3385 3386 3387 3388 3389
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3390
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3391
","
3392 3393 3394 3395
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
3396 3397 3398 3399 3400
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3401
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3402 3403
","
Expands data that was compressed using the COMPRESS function.
3404
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3405 3406 3407 3408 3409
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3410
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3411 3412 3413 3414 3415 3416 3417
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3418
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3419 3420
","
Returns the ASCII value of the first character in the string.
3421
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3422 3423 3424 3425
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3426
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3427
","
3428 3429 3430
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
3431 3432 3433 3434 3435
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3436
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3437
","
3438 3439 3440
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
3441 3442 3443 3444 3445
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3446
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3447
","
3448 3449 3450 3451
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
3452 3453 3454 3455 3456
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3457
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3458 3459
","
Returns the character that represents the ASCII value.
3460
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3461 3462 3463 3464 3465
","
CHAR(65)
"

"Functions (String)","CONCAT","
3466
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3467 3468
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3469
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3470
and do not cause the result to become NULL.
3471
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3472 3473 3474 3475
","
CONCAT(NAME, '!')
"

3476 3477 3478 3479
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3480
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3481
and do not cause the result to become NULL.
3482 3483 3484 3485 3486
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3487
"Functions (String)","DIFFERENCE","
3488
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3489 3490
","
Returns the difference between the sounds of two strings.
3491
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3492 3493 3494 3495 3496
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3497
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3498
","
3499 3500
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
3501 3502 3503 3504 3505
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3506
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3507
","
3508 3509 3510
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
3511 3512 3513 3514 3515
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3516
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3517
","
3518
Returns the location of a search string in a string.
3519 3520 3521
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
3522
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3523 3524 3525 3526 3527
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3528
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3529
","
3530 3531 3532
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
3533 3534 3535 3536 3537
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3538
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3539 3540 3541 3542 3543 3544 3545
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3546
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3547 3548 3549 3550 3551 3552 3553
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3554
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3555 3556 3557 3558 3559 3560 3561
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3562
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3563 3564 3565 3566 3567 3568 3569
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3570
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3571
","
3572 3573 3574 3575
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
3576 3577 3578 3579 3580
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3581
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3582 3583 3584 3585 3586 3587 3588
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3589
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3590
","
3591 3592 3593
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
3594 3595 3596 3597 3598
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3599
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3600
","
3601 3602 3603
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
3604 3605 3606 3607 3608
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3609
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3610 3611 3612 3613 3614 3615 3616
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3617
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3618 3619 3620 3621 3622 3623 3624
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3625
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3626
","
3627 3628
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
3629 3630 3631 3632 3633
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3634
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
3635
","
3636
Replaces each substring that matches a regular expression.
3637
For details, see the Java ""String.replaceAll()"" method.
3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651
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
3652 3653
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
3654
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3655 3656
"

3657 3658 3659 3660
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675
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)

3676 3677
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3678 3679
"

3680

Thomas Mueller's avatar
Thomas Mueller committed
3681
"Functions (String)","REPEAT","
3682
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3683 3684 3685 3686 3687 3688 3689
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3690
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3691
","
3692 3693
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.
3694
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3695 3696 3697 3698 3699
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3700
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3701
","
3702 3703 3704
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
3705 3706 3707 3708 3709
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3710
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3711 3712 3713 3714 3715 3716 3717
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3718
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3719
","
3720 3721 3722
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
3723 3724 3725 3726 3727
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3728
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3729
","
3730 3731 3732
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
3733 3734 3735 3736 3737
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3738
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3739 3740
","
Encodes a string to a byte array using the UTF8 encoding format.
3741
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3742 3743 3744 3745 3746
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3747
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3748
","
3749
Returns a substring of a string starting at a position.
3750
If the start index is negative, then the start index is relative to the end of the string.
3751
The length is optional.
3752
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3753
","
3754 3755
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3756 3757 3758
"

"Functions (String)","UTF8TOSTRING","
3759
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3760 3761 3762 3763 3764 3765 3766
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3767
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3768
","
3769
Creates an XML attribute element of the form ""name=value"".
3770 3771
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3772 3773 3774 3775 3776
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3777
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3778 3779
","
Create an XML node element.
3780 3781 3782
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.
3783
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3784 3785 3786 3787 3788
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3789
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3790
","
3791
Creates an XML comment.
3792
Two dashes (""--"") are converted to ""- -"".
3793
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3794 3795 3796 3797 3798
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3799
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3800
","
3801
Creates an XML CDATA element.
3802
If the value contains ""]]>"", an XML text element is created instead.
3803
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3804 3805 3806 3807 3808
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3809
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3810
","
Thomas Mueller's avatar
Thomas Mueller committed
3811
Returns the XML declaration.
3812
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3813 3814 3815 3816 3817
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3818
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3819 3820
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3821
If enabled, newline and linefeed is converted to an XML entity (&#).
3822
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3823 3824 3825 3826
","
CALL XMLTEXT('test')
"

3827
"Functions (String)","TO_CHAR","
3828
TO_CHAR(value [, formatString[, nlsParamString]])
3829 3830 3831 3832 3833 3834
","
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')
"

3835
"Functions (String)","TRANSLATE","
3836
TRANSLATE(value, searchString, replacementString)
3837 3838 3839 3840 3841 3842
","
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
3843
"Functions (Time and Date)","CURRENT_DATE","
3844
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3845 3846
","
Returns the current date.
3847
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3848 3849 3850 3851 3852
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3853
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3854 3855
","
Returns the current time.
3856
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3857 3858 3859 3860 3861
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3862
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3863
","
3864 3865
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3866
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3867 3868 3869 3870 3871
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3872
{ DATEADD| TIMESTAMPADD } (datetimeField, addIntLong, dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3873
","
3874
Adds units to a date-time value. The string indicates the unit.
3875
Use negative values to subtract units.
3876
addIntLong may be a long value when manipulating milliseconds,
3877
microseconds, or nanoseconds otherwise its range is restricted to int.
3878
This method returns a value with the same type as specified value if unit is compatible with this value.
3879 3880 3881
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
3882 3883 3884 3885 3886
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3887
{ DATEDIFF | TIMESTAMPDIFF } (datetimeField, aDateAndTime, bDateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3888
","
3889
Returns the the number of crossed unit boundaries between two date/time values.
3890 3891
This method returns a long.
The string indicates the unit.
3892 3893
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
3894 3895 3896 3897 3898
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3899
DAYNAME(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3900 3901 3902 3903 3904 3905 3906
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3907
DAY_OF_MONTH(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3908 3909 3910 3911 3912 3913 3914
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3915
DAY_OF_WEEK(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3916 3917 3918 3919 3920 3921
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

3922 3923 3924 3925 3926 3927 3928 3929
"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
3930
"Functions (Time and Date)","DAY_OF_YEAR","
3931
DAY_OF_YEAR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3932 3933 3934 3935 3936 3937 3938
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3939
EXTRACT ( datetimeField FROM dateAndTime )
Thomas Mueller's avatar
Thomas Mueller committed
3940
","
3941
Returns a value of the specific time unit from a date/time value.
3942 3943
This method returns a numeric value with EPOCH field and
an int for all other fields.
Thomas Mueller's avatar
Thomas Mueller committed
3944 3945 3946 3947 3948
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3949
FORMATDATETIME ( dateAndTime, formatString
3950
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3951
","
3952 3953 3954
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.
3955
For details of the format, see ""java.text.SimpleDateFormat"".
3956 3957
timeZoneString may be specified if dateAndTime is a DATE, TIME or TIMESTAMP.
timeZoneString is ignored if dateAndTime is TIMESTAMP WITH TIME ZONE.
3958
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3959 3960 3961 3962 3963 3964
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3965
HOUR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3966
","
3967
Returns the hour (0-23) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
3968 3969 3970 3971 3972
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3973
MINUTE(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3974
","
3975
Returns the minute (0-59) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
3976 3977 3978 3979 3980
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3981
MONTH(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3982
","
3983
Returns the month (1-12) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
3984 3985 3986 3987 3988
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3989
MONTHNAME(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3990 3991 3992 3993 3994 3995 3996
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3997
PARSEDATETIME(string, formatString
3998
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3999
","
4000 4001 4002
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.
4003
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
4004 4005 4006 4007 4008 4009
","
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","
4010
QUARTER(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4011
","
4012
Returns the quarter (1-4) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4013 4014 4015 4016 4017
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
4018
SECOND(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4019
","
4020
Returns the second (0-59) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4021 4022 4023 4024 4025
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
4026
WEEK(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4027
","
4028
Returns the week (1-53) from a date/time value.
4029
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
4030 4031 4032 4033
","
WEEK(CREATED)
"

4034
"Functions (Time and Date)","ISO_WEEK","
4035
ISO_WEEK(dateAndTime)
4036
","
4037
Returns the ISO week (1-53) from a date/time value.
4038
This function uses the ISO definition when
4039 4040 4041 4042 4043 4044
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
4045
"Functions (Time and Date)","YEAR","
4046
YEAR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4047
","
4048
Returns the year from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4049 4050 4051 4052
","
YEAR(CREATED)
"

4053
"Functions (Time and Date)","ISO_YEAR","
4054
ISO_YEAR(dateAndTime)
4055
","
4056
Returns the ISO week year from a date/time value.
4057 4058 4059 4060
","
ISO_YEAR(CREATED)
"

Thomas Mueller's avatar
Thomas Mueller committed
4061
"Functions (System)","ARRAY_GET","
4062
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
4063 4064
","
Returns one element of an array.
4065
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4066 4067 4068 4069 4070
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
4071
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
4072 4073 4074 4075 4076 4077
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

4078 4079 4080 4081 4082 4083 4084 4085
"Functions (System)","ARRAY_CONTAINS","
ARRAY_CONTAINS(arrayExpression, value)
","
Returns a boolean true if the array contains the value.
","
CALL ARRAY_CONTAINS(('Hello', 'World'), 'Hello')
"

Thomas Mueller's avatar
Thomas Mueller committed
4086
"Functions (System)","AUTOCOMMIT","
4087
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
4088 4089 4090 4091 4092 4093 4094
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
4095
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
4096
","
4097 4098 4099
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
4100 4101

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4102 4103 4104 4105 4106
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
4107
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4108 4109
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
4110
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
4111 4112 4113 4114 4115
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
4116
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
4117
","
4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129
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
4130 4131 4132
"

"Functions (System)","COALESCE","
4133
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4134 4135 4136 4137 4138 4139 4140
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
4141
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
4142 4143 4144 4145 4146 4147 4148
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
4149
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4150
","
4151 4152 4153 4154 4155
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
4156 4157 4158 4159 4160
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
4161
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4162
","
4163 4164
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
4165 4166

If the column names are specified (a list of column names separated with the
4167
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
4168 4169 4170 4171 4172
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
4173 4174 4175 4176 4177

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
4187 4188 4189
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
4190 4191 4192 4193
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
4194 4195 4196 4197
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
4198
SELECT ""Last Name"" FROM CSVREAD('address.csv');
4199
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
4200 4201 4202
"

"Functions (System)","CSVWRITE","
4203
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4204
","
4205
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
4206
If only a file name is specified, it will be written to the current working directory.
4207
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
4208
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
4209 4210 4211 4212 4213

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

Thomas Mueller's avatar
Thomas Mueller committed
4216 4217
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4218
","
Thomas Mueller's avatar
Thomas Mueller committed
4219 4220 4221 4222
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
4223 4224 4225
"

"Functions (System)","DATABASE","
4226
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
4227 4228 4229 4230 4231 4232 4233
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
4234
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
4235
","
Thomas Mueller's avatar
Thomas Mueller committed
4236 4237
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
4238 4239 4240 4241
","
CALL DATABASE_PATH();
"

4242
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
4243
DECODE(value, whenValue, thenValue [,...])
4244 4245 4246 4247 4248 4249 4250 4251
","
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');
"

4252
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
4253
DISK_SPACE_USED(tableNameString)
4254 4255 4256 4257 4258 4259 4260 4261
","
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');
"

4262
"Functions (System)","SIGNAL","
4263
SIGNAL(sqlStateString, messageString)
4264 4265 4266 4267 4268 4269
","
Throw an SQLException with the passed SQLState and reason.
","
CALL SIGNAL('23505', 'Duplicate user ID: ' || user_id);
"

Thomas Mueller's avatar
Thomas Mueller committed
4270
"Functions (System)","FILE_READ","
4271
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
4272 4273 4274 4275
","
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
4276
default character set for this system.
4277 4278 4279 4280

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

Thomas Mueller's avatar
Thomas Mueller committed
4281
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4282 4283 4284 4285 4286
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

4287
"Functions (System)","FILE_WRITE","
4288
FILE_WRITE(blobValue, fileNameString)
4289 4290 4291 4292 4293 4294 4295 4296
","
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
4297
"Functions (System)","GREATEST","
4298
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4299 4300 4301 4302 4303 4304 4305
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
4306
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
4307 4308
","
Returns the last inserted identity value for this session.
4309
This value changes whenever a new sequence number was generated,
4310
even within a trigger or Java function. See also SCOPE_IDENTITY.
4311
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4312 4313 4314 4315 4316
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
4317
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4318 4319 4320 4321 4322 4323 4324
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
4325
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4326 4327 4328 4329 4330 4331 4332
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
4333
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
4334 4335
","
Returns the current lock mode. See SET LOCK_MODE.
4336
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4337 4338 4339 4340 4341
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
4342
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
4343 4344 4345 4346 4347 4348 4349 4350
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
4351
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
4352
","
4353 4354 4355 4356 4357
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
4358
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4359 4360 4361 4362 4363
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
4364
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
4365
","
Thomas Mueller's avatar
Thomas Mueller committed
4366
Returns the free memory in KB (where 1024 bytes is a KB).
4367
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4368 4369
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4370 4371 4372 4373 4374
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
4375
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
4376
","
Thomas Mueller's avatar
Thomas Mueller committed
4377
Returns the used memory in KB (where 1024 bytes is a KB).
4378
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4379 4380
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4381 4382 4383 4384 4385
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
4386
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4387
","
4388 4389 4390 4391
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
4392 4393 4394 4395 4396
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
4397
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4398 4399 4400 4401 4402 4403
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4404 4405 4406 4407
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4408
The data type of the returned value is the data type of 'a' if this is a text type.
4409 4410 4411 4412
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4413
"Functions (System)","READONLY","
4414
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4415 4416 4417 4418 4419 4420 4421
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
4422
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
4423
","
4424
Returns the number of the current row.
4425 4426
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4427
The first row has the row number 1, and is calculated before ordering and grouping the result set,
4428
but after evaluating index conditions (even when the index conditions are specified in an outer query).
4429
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
4430
","
4431 4432
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4433
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4434 4435 4436
"

"Functions (System)","SCHEMA","
4437
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4438
","
4439
Returns the name of the default schema for this session.
Thomas Mueller's avatar
Thomas Mueller committed
4440 4441 4442 4443
","
CALL SCHEMA()
"

4444 4445 4446
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4447
Returns the last inserted identity value for this session for the current scope
4448
(the current statement).
4449 4450 4451 4452 4453 4454
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
4455
"Functions (System)","SESSION_ID","
4456
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4457
","
4458 4459 4460 4461
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
4462 4463 4464 4465 4466
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4467
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4468
","
4469 4470 4471
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
4472
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4473
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4474 4475 4476 4477 4478
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4479
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4480 4481 4482 4483 4484 4485 4486
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4487
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4488
","
4489 4490
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
4491
Otherwise a value of the following form is returned:
4492
""logFileId-position-sessionId"".
4493 4494
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4495 4496 4497 4498
","
CALL TRANSACTION_ID()
"

4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510
"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
4511
"Functions (System)","USER","
4512
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4513 4514 4515 4516 4517 4518
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4519 4520 4521 4522 4523 4524 4525 4526
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541
"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
4542