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

19
LIMIT and FETCH FIRST/NEXT ROW(S) ONLY limits the number of rows returned by the query (no limit if null or smaller than zero).
Thomas Mueller's avatar
Thomas Mueller committed
20
OFFSET specified how many rows to skip.
21
Please note using high offset values should be avoided because it can cause performance problems.
22
SAMPLE_SIZE limits the number of rows read for aggregate queries.
23

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

28 29
If FOR UPDATE is specified, the tables are locked for writing. When using
MVCC, only the selected rows are locked as in an UPDATE statement.
Thomas Mueller's avatar
Thomas Mueller committed
30
In this case, aggregate, GROUP BY, DISTINCT queries or joins
31
are not allowed in this case.
Thomas Mueller's avatar
Thomas Mueller committed
32 33
","
SELECT * FROM TEST;
34 35 36 37 38
SELECT * FROM TEST ORDER BY NAME;
SELECT ID, COUNT(*) FROM TEST GROUP BY ID;
SELECT NAME, COUNT(*) FROM TEST GROUP BY NAME HAVING COUNT(*) > 2;
SELECT 'ID' COL, MAX(ID) AS MAX FROM TEST UNION SELECT 'NAME', MAX(NAME) FROM TEST;
SELECT * FROM TEST LIMIT 1000;
Thomas Mueller's avatar
Thomas Mueller committed
39 40 41 42 43 44
SELECT * FROM (SELECT ID, COUNT(*) FROM TEST
    GROUP BY ID UNION SELECT NULL, COUNT(*) FROM TEST)
    ORDER BY 1 NULLS LAST;
"

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

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

When using SORTED, b-tree pages are split at the insertion point. This can improve performance and reduce disk usage.
Thomas Mueller's avatar
Thomas Mueller committed
55 56 57 58 59
","
INSERT INTO TEST VALUES(1, 'Hello')
"

"Commands (DML)","UPDATE","
60 61 62
UPDATE tableName [ [ AS ] newTableAlias ] SET
{ { columnName = { DEFAULT | expression } } [,...] } |
    { ( columnName [,...] ) = ( select ) }
63
[ WHERE expression ] [ ORDER BY order [,...] ] [ LIMIT expression ]
Thomas Mueller's avatar
Thomas Mueller committed
64 65
","
Updates data in a table.
66
ORDER BY is supported for MySQL compatibility, but it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
67
","
68 69
UPDATE TEST SET NAME='Hi' WHERE ID=1;
UPDATE PERSON P SET NAME=(SELECT A.NAME FROM ADDRESS A WHERE A.ID=P.ID);
Thomas Mueller's avatar
Thomas Mueller committed
70 71 72
"

"Commands (DML)","DELETE","
73
DELETE [ TOP term ] FROM tableName [ WHERE expression ] [ LIMIT term ]
Thomas Mueller's avatar
Thomas Mueller committed
74 75
","
Deletes rows form a table.
76
If TOP or LIMIT is specified, at most the specified number of rows are deleted (no limit if null or smaller than zero).
Thomas Mueller's avatar
Thomas Mueller committed
77 78 79 80 81 82 83
","
DELETE FROM TEST WHERE ID=2
"

"Commands (DML)","BACKUP","
BACKUP TO fileNameString
","
Thomas Mueller's avatar
Thomas Mueller committed
84 85
Backs up the database files to a .zip file. Objects are not locked, but
the backup is transactionally consistent because the transaction log is also copied.
Thomas Mueller's avatar
Thomas Mueller committed
86
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
87 88 89 90 91 92 93
","
BACKUP TO 'backup.zip'
"

"Commands (DML)","CALL","
CALL expression
","
Thomas Mueller's avatar
Thomas Mueller committed
94 95 96
Calculates a simple expression. This statement returns a result set with one row,
except if the called function returns a result set itself.
If the called function returns an array, then each element in this array is returned as a column.
Thomas Mueller's avatar
Thomas Mueller committed
97 98 99 100 101
","
CALL 15*25
"

"Commands (DML)","EXPLAIN","
Thomas Mueller's avatar
Thomas Mueller committed
102
EXPLAIN { [ PLAN FOR ] | ANALYZE } { select | insert | update | delete | merge }
Thomas Mueller's avatar
Thomas Mueller committed
103 104
","
Shows the execution plan for a statement.
105 106
When using EXPLAIN ANALYZE, the statement is actually executed, and the query plan
will include the actual row scan count for each table.
Thomas Mueller's avatar
Thomas Mueller committed
107 108 109 110 111
","
EXPLAIN SELECT * FROM TEST WHERE ID=1
"

"Commands (DML)","MERGE","
112 113
MERGE INTO tableName [ ( columnName [,...] ) ]
[ KEY ( columnName [,...] ) ]
114
{ VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | select }
Thomas Mueller's avatar
Thomas Mueller committed
115 116 117 118 119 120 121 122 123 124
","
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
row per new row is affected, an exception is thrown. If the table contains an
auto-incremented key or identity column, and the row was updated, the generated
key is set to 0; otherwise it is set to the new key.
","
MERGE INTO TEST KEY(ID) VALUES(2, 'World')
"

Owner's avatar
Owner committed
125
"Commands (DML)","MERGE USING","
126 127 128 129 130 131 132 133 134 135 136 137
MERGE INTO targetTableName [ [AS] targetAlias]
USING { ( select ) | sourceTableName }[ [AS] sourceAlias ]
ON ( expression )
[ WHEN MATCHED THEN [ update ] [ delete] ]
[ WHEN NOT MATCHED THEN insert  ]
","
Updates or deletes existing rows, and insert rows that don't exist. The ON clause
specifies the matching column expression and must be specified. If more than one row
is updated per input row, an exception is thrown.
If the source data contains duplicate rows (specifically those columns used in the
row matching ON clause), then an exception is thrown to prevent two updates applying
to the same target row. The embedded update, delete or insert statements can not re-specify
Owner's avatar
Owner committed
138 139
the target table name.
","
140 141 142 143 144 145 146 147 148 149 150 151 152 153
MERGE INTO TARGET_TABLE AS T USING SOURCE_TABLE AS S
    ON (T.ID = S.ID)
    WHEN MATCHED THEN
        UPDATE SET T.COL1 = S.COL1 WHERE T.COL2<>'FINAL'
        DELETE WHERE T.COL2='FINAL'
    WHEN NOT MATCHED THEN
        INSERT (ID,COL1,COL2) VALUES(S.ID,S.COL1,S.COL2)
MERGE INTO TARGET_TABLE AS T USING (SELECT * FROM SOURCE_TABLE) AS S
    ON (T.ID = S.ID)
    WHEN MATCHED THEN
        UPDATE SET T.COL1 = S.COL1 WHERE T.COL2<>'FINAL'
        DELETE WHERE T.COL2='FINAL'
    WHEN NOT MATCHED THEN
        INSERT (ID,COL1,COL2) VALUES(S.ID,S.COL1,S.COL2)
Owner's avatar
Owner committed
154 155
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
","
ANALYZE SAMPLE_SIZE 1000
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
677

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

"Commands (DDL)","DROP SCHEMA","
889
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
890
","
Thomas Mueller's avatar
Thomas Mueller committed
891
Drops a schema.
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 SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
898
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
899
","
Thomas Mueller's avatar
Thomas Mueller committed
900
Drops a sequence.
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 SEQUENCE SEQ_ID
"

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

"Commands (DDL)","DROP TRIGGER","
918
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
919
","
Thomas Mueller's avatar
Thomas Mueller committed
920
Drops an existing trigger.
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 TRIGGER TRIG_INS
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1521 1522 1523 1524 1525 1526 1527 1528 1529
","
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
1530 1531 1532
operation. The default max size is 100000. 0 means no limit.

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

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

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

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

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

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

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

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;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1581 1582 1583 1584 1585 1586 1587 1588 1589
","
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
1590

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
1880

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

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

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

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

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

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

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

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

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

1947 1948
ILIKE does a case-insensitive compare.

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

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

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

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

1990
""caseSensitiveColumnNames"" (true or false; disabled by default),
1991

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

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

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

thomasmueller's avatar
thomasmueller committed
1998
""fieldSeparator"" (a comma by default),
1999

2000
""lineComment"" (disabled by default),
2001

2002
""lineSeparator"" (the line separator used for writing; ignored for reading),
2003

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

2007
""preserveWhitespace"" (true or false; disabled by default),
2008

2009
""writeColumnHeader"" (true or false; enabled by default).
2010

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

"Other Grammar","Time","
TIME 'hh:mm:ss'
","
2305 2306
A time literal. A value is between plus and minus 2 million hours
and has nanosecond resolution.
2307 2308 2309 2310 2311 2312 2313 2314
","
TIME '23:59:59'
"

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

"Other Grammar","Value","
Thomas Mueller's avatar
Thomas Mueller committed
2322
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2323
","
Thomas Mueller's avatar
Thomas Mueller committed
2324
A literal value of any data type, or null.
2325 2326
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2327 2328 2329 2330 2331 2332 2333
"

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

2334
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2335 2336 2337 2338 2339 2340 2341 2342 2343
","
INT
"

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

2344
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2345 2346 2347 2348 2349 2350 2351 2352 2353
","
BOOLEAN
"

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

2354
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2355 2356 2357 2358 2359 2360 2361 2362 2363
","
TINYINT
"

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

2364
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2365 2366 2367 2368 2369 2370 2371 2372 2373
","
SMALLINT
"

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

2374
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385
","
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.

2386
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2387 2388 2389 2390 2391
","
IDENTITY
"

"Data Types","DECIMAL Type","
2392
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2393 2394 2395 2396
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2397
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2398 2399 2400 2401 2402
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2403
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2404
","
Thomas Mueller's avatar
Thomas Mueller committed
2405
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2406 2407
of rounding problems.

2408
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2409 2410 2411 2412 2413
","
DOUBLE
"

"Data Types","REAL Type","
2414
{ REAL | FLOAT4 }
Thomas Mueller's avatar
Thomas Mueller committed
2415
","
Thomas Mueller's avatar
Thomas Mueller committed
2416
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2417 2418
values, because of rounding problems.

2419
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2420 2421 2422 2423 2424 2425 2426
","
REAL
"

"Data Types","TIME Type","
TIME
","
Thomas Mueller's avatar
Thomas Mueller committed
2427
The time data type. The format is hh:mm:ss.
Thomas Mueller's avatar
Thomas Mueller committed
2428

2429
Mapped to ""java.sql.Time"". When converted to a ""java.sql.Date"", the date is set to ""1970-01-01"".
Thomas Mueller's avatar
Thomas Mueller committed
2430 2431 2432 2433 2434 2435 2436
","
TIME
"

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

2439
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2440
(or to the next possible time if midnight doesn't exist for the given date and timezone due to a daylight saving change).
Thomas Mueller's avatar
Thomas Mueller committed
2441 2442 2443 2444 2445
","
DATE
"

"Data Types","TIMESTAMP Type","
2446
{ TIMESTAMP | DATETIME | SMALLDATETIME }
Thomas Mueller's avatar
Thomas Mueller committed
2447
","
Thomas Mueller's avatar
Thomas Mueller committed
2448
The timestamp data type. The format is yyyy-MM-dd hh:mm:ss[.nnnnnnnnn].
2449
Stored internally as a BCD-encoded date, and nano-seconds since midnight.
Thomas Mueller's avatar
Thomas Mueller committed
2450

2451
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2452 2453 2454 2455
","
TIMESTAMP
"

2456 2457
"Data Types","TIMESTAMP WITH TIME ZONE Type","
TIMESTAMP WITH TIME ZONE
2458 2459
","
VERY MUCH STILL IN TESTING.
2460
The timestamp with time zone data type.
2461 2462 2463 2464 2465
Stored internally as a BCD-encoded date, nano-seconds since midnight, and timezone offset in minutes.
Note that range queries on this datatype may do some weird stuff close to DST boundaries.

Mapped to ""org.h2.api.TimestampWithTimeZone""
","
2466
TIMESTAMP WITH TIME ZONE
2467 2468
"

Thomas Mueller's avatar
Thomas Mueller committed
2469
"Data Types","BINARY Type","
2470
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2471
","
2472 2473 2474 2475 2476
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
2477 2478 2479 2480 2481 2482 2483 2484 2485

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2486 2487 2488 2489 2490
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
2491

2492
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2493 2494 2495 2496 2497
","
OTHER
"

"Data Types","VARCHAR Type","
2498 2499
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2500
","
Thomas Mueller's avatar
Thomas Mueller committed
2501
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2502 2503 2504 2505 2506 2507 2508
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
2509

2510
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2511 2512 2513 2514 2515
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2516
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2517
","
Thomas Mueller's avatar
Thomas Mueller committed
2518
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2519 2520 2521 2522 2523 2524 2525
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
2526

2527
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2528 2529 2530 2531 2532
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2533
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2534
","
Thomas Mueller's avatar
Thomas Mueller committed
2535 2536 2537
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
2538

Thomas Mueller's avatar
Thomas Mueller committed
2539 2540
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
2541

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

2545
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2546 2547 2548 2549 2550
","
CHAR(10)
"

"Data Types","BLOB Type","
2551
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2552 2553 2554
","
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
2555
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2556 2557
Advanced / Large Objects.

2558
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2559 2560 2561 2562 2563
","
BLOB
"

"Data Types","CLOB Type","
2564
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2565 2566 2567 2568 2569
","
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
2570
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2571 2572 2573 2574 2575

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.

2576
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2577 2578 2579 2580 2581 2582 2583
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2584 2585 2586 2587
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
2588

Thomas Mueller's avatar
Thomas Mueller committed
2589 2590 2591 2592 2593
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
2594
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2595 2596 2597 2598 2599 2600 2601
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2602
An array of values.
2603
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2604 2605 2606 2607


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
2608 2609 2610 2611
","
ARRAY
"

2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625
"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')
"
2626 2627 2628
"Data Types","GEOMETRY Type","
GEOMETRY
","
2629 2630
A spatial geometry type, based on the ""com.vividsolutions.jts"" library.
Normally represented in textual format using the WKT (well known text) format.
2631

Thomas Mueller's avatar
Thomas Mueller committed
2632
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2633 2634
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2635
GEOMETRY
2636 2637
"

Thomas Mueller's avatar
Thomas Mueller committed
2638
"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2639
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2640
","
2641 2642
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2643
Aggregates are only allowed in select statements.
2644
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2645 2646 2647 2648
","
AVG(X)
"

2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668
"Functions (Aggregate)","BIT_AND","
BIT_AND(expression)
","
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","
BIT_OR(expression)
","
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
2669
"Functions (Aggregate)","BOOL_AND","
2670
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2671
","
2672 2673 2674
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
2675 2676 2677 2678 2679
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2680
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2681
","
2682 2683 2684
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
2685 2686 2687 2688 2689
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2690
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2691
","
2692 2693 2694 2695
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
2696 2697 2698 2699 2700
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2701 2702
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2703
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2704
","
2705 2706 2707 2708 2709
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
2710 2711 2712 2713 2714
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2715
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2716
","
2717 2718 2719 2720
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
2721 2722 2723 2724 2725
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2726
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2727
","
2728 2729 2730 2731
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
2732 2733 2734 2735 2736
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2737
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2738
","
2739 2740 2741
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2742
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2743
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2744 2745 2746 2747 2748
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2749
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2750
","
2751 2752 2753 2754 2755
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
2756 2757 2758 2759 2760
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2761
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2762
","
2763 2764 2765
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
2766 2767 2768 2769 2770 2771
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2772
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2773
","
2774 2775 2776
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
2777 2778 2779 2780 2781 2782
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2783
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2784
","
2785 2786 2787 2788
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
2789 2790 2791 2792 2793
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2794
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2795
","
2796 2797 2798 2799
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
2800 2801 2802 2803
","
VAR_SAMP(X)
"

2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816
"Functions (Aggregate)","MEDIAN","
MEDIAN( [ DISTINCT ] value )
","
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
2817
"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2818
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2819
","
2820 2821
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"".
2822
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2823 2824 2825 2826 2827
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2828
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2829
","
Thomas Mueller's avatar
Thomas Mueller committed
2830 2831
Calculate the arc cosine.
See also Java ""Math.acos"".
2832
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2833 2834 2835 2836 2837
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2838
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2839
","
Thomas Mueller's avatar
Thomas Mueller committed
2840 2841
Calculate the arc sine.
See also Java ""Math.asin"".
2842
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2843 2844 2845 2846 2847
","
ASIN(D)
"

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

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2858
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2859
","
Thomas Mueller's avatar
Thomas Mueller committed
2860 2861
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2862
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2863 2864 2865 2866
","
COS(ANGLE)
"

2867
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2868
COSH(numeric)
2869 2870 2871 2872 2873 2874 2875 2876
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2877
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2878
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2879
","
Thomas Mueller's avatar
Thomas Mueller committed
2880
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2881
See also Java ""Math.*"" functions.
2882
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2883 2884 2885 2886 2887
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2888
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2889
","
Thomas Mueller's avatar
Thomas Mueller committed
2890 2891
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2892
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2893 2894 2895 2896
","
SIN(ANGLE)
"

2897
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2898
SINH(numeric)
2899 2900 2901 2902 2903 2904 2905 2906
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

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

2917
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2918
TANH(numeric)
2919 2920 2921 2922 2923 2924 2925 2926
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2927
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2928
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2929
","
Thomas Mueller's avatar
Thomas Mueller committed
2930
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2931
See also Java ""Math.atan2"".
2932
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2933 2934 2935 2936 2937
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2938
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2939
","
2940 2941
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2942 2943 2944 2945 2946
See also Java operator &.
","
BITAND(A, B)
"

2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957
"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
2958
"Functions (Numeric)","BITOR","
2959
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2960
","
2961 2962
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2963 2964 2965 2966 2967 2968
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2969
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2970
","
2971 2972
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2973 2974 2975 2976 2977 2978
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2979
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2980
","
2981 2982
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2983 2984 2985 2986 2987 2988
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2989
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2990
","
2991
See also Java ""Math.ceil"".
2992
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2993
","
2994
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2995 2996 2997
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2998
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2999
","
3000
See also Java ""Math.toDegrees"".
3001
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3002 3003 3004 3005 3006
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
3007
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3008
","
3009
See also Java ""Math.exp"".
3010
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3011 3012 3013 3014 3015
","
EXP(A)
"

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

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
3025
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3026
","
3027
See also Java ""Math.log"".
3028
In the PostgreSQL mode, LOG(x) is base 10.
3029
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3030 3031 3032 3033 3034
","
LOG(A)
"

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

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
3044
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3045
","
3046
See also Java ""Math.toRadians"".
3047
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3048 3049 3050 3051 3052
","
RADIANS(A)
"

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

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

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

"Functions (Numeric)","RAND","
3080
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
3081 3082 3083
","
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
3084
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
3085 3086 3087 3088 3089
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
3090
{ RANDOM_UUID | UUID } ()
Thomas Mueller's avatar
Thomas Mueller committed
3091 3092
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
3093 3094 3095 3096 3097

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
3098 3099 3100 3101 3102
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
3103
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
3104
","
3105
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
3106
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
3107 3108 3109 3110 3111
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
3112
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3113
","
3114 3115 3116 3117 3118 3119
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
3120 3121 3122 3123 3124
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
3125
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
3126 3127
","
Generates a number of cryptographically secure random numbers.
3128
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3129 3130 3131 3132 3133
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
3134
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3135 3136 3137 3138 3139 3140 3141
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
3142
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3143
","
3144
Encrypts data using a key.
3145
The supported algorithm is AES.
3146 3147
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3148 3149 3150 3151 3152
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
3153
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3154
","
3155
Decrypts data using a key.
3156
The supported algorithm is AES.
3157 3158
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3159 3160 3161 3162 3163 3164
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3165
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
3166
","
3167 3168 3169
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
3170 3171 3172 3173 3174
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3175
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3176 3177
","
Truncates to a number of digits (to the next value closer to 0).
3178
This method returns a double.
3179
When used with a timestamp, truncates a timestamp to a date (day) value.
3180 3181
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
3182 3183 3184 3185 3186
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3187
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3188
","
3189 3190 3191 3192
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
3193 3194 3195 3196 3197
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3198
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3199 3200
","
Expands data that was compressed using the COMPRESS function.
3201
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3202 3203 3204 3205 3206
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3207
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3208 3209 3210 3211 3212 3213 3214
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3215
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3216 3217
","
Returns the ASCII value of the first character in the string.
3218
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3219 3220 3221 3222
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3223
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3224
","
3225 3226 3227
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
3228 3229 3230 3231 3232
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3233
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3234
","
3235 3236 3237
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
3238 3239 3240 3241 3242
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3243
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3244
","
3245 3246 3247 3248
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
3249 3250 3251 3252 3253
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3254
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3255 3256
","
Returns the character that represents the ASCII value.
3257
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3258 3259 3260 3261 3262
","
CHAR(65)
"

"Functions (String)","CONCAT","
3263
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3264 3265
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3266
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3267
and do not cause the result to become NULL.
3268
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3269 3270 3271 3272
","
CONCAT(NAME, '!')
"

3273 3274 3275 3276
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3277
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3278
and do not cause the result to become NULL.
3279 3280 3281 3282 3283
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3284
"Functions (String)","DIFFERENCE","
3285
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3286 3287
","
Returns the difference between the sounds of two strings.
3288
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3289 3290 3291 3292 3293
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3294
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3295
","
3296 3297
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
3298 3299 3300 3301 3302
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3303
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3304
","
3305 3306 3307
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
3308 3309 3310 3311 3312
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3313
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3314
","
3315
Returns the location of a search string in a string.
3316 3317 3318
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
3319
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3320 3321 3322 3323 3324
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3325
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3326
","
3327 3328 3329
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
3330 3331 3332 3333 3334
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3335
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3336 3337 3338 3339 3340 3341 3342
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3343
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3344 3345 3346 3347 3348 3349 3350
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3351
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3352 3353 3354 3355 3356 3357 3358
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3359
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3360 3361 3362 3363 3364 3365 3366
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3367
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3368
","
3369 3370 3371 3372
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
3373 3374 3375 3376 3377
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3378
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3379 3380 3381 3382 3383 3384 3385
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3386
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3387
","
3388 3389 3390
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
3391 3392 3393 3394 3395
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3396
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3397
","
3398 3399 3400
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
3401 3402 3403 3404 3405
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3406
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3407 3408 3409 3410 3411 3412 3413
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3414
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3415 3416 3417 3418 3419 3420 3421
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3422
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3423
","
3424 3425
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
3426 3427 3428 3429 3430
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3431
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
3432
","
3433
Replaces each substring that matches a regular expression.
3434
For details, see the Java ""String.replaceAll()"" method.
3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448
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
3449 3450
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
3451
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3452 3453
"

3454 3455 3456 3457
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472
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)

3473 3474
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3475 3476
"

3477

Thomas Mueller's avatar
Thomas Mueller committed
3478
"Functions (String)","REPEAT","
3479
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3480 3481 3482 3483 3484 3485 3486
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3487
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3488
","
3489 3490
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.
3491
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3492 3493 3494 3495 3496
","
REPLACE(NAME, ' ')
"

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

"Functions (String)","SPACE","
3507
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3508 3509 3510 3511 3512 3513 3514
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3515
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3516
","
3517 3518 3519
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
3520 3521 3522 3523 3524
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3525
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3526
","
3527 3528 3529
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
3530 3531 3532 3533 3534
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3535
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3536 3537
","
Encodes a string to a byte array using the UTF8 encoding format.
3538
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3539 3540 3541 3542 3543
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3544
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3545
","
3546
Returns a substring of a string starting at a position.
3547
If the start index is negative, then the start index is relative to the end of the string.
3548
The length is optional.
3549
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3550
","
3551 3552
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3553 3554 3555
"

"Functions (String)","UTF8TOSTRING","
3556
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3557 3558 3559 3560 3561 3562 3563
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3564
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3565
","
3566
Creates an XML attribute element of the form ""name=value"".
3567 3568
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3569 3570 3571 3572 3573
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3574
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3575 3576
","
Create an XML node element.
3577 3578 3579
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.
3580
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3581 3582 3583 3584 3585
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3586
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3587
","
3588
Creates an XML comment.
3589
Two dashes (""--"") are converted to ""- -"".
3590
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3591 3592 3593 3594 3595
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3596
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3597
","
3598
Creates an XML CDATA element.
3599
If the value contains ""]]>"", an XML text element is created instead.
3600
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3601 3602 3603 3604 3605
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3606
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3607
","
Thomas Mueller's avatar
Thomas Mueller committed
3608
Returns the XML declaration.
3609
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3610 3611 3612 3613 3614
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3615
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3616 3617
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3618
If enabled, newline and linefeed is converted to an XML entity (&#).
3619
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3620 3621 3622 3623
","
CALL XMLTEXT('test')
"

3624
"Functions (String)","TO_CHAR","
3625
TO_CHAR(value [, formatString[, nlsParamString]])
3626 3627 3628 3629 3630 3631
","
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')
"

3632 3633 3634 3635 3636 3637 3638 3639
"Functions (String)","TRANSLATE","
TRANSLATE(value , searchString, replacementString]])
","
Oracle-compatible TRANSLATE function that replaces a sequence of characters in a string with another set of characters.
","
CALL TRANSLATE('Hello world', 'eo', 'EO')
"

Thomas Mueller's avatar
Thomas Mueller committed
3640
"Functions (Time and Date)","CURRENT_DATE","
3641
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3642 3643
","
Returns the current date.
3644
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3645 3646 3647 3648 3649
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3650
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3651 3652
","
Returns the current time.
3653
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3654 3655 3656 3657 3658
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3659
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3660
","
3661 3662
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3663
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3664 3665 3666 3667 3668
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3669
{ DATEADD| TIMESTAMPADD } (unitString, addIntLong, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3670
","
3671 3672
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
3673 3674
addIntLong may be a long value when manipulating milliseconds,
otherwise it's range is restricted to int.
3675
The same units as in the EXTRACT function are supported.
3676
DATEADD method returns a timestamp. TIMESTAMPADD method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3677 3678 3679 3680 3681
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3682
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3683
","
Thomas Mueller's avatar
Thomas Mueller committed
3684
Returns the the number of crossed unit boundaries between two timestamps.
3685 3686
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3687
The same units as in the EXTRACT function are supported.
3688
If timestamps have time zone offset component it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
3689 3690 3691 3692 3693
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3694
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3695 3696 3697 3698 3699 3700 3701
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3702
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3703 3704 3705 3706 3707 3708 3709
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3710
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3711 3712 3713 3714 3715 3716 3717
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3718
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3719 3720 3721 3722 3723 3724 3725
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3726
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | ISO_WEEK | DAY | DD | DAY_OF_YEAR
3727
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3728
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3729 3730
","
Returns a specific value from a timestamps.
3731
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3732 3733 3734 3735 3736
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3737
FORMATDATETIME ( timestamp, formatString
3738
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3739
","
3740 3741 3742
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.
3743
For details of the format, see ""java.text.SimpleDateFormat"".
3744
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3745 3746 3747 3748 3749 3750
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3751
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3752 3753 3754 3755 3756 3757 3758
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3759
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3760 3761 3762 3763 3764 3765 3766
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3767
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3768 3769 3770 3771 3772 3773 3774
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3775
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3776 3777 3778 3779 3780 3781 3782
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3783
PARSEDATETIME(string, formatString
3784
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3785
","
3786 3787 3788
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.
3789
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3790 3791 3792 3793 3794 3795
","
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","
3796
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3797 3798 3799 3800 3801 3802 3803
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3804
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3805 3806 3807 3808 3809 3810 3811
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3812
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3813
","
3814 3815
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3816 3817 3818 3819 3820
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3821
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3822 3823 3824 3825 3826 3827 3828
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3829
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3830 3831
","
Returns one element of an array.
3832
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3833 3834 3835 3836 3837
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3838
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3839 3840 3841 3842 3843 3844
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3845 3846 3847 3848 3849 3850 3851 3852
"Functions (System)","ARRAY_CONTAINS","
ARRAY_CONTAINS(arrayExpression, value)
","
Returns a boolean true if the array contains the value.
","
CALL ARRAY_CONTAINS(('Hello', 'World'), 'Hello')
"

Thomas Mueller's avatar
Thomas Mueller committed
3853
"Functions (System)","AUTOCOMMIT","
3854
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3855 3856 3857 3858 3859 3860 3861
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3862
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3863
","
3864 3865 3866
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
3867 3868

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3869 3870 3871 3872 3873
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3874
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3875 3876
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3877
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3878 3879 3880 3881 3882
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3883
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3884
","
3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896
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
3897 3898 3899
"

"Functions (System)","COALESCE","
3900
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3901 3902 3903 3904 3905 3906 3907
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3908
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3909 3910 3911 3912 3913 3914 3915
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3916
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3917
","
3918 3919 3920 3921 3922
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
3923 3924 3925 3926 3927
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3928
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3929
","
3930 3931
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
3932 3933

If the column names are specified (a list of column names separated with the
3934
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3935 3936 3937 3938 3939
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
3940 3941 3942 3943 3944

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3954 3955 3956
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
3957 3958 3959 3960
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
3961 3962 3963 3964
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
3965
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3966
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3967 3968 3969
"

"Functions (System)","CSVWRITE","
3970
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3971
","
3972
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3973
If only a file name is specified, it will be written to the current working directory.
3974
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3975
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
3976 3977 3978 3979 3980

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

Thomas Mueller's avatar
Thomas Mueller committed
3983 3984
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3985
","
Thomas Mueller's avatar
Thomas Mueller committed
3986 3987 3988 3989
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
3990 3991 3992
"

"Functions (System)","DATABASE","
3993
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3994 3995 3996 3997 3998 3999 4000
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
4001
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
4002
","
Thomas Mueller's avatar
Thomas Mueller committed
4003 4004
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
4005 4006 4007 4008
","
CALL DATABASE_PATH();
"

4009
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
4010
DECODE(value, whenValue, thenValue [,...])
4011 4012 4013 4014 4015 4016 4017 4018
","
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');
"

4019
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
4020
DISK_SPACE_USED(tableNameString)
4021 4022 4023 4024 4025 4026 4027 4028
","
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');
"

4029
"Functions (System)","SIGNAL","
4030
SIGNAL(sqlStateString, messageString)
4031 4032 4033 4034 4035 4036
","
Throw an SQLException with the passed SQLState and reason.
","
CALL SIGNAL('23505', 'Duplicate user ID: ' || user_id);
"

Thomas Mueller's avatar
Thomas Mueller committed
4037
"Functions (System)","FILE_READ","
4038
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
4039 4040 4041 4042
","
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
4043
default character set for this system.
4044 4045 4046 4047

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

Thomas Mueller's avatar
Thomas Mueller committed
4048
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4049 4050 4051 4052 4053
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

4054
"Functions (System)","FILE_WRITE","
4055
FILE_WRITE(blobValue, fileNameString)
4056 4057 4058 4059 4060 4061 4062 4063
","
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
4064
"Functions (System)","GREATEST","
4065
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4066 4067 4068 4069 4070 4071 4072
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
4073
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
4074 4075
","
Returns the last inserted identity value for this session.
4076
This value changes whenever a new sequence number was generated,
4077
even within a trigger or Java function. See also SCOPE_IDENTITY.
4078
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4079 4080 4081 4082 4083
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
4084
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4085 4086 4087 4088 4089 4090 4091
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
4092
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4093 4094 4095 4096 4097 4098 4099
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
4100
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
4101 4102
","
Returns the current lock mode. See SET LOCK_MODE.
4103
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4104 4105 4106 4107 4108
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
4109
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
4110 4111 4112 4113 4114 4115 4116 4117
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
4118
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
4119
","
4120 4121 4122 4123 4124
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
4125
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4126 4127 4128 4129 4130
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
4131
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
4132
","
Thomas Mueller's avatar
Thomas Mueller committed
4133
Returns the free memory in KB (where 1024 bytes is a KB).
4134
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4135 4136
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4137 4138 4139 4140 4141
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
4142
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
4143
","
Thomas Mueller's avatar
Thomas Mueller committed
4144
Returns the used memory in KB (where 1024 bytes is a KB).
4145
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4146 4147
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4148 4149 4150 4151 4152
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
4153
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4154
","
4155 4156 4157 4158
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
4159 4160 4161 4162 4163
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
4164
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4165 4166 4167 4168 4169 4170
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4171 4172 4173 4174
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4175
The data type of the returned value is the data type of 'a' if this is a text type.
4176 4177 4178 4179
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4180
"Functions (System)","READONLY","
4181
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4182 4183 4184 4185 4186 4187 4188
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
4189
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
4190
","
4191
Returns the number of the current row.
4192 4193
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4194 4195
The first row has the row number 1, and is calculated before ordering and grouping the result set,
but after evaluating index conditions (even when the  index conditions are specified in an outer query).
4196
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
4197
","
4198 4199
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4200
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4201 4202 4203
"

"Functions (System)","SCHEMA","
4204
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4205 4206 4207 4208 4209 4210
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

4211 4212 4213
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4214
Returns the last inserted identity value for this session for the current scope
Thomas Mueller's avatar
Thomas Mueller committed
4215
(ie. the current statement).
4216 4217 4218 4219 4220 4221
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
4222
"Functions (System)","SESSION_ID","
4223
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4224
","
4225 4226 4227 4228
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
4229 4230 4231 4232 4233
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4234
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4235
","
4236 4237 4238
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
4239
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4240
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4241 4242 4243 4244 4245
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4246
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4247 4248 4249 4250 4251 4252 4253
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4254
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4255
","
4256 4257
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
4258
Otherwise a value of the following form is returned:
4259
""logFileId-position-sessionId"".
4260 4261
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4262 4263 4264 4265
","
CALL TRANSACTION_ID()
"

4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277
"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
4278
"Functions (System)","USER","
4279
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4280 4281 4282 4283 4284 4285
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4286 4287 4288 4289 4290 4291 4292 4293
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308
"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
4309