help.csv 131.3 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
{ [ IF NOT EXISTS ] columnName columnDefinition | ( { columnName columnDefinition } [,...] ) }
288
[ { BEFORE | AFTER } columnName ]
Thomas Mueller's avatar
Thomas Mueller committed
289
","
Thomas Mueller's avatar
Thomas Mueller committed
290
Adds a new column to a table.
Thomas Mueller's avatar
Thomas Mueller committed
291
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
292 293 294 295 296
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
625
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
626
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
627 628 629 630 631 632 633 634 635
","
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","
636
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
637
","
Thomas Mueller's avatar
Thomas Mueller committed
638
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
639
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
640 641 642 643 644
","
CREATE ROLE READONLY
"

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

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

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

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
675

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

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

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

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

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

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

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

714 715 716
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
717 718
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
719 720 721 722 723
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

"Commands (DDL)","DROP SCHEMA","
887
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
888
","
Thomas Mueller's avatar
Thomas Mueller committed
889
Drops a schema.
Thomas Mueller's avatar
Thomas Mueller committed
890
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
891 892 893 894 895
","
DROP SCHEMA TEST_SCHEMA
"

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

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

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

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

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

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

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

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

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
965
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
966 967

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
968 969 970 971 972 973 974
","
CHECKPOINT
"

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

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
979 980 981 982 983
","
CHECKPOINT SYNC
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1227 1228 1229 1230 1231
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).
1232 1233
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.
1234

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1298
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1299
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1300
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1301 1302 1303 1304 1305
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

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

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

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

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

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

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

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


1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
"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
"

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

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

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

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

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

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

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

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

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

1465
This is the maximum length of an LOB that is stored with the record itself,
1466 1467
and the default value is 128.

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1484
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1485
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1486
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1487 1488 1489 1490 1491 1492 1493 1494
","
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
1495
are read, then the rows are buffered to disk.
1496
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1497

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

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

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

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

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

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

"Commands (Other)","SET MULTI_THREADED","
1553
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1554 1555 1556
","
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
1557 1558 1559 1560 1561
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
1562
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1563
This command commits an open transaction in this connection.
1564
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1565 1566 1567 1568 1569
","
SET MULTI_THREADED 1
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1778 1779
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
1780 1781 1782

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,
1783
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
1784 1785

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1789
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1790
","
1791
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1792 1793
"

1794 1795
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1796
","
1797
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1798
","
1799
A
Thomas Mueller's avatar
Thomas Mueller committed
1800 1801
"

1802 1803
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1804
","
1805
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1806
","
1807
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1808 1809
"

1810
"Other Grammar","Array","
1811
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1812
","
1813 1814
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
1815
","
1816
(1, 2)
1817 1818
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1819 1820
"

1821 1822
"Other Grammar","Boolean","
TRUE | FALSE
1823
","
1824
A boolean value.
1825
","
1826
TRUE
1827 1828
"

1829 1830
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1831
","
1832
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1833
","
1834
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1835 1836
"

1837 1838 1839
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1840
","
1841 1842
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
1843
","
1844
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1845 1846
"

1847 1848 1849
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1850
","
1851 1852
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1853
","
1854 1855 1856 1857
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
1858
AES
1859
","
1860
Only the algorithm AES (""AES-128"") is supported currently.
1861 1862
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1863 1864
"

1865
"Other Grammar","Column Definition","
1866
dataType [ VISIBLE | INVISIBLE ]
Thomas Mueller's avatar
Thomas Mueller committed
1867
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1868
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1869 1870
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1871 1872
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1873
The computed column expression is evaluated and assigned whenever the row changes.
1874 1875 1876 1877

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
1878

1879 1880 1881
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
1882 1883
The options PRIMARY KEY, UNIQUE, and CHECK are not supported for ALTER statements.

Thomas Mueller's avatar
Thomas Mueller committed
1884 1885
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
1886 1887
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1888

1889
","
Thomas Mueller's avatar
Thomas Mueller committed
1890 1891 1892
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);
1893 1894
"

1895 1896
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1897
","
1898 1899 1900
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
1901
","
1902
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1903 1904
"

1905
"Other Grammar","Compare","
1906
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
1907
","
1908
Comparison operator. The operator != is the same as <>.
1909
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
1910
","
1911
<>
Thomas Mueller's avatar
Thomas Mueller committed
1912 1913 1914
"

"Other Grammar","Condition","
1915
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1916 1917 1918 1919 1920 1921 1922
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1923 1924
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1925
    | IS [ NOT ] [ DISTINCT FROM ] operand
1926 1927
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
1928
    | [ NOT ] [ LIKE | ILIKE ] operand [ ESCAPE string ]
1929
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1930
","
Thomas Mueller's avatar
Thomas Mueller committed
1931
The right hand side of a condition.
1932

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

Thomas Mueller's avatar
Thomas Mueller committed
1936 1937 1938 1939 1940
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).
1941 1942 1943
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.
1944

1945 1946
ILIKE does a case-insensitive compare.

Thomas Mueller's avatar
Thomas Mueller committed
1947
When comparing with REGEXP, regular expression matching is used.
1948
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1949 1950 1951 1952
","
LIKE 'Jo%'
"

1953
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
1954 1955 1956 1957 1958
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
1959
","
Thomas Mueller's avatar
Thomas Mueller committed
1960 1961
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1962
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1963 1964
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
1965
","
1966
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1967 1968
"

1969 1970
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1971
","
1972
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1973
","
1974
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1975 1976
"

1977 1978
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1979
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1980
","
1981
Optional parameters for CSVREAD and CSVWRITE.
1982 1983
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
1984 1985
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1986
The following options are supported:
1987

1988
""caseSensitiveColumnNames"" (true or false; disabled by default),
1989

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

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

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

thomasmueller's avatar
thomasmueller committed
1996
""fieldSeparator"" (a comma by default),
1997

1998
""lineComment"" (disabled by default),
1999

2000
""lineSeparator"" (the line separator used for writing; ignored for reading),
2001

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

2005
""preserveWhitespace"" (true or false; disabled by default),
2006

2007
""writeColumnHeader"" (true or false; enabled by default).
2008

Thomas Mueller's avatar
Thomas Mueller committed
2009
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
2010
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
2011 2012 2013
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
2014
","
2015
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
2016 2017
"

2018 2019 2020 2021
"Other Grammar","Data Type","
intType | booleanType | tinyintType | smallintType | bigintType | identityType
    | decimalType | doubleType | realType | dateType | timeType | timestampType
    | binaryType | otherType | varcharType | varcharIgnorecaseType | charType
2022
    | blobType | clobType | uuidType | arrayType | enumType
Thomas Mueller's avatar
Thomas Mueller committed
2023
","
2024
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
2025
","
2026
INT
Thomas Mueller's avatar
Thomas Mueller committed
2027 2028
"

2029 2030
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
2031
","
2032
A date literal. The limitations are the same as for the Java data type
2033
""java.sql.Date"", but for compatibility with other databases the suggested minimum
2034
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
2035
","
2036
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
2037 2038
"

2039
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
2040
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
2041
","
Thomas Mueller's avatar
Thomas Mueller committed
2042 2043 2044 2045 2046 2047
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)"".
2048
","
Thomas Mueller's avatar
Thomas Mueller committed
2049 2050 2051
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
2052 2053
"

2054 2055
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
2056
","
2057
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
2058
","
2059
0
Thomas Mueller's avatar
Thomas Mueller committed
2060 2061
"

2062 2063
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
2064
","
2065 2066 2067
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
2068
","
2069
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
2070 2071
"

2072 2073
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2074
","
2075
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2076
","
2077
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2078 2079
"

2080
"Other Grammar","Factor","
2081
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2082
","
2083
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
2084
","
2085
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
2086 2087
"

2088 2089
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
2090
","
2091 2092
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
2093
","
2094
cafe
Thomas Mueller's avatar
Thomas Mueller committed
2095 2096
"

2097 2098
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
2099
","
2100
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
2101
","
2102
0xff
Thomas Mueller's avatar
Thomas Mueller committed
2103 2104
"

2105 2106
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2107
","
2108 2109 2110
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
2111
","
2112
NAME
Thomas Mueller's avatar
Thomas Mueller committed
2113 2114 2115
"

"Other Grammar","Int","
2116
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2117 2118 2119 2120 2121 2122 2123
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2124
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2125 2126 2127 2128 2129 2130
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2131
"Other Grammar","Name","
2132
{ { A-Z|_ } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2133
","
2134
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2135
","
2136
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2137 2138
"

2139 2140
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2141
","
2142
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2143
","
2144
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2145 2146
"

2147 2148 2149 2150 2151 2152 2153 2154
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2155
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2156
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2157
","
Thomas Mueller's avatar
Thomas Mueller committed
2158
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2159 2160 2161 2162 2163 2164 2165
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
"

2166 2167
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2168
","
2169
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2170
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2171
","
2172
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2173 2174
"

2175 2176
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2177
","
2178 2179 2180
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
2181
","
2182
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2183 2184
"

2185 2186
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2187
","
2188 2189 2190
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
2191
","
2192
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2193 2194
"

2195 2196 2197
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2198
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2199
","
Thomas Mueller's avatar
Thomas Mueller committed
2200 2201 2202
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
2203 2204 2205
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
2206
","
2207
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2208 2209
"

Thomas Mueller's avatar
Thomas Mueller committed
2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220
"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
"

2221 2222
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2223
","
2224 2225
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
2226 2227 2228 2229 2230
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2231 2232
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2233
","
2234
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2235
","
2236
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2237 2238
"

2239 2240
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2241
","
2242 2243
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
2244
","
2245
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2246 2247
"

2248 2249
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2250
","
Thomas Mueller's avatar
Thomas Mueller committed
2251
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2252

Thomas Mueller's avatar
Thomas Mueller committed
2253
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2254
","
2255
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2256 2257
"

2258
"Other Grammar","Table Expression","
2259
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
2260
[ USE INDEX ([ indexName [,...] ]) ]
2261 2262
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2263
","
2264 2265 2266
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
2267
","
2268
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2269 2270
"

2271 2272 2273 2274 2275 2276 2277 2278 2279
"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;
"

2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2292
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2293
","
2294
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2295
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2296
","
2297 2298 2299 2300
'Hello'
"

"Other Grammar","Time","
2301
TIME [ WITHOUT TIME ZONE ] 'hh:mm:ss[.nnnnnnnnn]'
2302
","
2303
A time literal. A value is between 0:00:00 and 23:59:59.999999999
2304
and has nanosecond resolution.
2305 2306 2307 2308 2309
","
TIME '23:59:59'
"

"Other Grammar","Timestamp","
2310
TIMESTAMP [ WITHOUT TIME ZONE ] 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]'
2311 2312
","
A timestamp literal. The limitations are the same as for the Java data type
2313
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2314 2315 2316 2317 2318
minimum and maximum years are 0001 and 9999.
","
TIMESTAMP '2005-12-31 23:59:59'
"

2319
"Other Grammar","Timestamp with time zone","
2320
TIMESTAMP WITH TIME ZONE 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]
2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331
[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'
"

2332
"Other Grammar","Value","
Thomas Mueller's avatar
Thomas Mueller committed
2333
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2334
","
Thomas Mueller's avatar
Thomas Mueller committed
2335
A literal value of any data type, or null.
2336 2337
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2338 2339 2340 2341 2342 2343 2344
"

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

2345
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2346 2347 2348 2349 2350 2351 2352 2353 2354
","
INT
"

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

2355
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2356 2357 2358 2359 2360 2361 2362 2363 2364
","
BOOLEAN
"

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

2365
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2366 2367 2368 2369 2370 2371 2372 2373 2374
","
TINYINT
"

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

2375
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2376 2377 2378 2379 2380 2381 2382 2383 2384
","
SMALLINT
"

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

2385
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396
","
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.

2397
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2398 2399 2400 2401 2402
","
IDENTITY
"

"Data Types","DECIMAL Type","
2403
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2404 2405 2406 2407
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2408
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2409 2410 2411 2412 2413
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2414
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2415
","
Thomas Mueller's avatar
Thomas Mueller committed
2416
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2417 2418
of rounding problems.

2419
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2420 2421 2422 2423 2424
","
DOUBLE
"

"Data Types","REAL Type","
2425
{ REAL | FLOAT4 }
Thomas Mueller's avatar
Thomas Mueller committed
2426
","
Thomas Mueller's avatar
Thomas Mueller committed
2427
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2428 2429
values, because of rounding problems.

2430
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2431 2432 2433 2434 2435
","
REAL
"

"Data Types","TIME Type","
2436
TIME [ WITHOUT TIME ZONE ]
Thomas Mueller's avatar
Thomas Mueller committed
2437
","
2438
The time data type. The format is hh:mm:ss[.nnnnnnnnn].
Thomas Mueller's avatar
Thomas Mueller committed
2439

2440
Mapped to ""java.sql.Time"". When converted to a ""java.sql.Date"", the date is set to ""1970-01-01"".
2441
""java.time.LocalTime"" is also supported on Java 8 and later versions.
Evgenij Ryazanov's avatar
Evgenij Ryazanov committed
2442
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
2443 2444 2445 2446 2447 2448 2449
","
TIME
"

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

2452
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2453
(or to the next possible time if midnight doesn't exist for the given date and timezone due to a daylight saving change).
2454
""java.time.LocalDate"" is also supported on Java 8 and later versions.
Thomas Mueller's avatar
Thomas Mueller committed
2455 2456 2457 2458 2459
","
DATE
"

"Data Types","TIMESTAMP Type","
2460
{ TIMESTAMP [ WITHOUT TIME ZONE ] | DATETIME | SMALLDATETIME }
Thomas Mueller's avatar
Thomas Mueller committed
2461
","
Thomas Mueller's avatar
Thomas Mueller committed
2462
The timestamp data type. The format is yyyy-MM-dd hh:mm:ss[.nnnnnnnnn].
2463
Stored internally as a BCD-encoded date, and nanoseconds since midnight.
Thomas Mueller's avatar
Thomas Mueller committed
2464

2465 2466
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
2467 2468 2469 2470
","
TIMESTAMP
"

2471 2472
"Data Types","TIMESTAMP WITH TIME ZONE Type","
TIMESTAMP WITH TIME ZONE
2473
","
2474
The timestamp with time zone data type.
2475
Stored internally as a BCD-encoded date, nanoseconds since midnight, and time zone offset in minutes.
2476

2477 2478 2479 2480 2481 2482 2483
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.
2484
","
2485
TIMESTAMP WITH TIME ZONE
2486 2487
"

Thomas Mueller's avatar
Thomas Mueller committed
2488
"Data Types","BINARY Type","
2489
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2490
","
2491 2492 2493 2494 2495
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
2496 2497 2498 2499 2500 2501 2502 2503 2504

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2505 2506 2507 2508 2509
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
2510

2511
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2512 2513 2514 2515 2516
","
OTHER
"

"Data Types","VARCHAR Type","
2517
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
2518
    | NVARCHAR2 | VARCHAR_CASESENSITIVE} [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2519
","
Thomas Mueller's avatar
Thomas Mueller committed
2520
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2521 2522 2523 2524 2525 2526 2527
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
2528

2529
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2530 2531 2532 2533 2534
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2535
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2536
","
Thomas Mueller's avatar
Thomas Mueller committed
2537
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2538 2539 2540 2541 2542 2543 2544
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
2545

2546
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2547 2548 2549 2550 2551
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2552
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2553
","
Thomas Mueller's avatar
Thomas Mueller committed
2554 2555 2556
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
2557

Thomas Mueller's avatar
Thomas Mueller committed
2558 2559
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
2560

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

2564
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2565 2566 2567 2568 2569
","
CHAR(10)
"

"Data Types","BLOB Type","
2570
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2571 2572 2573
","
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
2574
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2575 2576
Advanced / Large Objects.

2577
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2578 2579 2580 2581 2582
","
BLOB
"

"Data Types","CLOB Type","
2583
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2584 2585 2586 2587 2588
","
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
2589
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2590 2591 2592 2593 2594

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.

2595
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2596 2597 2598 2599 2600 2601 2602
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2603 2604 2605 2606
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
2607

Thomas Mueller's avatar
Thomas Mueller committed
2608 2609 2610 2611 2612
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
2613
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2614 2615 2616 2617 2618 2619 2620
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2621
An array of values.
2622
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2623 2624 2625 2626


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
2627 2628 2629 2630
","
ARRAY
"

2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644
"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')
"
2645 2646 2647
"Data Types","GEOMETRY Type","
GEOMETRY
","
2648
A spatial geometry type, based on the ""org.locationtech.jts"" library.
2649
Normally represented in textual format using the WKT (well known text) format.
2650

Thomas Mueller's avatar
Thomas Mueller committed
2651
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2652 2653
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2654
GEOMETRY
2655 2656
"

Thomas Mueller's avatar
Thomas Mueller committed
2657
"Functions (Aggregate)","AVG","
2658
AVG ( [ DISTINCT ] { numeric } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2659
","
2660 2661
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2662
Aggregates are only allowed in select statements.
2663
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2664 2665 2666 2667
","
AVG(X)
"

2668
"Functions (Aggregate)","BIT_AND","
2669
BIT_AND(expression) [ FILTER ( WHERE expression ) ]
2670 2671 2672 2673 2674 2675 2676 2677 2678
","
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","
2679
BIT_OR(expression) [ FILTER ( WHERE expression ) ]
2680 2681 2682 2683 2684 2685 2686 2687
","
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
2688
"Functions (Aggregate)","BOOL_AND","
2689
BOOL_AND(boolean) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2690
","
2691 2692 2693
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
2694 2695 2696 2697 2698
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2699
BOOL_OR(boolean) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2700
","
2701 2702 2703
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
2704 2705 2706 2707 2708
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2709
COUNT( { * | { [ DISTINCT ] expression } } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2710
","
2711 2712 2713 2714
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
2715 2716 2717 2718 2719
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2720 2721
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2722
[ SEPARATOR expression ] ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2723
","
2724 2725 2726 2727 2728
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
2729 2730 2731 2732 2733
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2734
MAX(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2735
","
2736 2737 2738 2739
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
2740 2741 2742 2743 2744
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2745
MIN(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2746
","
2747 2748 2749 2750
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
2751 2752 2753 2754 2755
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
2756
SUM( [ DISTINCT ] { numeric } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2757
","
2758 2759 2760
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2761
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2762
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2763 2764 2765 2766 2767
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2768
SELECTIVITY(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2769
","
2770 2771 2772 2773 2774
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
2775 2776 2777 2778 2779
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
2780
STDDEV_POP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2781
","
2782 2783 2784
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
2785 2786 2787 2788 2789 2790
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
2791
STDDEV_SAMP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2792
","
2793 2794 2795
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
2796 2797 2798 2799 2800 2801
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
2802
VAR_POP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2803
","
2804 2805 2806 2807
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
2808 2809 2810 2811 2812
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
2813
VAR_SAMP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2814
","
2815 2816 2817 2818
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
2819 2820 2821 2822
","
VAR_SAMP(X)
"

2823
"Functions (Aggregate)","MEDIAN","
2824
MEDIAN( [ DISTINCT ] value ) [ FILTER ( WHERE expression ) ]
2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835
","
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
2836
"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2837
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2838
","
2839 2840
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"".
2841
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2842 2843 2844 2845 2846
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2847
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2848
","
Thomas Mueller's avatar
Thomas Mueller committed
2849 2850
Calculate the arc cosine.
See also Java ""Math.acos"".
2851
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2852 2853 2854 2855 2856
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2857
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2858
","
Thomas Mueller's avatar
Thomas Mueller committed
2859 2860
Calculate the arc sine.
See also Java ""Math.asin"".
2861
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2862 2863 2864 2865 2866
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2867
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2868
","
Thomas Mueller's avatar
Thomas Mueller committed
2869 2870
Calculate the arc tangent.
See also Java ""Math.atan"".
2871
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2872 2873 2874 2875 2876
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2877
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2878
","
Thomas Mueller's avatar
Thomas Mueller committed
2879 2880
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2881
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2882 2883 2884 2885
","
COS(ANGLE)
"

2886
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2887
COSH(numeric)
2888 2889 2890 2891 2892 2893 2894 2895
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2896
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2897
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2898
","
Thomas Mueller's avatar
Thomas Mueller committed
2899
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2900
See also Java ""Math.*"" functions.
2901
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2902 2903 2904 2905 2906
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2907
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2908
","
Thomas Mueller's avatar
Thomas Mueller committed
2909 2910
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2911
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2912 2913 2914 2915
","
SIN(ANGLE)
"

2916
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2917
SINH(numeric)
2918 2919 2920 2921 2922 2923 2924 2925
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2926
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2927
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2928
","
Thomas Mueller's avatar
Thomas Mueller committed
2929 2930
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2931
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2932 2933 2934 2935
","
TAN(ANGLE)
"

2936
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2937
TANH(numeric)
2938 2939 2940 2941 2942 2943 2944 2945
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2946
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2947
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2948
","
Thomas Mueller's avatar
Thomas Mueller committed
2949
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2950
See also Java ""Math.atan2"".
2951
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2952 2953 2954 2955 2956
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2957
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2958
","
2959 2960
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2961 2962 2963 2964 2965
See also Java operator &.
","
BITAND(A, B)
"

2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976
"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
2977
"Functions (Numeric)","BITOR","
2978
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2979
","
2980 2981
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2982 2983 2984 2985 2986 2987
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2988
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2989
","
2990 2991
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2992 2993 2994 2995 2996 2997
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2998
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2999
","
3000 3001
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3002 3003 3004 3005 3006 3007
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
3008
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3009
","
3010
See also Java ""Math.ceil"".
3011
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3012
","
3013
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
3014 3015 3016
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
3017
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3018
","
3019
See also Java ""Math.toDegrees"".
3020
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3021 3022 3023 3024 3025
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
3026
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3027
","
3028
See also Java ""Math.exp"".
3029
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3030 3031 3032 3033 3034
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
3035
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3036
","
3037
See also Java ""Math.floor"".
3038
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3039 3040 3041 3042 3043
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
3044
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3045
","
3046
See also Java ""Math.log"".
3047
In the PostgreSQL mode, LOG(x) is base 10.
3048
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3049 3050 3051 3052 3053
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
3054
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3055
","
3056
See also Java ""Math.log10"" (in Java 5).
3057
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3058 3059 3060 3061 3062
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
3063
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3064
","
3065
See also Java ""Math.toRadians"".
3066
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3067 3068 3069 3070 3071
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
3072
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3073
","
3074
See also Java ""Math.sqrt"".
3075
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3076 3077 3078 3079 3080
","
SQRT(A)
"

"Functions (Numeric)","PI","
3081
PI()
Thomas Mueller's avatar
Thomas Mueller committed
3082
","
3083
See also Java ""Math.PI"".
3084
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3085 3086 3087 3088 3089
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
3090
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3091
","
3092
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
3093
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3094 3095 3096 3097 3098
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
3099
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
3100 3101 3102
","
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
3103
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
3104 3105 3106 3107 3108
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
3109
{ RANDOM_UUID | UUID } ()
Thomas Mueller's avatar
Thomas Mueller committed
3110 3111
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
3112 3113 3114 3115 3116

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
3117 3118 3119 3120 3121
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
3122
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
3123
","
3124
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
3125
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
3126 3127 3128 3129 3130
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
3131
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3132
","
3133 3134 3135 3136 3137 3138
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
3139 3140 3141 3142 3143
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
3144
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
3145 3146
","
Generates a number of cryptographically secure random numbers.
3147
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3148 3149 3150 3151 3152
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
3153
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3154 3155 3156 3157 3158 3159 3160
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
3161
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3162
","
3163
Encrypts data using a key.
3164
The supported algorithm is AES.
3165 3166
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3167 3168 3169 3170 3171
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
3172
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3173
","
3174
Decrypts data using a key.
3175
The supported algorithm is AES.
3176 3177
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3178 3179 3180 3181 3182 3183
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3184
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
3185
","
3186 3187 3188
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
3189 3190 3191 3192 3193
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3194
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3195 3196
","
Truncates to a number of digits (to the next value closer to 0).
3197
This method returns a double.
3198
When used with a timestamp, truncates a timestamp to a date (day) value.
3199 3200
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
3201 3202 3203 3204 3205
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3206
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3207
","
3208 3209 3210 3211
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
3212 3213 3214 3215 3216
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3217
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3218 3219
","
Expands data that was compressed using the COMPRESS function.
3220
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3221 3222 3223 3224 3225
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3226
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3227 3228 3229 3230 3231 3232 3233
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3234
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3235 3236
","
Returns the ASCII value of the first character in the string.
3237
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3238 3239 3240 3241
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3242
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3243
","
3244 3245 3246
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
3247 3248 3249 3250 3251
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3252
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3253
","
3254 3255 3256
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
3257 3258 3259 3260 3261
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3262
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3263
","
3264 3265 3266 3267
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
3268 3269 3270 3271 3272
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3273
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3274 3275
","
Returns the character that represents the ASCII value.
3276
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3277 3278 3279 3280 3281
","
CHAR(65)
"

"Functions (String)","CONCAT","
3282
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3283 3284
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3285
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3286
and do not cause the result to become NULL.
3287
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3288 3289 3290 3291
","
CONCAT(NAME, '!')
"

3292 3293 3294 3295
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3296
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3297
and do not cause the result to become NULL.
3298 3299 3300 3301 3302
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3303
"Functions (String)","DIFFERENCE","
3304
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3305 3306
","
Returns the difference between the sounds of two strings.
3307
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3308 3309 3310 3311 3312
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3313
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3314
","
3315 3316
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
3317 3318 3319 3320 3321
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3322
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3323
","
3324 3325 3326
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
3327 3328 3329 3330 3331
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3332
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3333
","
3334
Returns the location of a search string in a string.
3335 3336 3337
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
3338
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3339 3340 3341 3342 3343
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3344
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3345
","
3346 3347 3348
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
3349 3350 3351 3352 3353
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3354
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3355 3356 3357 3358 3359 3360 3361
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3362
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3363 3364 3365 3366 3367 3368 3369
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3370
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3371 3372 3373 3374 3375 3376 3377
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3378
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3379 3380 3381 3382 3383 3384 3385
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3386
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3387
","
3388 3389 3390 3391
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
3392 3393 3394 3395 3396
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3397
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3398 3399 3400 3401 3402 3403 3404
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3405
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3406
","
3407 3408 3409
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
3410 3411 3412 3413 3414
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3415
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3416
","
3417 3418 3419
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
3420 3421 3422 3423 3424
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3425
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3426 3427 3428 3429 3430 3431 3432
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3433
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3434 3435 3436 3437 3438 3439 3440
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3441
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3442
","
3443 3444
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
3445 3446 3447 3448 3449
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3450
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
3451
","
3452
Replaces each substring that matches a regular expression.
3453
For details, see the Java ""String.replaceAll()"" method.
3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467
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
3468 3469
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
3470
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3471 3472
"

3473 3474 3475 3476
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491
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)

3492 3493
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3494 3495
"

3496

Thomas Mueller's avatar
Thomas Mueller committed
3497
"Functions (String)","REPEAT","
3498
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3499 3500 3501 3502 3503 3504 3505
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3506
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3507
","
3508 3509
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.
3510
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3511 3512 3513 3514 3515
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3516
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3517
","
3518 3519 3520
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
3521 3522 3523 3524 3525
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3526
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3527 3528 3529 3530 3531 3532 3533
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3534
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3535
","
3536 3537 3538
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
3539 3540 3541 3542 3543
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3544
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3545
","
3546 3547 3548
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
3549 3550 3551 3552 3553
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3554
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3555 3556
","
Encodes a string to a byte array using the UTF8 encoding format.
3557
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3558 3559 3560 3561 3562
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3563
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3564
","
3565
Returns a substring of a string starting at a position.
3566
If the start index is negative, then the start index is relative to the end of the string.
3567
The length is optional.
3568
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3569
","
3570 3571
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3572 3573 3574
"

"Functions (String)","UTF8TOSTRING","
3575
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3576 3577 3578 3579 3580 3581 3582
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3583
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3584
","
3585
Creates an XML attribute element of the form ""name=value"".
3586 3587
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3588 3589 3590 3591 3592
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3593
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3594 3595
","
Create an XML node element.
3596 3597 3598
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.
3599
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3600 3601 3602 3603 3604
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3605
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3606
","
3607
Creates an XML comment.
3608
Two dashes (""--"") are converted to ""- -"".
3609
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3610 3611 3612 3613 3614
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3615
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3616
","
3617
Creates an XML CDATA element.
3618
If the value contains ""]]>"", an XML text element is created instead.
3619
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3620 3621 3622 3623 3624
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3625
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3626
","
Thomas Mueller's avatar
Thomas Mueller committed
3627
Returns the XML declaration.
3628
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3629 3630 3631 3632 3633
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3634
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3635 3636
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3637
If enabled, newline and linefeed is converted to an XML entity (&#).
3638
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3639 3640 3641 3642
","
CALL XMLTEXT('test')
"

3643
"Functions (String)","TO_CHAR","
3644
TO_CHAR(value [, formatString[, nlsParamString]])
3645 3646 3647 3648 3649 3650
","
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')
"

3651 3652 3653 3654 3655 3656 3657 3658
"Functions (String)","TRANSLATE","
TRANSLATE(value , searchString, replacementString]])
","
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
3659
"Functions (Time and Date)","CURRENT_DATE","
3660
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3661 3662
","
Returns the current date.
3663
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3664 3665 3666 3667 3668
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3669
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3670 3671
","
Returns the current time.
3672
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3673 3674 3675 3676 3677
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3678
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3679
","
3680 3681
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3682
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3683 3684 3685 3686 3687
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3688
{ DATEADD| TIMESTAMPADD } (unitString, addIntLong, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3689
","
3690
Adds units to a date-time value. The string indicates the unit.
3691
Use negative values to subtract units.
3692
addIntLong may be a long value when manipulating milliseconds,
3693
microseconds, or nanoseconds otherwise its range is restricted to int.
3694
The same units as in the EXTRACT function are supported.
3695
This method returns a value with the same type as specified value if unit is compatible with this value.
3696 3697
If specified unit is a HOUR, MINUTE, SECOND, MILLISECOND, etc and value is a DATE value DATEADD returns combined TIMESTAMP.
Units DAY, MONTH, YEAR, WEEK, etc are not allowed for TIME values.
3698
Units TIMEZONE_HOUR and TIMEZONE_MINUTE are only allowed for TIMESTAMP WITH TIME ZONE values.
Thomas Mueller's avatar
Thomas Mueller committed
3699 3700 3701 3702 3703
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3704
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3705
","
Thomas Mueller's avatar
Thomas Mueller committed
3706
Returns the the number of crossed unit boundaries between two timestamps.
3707 3708
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3709
The same units as in the EXTRACT function are supported.
3710 3711
Only TIMEZONE_HOUR and TIMEZONE_MINUTE units use the time zone offset component.
With all other units if timestamps have time zone offset component it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
3712 3713 3714 3715 3716
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3717
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3718 3719 3720 3721 3722 3723 3724
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3725
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3726 3727 3728 3729 3730 3731 3732
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3733
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3734 3735 3736 3737 3738 3739 3740
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3741
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3742 3743 3744 3745 3746 3747 3748
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3749 3750
EXTRACT ( { YEAR | YY | MONTH | MM | QUARTER | WEEK | ISO_WEEK
    | DAY | DD | DAY_OF_YEAR | DOY
3751
    | HOUR | HH | MINUTE | MI | SECOND | SS | EPOCH
3752 3753
    | MILLISECOND | MS | MICROSECOND | MCS | NANOSECOND | NS
    | TIMEZONE_HOUR | TIMEZONE_MINUTE }
3754
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3755 3756
","
Returns a specific value from a timestamps.
3757 3758
This method returns a numeric value with EPOCH unit and
an int for all other time units.
Thomas Mueller's avatar
Thomas Mueller committed
3759 3760 3761 3762 3763
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3764
FORMATDATETIME ( timestamp, formatString
3765
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3766
","
3767 3768 3769
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.
3770
For details of the format, see ""java.text.SimpleDateFormat"".
3771 3772
timeZoneString may be specified if timestamp is a DATE, TIME or TIMESTAMP.
timeZoneString is ignored if timestamp is TIMESTAMP WITH TIME ZONE.
3773
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3774 3775 3776 3777 3778 3779
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3780
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3781 3782 3783 3784 3785 3786 3787
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3788
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3789 3790 3791 3792 3793 3794 3795
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3796
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3797 3798 3799 3800 3801 3802 3803
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3804
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3805 3806 3807 3808 3809 3810 3811
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3812
PARSEDATETIME(string, formatString
3813
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3814
","
3815 3816 3817
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.
3818
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3819 3820 3821 3822 3823 3824
","
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","
3825
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3826 3827 3828 3829 3830 3831 3832
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3833
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3834 3835 3836 3837 3838 3839 3840
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3841
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3842
","
3843 3844
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3845 3846 3847 3848
","
WEEK(CREATED)
"

3849 3850 3851
"Functions (Time and Date)","ISO_WEEK","
ISO_WEEK(timestamp)
","
3852
Returns the ISO week (1-53) from a timestamp.
3853 3854 3855 3856 3857 3858 3859
This method uses the ISO definition when
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
3860
"Functions (Time and Date)","YEAR","
3861
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3862 3863 3864 3865 3866 3867
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

3868 3869 3870 3871 3872 3873 3874 3875
"Functions (Time and Date)","ISO_YEAR","
ISO_YEAR(timestamp)
","
Returns the ISO week year from a timestamp.
","
ISO_YEAR(CREATED)
"

Thomas Mueller's avatar
Thomas Mueller committed
3876
"Functions (System)","ARRAY_GET","
3877
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3878 3879
","
Returns one element of an array.
3880
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3881 3882 3883 3884 3885
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3886
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3887 3888 3889 3890 3891 3892
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3893 3894 3895 3896 3897 3898 3899 3900
"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
3901
"Functions (System)","AUTOCOMMIT","
3902
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3903 3904 3905 3906 3907 3908 3909
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3910
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3911
","
3912 3913 3914
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
3915 3916

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3917 3918 3919 3920 3921
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3922
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3923 3924
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3925
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3926 3927 3928 3929 3930
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3931
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3932
","
3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944
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
3945 3946 3947
"

"Functions (System)","COALESCE","
3948
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3949 3950 3951 3952 3953 3954 3955
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3956
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3957 3958 3959 3960 3961 3962 3963
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3964
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3965
","
3966 3967 3968 3969 3970
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
3971 3972 3973 3974 3975
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3976
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3977
","
3978 3979
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
3980 3981

If the column names are specified (a list of column names separated with the
3982
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3983 3984 3985 3986 3987
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
3988 3989 3990 3991 3992

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
4002 4003 4004
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
4005 4006 4007 4008
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
4009 4010 4011 4012
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
4013
SELECT ""Last Name"" FROM CSVREAD('address.csv');
4014
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
4015 4016 4017
"

"Functions (System)","CSVWRITE","
4018
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4019
","
4020
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
4021
If only a file name is specified, it will be written to the current working directory.
4022
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
4023
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
4024 4025 4026 4027 4028

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

Thomas Mueller's avatar
Thomas Mueller committed
4031 4032
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4033
","
Thomas Mueller's avatar
Thomas Mueller committed
4034 4035 4036 4037
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
4038 4039 4040
"

"Functions (System)","DATABASE","
4041
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
4042 4043 4044 4045 4046 4047 4048
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
4049
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
4050
","
Thomas Mueller's avatar
Thomas Mueller committed
4051 4052
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
4053 4054 4055 4056
","
CALL DATABASE_PATH();
"

4057
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
4058
DECODE(value, whenValue, thenValue [,...])
4059 4060 4061 4062 4063 4064 4065 4066
","
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');
"

4067
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
4068
DISK_SPACE_USED(tableNameString)
4069 4070 4071 4072 4073 4074 4075 4076
","
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');
"

4077
"Functions (System)","SIGNAL","
4078
SIGNAL(sqlStateString, messageString)
4079 4080 4081 4082 4083 4084
","
Throw an SQLException with the passed SQLState and reason.
","
CALL SIGNAL('23505', 'Duplicate user ID: ' || user_id);
"

Thomas Mueller's avatar
Thomas Mueller committed
4085
"Functions (System)","FILE_READ","
4086
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
4087 4088 4089 4090
","
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
4091
default character set for this system.
4092 4093 4094 4095

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

Thomas Mueller's avatar
Thomas Mueller committed
4096
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4097 4098 4099 4100 4101
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

4102
"Functions (System)","FILE_WRITE","
4103
FILE_WRITE(blobValue, fileNameString)
4104 4105 4106 4107 4108 4109 4110 4111
","
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
4112
"Functions (System)","GREATEST","
4113
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4114 4115 4116 4117 4118 4119 4120
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
4121
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
4122 4123
","
Returns the last inserted identity value for this session.
4124
This value changes whenever a new sequence number was generated,
4125
even within a trigger or Java function. See also SCOPE_IDENTITY.
4126
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4127 4128 4129 4130 4131
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
4132
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4133 4134 4135 4136 4137 4138 4139
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
4140
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4141 4142 4143 4144 4145 4146 4147
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
4148
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
4149 4150
","
Returns the current lock mode. See SET LOCK_MODE.
4151
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4152 4153 4154 4155 4156
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
4157
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
4158 4159 4160 4161 4162 4163 4164 4165
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
4166
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
4167
","
4168 4169 4170 4171 4172
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
4173
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4174 4175 4176 4177 4178
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
4179
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
4180
","
Thomas Mueller's avatar
Thomas Mueller committed
4181
Returns the free memory in KB (where 1024 bytes is a KB).
4182
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4183 4184
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4185 4186 4187 4188 4189
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
4190
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
4191
","
Thomas Mueller's avatar
Thomas Mueller committed
4192
Returns the used memory in KB (where 1024 bytes is a KB).
4193
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4194 4195
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4196 4197 4198 4199 4200
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
4201
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4202
","
4203 4204 4205 4206
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
4207 4208 4209 4210 4211
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
4212
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4213 4214 4215 4216 4217 4218
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4219 4220 4221 4222
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4223
The data type of the returned value is the data type of 'a' if this is a text type.
4224 4225 4226 4227
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4228
"Functions (System)","READONLY","
4229
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4230 4231 4232 4233 4234 4235 4236
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
4237
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
4238
","
4239
Returns the number of the current row.
4240 4241
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4242
The first row has the row number 1, and is calculated before ordering and grouping the result set,
4243
but after evaluating index conditions (even when the index conditions are specified in an outer query).
4244
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
4245
","
4246 4247
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4248
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4249 4250 4251
"

"Functions (System)","SCHEMA","
4252
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4253
","
4254
Returns the name of the default schema for this session.
Thomas Mueller's avatar
Thomas Mueller committed
4255 4256 4257 4258
","
CALL SCHEMA()
"

4259 4260 4261
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4262
Returns the last inserted identity value for this session for the current scope
4263
(the current statement).
4264 4265 4266 4267 4268 4269
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
4270
"Functions (System)","SESSION_ID","
4271
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4272
","
4273 4274 4275 4276
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
4277 4278 4279 4280 4281
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4282
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4283
","
4284 4285 4286
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
4287
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4288
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4289 4290 4291 4292 4293
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4294
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4295 4296 4297 4298 4299 4300 4301
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4302
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4303
","
4304 4305
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
4306
Otherwise a value of the following form is returned:
4307
""logFileId-position-sessionId"".
4308 4309
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4310 4311 4312 4313
","
CALL TRANSACTION_ID()
"

4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325
"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
4326
"Functions (System)","USER","
4327
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4328 4329 4330 4331 4332 4333
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4334 4335 4336 4337 4338 4339 4340 4341
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356
"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
4357