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

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

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

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

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

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

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

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

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

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

Owner's avatar
Owner committed
122
"Commands (DML)","MERGE USING","
123 124
MERGE INTO targetTableName [ [AS] targetAlias]
USING { ( select ) | sourceTableName }[ [AS] sourceAlias ]
125
ON expression
126
[ WHEN MATCHED THEN
127
    [ UPDATE SET setClauseList ] [ DELETE deleteSearchCondition ] ]
128
[ WHEN NOT MATCHED THEN INSERT insertColumnsAndSource ]
129 130 131 132 133 134
","
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
135 136 137
to the same target row.
WHEN MATCHED THEN or WHEN NOT MATCHED THEN clauses or both of them in any order should be specified.
If WHEN MATCHED THEN is specified it should contain UPDATE or DELETE clauses of both of them.
138
If statement doesn't need a source table a DUAL table can be substituted.
Owner's avatar
Owner committed
139
","
140
MERGE INTO TARGET_TABLE AS T USING SOURCE_TABLE AS S
141
    ON T.ID = S.ID
142 143 144 145 146 147
    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
148
    ON T.ID = S.ID
149 150 151 152 153
    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)
154
MERGE INTO TARGET_TABLE USING DUAL ON ID = 1
155 156
    WHEN NOT MATCHED THEN INSERT (ID, NAME) VALUES (1, 'Test')
    WHEN MATCHED THEN UPDATE SET NAME = 'Test'
Owner's avatar
Owner committed
157 158
"

Thomas Mueller's avatar
Thomas Mueller committed
159
"Commands (DML)","RUNSCRIPT","
160 161
RUNSCRIPT FROM fileNameString scriptCompressionEncryption
[ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
162 163 164 165 166 167
","
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.

168
Instead of a file name, an URL may be used.
169
To read a stream from the classpath, use the prefix 'classpath:'.
170
See the Pluggable File System section on the Advanced page.
171

172
The compression algorithm must match the one used when creating the script.
Thomas Mueller's avatar
Thomas Mueller committed
173 174 175
Instead of a file, an URL may be used.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
176
","
177
RUNSCRIPT FROM 'backup.sql'
178
RUNSCRIPT FROM 'classpath:/com/acme/test.sql'
Thomas Mueller's avatar
Thomas Mueller committed
179 180 181
"

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

201
If no 'TO fileName' clause is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
202 203 204 205
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.

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

Thomas Mueller's avatar
Thomas Mueller committed
210 211 212
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
213
Admin rights are required to execute this command.
214

215
When using the TABLE or SCHEMA option, only the selected table(s) / schema(s) are included.
Thomas Mueller's avatar
Thomas Mueller committed
216 217 218 219 220
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
221 222
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
223 224 225 226 227 228
","
Lists the schemas, tables, or the columns of a table.
","
SHOW TABLES
"

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

Example 2:
WITH cte1 AS (
250
        SELECT 1 AS FIRST_COLUMN
251 252
), cte2 AS (
        SELECT FIRST_COLUMN+1 AS FIRST_COLUMN FROM cte1
253
)
254
SELECT sum(FIRST_COLUMN) FROM cte2;
255 256
"

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

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

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

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

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

315
"Commands (DDL)","ALTER TABLE RENAME CONSTRAINT","
316 317
ALTER TABLE [ IF EXISTS ] tableName RENAME oldConstraintName
TO newConstraintName
318 319 320 321 322 323 324
","
Renames a constraint.
This command commits an open transaction in this connection.
","
ALTER TABLE TEST RENAME CONSTRAINT FOO TO BAR
"

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

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

343 344 345
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
346

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

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

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

356
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
357
Single column indexes on this column are dropped.
358 359 360

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

361 362 363
SET INVISIBLE makes the column hidden, i.e. it will not appear in SELECT * results.
SET VISIBLE has the reverse effect.

364 365 366 367
DROP DEFAULT removes the default value of a column.

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
413
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
414 415 416 417 418
","
ALTER TABLE TEST SET REFERENTIAL_INTEGRITY FALSE
"

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

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

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

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

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

"Commands (DDL)","ANALYZE","
477
ANALYZE [ TABLE tableName ] [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
478
","
479 480 481
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
482 483 484 485 486
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.
487

Thomas Mueller's avatar
Thomas Mueller committed
488
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
489 490 491 492 493
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
494 495 496 497 498
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
499
","
Thomas Mueller's avatar
Thomas Mueller committed
500 501 502
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
503
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
504 505 506 507 508
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
509
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
510 511 512
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
513
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
514 515

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
516
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
517
","
518
CREATE AGGREGATE SIMPLE_MEDIAN FOR ""com.acme.db.Median""
Thomas Mueller's avatar
Thomas Mueller committed
519 520 521
"

"Commands (DDL)","CREATE ALIAS","
Thomas Mueller's avatar
Thomas Mueller committed
522
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
Thomas Mueller's avatar
Thomas Mueller committed
523
[ NOBUFFER ] { FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
524
","
525 526 527 528 529 530
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.
531 532 533

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

539 540
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.
541 542
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
543 544
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
545

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

549
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
550 551 552
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.
553

Thomas Mueller's avatar
Thomas Mueller committed
554
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
555
This command commits an open transaction in this connection.
556 557

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
558 559 560 561 562
","
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');
563 564
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
565 566 567 568 569
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
570 571 572
"

"Commands (DDL)","CREATE CONSTANT","
573
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
574
","
Thomas Mueller's avatar
Thomas Mueller committed
575
Creates a new constant.
Thomas Mueller's avatar
Thomas Mueller committed
576
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
577 578 579 580 581
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
582 583 584
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
585 586
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
587
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
588
to the value being tested.
589

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

Thomas Mueller's avatar
Thomas Mueller committed
592
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
593 594 595 596 597
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
598
CREATE
Thomas Mueller's avatar
Thomas Mueller committed
599
{ [ UNIQUE ] [ HASH | SPATIAL] INDEX [ [ IF NOT EXISTS ] newIndexName ]
600 601
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
602
","
Thomas Mueller's avatar
Thomas Mueller committed
603
Creates a new index.
Thomas Mueller's avatar
Thomas Mueller committed
604
This command commits an open transaction in this connection.
605

Thomas Mueller's avatar
Thomas Mueller committed
606
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
607 608
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
609
Non-unique keys are supported.
610
Spatial indexes are supported only on Geometry columns.
Thomas Mueller's avatar
Thomas Mueller committed
611 612 613 614 615
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
616
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ]
Thomas Mueller's avatar
Thomas Mueller committed
617
LINKED TABLE [ IF NOT EXISTS ]
618 619
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
620 621 622 623 624
","
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.

625 626 627
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
628 629
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
630
work. Linked tables to the same database share one connection.
631

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

Thomas Mueller's avatar
Thomas Mueller committed
634 635 636
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).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
644
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
645
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
646
","
647 648
CREATE LINKED TABLE LINK('org.h2.Driver', 'jdbc:h2:test2',
    'sa', 'sa', 'TEST');
Thomas Mueller's avatar
Thomas Mueller committed
649 650 651
CREATE LINKED TABLE LINK('', 'jdbc:h2:test2', 'sa', 'sa',
    '(SELECT * FROM TEST WHERE ID>0)');
CREATE LINKED TABLE LINK('javax.naming.InitialContext',
652 653
    'java:comp/env/jdbc/Test', NULL, NULL,
    '(SELECT * FROM TEST WHERE ID>0)');
Thomas Mueller's avatar
Thomas Mueller committed
654 655 656
"

"Commands (DDL)","CREATE ROLE","
657
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
658
","
Thomas Mueller's avatar
Thomas Mueller committed
659
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
660
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
661 662 663 664 665
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
666 667
CREATE SCHEMA [ IF NOT EXISTS ] name
[ AUTHORIZATION ownerUserName ]
668
[ WITH tableEngineParamName [,...] ]
Thomas Mueller's avatar
Thomas Mueller committed
669 670 671
","
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
672
Specifying the owner currently has no effect.
673 674
Optional table engine parameters are used when CREATE TABLE command
is run on this schema without having its engine params set.
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 SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
682 683
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName
[ START WITH long ]
684 685 686
[ INCREMENT BY long ]
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
687 688
[ CYCLE long | NOCYCLE | NO CYCLE ]
[ CACHE long | NOCACHE | NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
689
","
Thomas Mueller's avatar
Thomas Mueller committed
690 691 692
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
693 694 695 696 697

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
698

Thomas Mueller's avatar
Thomas Mueller committed
699
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
700 701 702 703 704
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
705 706
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
707
[ ( { columnName columnDefinition | constraint } [,...] ) ]
708 709
[ ENGINE tableEngineName ]
[ WITH tableEngineParamName [,...] ]
710
[ NOT PERSISTENT ] [ TRANSACTIONAL ]
711
[ AS select [ WITH [ NO ] DATA ] ]","
Thomas Mueller's avatar
Thomas Mueller committed
712 713
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
714 715 716 717
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
718
that means memory tables should not get too large.
719

Thomas Mueller's avatar
Thomas Mueller committed
720 721 722 723 724
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,
725
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
726

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

731 732 733
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.

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

737 738
The column definition is optional if a query is specified.
In that case the column list of the query is used.
739
If the query is specified its results are inserted into created table unless WITH NO DATA is specified.
740

Thomas Mueller's avatar
Thomas Mueller committed
741 742
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
743 744 745 746 747
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
748 749 750 751 752 753
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName
{ BEFORE | AFTER | INSTEAD OF }
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK }
[,...] ON tableName [ FOR EACH ROW ]
[ QUEUE int ] [ NOWAIT ]
{ CALL triggeredClassName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
754
","
Thomas Mueller's avatar
Thomas Mueller committed
755 756 757 758 759
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).
760

761 762
The sourceCodeString must define a single method with no parameters that returns ""org.h2.api.Trigger"".
See CREATE ALIAS for requirements regarding the compilation.
763 764 765
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"".
766

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

Thomas Mueller's avatar
Thomas Mueller committed
772
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
773
Only row based AFTER trigger can be called on ROLLBACK.
774
Exceptions that occur within such triggers are ignored.
775 776
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.
777

778
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
779
Only the first such trigger is called. Such triggers on views are supported.
780
They can be used to make views updatable.
781

Thomas Mueller's avatar
Thomas Mueller committed
782 783
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.
784 785
The trigger is called with both 'old' and 'new' set to null.

786 787 788 789
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
790 791
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
792 793 794
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.

795 796
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

Thomas Mueller's avatar
Thomas Mueller committed
797 798
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.
799

Thomas Mueller's avatar
Thomas Mueller committed
800
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
801
","
802
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger"";
Thomas Mueller's avatar
Thomas Mueller committed
803
CREATE TRIGGER TRIG_SRC BEFORE INSERT ON TEST AS $$org.h2.api.Trigger create() { return new MyTrigger(""constructorParam""); } $$;
804 805
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
806 807
"
"Commands (DDL)","CREATE USER","
808 809
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
810
","
Thomas Mueller's avatar
Thomas Mueller committed
811 812 813
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.
814

Thomas Mueller's avatar
Thomas Mueller committed
815
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
816
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
817 818 819 820 821
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
822
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
823
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
824 825
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
826
if the underlying table(s) don't exist.
827

Thomas Mueller's avatar
Thomas Mueller committed
828 829 830 831 832
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.

833 834
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
835
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
836
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
837 838 839 840 841
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
842
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
843
","
Thomas Mueller's avatar
Thomas Mueller committed
844 845 846
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
847
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
848
","
849
DROP AGGREGATE SIMPLE_MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
850 851 852
"

"Commands (DDL)","DROP ALIAS","
853
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
854
","
Thomas Mueller's avatar
Thomas Mueller committed
855 856 857
Drops an existing function alias.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
858
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
859
","
Thomas Mueller's avatar
Thomas Mueller committed
860
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
861 862 863
"

"Commands (DDL)","DROP ALL OBJECTS","
864
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
865 866 867 868 869
","
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
870 871 872
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
873 874 875 876 877
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
878
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
879
","
Thomas Mueller's avatar
Thomas Mueller committed
880
Drops a constant.
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 CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
887
DROP DOMAIN [ IF EXISTS ] domainName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
888
","
Thomas Mueller's avatar
Thomas Mueller committed
889
Drops a data type (domain).
890 891
The command will fail if it is referenced by a column (the default).
Column descriptors are replaced with original definition of specified domain if the CASCADE clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
892
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
893 894 895 896 897
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
898
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
899
","
Thomas Mueller's avatar
Thomas Mueller committed
900
Drops an index.
Thomas Mueller's avatar
Thomas Mueller committed
901
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
902 903 904 905 906
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
907
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
908
","
Thomas Mueller's avatar
Thomas Mueller committed
909
Drops a role.
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 ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
916
DROP SCHEMA [ IF EXISTS ] schemaName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
917
","
Thomas Mueller's avatar
Thomas Mueller committed
918
Drops a schema.
919 920
The command will fail if objects in this schema exist and the RESTRICT clause is used (the default).
All objects in this schema are dropped as well if the CASCADE clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
921
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
922 923 924 925 926
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
927
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
928
","
Thomas Mueller's avatar
Thomas Mueller committed
929
Drops a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
930
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
931 932 933 934 935
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
936
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
937
","
Thomas Mueller's avatar
Thomas Mueller committed
938
Drops an existing table, or a list of tables.
939 940
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
941
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
942 943 944 945 946
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
947
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
948
","
Thomas Mueller's avatar
Thomas Mueller committed
949
Drops an existing trigger.
Thomas Mueller's avatar
Thomas Mueller committed
950
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
951 952 953 954 955
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
956
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
957
","
Thomas Mueller's avatar
Thomas Mueller committed
958 959
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
960

Thomas Mueller's avatar
Thomas Mueller committed
961
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
962
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
963 964 965 966 967
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
968
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
969
","
Thomas Mueller's avatar
Thomas Mueller committed
970 971 972
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
973
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
974 975 976 977 978
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
979
TRUNCATE TABLE tableName [ [ CONTINUE | RESTART ] IDENTITY ]
Thomas Mueller's avatar
Thomas Mueller committed
980
","
981 982 983 984 985
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).
986
Linked tables can't be truncated.
987
If RESTART IDENTITY is specified next values for auto-incremented columns are restarted.
Thomas Mueller's avatar
Thomas Mueller committed
988

Thomas Mueller's avatar
Thomas Mueller committed
989
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
990 991 992 993 994 995 996
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
997
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
998 999

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1000 1001 1002 1003 1004 1005 1006
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
1007
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
1008 1009 1010
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1011 1012 1013 1014 1015
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
1016
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
1017 1018 1019 1020 1021 1022 1023 1024 1025
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
1026 1027 1028 1029
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
1030 1031 1032 1033 1034
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
1035
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1036 1037
{ { SCHEMA schemaName } | { tableName [,...] } }
TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1038
","
Thomas Mueller's avatar
Thomas Mueller committed
1039 1040 1041
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
1042
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1043 1044 1045 1046
","
GRANT SELECT ON TEST TO READONLY
"

1047 1048 1049 1050 1051 1052
"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
1053
This command commits an open transaction in this connection.
1054 1055 1056 1057
","
GRANT ALTER ANY SCHEMA TO Bob
"

Thomas Mueller's avatar
Thomas Mueller committed
1058
"Commands (Other)","GRANT ROLE","
1059
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1060
","
Thomas Mueller's avatar
Thomas Mueller committed
1061 1062 1063
Grants a role to a user or role.

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

"Commands (Other)","HELP","
1070
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1071 1072 1073 1074 1075 1076 1077 1078 1079
","
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
1080 1081
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
1082 1083 1084 1085 1086
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
1087
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1088 1089
{ { SCHEMA schemaName } | { tableName [,...] } }
FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1090
","
Thomas Mueller's avatar
Thomas Mueller committed
1091 1092 1093
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
1094
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1095 1096 1097 1098 1099
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
1100
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1101
","
Thomas Mueller's avatar
Thomas Mueller committed
1102 1103 1104
Removes a role from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1105
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1106 1107 1108 1109 1110
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
1111
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
","
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
1122 1123 1124 1125
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
1126 1127 1128 1129 1130 1131 1132
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1133 1134
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
1135 1136 1137 1138 1139
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1140
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1141
","
Thomas Mueller's avatar
Thomas Mueller committed
1142
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1143
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
1144
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1145 1146 1147 1148 1149
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1150
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
","
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
1161 1162
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1163
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1164
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1165
This setting is persistent.
1166
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1167 1168 1169 1170 1171
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
1172
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
1173 1174
","
Switches auto commit on or off.
1175
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
1176
however this will not work as expected when using a connection pool
1177 1178
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
1179
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
1180 1181 1182 1183 1184 1185 1186
","
SET AUTOCOMMIT OFF
"

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1198
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1199
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1200
This setting is persistent.
1201
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
","
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
1214 1215
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1216
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1217 1218 1219 1220
","
SET CLUSTER ''
"

1221 1222 1223 1224
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1225 1226
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.
1227 1228 1229
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
1230
This command commits an open transaction in this connection.
1231 1232 1233 1234 1235
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
"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
1249
"Commands (Other)","SET COLLATION","
1250
SET [ DATABASE ] COLLATION
1251 1252
{ OFF | collationName
    [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1253
","
Thomas Mueller's avatar
Thomas Mueller committed
1254 1255
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
1256 1257
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
1258
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1259

1260 1261 1262 1263 1264
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).
1265 1266
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.
1267

Thomas Mueller's avatar
Thomas Mueller committed
1268
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1269
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1270
This setting is persistent.
1271
This setting can be appended to the database URL: ""jdbc:h2:test;COLLATION='ENGLISH'""
Thomas Mueller's avatar
Thomas Mueller committed
1272 1273
","
SET COLLATION ENGLISH
1274
SET COLLATION CHARSET_CP500
Thomas Mueller's avatar
Thomas Mueller committed
1275 1276 1277
"

"Commands (Other)","SET COMPRESS_LOB","
1278
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1279
","
Thomas Mueller's avatar
Thomas Mueller committed
1280 1281 1282 1283
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
1284 1285
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
1286

Thomas Mueller's avatar
Thomas Mueller committed
1287
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1288
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1289
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1290 1291 1292 1293 1294 1295 1296 1297
","
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
1298 1299 1300 1301
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).
1302
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1303 1304 1305 1306 1307 1308 1309
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1310 1311
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
1312 1313 1314 1315
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
1316

Thomas Mueller's avatar
Thomas Mueller committed
1317
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1318
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1319
This setting is persistent.
1320
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1321 1322 1323 1324 1325 1326 1327 1328
","
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
1329 1330
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1331
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1332
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1333
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1334 1335 1336 1337 1338
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1339
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1340 1341 1342
","
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
1343
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1344
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1345

Thomas Mueller's avatar
Thomas Mueller committed
1346
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1347
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1348
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1349
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1350 1351 1352 1353 1354
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1355
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1356
","
Thomas Mueller's avatar
Thomas Mueller committed
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
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
1367 1368

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1369
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1370
","
Thomas Mueller's avatar
Thomas Mueller committed
1371
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1372 1373 1374
"

"Commands (Other)","SET IGNORECASE","
1375
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1376 1377 1378 1379 1380
","
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
1381
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1382

Thomas Mueller's avatar
Thomas Mueller committed
1383
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1384
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1385
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1386
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1387 1388 1389 1390
","
SET IGNORECASE TRUE
"

1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
"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
1403
This command commits an open transaction in this connection.
1404 1405 1406 1407 1408 1409 1410
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'
"


1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
"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
"

1428
"Commands (Other)","SET LOG","
1429
SET LOG int
1430 1431 1432 1433
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1434
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1435 1436 1437 1438
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.

1439 1440
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
1441 1442
against power failure is required, but the data must be protected against killing the process.

1443 1444
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
1445 1446
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1447
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1448
This command commits an open transaction in this connection.
1449
This setting is not persistent.
1450
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1451 1452 1453 1454
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1455 1456 1457 1458
"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
1459
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472

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
1473
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1474
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1475
This setting is persistent.
1476
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1477 1478 1479 1480 1481 1482 1483 1484
","
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
1485 1486 1487
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1488
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1489 1490 1491 1492 1493 1494 1495
","
SET LOCK_TIMEOUT 1000
"

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

1498
This is the maximum length of an LOB that is stored with the record itself,
1499 1500
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1501
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1502
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1503
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1504 1505 1506 1507 1508 1509 1510
","
SET MAX_LENGTH_INPLACE_LOB 128
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1517
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1518
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1519
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1520 1521 1522 1523 1524 1525 1526 1527
","
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
1528
are read, then the rows are buffered to disk.
1529
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1530

Thomas Mueller's avatar
Thomas Mueller committed
1531
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1532
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1533
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1534
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1535 1536 1537 1538 1539 1540 1541
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1548
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1549
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1550
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1551
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1552 1553 1554 1555 1556 1557 1558 1559 1560
","
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
1561 1562 1563
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1564
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1565
It has no effect for in-memory databases.
1566
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1567 1568 1569 1570 1571
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1572
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1573 1574
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1575 1576 1577
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1578
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1579
This command commits an open transaction in this connection.
1580
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1581 1582 1583 1584 1585
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1586
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1587
","
1588 1589 1590
Enabled (1) or disabled (0) multi-threading inside the database engine.
MULTI_THREADED is enabled by default with default MVStore storage engine.
MULTI_THREADED is disabled by default when using PageStore storage engine, enabling this with PageStore is experimental only.
Thomas Mueller's avatar
Thomas Mueller committed
1591 1592 1593 1594

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
1595
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1596
This command commits an open transaction in this connection.
1597
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1598 1599 1600 1601 1602
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1603
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1604 1605 1606
","
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
1607 1608
the tables was changed. This option is enabled by default.

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

Thomas Mueller's avatar
Thomas Mueller committed
1622
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1623 1624 1625 1626
","
SET PASSWORD 'abcstzri!.5'
"

1627 1628 1629 1630 1631 1632 1633
"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
1634
This command commits an open transaction in this connection.
1635 1636 1637 1638 1639
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
"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
1653 1654 1655 1656 1657
"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
1658 1659 1660
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
1661 1662 1663 1664 1665
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1666
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1667 1668 1669
","
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
1670 1671 1672
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1673
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1674
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1675 1676 1677 1678
","
SET REFERENTIAL_INTEGRITY FALSE
"

1679 1680 1681 1682 1683 1684
"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.
1685 1686 1687
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,
1688 1689 1690 1691
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
1692
This command commits an open transaction in this connection.
1693 1694 1695 1696 1697 1698
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
1699 1700 1701 1702 1703
"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
1704

Thomas Mueller's avatar
Thomas Mueller committed
1705
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1706 1707 1708 1709 1710 1711 1712 1713 1714
","
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
1715 1716 1717
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1718
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1719 1720 1721 1722 1723 1724 1725 1726 1727
","
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
1728 1729 1730
connections is PUBLIC.

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

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

"Commands (Other)","SET TRACE_LEVEL","
1750
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1751 1752 1753
","
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.
1754
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1755

Thomas Mueller's avatar
Thomas Mueller committed
1756
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1757
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1758
This command does not commit a transaction, and rollback does not affect it.
1759
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
","
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
1771
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1772
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1773
This command commits an open transaction in this connection.
1774
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
","
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
1785

Thomas Mueller's avatar
Thomas Mueller committed
1786
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1787 1788 1789 1790 1791 1792 1793 1794
","
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
1795 1796
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1797
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1798
This command commits an open transaction in this connection.
1799
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1800 1801 1802 1803 1804
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1805
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1806
","
1807 1808
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
1809
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1810

1811 1812
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
1813 1814 1815

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,
1816
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
1817 1818

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1822
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1823
","
1824
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1825 1826
"

1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958
"Datetime fields","Datetime field","
yearField | monthField | dayOfMonthField
    | hourField | minuteField | secondField
    | millisecondField | microsecondField | nanosecondField
    | timezoneHourField | timezoneMinuteField
    | dayOfWeekField | isoDayOfWeekField
    | weekOfYearField | isoWeekOfYearField
    | quarterField | dayOfYearField | epochField
","
Fields for EXTRACT, DATEADD, and DATEDIFF functions.
","
YEAR
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

"Datetime fields","ISO week of year field","
ISO_WEEK
","
ISO week of year (1-53).
1959 1960
ISO definition is used when first week of year should have at least four days
and week is started with Monday.
1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991
","
ISO_WEEK
"

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

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

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

1992 1993
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1994
","
1995
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1996
","
1997
A
Thomas Mueller's avatar
Thomas Mueller committed
1998 1999
"

2000 2001
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2002
","
2003
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2004
","
2005
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2006 2007
"

2008
"Other Grammar","Array","
2009
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
2010
","
2011 2012
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
2013
","
2014
(1, 2)
2015 2016
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
2017 2018
"

2019 2020
"Other Grammar","Boolean","
TRUE | FALSE
2021
","
2022
A boolean value.
2023
","
2024
TRUE
2025 2026
"

2027 2028
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
2029
","
2030
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
2031
","
2032
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
2033 2034
"

2035 2036 2037
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
2038
","
2039 2040
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
2041
","
2042
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
2043 2044
"

2045 2046 2047
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
2048
","
2049 2050
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2051
","
2052 2053 2054 2055
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
2056
AES
2057
","
2058
Only the algorithm AES (""AES-128"") is supported currently.
2059 2060
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
2061 2062
"

2063
"Other Grammar","Column Definition","
2064
dataType [ VISIBLE | INVISIBLE ]
2065 2066
[ { DEFAULT expression | AS computedColumnExpression } ]
[ ON UPDATE expression ] [ [ NOT ] NULL ]
2067
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2068 2069
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
2070 2071
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
2072
The computed column expression is evaluated and assigned whenever the row changes.
2073 2074 2075
On update column expression is used if row is updated,
at least one column have a new value that is different from its previous value
and value for this column is not set explicitly in update statement.
2076 2077 2078 2079

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
2080

2081 2082 2083
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
2084 2085
The options PRIMARY KEY, UNIQUE, and CHECK are not supported for ALTER statements.

Thomas Mueller's avatar
Thomas Mueller committed
2086 2087
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
2088 2089
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
2090

2091
","
Thomas Mueller's avatar
Thomas Mueller committed
2092 2093 2094
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);
2095 2096
"

2097 2098
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
2099
","
2100 2101 2102
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
2103
","
2104
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
2105 2106
"

2107
"Other Grammar","Compare","
2108
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
2109
","
2110
Comparison operator. The operator != is the same as <>.
2111
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
2112
","
2113
<>
Thomas Mueller's avatar
Thomas Mueller committed
2114 2115 2116
"

"Other Grammar","Condition","
2117
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
2118 2119 2120 2121 2122 2123 2124
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
2125 2126
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
2127
    | IS [ NOT ] [ DISTINCT FROM ] operand
2128 2129
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
2130
    | [ NOT ] [ LIKE | ILIKE ] operand [ ESCAPE string ]
2131
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
2132
","
Thomas Mueller's avatar
Thomas Mueller committed
2133
The right hand side of a condition.
2134

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

Thomas Mueller's avatar
Thomas Mueller committed
2138 2139 2140 2141 2142
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).
2143 2144 2145
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.
2146

2147 2148
ILIKE does a case-insensitive compare.

Thomas Mueller's avatar
Thomas Mueller committed
2149
When comparing with REGEXP, regular expression matching is used.
2150
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
2151 2152 2153 2154
","
LIKE 'Jo%'
"

2155
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
2156 2157 2158 2159 2160
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
2161
","
Thomas Mueller's avatar
Thomas Mueller committed
2162 2163
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2164
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
2165 2166
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
2167
","
2168
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
2169 2170
"

2171 2172
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
2173
","
2174
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
2175
","
2176
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
2177 2178
"

2179 2180
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
2181
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
2182
","
2183
Optional parameters for CSVREAD and CSVWRITE.
2184 2185
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
2186 2187
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
2188
The following options are supported:
2189

2190
""caseSensitiveColumnNames"" (true or false; disabled by default),
2191

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

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

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

thomasmueller's avatar
thomasmueller committed
2198
""fieldSeparator"" (a comma by default),
2199

2200
""lineComment"" (disabled by default),
2201

2202
""lineSeparator"" (the line separator used for writing; ignored for reading),
2203

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

2207
""preserveWhitespace"" (true or false; disabled by default),
2208

2209
""writeColumnHeader"" (true or false; enabled by default).
2210

Thomas Mueller's avatar
Thomas Mueller committed
2211
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
2212
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
2213 2214 2215
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
2216
","
2217
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
2218 2219
"

2220 2221 2222
"Other Grammar","Data Type","
intType | booleanType | tinyintType | smallintType | bigintType | identityType
    | decimalType | doubleType | realType | dateType | timeType | timestampType
2223 2224 2225
    | timestampWithTimeZoneType | binaryType | otherType | varcharType
    | varcharIgnorecaseType | charType | blobType | clobType | uuidType
    | arrayType | enumType
Thomas Mueller's avatar
Thomas Mueller committed
2226
","
2227
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
2228
","
2229
INT
Thomas Mueller's avatar
Thomas Mueller committed
2230 2231
"

2232 2233
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
2234
","
2235
A date literal. The limitations are the same as for the Java data type
2236
""java.sql.Date"", but for compatibility with other databases the suggested minimum
2237
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
2238
","
2239
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
2240 2241
"

2242
"Other Grammar","Decimal","
2243 2244
[ + | - ] { { number [ . number ] } | { . number } }
[ E [ + | - ] expNumber [...] ] ]
2245
","
Thomas Mueller's avatar
Thomas Mueller committed
2246 2247 2248 2249 2250 2251
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)"".
2252
","
Thomas Mueller's avatar
Thomas Mueller committed
2253 2254 2255
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
2256 2257
"

2258 2259 2260 2261 2262 2263 2264 2265
"Other Grammar","Delete search condition","
[ WHERE expression ] [ LIMIT term ]
","
Search condition for DELETE statement.
","
WHERE ID = 2
"

2266 2267
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
2268
","
2269
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
2270
","
2271
0
Thomas Mueller's avatar
Thomas Mueller committed
2272 2273
"

2274 2275
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
2276
","
2277 2278 2279
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
2280
","
2281
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
2282 2283
"

2284 2285
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2286
","
2287
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2288
","
2289
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2290 2291
"

2292
"Other Grammar","Factor","
2293
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2294
","
2295
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
2296
","
2297
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
2298 2299
"

2300 2301
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
2302
","
2303 2304
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
2305
","
2306
cafe
Thomas Mueller's avatar
Thomas Mueller committed
2307 2308
"

2309 2310
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
2311
","
2312
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
2313
","
2314
0xff
Thomas Mueller's avatar
Thomas Mueller committed
2315 2316
"

2317 2318
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2319
","
2320 2321 2322
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
2323
","
2324
NAME
Thomas Mueller's avatar
Thomas Mueller committed
2325 2326
"

2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337
"Other Grammar","Insert columns and source","
{ [ ( columnName [,...] ) ]
    { VALUES { ( { DEFAULT | expression } [,...] ) } [,...]
        | [ DIRECT ] [ SORTED ] select } } |
    { SET { columnName = { DEFAULT | expression } } [,...] }
","
Names of columns and their values for INSERT statement.
","
(ID, NAME) VALUES (1, 'Test')
"

Thomas Mueller's avatar
Thomas Mueller committed
2338
"Other Grammar","Int","
2339
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2340 2341 2342 2343 2344 2345 2346
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2347
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2348 2349 2350 2351 2352 2353
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2354
"Other Grammar","Name","
2355
{ { A-Z|_ } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2356
","
2357
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2358
","
2359
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2360 2361
"

2362 2363
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2364
","
2365
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2366
","
2367
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2368 2369
"

2370 2371 2372 2373 2374 2375 2376 2377
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2378
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2379
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2380
","
Thomas Mueller's avatar
Thomas Mueller committed
2381
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2382 2383 2384 2385 2386 2387 2388
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
"

2389 2390
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2391
","
2392
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2393
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2394
","
2395
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2396 2397
"

2398 2399
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2400
","
2401 2402 2403
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
2404
","
2405
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2406 2407
"

2408 2409
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2410
","
2411 2412 2413
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
2414
","
2415
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2416 2417
"

2418 2419 2420
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2421
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2422
","
Thomas Mueller's avatar
Thomas Mueller committed
2423 2424 2425
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
2426 2427 2428
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
2429
","
2430
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2431 2432
"

Thomas Mueller's avatar
Thomas Mueller committed
2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443
"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
"

2444
"Other Grammar","Script Compression Encryption","
2445 2446
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ]
[ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2447
","
2448 2449
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
2450 2451 2452 2453 2454
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2455 2456
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2457
","
2458
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2459
","
2460
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2461 2462
"

2463 2464 2465 2466 2467 2468 2469 2470 2471
"Other Grammar","Set clause list","
{ { columnName = { DEFAULT | expression } } [,...] } |
    { ( columnName [,...] ) = ( select ) }
","
List of SET clauses.
","
NAME = 'Test', VALUE = 2
"

2472 2473
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2474
","
2475 2476
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
2477
","
2478
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2479 2480
"

2481 2482
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2483
","
Thomas Mueller's avatar
Thomas Mueller committed
2484
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2485

Thomas Mueller's avatar
Thomas Mueller committed
2486
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2487
","
2488
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2489 2490
"

2491
"Other Grammar","Table Expression","
2492 2493
{ [ schemaName. ] tableName | ( select ) | valuesExpression }
[ [ AS ] newTableAlias [ ( columnName [,...] ) ] ]
2494
[ USE INDEX ([ indexName [,...] ]) ]
2495 2496
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2497
","
2498 2499 2500
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
2501
","
2502
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2503 2504
"

2505 2506 2507 2508 2509 2510 2511 2512 2513
"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;
"

2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2526
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2527
","
2528
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2529
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2530
","
2531 2532 2533 2534
'Hello'
"

"Other Grammar","Time","
2535
TIME [ WITHOUT TIME ZONE ] 'hh:mm:ss[.nnnnnnnnn]'
2536
","
2537
A time literal. A value is between 0:00:00 and 23:59:59.999999999
2538
and has nanosecond resolution.
2539 2540 2541 2542 2543
","
TIME '23:59:59'
"

"Other Grammar","Timestamp","
2544
TIMESTAMP [ WITHOUT TIME ZONE ] 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]'
2545 2546
","
A timestamp literal. The limitations are the same as for the Java data type
2547
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2548 2549 2550 2551 2552
minimum and maximum years are 0001 and 9999.
","
TIMESTAMP '2005-12-31 23:59:59'
"

2553
"Other Grammar","Timestamp with time zone","
2554
TIMESTAMP WITH TIME ZONE 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565
[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'
"

2566 2567 2568 2569 2570 2571 2572 2573
"Other Grammar","Date and time","
date | time | timestamp | timestampWithTimeZone
","
A literal value of any date-time data type.
","
TIMESTAMP '1999-01-31 10:00:00'
"

2574
"Other Grammar","Value","
2575
string | dollarQuotedString | numeric | dateAndTime | boolean | bytes | array | null
2576
","
Thomas Mueller's avatar
Thomas Mueller committed
2577
A literal value of any data type, or null.
2578 2579
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2580 2581 2582 2583 2584 2585 2586
"

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

2587
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2588 2589 2590 2591 2592 2593 2594 2595 2596
","
INT
"

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

2597
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2598 2599 2600 2601 2602 2603 2604 2605 2606
","
BOOLEAN
"

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

2607
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2608 2609 2610 2611 2612 2613 2614 2615 2616
","
TINYINT
"

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

2617
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2618 2619 2620 2621 2622 2623 2624 2625 2626
","
SMALLINT
"

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

2627
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638
","
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.

2639
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2640 2641 2642 2643 2644
","
IDENTITY
"

"Data Types","DECIMAL Type","
2645
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2646 2647 2648 2649
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2650
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2651 2652 2653 2654 2655
","
DECIMAL(20, 2)
"

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

2662
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2663 2664 2665 2666 2667
","
DOUBLE
"

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

2674
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2675 2676 2677 2678 2679
","
REAL
"

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

2685
Mapped to ""java.sql.Time"". When converted to a ""java.sql.Date"", the date is set to ""1970-01-01"".
2686
""java.time.LocalTime"" is also supported on Java 8 and later versions.
Evgenij Ryazanov's avatar
Evgenij Ryazanov committed
2687
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
2688 2689 2690 2691 2692 2693 2694
","
TIME
"

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

2697
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2698
(or to the next possible time if midnight doesn't exist for the given date and timezone due to a daylight saving change).
2699
""java.time.LocalDate"" is also supported on Java 8 and later versions.
Thomas Mueller's avatar
Thomas Mueller committed
2700 2701 2702 2703 2704
","
DATE
"

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

2713 2714
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
2715 2716 2717 2718
","
TIMESTAMP
"

2719
"Data Types","TIMESTAMP WITH TIME ZONE Type","
2720
TIMESTAMP [ ( precisionInt ) ] WITH TIME ZONE
2721
","
2722
The timestamp with time zone data type.
2723
Stored internally as a BCD-encoded date, nanoseconds since midnight, and time zone offset in minutes.
2724
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
2725

2726 2727 2728 2729 2730 2731 2732
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.
2733
","
2734
TIMESTAMP WITH TIME ZONE
2735 2736
"

Thomas Mueller's avatar
Thomas Mueller committed
2737
"Data Types","BINARY Type","
2738 2739
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA }
[ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2740
","
2741 2742 2743 2744 2745
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
2746 2747 2748 2749 2750 2751 2752 2753 2754

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2755 2756 2757 2758 2759
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
2760

2761
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2762 2763 2764 2765 2766
","
OTHER
"

"Data Types","VARCHAR Type","
2767
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
2768
    | NVARCHAR2 | VARCHAR_CASESENSITIVE} [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2769
","
Thomas Mueller's avatar
Thomas Mueller committed
2770
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2771 2772 2773 2774 2775 2776 2777
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
2778

2779
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2780 2781 2782 2783 2784
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2785
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2786
","
Thomas Mueller's avatar
Thomas Mueller committed
2787
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2788 2789 2790 2791 2792 2793 2794
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
2795

2796
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2797 2798 2799 2800 2801
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2802
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2803
","
Thomas Mueller's avatar
Thomas Mueller committed
2804 2805 2806
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
2807

Thomas Mueller's avatar
Thomas Mueller committed
2808 2809
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
2810

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

2814
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2815 2816 2817 2818 2819
","
CHAR(10)
"

"Data Types","BLOB Type","
2820 2821
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID }
[ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2822 2823 2824
","
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
2825
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2826 2827
Advanced / Large Objects.

2828
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2829 2830 2831 2832 2833
","
BLOB
"

"Data Types","CLOB Type","
2834 2835
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB }
[ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2836 2837 2838 2839 2840
","
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
2841
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2842 2843 2844 2845 2846

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.

2847
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2848 2849 2850 2851 2852 2853 2854
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2855 2856 2857 2858
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
2859

Thomas Mueller's avatar
Thomas Mueller committed
2860 2861 2862 2863 2864
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
2865
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2866 2867 2868 2869 2870 2871 2872
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2873
An array of values.
2874
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2875 2876 2877 2878


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
2879 2880 2881 2882
","
ARRAY
"

2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896
"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')
"
2897 2898 2899
"Data Types","GEOMETRY Type","
GEOMETRY
","
2900
A spatial geometry type, based on the ""org.locationtech.jts"" library.
2901 2902
May be represented in textual format using the WKT (well-known text) or EWKT (extended well-known text) format.
Values are stored internally in EWKB (extended well-known binary) format.
2903

2904
Use a quoted string containing a WKT/EWKT formatted string or ""PreparedStatement.setObject()"" to store values,
2905 2906
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2907
GEOMETRY
2908 2909
"

Thomas Mueller's avatar
Thomas Mueller committed
2910
"Functions (Aggregate)","AVG","
2911
AVG ( [ DISTINCT ] { numeric } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2912
","
2913 2914
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2915
Aggregates are only allowed in select statements.
2916
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2917 2918 2919 2920
","
AVG(X)
"

2921
"Functions (Aggregate)","BIT_AND","
2922
BIT_AND(expression) [ FILTER ( WHERE expression ) ]
2923 2924 2925 2926 2927 2928 2929 2930 2931
","
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","
2932
BIT_OR(expression) [ FILTER ( WHERE expression ) ]
2933 2934 2935 2936 2937 2938 2939 2940
","
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
2941
"Functions (Aggregate)","BOOL_AND","
2942
BOOL_AND(boolean) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2943
","
2944 2945 2946
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
2947 2948 2949 2950 2951
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2952
BOOL_OR(boolean) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2953
","
2954 2955 2956
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
2957 2958 2959 2960 2961
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2962
COUNT( { * | { [ DISTINCT ] expression } } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2963
","
2964 2965 2966 2967
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
2968 2969 2970 2971 2972
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2973 2974
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2975
[ SEPARATOR expression ] ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2976
","
2977 2978 2979 2980 2981
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
2982 2983 2984 2985
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998
"Functions (Aggregate)","ARRAY_AGG","
ARRAY_AGG ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ] )
[ FILTER ( WHERE expression ) ]
","
Aggregate the value into an array.
This method returns an array.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
ARRAY_AGG(NAME ORDER BY ID)
"

Thomas Mueller's avatar
Thomas Mueller committed
2999
"Functions (Aggregate)","MAX","
3000
MAX(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3001
","
3002 3003 3004 3005
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
3006 3007 3008 3009 3010
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
3011
MIN(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3012
","
3013 3014 3015 3016
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
3017 3018 3019 3020 3021
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
3022
SUM( [ DISTINCT ] { numeric } ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3023
","
3024 3025 3026
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
3027
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
3028
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
3029 3030 3031 3032 3033
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
3034
SELECTIVITY(value) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3035
","
3036 3037 3038 3039 3040
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
3041 3042 3043 3044 3045
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
3046
STDDEV_POP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3047
","
3048 3049 3050
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
3051 3052 3053 3054 3055 3056
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

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

"Functions (Aggregate)","VAR_POP","
3068
VAR_POP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3069
","
3070 3071 3072 3073
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
3074 3075 3076 3077 3078
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
3079
VAR_SAMP( [ DISTINCT ] numeric ) [ FILTER ( WHERE expression ) ]
Thomas Mueller's avatar
Thomas Mueller committed
3080
","
3081 3082 3083 3084
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
3085 3086 3087 3088
","
VAR_SAMP(X)
"

3089
"Functions (Aggregate)","MEDIAN","
3090
MEDIAN( [ DISTINCT ] value ) [ FILTER ( WHERE expression ) ]
3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101
","
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
3102
"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
3103
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3104
","
3105 3106
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"".
3107
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3108 3109 3110 3111 3112
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
3113
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3114
","
Thomas Mueller's avatar
Thomas Mueller committed
3115 3116
Calculate the arc cosine.
See also Java ""Math.acos"".
3117
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3118 3119 3120 3121 3122
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
3123
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3124
","
Thomas Mueller's avatar
Thomas Mueller committed
3125 3126
Calculate the arc sine.
See also Java ""Math.asin"".
3127
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3128 3129 3130 3131 3132
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
3133
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3134
","
Thomas Mueller's avatar
Thomas Mueller committed
3135 3136
Calculate the arc tangent.
See also Java ""Math.atan"".
3137
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3138 3139 3140 3141 3142
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
3143
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3144
","
Thomas Mueller's avatar
Thomas Mueller committed
3145 3146
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
3147
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3148 3149 3150 3151
","
COS(ANGLE)
"

3152
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
3153
COSH(numeric)
3154 3155 3156 3157 3158 3159 3160 3161
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
3162
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
3163
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3164
","
Thomas Mueller's avatar
Thomas Mueller committed
3165
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
3166
See also Java ""Math.*"" functions.
3167
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3168 3169 3170 3171 3172
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
3173
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3174
","
Thomas Mueller's avatar
Thomas Mueller committed
3175 3176
Calculate the trigonometric sine.
See also Java ""Math.sin"".
3177
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3178 3179 3180 3181
","
SIN(ANGLE)
"

3182
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
3183
SINH(numeric)
3184 3185 3186 3187 3188 3189 3190 3191
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
3192
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
3193
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3194
","
Thomas Mueller's avatar
Thomas Mueller committed
3195 3196
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
3197
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3198 3199 3200 3201
","
TAN(ANGLE)
"

3202
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
3203
TANH(numeric)
3204 3205 3206 3207 3208 3209 3210 3211
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
3212
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
3213
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3214
","
Thomas Mueller's avatar
Thomas Mueller committed
3215
Calculate the angle when converting the rectangular coordinates to polar coordinates.
3216
See also Java ""Math.atan2"".
3217
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3218 3219 3220 3221 3222
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
3223
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3224
","
3225 3226
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3227 3228 3229 3230 3231
See also Java operator &.
","
BITAND(A, B)
"

3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242
"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
3243
"Functions (Numeric)","BITOR","
3244
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3245
","
3246 3247
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3248 3249 3250 3251 3252 3253
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
3254
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3255
","
3256 3257
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3258 3259 3260 3261 3262 3263
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
3264
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
3265
","
3266 3267
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3268 3269 3270 3271 3272 3273
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
3274
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3275
","
3276
See also Java ""Math.ceil"".
3277
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3278
","
3279
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
3280 3281 3282
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
3283
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3284
","
3285
See also Java ""Math.toDegrees"".
3286
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3287 3288 3289 3290 3291
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
3292
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3293
","
3294
See also Java ""Math.exp"".
3295
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3296 3297 3298 3299 3300
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
3301
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3302
","
3303
See also Java ""Math.floor"".
3304
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3305 3306 3307 3308 3309
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
3310
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3311
","
3312
See also Java ""Math.log"".
3313
In the PostgreSQL mode, LOG(x) is base 10.
3314
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3315 3316 3317 3318 3319
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
3320
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3321
","
3322
See also Java ""Math.log10"".
3323
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3324 3325 3326 3327
","
LOG10(A)
"

3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340
"Functions (Numeric)","ORA_HASH","
ORA_HASH(expression [, bucketLong [, seedLong]])
","
Computes a hash value.
Optional bucket argument determines the maximum returned value.
This argument should be between 0 and 4294967295, default is 4294967295.
Optional seed argument is combined with the given expression to return the different values for the same expression.
This argument should be between 0 and 4294967295, default is 0.
This method returns a long value between 0 and the specified or default bucket value inclusive.
","
ORA_HASH(A)
"

Thomas Mueller's avatar
Thomas Mueller committed
3341
"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
3342
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3343
","
3344
See also Java ""Math.toRadians"".
3345
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3346 3347 3348 3349 3350
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
3351
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3352
","
3353
See also Java ""Math.sqrt"".
3354
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3355 3356 3357 3358 3359
","
SQRT(A)
"

"Functions (Numeric)","PI","
3360
PI()
Thomas Mueller's avatar
Thomas Mueller committed
3361
","
3362
See also Java ""Math.PI"".
3363
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3364 3365 3366 3367 3368
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
3369
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3370
","
3371
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
3372
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3373 3374 3375 3376 3377
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
3378
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
3379 3380 3381
","
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
3382
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
3383 3384 3385 3386 3387
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
3388
{ RANDOM_UUID | UUID } ()
Thomas Mueller's avatar
Thomas Mueller committed
3389 3390
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
3391 3392 3393 3394 3395

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
3396 3397 3398 3399 3400
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
3401
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
3402
","
3403
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
3404
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
3405 3406 3407 3408 3409
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
3410
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3411
","
3412 3413 3414 3415 3416 3417
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
3418 3419 3420 3421 3422
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
3423
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
3424 3425
","
Generates a number of cryptographically secure random numbers.
3426
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3427 3428 3429 3430 3431
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
3432
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3433 3434 3435 3436 3437 3438 3439
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
3440
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3441
","
3442
Encrypts data using a key.
3443
The supported algorithm is AES.
3444 3445
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3446 3447 3448 3449 3450
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
3451
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3452
","
3453
Decrypts data using a key.
3454
The supported algorithm is AES.
3455 3456
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3457 3458 3459 3460 3461 3462
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3463
HASH(algorithmString, expression [, iterationInt])
Thomas Mueller's avatar
Thomas Mueller committed
3464
","
3465 3466 3467
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
3468 3469 3470 3471 3472
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3473 3474
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt}
    | timestamp | timestampWithTimeZone | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3475 3476
","
Truncates to a number of digits (to the next value closer to 0).
3477
This method returns a double.
3478
When used with a timestamp, truncates a timestamp to a date (day) value.
3479 3480
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
3481 3482 3483 3484 3485
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3486
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3487
","
3488 3489 3490 3491
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
3492 3493 3494 3495 3496
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3497
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3498 3499
","
Expands data that was compressed using the COMPRESS function.
3500
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3501 3502 3503 3504 3505
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3506
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3507 3508 3509 3510 3511 3512 3513
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3514
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3515 3516
","
Returns the ASCII value of the first character in the string.
3517
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3518 3519 3520 3521
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3522
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3523
","
3524 3525 3526
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
3527 3528 3529 3530 3531
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3532
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3533
","
3534 3535 3536
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
3537 3538 3539 3540 3541
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3542
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3543
","
3544 3545 3546 3547
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
3548 3549 3550 3551 3552
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3553
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3554 3555
","
Returns the character that represents the ASCII value.
3556
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3557 3558 3559 3560 3561
","
CHAR(65)
"

"Functions (String)","CONCAT","
3562
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3563 3564
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3565
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3566
and do not cause the result to become NULL.
3567
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3568 3569 3570 3571
","
CONCAT(NAME, '!')
"

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

Thomas Mueller's avatar
Thomas Mueller committed
3583
"Functions (String)","DIFFERENCE","
3584
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3585 3586
","
Returns the difference between the sounds of two strings.
3587
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3588 3589 3590 3591 3592
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3593
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3594
","
3595 3596
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
3597 3598 3599 3600 3601
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3602
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3603
","
3604 3605 3606
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
3607 3608 3609 3610 3611
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3612
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3613
","
3614
Returns the location of a search string in a string.
3615 3616 3617
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
3618
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3619 3620 3621 3622 3623
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3624
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3625
","
3626 3627 3628
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
3629 3630 3631 3632 3633
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3634
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3635 3636 3637 3638 3639 3640 3641
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3642
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3643 3644 3645 3646 3647 3648 3649
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3650
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3651 3652 3653 3654 3655 3656 3657
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3658
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3659 3660 3661 3662 3663 3664 3665
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3666
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3667
","
3668 3669 3670 3671
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
3672 3673 3674 3675 3676
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3677
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3678 3679 3680 3681 3682 3683 3684
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3685
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3686
","
3687 3688 3689
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
3690 3691 3692 3693 3694
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3695
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3696
","
3697 3698 3699
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
3700 3701 3702 3703 3704
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3705
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3706 3707 3708 3709 3710 3711 3712
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3713
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3714 3715 3716 3717 3718 3719 3720
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3721
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3722
","
3723 3724
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
3725 3726 3727 3728 3729
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3730
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
3731
","
3732
Replaces each substring that matches a regular expression.
3733
For details, see the Java ""String.replaceAll()"" method.
3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747
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
3748 3749
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
3750
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3751 3752
"

3753 3754 3755 3756
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771
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)

3772 3773
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3774 3775
"

3776

Thomas Mueller's avatar
Thomas Mueller committed
3777
"Functions (String)","REPEAT","
3778
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3779 3780 3781 3782 3783 3784 3785
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3786
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3787
","
3788 3789
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.
3790
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3791 3792 3793 3794 3795
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3796
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3797
","
3798 3799 3800
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
3801 3802 3803 3804 3805
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3806
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3807 3808 3809 3810 3811 3812 3813
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3814
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3815
","
3816 3817 3818
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
3819 3820 3821 3822 3823
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

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

"Functions (String)","STRINGTOUTF8","
3834
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3835 3836
","
Encodes a string to a byte array using the UTF8 encoding format.
3837
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3838 3839 3840 3841 3842
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3843
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3844
","
3845
Returns a substring of a string starting at a position.
3846
If the start index is negative, then the start index is relative to the end of the string.
3847
The length is optional.
3848
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3849
","
3850 3851
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3852 3853 3854
"

"Functions (String)","UTF8TOSTRING","
3855
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3856 3857 3858 3859 3860 3861 3862
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3863
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3864
","
3865
Creates an XML attribute element of the form ""name=value"".
3866 3867
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3868 3869 3870 3871 3872
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3873
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3874 3875
","
Create an XML node element.
3876 3877 3878
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.
3879
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3880 3881 3882 3883 3884
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3885
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3886
","
3887
Creates an XML comment.
3888
Two dashes (""--"") are converted to ""- -"".
3889
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3890 3891 3892 3893 3894
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3895
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3896
","
3897
Creates an XML CDATA element.
3898
If the value contains ""]]>"", an XML text element is created instead.
3899
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3900 3901 3902 3903 3904
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3905
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3906
","
Thomas Mueller's avatar
Thomas Mueller committed
3907
Returns the XML declaration.
3908
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3909 3910 3911 3912 3913
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3914
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3915 3916
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3917
If enabled, newline and linefeed is converted to an XML entity (&#).
3918
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3919 3920 3921 3922
","
CALL XMLTEXT('test')
"

3923
"Functions (String)","TO_CHAR","
3924
TO_CHAR(value [, formatString[, nlsParamString]])
3925 3926 3927 3928 3929 3930
","
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')
"

3931
"Functions (String)","TRANSLATE","
3932
TRANSLATE(value, searchString, replacementString)
3933 3934 3935 3936 3937 3938
","
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
3939
"Functions (Time and Date)","CURRENT_DATE","
3940
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3941 3942
","
Returns the current date.
3943
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3944 3945 3946 3947 3948
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3949
{ CURRENT_TIME [ ( [ int ] ) ] | LOCALTIME [ ( [ int ] ) ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3950 3951
","
Returns the current time.
3952 3953 3954 3955 3956
If fractional seconds precision is specified it should be from 0 to 9, 0 is default.
The specified value can be used only to limit precision of a result.
The actual maximum available precision depends on operating system and JVM and can be 3 (milliseconds) or higher.
Higher precision is not available before Java 9.
These methods always return the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3957 3958 3959 3960 3961
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3962 3963 3964 3965
CURRENT_TIMESTAMP [ ( [ int ] ) ]
","
Returns the current timestamp with time zone.
Time zone offset is set to a current time zone offset
3966
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
3967 3968 3969 3970 3971 3972 3973 3974 3975 3976
The specified value can be used only to limit precision of a result.
The actual maximum available precision depends on operating system and JVM and can be 3 (milliseconds) or higher.
Higher precision is not available before Java 9.
This method always returns the same value within a transaction.
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","LOCALTIMESTAMP","
{ LOCALTIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3977
","
3978
Returns the current timestamp.
3979
If fractional seconds precision is specified it should be from 0 to 9, 6 is default.
3980 3981 3982 3983
The specified value can be used only to limit precision of a result.
The actual maximum available precision depends on operating system and JVM and can be 3 (milliseconds) or higher.
Higher precision is not available before Java 9.
These methods always return the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3984
","
3985
LOCALTIMESTAMP()
Thomas Mueller's avatar
Thomas Mueller committed
3986 3987 3988
"

"Functions (Time and Date)","DATEADD","
3989
{ DATEADD| TIMESTAMPADD } (datetimeField, addIntLong, dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
3990
","
3991
Adds units to a date-time value. The datetimeField indicates the unit.
3992
Use negative values to subtract units.
3993
addIntLong may be a long value when manipulating milliseconds,
3994
microseconds, or nanoseconds otherwise its range is restricted to int.
3995
This method returns a value with the same type as specified value if unit is compatible with this value.
3996 3997 3998
If specified field is a HOUR, MINUTE, SECOND, MILLISECOND, etc and value is a DATE value DATEADD returns combined TIMESTAMP.
Fields DAY, MONTH, YEAR, WEEK, etc are not allowed for TIME values.
Fields TIMEZONE_HOUR and TIMEZONE_MINUTE are only allowed for TIMESTAMP WITH TIME ZONE values.
Thomas Mueller's avatar
Thomas Mueller committed
3999 4000 4001 4002 4003
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
4004
{ DATEDIFF | TIMESTAMPDIFF } (datetimeField, aDateAndTime, bDateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4005
","
4006
Returns the the number of crossed unit boundaries between two date/time values.
4007
This method returns a long.
4008
The datetimeField indicates the unit.
4009 4010
Only TIMEZONE_HOUR and TIMEZONE_MINUTE fields use the time zone offset component.
With all other fields if date/time values have time zone offset component it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
4011 4012 4013 4014 4015
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
4016
DAYNAME(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4017 4018 4019 4020 4021 4022 4023
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
4024
DAY_OF_MONTH(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4025 4026 4027 4028 4029 4030 4031
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
4032
DAY_OF_WEEK(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4033 4034 4035 4036 4037 4038
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

4039 4040 4041 4042 4043 4044 4045 4046
"Functions (Time and Date)","ISO_DAY_OF_WEEK","
ISO_DAY_OF_WEEK(dateAndTime)
","
Returns the ISO day of the week (1 means Monday).
","
ISO_DAY_OF_WEEK(CREATED)
"

Thomas Mueller's avatar
Thomas Mueller committed
4047
"Functions (Time and Date)","DAY_OF_YEAR","
4048
DAY_OF_YEAR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4049 4050 4051 4052 4053 4054 4055
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
4056
EXTRACT ( datetimeField FROM dateAndTime )
Thomas Mueller's avatar
Thomas Mueller committed
4057
","
4058
Returns a value of the specific time unit from a date/time value.
4059 4060
This method returns a numeric value with EPOCH field and
an int for all other fields.
Thomas Mueller's avatar
Thomas Mueller committed
4061 4062 4063 4064 4065
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
4066
FORMATDATETIME ( dateAndTime, formatString
4067
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4068
","
4069 4070 4071
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.
4072
For details of the format, see ""java.text.SimpleDateFormat"".
4073 4074
timeZoneString may be specified if dateAndTime is a DATE, TIME or TIMESTAMP.
timeZoneString is ignored if dateAndTime is TIMESTAMP WITH TIME ZONE.
4075
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
4076 4077 4078 4079 4080 4081
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
4082
HOUR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4083
","
4084
Returns the hour (0-23) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4085 4086 4087 4088 4089
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
4090
MINUTE(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4091
","
4092
Returns the minute (0-59) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4093 4094 4095 4096 4097
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
4098
MONTH(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4099
","
4100
Returns the month (1-12) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4101 4102 4103 4104 4105
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
4106
MONTHNAME(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4107 4108 4109 4110 4111 4112 4113
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
4114
PARSEDATETIME(string, formatString
4115
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
4116
","
4117 4118 4119
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.
4120
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
4121 4122 4123 4124 4125 4126
","
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","
4127
QUARTER(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4128
","
4129
Returns the quarter (1-4) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4130 4131 4132 4133 4134
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
4135
SECOND(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4136
","
4137
Returns the second (0-59) from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4138 4139 4140 4141 4142
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
4143
WEEK(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4144
","
4145
Returns the week (1-53) from a date/time value.
4146
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
4147 4148 4149 4150
","
WEEK(CREATED)
"

4151
"Functions (Time and Date)","ISO_WEEK","
4152
ISO_WEEK(dateAndTime)
4153
","
4154
Returns the ISO week (1-53) from a date/time value.
4155
This function uses the ISO definition when
4156 4157 4158 4159 4160 4161
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
4162
"Functions (Time and Date)","YEAR","
4163
YEAR(dateAndTime)
Thomas Mueller's avatar
Thomas Mueller committed
4164
","
4165
Returns the year from a date/time value.
Thomas Mueller's avatar
Thomas Mueller committed
4166 4167 4168 4169
","
YEAR(CREATED)
"

4170
"Functions (Time and Date)","ISO_YEAR","
4171
ISO_YEAR(dateAndTime)
4172
","
4173
Returns the ISO week year from a date/time value.
4174 4175 4176 4177
","
ISO_YEAR(CREATED)
"

Thomas Mueller's avatar
Thomas Mueller committed
4178
"Functions (System)","ARRAY_GET","
4179
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
4180 4181
","
Returns one element of an array.
4182
Returns NULL if there is no such element or array is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
4183 4184 4185 4186 4187
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
4188
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
4189 4190
","
Returns the length of an array.
4191
Returns NULL if the specified array is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
4192 4193 4194 4195
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

4196 4197 4198
"Functions (System)","ARRAY_CONTAINS","
ARRAY_CONTAINS(arrayExpression, value)
","
4199 4200
Returns a boolean TRUE if the array contains the value or FALSE if it does not contain it.
Returns NULL if the specified array is NULL.
4201 4202 4203 4204
","
CALL ARRAY_CONTAINS(('Hello', 'World'), 'Hello')
"

Thomas Mueller's avatar
Thomas Mueller committed
4205
"Functions (System)","AUTOCOMMIT","
4206
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
4207 4208 4209 4210 4211 4212 4213
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
4214
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
4215
","
4216 4217 4218
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
4219 4220

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4221 4222 4223 4224 4225
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
4226
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4227 4228
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
4229
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
4230 4231 4232 4233 4234
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
4235
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
4236
","
4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248
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
4249 4250 4251
"

"Functions (System)","COALESCE","
4252
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4253 4254 4255 4256 4257 4258 4259
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
4260
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
4261 4262 4263 4264 4265 4266 4267
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
4268
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4269
","
4270 4271 4272 4273 4274
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
4275 4276 4277 4278 4279
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
4280
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4281
","
4282 4283
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
4284 4285

If the column names are specified (a list of column names separated with the
4286
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
4287 4288 4289 4290 4291
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
4292 4293 4294 4295 4296

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
4306 4307 4308
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
4309 4310 4311 4312
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
4313 4314 4315 4316
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
4317
SELECT ""Last Name"" FROM CSVREAD('address.csv');
4318
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
4319 4320 4321
"

"Functions (System)","CSVWRITE","
4322
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
4323
","
4324
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
4325
If only a file name is specified, it will be written to the current working directory.
4326
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
4327
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
4328 4329 4330 4331 4332

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

Thomas Mueller's avatar
Thomas Mueller committed
4335 4336
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4337
","
Thomas Mueller's avatar
Thomas Mueller committed
4338 4339 4340 4341
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
4342 4343 4344
"

"Functions (System)","DATABASE","
4345
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
4346 4347 4348 4349 4350 4351 4352
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
4353
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
4354
","
Thomas Mueller's avatar
Thomas Mueller committed
4355 4356
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
4357 4358 4359 4360
","
CALL DATABASE_PATH();
"

4361
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
4362
DECODE(value, whenValue, thenValue [,...])
4363 4364 4365 4366 4367 4368 4369 4370
","
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');
"

4371
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
4372
DISK_SPACE_USED(tableNameString)
4373 4374 4375 4376 4377 4378 4379 4380
","
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');
"

4381
"Functions (System)","SIGNAL","
4382
SIGNAL(sqlStateString, messageString)
4383 4384 4385 4386 4387 4388
","
Throw an SQLException with the passed SQLState and reason.
","
CALL SIGNAL('23505', 'Duplicate user ID: ' || user_id);
"

Thomas Mueller's avatar
Thomas Mueller committed
4389
"Functions (System)","FILE_READ","
4390
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
4391 4392 4393 4394
","
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
4395
default character set for this system.
4396 4397 4398 4399

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

Thomas Mueller's avatar
Thomas Mueller committed
4400
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4401 4402 4403 4404 4405
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

4406
"Functions (System)","FILE_WRITE","
4407
FILE_WRITE(blobValue, fileNameString)
4408 4409 4410 4411 4412 4413 4414 4415
","
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
4416
"Functions (System)","GREATEST","
4417
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4418 4419 4420 4421 4422 4423 4424
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
4425
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
4426 4427
","
Returns the last inserted identity value for this session.
4428
This value changes whenever a new sequence number was generated,
4429
even within a trigger or Java function. See also SCOPE_IDENTITY.
4430
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4431 4432 4433 4434 4435
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
4436
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4437 4438 4439 4440 4441 4442 4443
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
4444
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4445 4446 4447 4448 4449 4450 4451
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
4452
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
4453 4454
","
Returns the current lock mode. See SET LOCK_MODE.
4455
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4456 4457 4458 4459 4460
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
4461
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
4462 4463 4464 4465 4466 4467 4468 4469
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
4470
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
4471
","
4472 4473 4474 4475 4476
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
4477
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4478 4479 4480 4481 4482
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
4483
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
4484
","
Thomas Mueller's avatar
Thomas Mueller committed
4485
Returns the free memory in KB (where 1024 bytes is a KB).
4486
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4487 4488
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4489 4490 4491 4492 4493
","
MEMORY_FREE()
"

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

"Functions (System)","NEXTVAL","
4505
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4506
","
4507 4508 4509 4510
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
4511 4512 4513 4514 4515
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
4516
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4517 4518 4519 4520 4521 4522
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4523 4524 4525 4526
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4527
The data type of the returned value is the data type of 'a' if this is a text type.
4528 4529 4530 4531
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4532
"Functions (System)","READONLY","
4533
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4534 4535 4536 4537 4538 4539 4540
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
4541
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
4542
","
4543
Returns the number of the current row.
4544 4545
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4546
The first row has the row number 1, and is calculated before ordering and grouping the result set,
4547
but after evaluating index conditions (even when the index conditions are specified in an outer query).
4548
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
4549
","
4550 4551
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4552
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4553 4554 4555
"

"Functions (System)","SCHEMA","
4556
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4557
","
4558
Returns the name of the default schema for this session.
Thomas Mueller's avatar
Thomas Mueller committed
4559 4560 4561 4562
","
CALL SCHEMA()
"

4563 4564 4565
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4566
Returns the last inserted identity value for this session for the current scope
4567
(the current statement).
4568 4569 4570 4571 4572 4573
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
4574
"Functions (System)","SESSION_ID","
4575
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4576
","
4577 4578 4579 4580
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
4581 4582 4583 4584 4585
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4586
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4587
","
4588 4589 4590
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
4591
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4592
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4593 4594 4595 4596 4597
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4598
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4599 4600 4601 4602 4603 4604 4605
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4606
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4607
","
4608 4609
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
4610
Otherwise a value of the following form is returned:
4611
""logFileId-position-sessionId"".
4612 4613
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4614 4615 4616 4617
","
CALL TRANSACTION_ID()
"

4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629
"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
4630
"Functions (System)","USER","
4631
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4632 4633 4634 4635 4636 4637
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4638 4639 4640 4641 4642 4643 4644 4645
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660
"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
4661