help.csv 125.3 KB
Newer Older
1 2
# Copyright 2004-2014 H2 Group. Multiple-Licensed under the MPL 2.0,
# 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

24
Multiple set operators (UNION, INTERSECT, MINUS, EXPECT) 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 125
","
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')
"

"Commands (DML)","RUNSCRIPT","
126 127
RUNSCRIPT FROM fileNameString scriptCompressionEncryption
[ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
128 129 130 131 132 133
","
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.

134
Instead of a file name, an URL may be used.
135
To read a stream from the classpath, use the prefix 'classpath:'.
136
See the Pluggable File System section on the Advanced page.
137

138
The compression algorithm must match the one used when creating the script.
Thomas Mueller's avatar
Thomas Mueller committed
139 140 141
Instead of a file, an URL may be used.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
142
","
143
RUNSCRIPT FROM 'backup.sql'
144
RUNSCRIPT FROM 'classpath:/com/acme/test.sql'
Thomas Mueller's avatar
Thomas Mueller committed
145 146 147
"

"Commands (DML)","SCRIPT","
148 149
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
150
[ TO fileNameString scriptCompressionEncryption
151
    [ CHARSET charsetString ] ]
152 153
[ TABLE tableName [, ...] ]
[ SCHEMA schemaName [, ...] ]
Thomas Mueller's avatar
Thomas Mueller committed
154
","
155 156 157 158 159 160 161
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
162 163
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
164
out-of-line commands.
Thomas Mueller's avatar
Thomas Mueller committed
165
NOSETTINGS turns off dumping the database settings (the SET XXX commands)
166

167
If no 'TO fileName' clause is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
168 169 170 171
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.

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

Thomas Mueller's avatar
Thomas Mueller committed
176 177 178
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
179
Admin rights are required to execute this command.
180

181
When using the TABLE or SCHEMA option, only the selected table(s) / schema(s) are included.
Thomas Mueller's avatar
Thomas Mueller committed
182 183 184 185 186
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
187 188
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
189 190 191 192 193 194
","
Lists the schemas, tables, or the columns of a table.
","
SHOW TABLES
"

195
"Commands (DML)","WITH","
196 197
WITH [ RECURSIVE ] { name [( columnName [,...] )]
    AS ( select ) [,...] }
198 199
    select
","
200
Can be used to create a recursive or non-recursive query (common table expression).
201
For recursive queries the first select has to be a UNION.
202
One or more common table entries can be referred to by name.
203
Column name declarations are now optional - the column names will be inferred from the named select queries.
204 205 206 207 208 209 210 211 212
","
WITH RECURSIVE t(n) AS (
        SELECT 1
    UNION ALL
        SELECT n + 1
        FROM t
        WHERE n < 100
)
SELECT sum(n) FROM t;
213 214 215
","
WITH t1 AS (
        SELECT 1 AS FIRST_COLUMN
216
), t2 AS (
217 218 219
        SELECT FIRST_COLUMN+1 AS FIRST_COLUMN FROM t1
)
SELECT sum(FIRST_COLUMN) FROM t2;
220 221
"

Thomas Mueller's avatar
Thomas Mueller committed
222
"Commands (DDL)","ALTER INDEX RENAME","
223
ALTER INDEX [ IF EXISTS ] indexName RENAME TO newIndexName
Thomas Mueller's avatar
Thomas Mueller committed
224
","
Thomas Mueller's avatar
Thomas Mueller committed
225
Renames an index.
Thomas Mueller's avatar
Thomas Mueller committed
226
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
227 228 229 230
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

231
"Commands (DDL)","ALTER SCHEMA RENAME","
232
ALTER SCHEMA [ IF EXISTS ] schema RENAME TO newSchemaName
233 234
","
Renames a schema.
Thomas Mueller's avatar
Thomas Mueller committed
235
This command commits an open transaction in this connection.
236 237 238 239
","
ALTER SCHEMA TEST RENAME TO PRODUCTION
"

Thomas Mueller's avatar
Thomas Mueller committed
240
"Commands (DDL)","ALTER SEQUENCE","
241
ALTER SEQUENCE [ IF EXISTS ] sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
242 243 244 245
[ 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
246
","
247
Changes the parameters of a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
248
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
249 250 251 252 253 254
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

"Commands (DDL)","ALTER TABLE ADD","
255
ALTER TABLE [ IF EXISTS ] tableName ADD [ COLUMN ]
256 257
{ [ IF NOT EXISTS ] columnDefinition | ( { columnDefinition } [,...] ) }
[ { BEFORE | AFTER } columnName ]
Thomas Mueller's avatar
Thomas Mueller committed
258
","
Thomas Mueller's avatar
Thomas Mueller committed
259
Adds a new column to a table.
Thomas Mueller's avatar
Thomas Mueller committed
260
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
261 262 263 264 265
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
266
ALTER TABLE [ IF EXISTS ] tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
267 268 269
","
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
270
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
271
It is not possible to disable checking for unique constraints.
Thomas Mueller's avatar
Thomas Mueller committed
272
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
273 274 275 276
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

277
"Commands (DDL)","ALTER TABLE RENAME CONSTRAINT","
278
ALTER TABLE [ IF EXISTS ] tableName RENAME oldConstraintName TO newConstraintName
279 280 281 282 283 284 285
","
Renames a constraint.
This command commits an open transaction in this connection.
","
ALTER TABLE TEST RENAME CONSTRAINT FOO TO BAR
"

286
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
287
ALTER TABLE [ IF EXISTS ] tableName ALTER COLUMN columnName
288
{ { dataType [ VISIBLE | INVISIBLE ] [ DEFAULT expression ] [ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] }
289 290 291 292 293
    | { RENAME TO name }
    | { RESTART WITH long }
    | { SELECTIVITY int }
    | { SET DEFAULT expression }
    | { SET NULL }
294 295
    | { SET NOT NULL }
    | { SET { VISIBLE | INVISIBLE } } }
Thomas Mueller's avatar
Thomas Mueller committed
296
","
297 298
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
299

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

302 303 304
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
305

306 307 308 309
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
310

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

313
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
314
Single column indexes on this column are dropped.
315 316 317

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

318 319 320
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
321
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
322
","
323 324 325 326 327 328 329
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;
330 331
ALTER TABLE TEST ALTER COLUMN NAME SET VISIBLE;
ALTER TABLE TEST ALTER COLUMN NAME SET INVISIBLE;
Thomas Mueller's avatar
Thomas Mueller committed
332 333 334
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
335
ALTER TABLE [ IF EXISTS ] tableName DROP COLUMN [ IF EXISTS ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
336
","
337
Removes column(s) from a table.
Thomas Mueller's avatar
Thomas Mueller committed
338
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
339 340
","
ALTER TABLE TEST DROP COLUMN NAME
341
ALTER TABLE TEST DROP COLUMN NAME1, NAME2
Thomas Mueller's avatar
Thomas Mueller committed
342 343 344
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
345
ALTER TABLE [ IF EXISTS ] tableName DROP { CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
346 347
","
Removes a constraint or a primary key from a table.
Thomas Mueller's avatar
Thomas Mueller committed
348
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
349 350 351 352 353
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
354
ALTER TABLE [ IF EXISTS ] tableName SET REFERENTIAL_INTEGRITY
355
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
356 357 358 359 360 361
","
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.
362

Thomas Mueller's avatar
Thomas Mueller committed
363
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
364 365 366 367 368
","
ALTER TABLE TEST SET REFERENTIAL_INTEGRITY FALSE
"

"Commands (DDL)","ALTER TABLE RENAME","
369
ALTER TABLE [ IF EXISTS ] tableName RENAME TO newName
Thomas Mueller's avatar
Thomas Mueller committed
370
","
Thomas Mueller's avatar
Thomas Mueller committed
371
Renames a table.
Thomas Mueller's avatar
Thomas Mueller committed
372
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
373 374 375 376 377
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
378
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
379
","
Thomas Mueller's avatar
Thomas Mueller committed
380 381 382 383
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
384
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
385 386 387 388 389 390 391
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
392 393 394 395
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
396
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
397
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
398 399 400 401 402
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
403
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
404
","
Thomas Mueller's avatar
Thomas Mueller committed
405 406 407 408 409 410
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
411
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
412 413 414 415 416
","
ALTER USER SA SET PASSWORD 'rioyxlgt'
"

"Commands (DDL)","ALTER VIEW","
417
ALTER VIEW [ IF EXISTS ] viewName RECOMPILE
Thomas Mueller's avatar
Thomas Mueller committed
418 419
","
Recompiles a view after the underlying tables have been changed or created.
Thomas Mueller's avatar
Thomas Mueller committed
420
This command is used for views created using CREATE FORCE VIEW.
Thomas Mueller's avatar
Thomas Mueller committed
421
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
422 423 424 425 426
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
427
ANALYZE [ TABLE tableName ] [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
428
","
429 430 431
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
432 433 434 435 436
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.
437

Thomas Mueller's avatar
Thomas Mueller committed
438
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
439 440 441 442 443
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
444 445 446 447 448
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
449
","
Thomas Mueller's avatar
Thomas Mueller committed
450 451 452
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
453
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
454 455 456 457 458
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
459
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
460 461 462
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
463
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
464 465

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
466
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
467 468 469 470 471
","
CREATE AGGREGATE MEDIAN FOR ""com.acme.db.Median""
"

"Commands (DDL)","CREATE ALIAS","
Thomas Mueller's avatar
Thomas Mueller committed
472
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
Thomas Mueller's avatar
Thomas Mueller committed
473
[ NOBUFFER ] { FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
474
","
475 476 477 478 479 480
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.
481 482 483

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

489 490
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.
491 492
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
493 494
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
495

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

499
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
500 501 502
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.
503

Thomas Mueller's avatar
Thomas Mueller committed
504
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
505
This command commits an open transaction in this connection.
506 507

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
508 509 510 511 512
","
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');
513 514
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
515 516 517 518 519
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
520 521 522
"

"Commands (DDL)","CREATE CONSTANT","
523
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
524
","
Thomas Mueller's avatar
Thomas Mueller committed
525
Creates a new constant.
Thomas Mueller's avatar
Thomas Mueller committed
526
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
527 528 529 530 531
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
532 533 534
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
535 536
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
537
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
538
to the value being tested.
539

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

Thomas Mueller's avatar
Thomas Mueller committed
542
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
543 544 545 546 547
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
548
CREATE
Thomas Mueller's avatar
Thomas Mueller committed
549
{ [ UNIQUE ] [ HASH | SPATIAL] INDEX [ [ IF NOT EXISTS ] newIndexName ]
550 551
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
552
","
Thomas Mueller's avatar
Thomas Mueller committed
553
Creates a new index.
Thomas Mueller's avatar
Thomas Mueller committed
554
This command commits an open transaction in this connection.
555

Thomas Mueller's avatar
Thomas Mueller committed
556
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
557 558
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
559
Non-unique keys are supported.
560
Spatial indexes are supported only on Geometry columns.
Thomas Mueller's avatar
Thomas Mueller committed
561 562 563 564 565
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
566
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ]
Thomas Mueller's avatar
Thomas Mueller committed
567
LINKED TABLE [ IF NOT EXISTS ]
568 569
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
570 571 572 573 574
","
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.

575 576 577
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
578 579
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
580
work. Linked tables to the same database share one connection.
581

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

Thomas Mueller's avatar
Thomas Mueller committed
584 585 586
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).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
594
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
595
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
596 597 598 599 600 601 602 603 604
","
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","
605
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
606
","
Thomas Mueller's avatar
Thomas Mueller committed
607
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
608
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
609 610 611 612 613
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
614
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
615
[ WITH tableEngineParamName [,...] ]
Thomas Mueller's avatar
Thomas Mueller committed
616 617 618
","
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
619
Specifying the owner currently has no effect.
620 621
Optional table engine parameters are used when CREATE TABLE command
is run on this schema without having its engine params set.
622

Thomas Mueller's avatar
Thomas Mueller committed
623
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
624 625 626 627 628
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
629
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
630 631 632 633 634
[ 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
635
","
Thomas Mueller's avatar
Thomas Mueller committed
636 637 638
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
639 640 641 642 643

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
644

Thomas Mueller's avatar
Thomas Mueller committed
645
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
646 647 648 649 650
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
651 652
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
653
[ ( { columnDefinition | constraint } [,...] ) ]
654 655
[ ENGINE tableEngineName ]
[ WITH tableEngineParamName [,...] ]
656
[ NOT PERSISTENT ] [ TRANSACTIONAL ]
657
[ AS select ]","
Thomas Mueller's avatar
Thomas Mueller committed
658 659
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
660 661 662 663
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
664
that means memory tables should not get too large.
665

Thomas Mueller's avatar
Thomas Mueller committed
666 667 668 669 670
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,
671
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
672

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

677 678 679
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.

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

683 684 685
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
686 687
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
688 689 690 691 692
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
693
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
694
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
695
[ QUEUE int ] [ NOWAIT ] { CALL triggeredClassName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
696
","
Thomas Mueller's avatar
Thomas Mueller committed
697 698 699 700 701
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).
702

703 704 705
The sourceCodeString must define a single method with no parameters that returns ""org.h2.api.Trigger"".
See CREATE ALIAS for requirements regarding the compilation.

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

Thomas Mueller's avatar
Thomas Mueller committed
711
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
712
Only row based AFTER trigger can be called on ROLLBACK.
713
Exceptions that occur within such triggers are ignored.
714 715
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.
716

717
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
718
Only the first such trigger is called. Such triggers on views are supported.
719
They can be used to make views updatable.
720

Thomas Mueller's avatar
Thomas Mueller committed
721 722
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.
723 724
The trigger is called with both 'old' and 'new' set to null.

725 726 727 728
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
729 730
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
731 732 733
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.

734 735
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

Thomas Mueller's avatar
Thomas Mueller committed
736 737
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.
738

Thomas Mueller's avatar
Thomas Mueller committed
739
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
740
","
741
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger"";
Thomas Mueller's avatar
Thomas Mueller committed
742
CREATE TRIGGER TRIG_SRC BEFORE INSERT ON TEST AS $$org.h2.api.Trigger create() { return new MyTrigger(""constructorParam""); } $$;
Thomas Mueller's avatar
Thomas Mueller committed
743 744
"
"Commands (DDL)","CREATE USER","
745 746
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
747
","
Thomas Mueller's avatar
Thomas Mueller committed
748 749 750
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.
751

Thomas Mueller's avatar
Thomas Mueller committed
752
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
753
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
754 755 756 757 758
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
759
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
760
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
761 762
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
763
if the underlying table(s) don't exist.
764

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

770 771
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
772
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
773
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
774 775 776 777 778
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
779
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
780
","
Thomas Mueller's avatar
Thomas Mueller committed
781 782 783
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
784
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
785
","
Thomas Mueller's avatar
Thomas Mueller committed
786
DROP AGGREGATE MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
787 788 789
"

"Commands (DDL)","DROP ALIAS","
790
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
791
","
Thomas Mueller's avatar
Thomas Mueller committed
792 793 794
Drops an existing function alias.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
795
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
796
","
Thomas Mueller's avatar
Thomas Mueller committed
797
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
798 799 800
"

"Commands (DDL)","DROP ALL OBJECTS","
801
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
802 803 804 805 806
","
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
807 808 809
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
810 811 812 813 814
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
815
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
816
","
Thomas Mueller's avatar
Thomas Mueller committed
817
Drops a constant.
Thomas Mueller's avatar
Thomas Mueller committed
818
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
819 820 821 822 823
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
824
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
825
","
Thomas Mueller's avatar
Thomas Mueller committed
826
Drops a data type (domain).
Thomas Mueller's avatar
Thomas Mueller committed
827
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
828 829 830 831 832
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
833
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
834
","
Thomas Mueller's avatar
Thomas Mueller committed
835
Drops an index.
Thomas Mueller's avatar
Thomas Mueller committed
836
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
837 838 839 840 841
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
842
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
843
","
Thomas Mueller's avatar
Thomas Mueller committed
844
Drops a role.
Thomas Mueller's avatar
Thomas Mueller committed
845
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
846 847 848 849 850
","
DROP ROLE READONLY
"

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

"Commands (DDL)","DROP SEQUENCE","
860
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
861
","
Thomas Mueller's avatar
Thomas Mueller committed
862
Drops a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
863
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
864 865 866 867 868
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
869
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
870
","
Thomas Mueller's avatar
Thomas Mueller committed
871
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
872 873
The command will fail if dependent views exist and the RESTRICT clause is used (the default).
All dependent views are dropped as well if the CASCADE clause is used.
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 TABLE TEST
"

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

"Commands (DDL)","DROP USER","
889
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
890
","
Thomas Mueller's avatar
Thomas Mueller committed
891 892
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
893

Thomas Mueller's avatar
Thomas Mueller committed
894
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
895
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
896 897 898 899 900
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
901
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
902
","
Thomas Mueller's avatar
Thomas Mueller committed
903 904 905
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
906
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
907 908 909 910 911 912 913
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
914 915 916 917 918
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).
919
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
920

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 927 928
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
929
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
930 931

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
932 933 934 935 936 937 938
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
939
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
940 941 942
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
943 944 945 946 947
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
948
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
949 950 951 952 953 954 955 956 957
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
958 959 960 961
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
962 963 964 965 966
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
967
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
968 969
{ { SCHEMA schemaName } | { tableName [,...] } }
TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
970
","
Thomas Mueller's avatar
Thomas Mueller committed
971 972 973
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
974
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
975 976 977 978
","
GRANT SELECT ON TEST TO READONLY
"

979 980 981 982 983 984
"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
985
This command commits an open transaction in this connection.
986 987 988 989
","
GRANT ALTER ANY SCHEMA TO Bob
"

Thomas Mueller's avatar
Thomas Mueller committed
990
"Commands (Other)","GRANT ROLE","
991
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
992
","
Thomas Mueller's avatar
Thomas Mueller committed
993 994 995
Grants a role to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
996
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
997 998 999 1000 1001
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
1002
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1003 1004 1005 1006 1007 1008 1009 1010 1011
","
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
1012 1013
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
1014 1015 1016 1017 1018
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
1019
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1020 1021
{ { SCHEMA schemaName } | { tableName [,...] } }
FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1022
","
Thomas Mueller's avatar
Thomas Mueller committed
1023 1024 1025
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
1026
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1027 1028 1029 1030 1031
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
1032
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1033
","
Thomas Mueller's avatar
Thomas Mueller committed
1034 1035 1036
Removes a role from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1037
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1038 1039 1040 1041 1042
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
1043
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
","
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
1054 1055 1056 1057
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
1058 1059 1060 1061 1062 1063 1064
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1065 1066
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
1067 1068 1069 1070 1071
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1072
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1073
","
Thomas Mueller's avatar
Thomas Mueller committed
1074
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1075
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
1076
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1077 1078 1079 1080 1081
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1082
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
","
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
1093 1094
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1095
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1096
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1097
This setting is persistent.
1098
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1099 1100 1101 1102 1103
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
1104
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
1105 1106
","
Switches auto commit on or off.
1107
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
1108
however this will not work as expected when using a connection pool
1109 1110
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
1111
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
1112 1113 1114 1115 1116 1117 1118
","
SET AUTOCOMMIT OFF
"

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1130
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1131
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1132
This setting is persistent.
1133
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
","
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
1146 1147
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1148
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1149 1150 1151 1152
","
SET CLUSTER ''
"

1153 1154 1155 1156
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1157 1158
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.
1159 1160 1161
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
1162
This command commits an open transaction in this connection.
1163 1164 1165 1166 1167
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
"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
1181
"Commands (Other)","SET COLLATION","
1182 1183
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1184
","
Thomas Mueller's avatar
Thomas Mueller committed
1185 1186
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
1187 1188
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
1189
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1190

1191 1192 1193 1194 1195
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).
1196 1197
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.
1198

Thomas Mueller's avatar
Thomas Mueller committed
1199
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.
Thomas Mueller's avatar
Thomas Mueller committed
1201
This setting is persistent.
1202
This setting can be appended to the database URL: ""jdbc:h2:test;COLLATION='ENGLISH'""
Thomas Mueller's avatar
Thomas Mueller committed
1203 1204
","
SET COLLATION ENGLISH
1205
SET COLLATION CHARSET_CP500
Thomas Mueller's avatar
Thomas Mueller committed
1206 1207 1208
"

"Commands (Other)","SET COMPRESS_LOB","
1209
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1210
","
Thomas Mueller's avatar
Thomas Mueller committed
1211 1212 1213 1214
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
1215 1216
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
1217

Thomas Mueller's avatar
Thomas Mueller committed
1218
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1219
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1220
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1221 1222 1223 1224 1225 1226 1227 1228
","
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
1229 1230 1231 1232
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).
1233
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1234 1235 1236 1237 1238 1239 1240
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1241 1242
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
1243 1244 1245 1246
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
1247

Thomas Mueller's avatar
Thomas Mueller committed
1248
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1249
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1250
This setting is persistent.
1251
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1252 1253 1254 1255 1256 1257 1258 1259
","
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
1260 1261
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1262
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1263
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1264
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1265 1266 1267 1268 1269
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1270
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1271 1272 1273
","
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
1274
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1275
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1276

Thomas Mueller's avatar
Thomas Mueller committed
1277
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1278
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1279
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1280
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1281 1282 1283 1284 1285
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1286
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1287
","
Thomas Mueller's avatar
Thomas Mueller committed
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
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
1298 1299

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1300
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1301
","
Thomas Mueller's avatar
Thomas Mueller committed
1302
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1303 1304 1305
"

"Commands (Other)","SET IGNORECASE","
1306
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1307 1308 1309 1310 1311
","
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
1312
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1313

Thomas Mueller's avatar
Thomas Mueller committed
1314
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1315
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1316
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1317
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1318 1319 1320 1321
","
SET IGNORECASE TRUE
"

1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
"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
1334
This command commits an open transaction in this connection.
1335 1336 1337 1338 1339 1340 1341
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'
"


1342
"Commands (Other)","SET LOG","
1343
SET LOG int
1344 1345 1346 1347
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1348
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1349 1350 1351 1352
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.

1353 1354
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
1355 1356
against power failure is required, but the data must be protected against killing the process.

1357 1358
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
1359 1360
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1361
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1362
This command commits an open transaction in this connection.
1363
This setting is not persistent.
1364
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1365 1366 1367 1368
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1369 1370 1371 1372
"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
1373
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386

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
1387
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1388
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1389
This setting is persistent.
1390
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1391 1392 1393 1394 1395 1396 1397 1398
","
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
1399 1400 1401
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1402
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1403 1404 1405 1406 1407 1408 1409
","
SET LOCK_TIMEOUT 1000
"

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

1412
This is the maximum length of an LOB that is stored with the record itself,
1413 1414
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1415
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1416
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1417
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1418 1419 1420 1421 1422 1423 1424
","
SET MAX_LENGTH_INPLACE_LOB 128
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1431
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1432
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1433
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1434 1435 1436 1437 1438 1439 1440 1441
","
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
1442
are read, then the rows are buffered to disk.
1443
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1444

Thomas Mueller's avatar
Thomas Mueller committed
1445
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1446
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1447
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1448
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1449 1450 1451 1452 1453 1454 1455
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1462
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1463
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1464
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1465
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1466 1467 1468 1469 1470 1471 1472 1473 1474
","
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
1475 1476 1477
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1478
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1479
It has no effect for in-memory databases.
1480
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1481 1482 1483 1484 1485
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1486
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1487 1488
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1489 1490 1491
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1492
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1493
This command commits an open transaction in this connection.
1494
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1495 1496 1497 1498 1499
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1500
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1501 1502 1503
","
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
1504 1505 1506 1507 1508
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
1509
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1510
This command commits an open transaction in this connection.
1511
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1512 1513 1514 1515 1516
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1517
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1518 1519 1520
","
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
1521 1522
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1523
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1524
This command commits an open transaction in this connection.
1525
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1526 1527 1528 1529 1530 1531 1532 1533 1534
","
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
1535

Thomas Mueller's avatar
Thomas Mueller committed
1536
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1537 1538 1539 1540
","
SET PASSWORD 'abcstzri!.5'
"

1541 1542 1543 1544 1545 1546 1547
"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
1548
This command commits an open transaction in this connection.
1549 1550 1551 1552 1553
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
"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
1567 1568 1569 1570 1571
"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
1572 1573 1574
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
1575 1576 1577 1578 1579
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1580
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1581 1582 1583
","
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
1584 1585 1586
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1587
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1588
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1589 1590 1591 1592
","
SET REFERENTIAL_INTEGRITY FALSE
"

1593 1594 1595 1596 1597 1598
"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.
1599 1600 1601
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,
1602 1603 1604 1605
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
1606
This command commits an open transaction in this connection.
1607 1608 1609 1610 1611 1612
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
1613 1614 1615 1616 1617
"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
1618

Thomas Mueller's avatar
Thomas Mueller committed
1619
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1620 1621 1622 1623 1624 1625 1626 1627 1628
","
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
1629 1630 1631
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1632
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1633 1634 1635 1636 1637 1638 1639 1640 1641
","
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
1642 1643 1644
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1645
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1646 1647 1648 1649 1650 1651 1652 1653 1654
","
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
1655 1656 1657
disabled).

This command does not commit a transaction, and rollback does not affect it.
1658
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1659 1660 1661 1662 1663
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1664
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1665 1666 1667
","
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.
1668
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1669

Thomas Mueller's avatar
Thomas Mueller committed
1670
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1671
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1672
This command does not commit a transaction, and rollback does not affect it.
1673
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
","
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
1685
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1686
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1687
This command commits an open transaction in this connection.
1688
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698
","
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
1699

Thomas Mueller's avatar
Thomas Mueller committed
1700
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1701 1702 1703 1704 1705 1706 1707 1708
","
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
1709 1710
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1711
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1712
This command commits an open transaction in this connection.
1713
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1714 1715 1716 1717 1718
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1719
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1720
","
1721 1722
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
1723
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1724

1725 1726
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
1727 1728 1729

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,
1730
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
1731 1732

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1736
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1737
","
1738
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1739 1740
"

1741 1742
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1743
","
1744
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1745
","
1746
A
Thomas Mueller's avatar
Thomas Mueller committed
1747 1748
"

1749 1750
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1751
","
1752
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1753
","
1754
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1755 1756
"

1757
"Other Grammar","Array","
1758
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1759
","
1760 1761
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
1762
","
1763
(1, 2)
1764 1765
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1766 1767
"

1768 1769
"Other Grammar","Boolean","
TRUE | FALSE
1770
","
1771
A boolean value.
1772
","
1773
TRUE
1774 1775
"

1776 1777
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1778
","
1779
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1780
","
1781
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1782 1783
"

1784 1785 1786
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1787
","
1788 1789
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
1790
","
1791
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1792 1793
"

1794 1795 1796
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1797
","
1798 1799
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1800
","
1801 1802 1803 1804
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
1805
AES
1806
","
1807
Only the algorithm AES (""AES-128"") is supported currently.
1808 1809
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1810 1811
"

1812
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1813
columnName dataType
1814
[ VISIBLE | INVISIBLE ]
Thomas Mueller's avatar
Thomas Mueller committed
1815
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1816
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1817 1818
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1819 1820
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1821
The computed column expression is evaluated and assigned whenever the row changes.
1822 1823 1824 1825

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
1826

1827 1828 1829
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
1830 1831
The options PRIMARY KEY, UNIQUE, and CHECK are not supported for ALTER statements.

Thomas Mueller's avatar
Thomas Mueller committed
1832 1833
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
1834 1835
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1836

1837
","
Thomas Mueller's avatar
Thomas Mueller committed
1838 1839 1840
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);
1841 1842
"

1843 1844
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1845
","
1846 1847 1848
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
1849
","
1850
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1851 1852
"

1853
"Other Grammar","Compare","
1854
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
1855
","
1856
Comparison operator. The operator != is the same as <>.
1857
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
1858
","
1859
<>
Thomas Mueller's avatar
Thomas Mueller committed
1860 1861 1862
"

"Other Grammar","Condition","
1863
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1864 1865 1866 1867 1868 1869 1870
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1871 1872
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1873
    | IS [ NOT ] [ DISTINCT FROM ] operand
1874 1875
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
1876
    | [ NOT ] [ LIKE | ILIKE ] operand [ ESCAPE string ]
1877
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1878
","
Thomas Mueller's avatar
Thomas Mueller committed
1879
The right hand side of a condition.
1880

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

Thomas Mueller's avatar
Thomas Mueller committed
1884 1885 1886 1887 1888
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).
1889 1890 1891
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.
1892

1893 1894
ILIKE does a case-insensitive compare.

Thomas Mueller's avatar
Thomas Mueller committed
1895
When comparing with REGEXP, regular expression matching is used.
1896
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1897 1898 1899 1900
","
LIKE 'Jo%'
"

1901
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
1902 1903 1904 1905 1906
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
1907
","
Thomas Mueller's avatar
Thomas Mueller committed
1908 1909
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1910
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1911 1912
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
1913
","
1914
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1915 1916
"

1917 1918
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1919
","
1920
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1921
","
1922
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1923 1924
"

1925 1926
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1927
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1928
","
1929
Optional parameters for CSVREAD and CSVWRITE.
1930 1931
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
1932 1933
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1934
The following options are supported:
1935

1936
""caseSensitiveColumnNames"" (true or false; disabled by default),
1937

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1944
""fieldSeparator"" (a comma by default)),
1945

1946
""lineComment"" (disabled by default),
1947

1948
""lineSeparator"" (the line separator used for writing; ignored for reading),
1949

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

1953
""preserveWhitespace"" (true or false; disabled by default),
1954

1955
""writeColumnHeader"" (true or false; enabled by default).
1956

Thomas Mueller's avatar
Thomas Mueller committed
1957
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1958
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
1959 1960 1961
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
1962
","
1963
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1964 1965
"

1966 1967 1968 1969
"Other Grammar","Data Type","
intType | booleanType | tinyintType | smallintType | bigintType | identityType
    | decimalType | doubleType | realType | dateType | timeType | timestampType
    | binaryType | otherType | varcharType | varcharIgnorecaseType | charType
1970
    | blobType | clobType | uuidType | arrayType | enumType
Thomas Mueller's avatar
Thomas Mueller committed
1971
","
1972
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1973
","
1974
INT
Thomas Mueller's avatar
Thomas Mueller committed
1975 1976
"

1977 1978
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1979
","
1980
A date literal. The limitations are the same as for the Java data type
1981
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1982
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1983
","
1984
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1985 1986
"

1987
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
1988
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
1989
","
Thomas Mueller's avatar
Thomas Mueller committed
1990 1991 1992 1993 1994 1995
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)"".
1996
","
Thomas Mueller's avatar
Thomas Mueller committed
1997 1998 1999
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
2000 2001
"

2002 2003
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
2004
","
2005
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
2006
","
2007
0
Thomas Mueller's avatar
Thomas Mueller committed
2008 2009
"

2010 2011
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
2012
","
2013 2014 2015
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
2016
","
2017
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
2018 2019
"

2020 2021
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2022
","
2023
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2024
","
2025
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2026 2027
"

2028
"Other Grammar","Factor","
2029
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2030
","
2031
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
2032
","
2033
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
2034 2035
"

2036 2037
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
2038
","
2039 2040
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
2041
","
2042
cafe
Thomas Mueller's avatar
Thomas Mueller committed
2043 2044
"

2045 2046
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
2047
","
2048
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
2049
","
2050
0xff
Thomas Mueller's avatar
Thomas Mueller committed
2051 2052
"

2053 2054
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2055
","
2056 2057 2058
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
2059
","
2060
NAME
Thomas Mueller's avatar
Thomas Mueller committed
2061 2062 2063
"

"Other Grammar","Int","
2064
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2065 2066 2067 2068 2069 2070 2071
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2072
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2073 2074 2075 2076 2077 2078
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2079 2080
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2081
","
2082
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2083
","
2084
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2085 2086
"

2087 2088
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2089
","
2090
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2091
","
2092
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2093 2094
"

2095 2096 2097 2098 2099 2100 2101 2102
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2103
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2104
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2105
","
Thomas Mueller's avatar
Thomas Mueller committed
2106
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2107 2108 2109 2110 2111 2112 2113
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
"

2114 2115
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2116
","
2117
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2118
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2119
","
2120
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2121 2122
"

2123 2124
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2125
","
2126 2127 2128
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
2129
","
2130
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2131 2132
"

2133 2134
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2135
","
2136 2137 2138
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
2139
","
2140
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2141 2142
"

2143 2144 2145
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2146
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2147
","
Thomas Mueller's avatar
Thomas Mueller committed
2148 2149 2150
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
2151 2152 2153
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
2154
","
2155
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2156 2157
"

Thomas Mueller's avatar
Thomas Mueller committed
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168
"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
"

2169 2170
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2171
","
2172 2173
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
2174 2175 2176 2177 2178
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2179 2180
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2181
","
2182
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2183
","
2184
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2185 2186
"

2187 2188
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2189
","
2190 2191
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
2192
","
2193
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2194 2195
"

2196 2197
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2198
","
Thomas Mueller's avatar
Thomas Mueller committed
2199
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2200

Thomas Mueller's avatar
Thomas Mueller committed
2201
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2202
","
2203
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2204 2205
"

2206
"Other Grammar","Table Expression","
2207
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
2208
[ USE INDEX ([ indexName [,...] ]) ]
2209 2210
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2211
","
2212 2213 2214
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
2215
","
2216
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2217 2218
"

2219 2220 2221 2222 2223 2224 2225 2226 2227
"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;
"

2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2240
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2241
","
2242
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2243
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2244
","
2245 2246 2247 2248 2249 2250
'Hello'
"

"Other Grammar","Time","
TIME 'hh:mm:ss'
","
2251 2252
A time literal. A value is between plus and minus 2 million hours
and has nanosecond resolution.
2253 2254 2255 2256 2257 2258 2259 2260
","
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
2261
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2262 2263 2264 2265 2266 2267
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
2268
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2269
","
Thomas Mueller's avatar
Thomas Mueller committed
2270
A literal value of any data type, or null.
2271 2272
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2273 2274 2275 2276 2277 2278 2279
"

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

2280
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2281 2282 2283 2284 2285 2286 2287 2288 2289
","
INT
"

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

2290
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2291 2292 2293 2294 2295 2296 2297 2298 2299
","
BOOLEAN
"

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

2300
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2301 2302 2303 2304 2305 2306 2307 2308 2309
","
TINYINT
"

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

2310
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2311 2312 2313 2314 2315 2316 2317 2318 2319
","
SMALLINT
"

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

2320
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331
","
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.

2332
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2333 2334 2335 2336 2337
","
IDENTITY
"

"Data Types","DECIMAL Type","
2338
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2339 2340 2341 2342
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2343
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2344 2345 2346 2347 2348
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2349
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2350
","
Thomas Mueller's avatar
Thomas Mueller committed
2351
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2352 2353
of rounding problems.

2354
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2355 2356 2357 2358 2359
","
DOUBLE
"

"Data Types","REAL Type","
2360
{ REAL | FLOAT4 }
Thomas Mueller's avatar
Thomas Mueller committed
2361
","
Thomas Mueller's avatar
Thomas Mueller committed
2362
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2363 2364
values, because of rounding problems.

2365
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2366 2367 2368 2369 2370 2371 2372
","
REAL
"

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

2375
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
2376 2377 2378 2379 2380 2381 2382
","
TIME
"

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

2385
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2386
(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
2387 2388 2389 2390 2391
","
DATE
"

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

2397
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2398 2399 2400 2401
","
TIMESTAMP
"

2402 2403
"Data Types","TIMESTAMP WITH TIME ZONE Type","
TIMESTAMP WITH TIME ZONE
2404 2405
","
VERY MUCH STILL IN TESTING.
2406
The timestamp with time zone data type.
2407 2408 2409 2410 2411
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""
","
2412
TIMESTAMP WITH TIME ZONE
2413 2414
"

Thomas Mueller's avatar
Thomas Mueller committed
2415
"Data Types","BINARY Type","
2416
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2417
","
2418 2419 2420 2421 2422
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
2423 2424 2425 2426 2427 2428 2429 2430 2431

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2432 2433 2434 2435 2436
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
2437

2438
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2439 2440 2441 2442 2443
","
OTHER
"

"Data Types","VARCHAR Type","
2444 2445
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2446
","
Thomas Mueller's avatar
Thomas Mueller committed
2447
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2448 2449 2450 2451 2452 2453 2454
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
2455

2456
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2457 2458 2459 2460 2461
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2462
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2463
","
Thomas Mueller's avatar
Thomas Mueller committed
2464
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2465 2466 2467 2468 2469 2470 2471
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
2472

2473
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2474 2475 2476 2477 2478
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2479
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2480
","
Thomas Mueller's avatar
Thomas Mueller committed
2481 2482 2483
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
2484

Thomas Mueller's avatar
Thomas Mueller committed
2485 2486
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
2487

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

2491
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2492 2493 2494 2495 2496
","
CHAR(10)
"

"Data Types","BLOB Type","
2497
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2498 2499 2500
","
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
2501
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2502 2503
Advanced / Large Objects.

2504
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2505 2506 2507 2508 2509
","
BLOB
"

"Data Types","CLOB Type","
2510
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2511 2512 2513 2514 2515
","
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
2516
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2517 2518 2519 2520 2521

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.

2522
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2523 2524 2525 2526 2527 2528 2529
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2530 2531 2532 2533
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
2534

Thomas Mueller's avatar
Thomas Mueller committed
2535 2536 2537 2538 2539
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
2540
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2541 2542 2543 2544 2545 2546 2547
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2548
An array of values.
2549
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2550 2551 2552 2553


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
2554 2555 2556 2557
","
ARRAY
"

2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571
"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')
"
2572 2573 2574
"Data Types","GEOMETRY Type","
GEOMETRY
","
2575 2576
A spatial geometry type, based on the ""com.vividsolutions.jts"" library.
Normally represented in textual format using the WKT (well known text) format.
2577

Thomas Mueller's avatar
Thomas Mueller committed
2578
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2579 2580
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2581
GEOMETRY
2582 2583
"

Thomas Mueller's avatar
Thomas Mueller committed
2584
"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2585
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2586
","
2587 2588
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2589
Aggregates are only allowed in select statements.
2590
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2591 2592 2593 2594
","
AVG(X)
"

2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614
"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
2615
"Functions (Aggregate)","BOOL_AND","
2616
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2617
","
2618 2619 2620
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
2621 2622 2623 2624 2625
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2626
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2627
","
2628 2629 2630
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
2631 2632 2633 2634 2635
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2636
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2637
","
2638 2639 2640 2641
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
2642 2643 2644 2645 2646
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2647 2648
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2649
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2650
","
2651 2652 2653 2654 2655
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
2656 2657 2658 2659 2660
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2661
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2662
","
2663 2664 2665 2666
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
2667 2668 2669 2670 2671
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2672
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2673
","
2674 2675 2676 2677
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
2678 2679 2680 2681 2682
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2683
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2684
","
2685 2686 2687
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2688
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2689
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2690 2691 2692 2693 2694
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2695
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2696
","
2697 2698 2699 2700 2701
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
2702 2703 2704 2705 2706
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2707
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2708
","
2709 2710 2711
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
2712 2713 2714 2715 2716 2717
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2718
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2719
","
2720 2721 2722
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
2723 2724 2725 2726 2727 2728
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2729
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2730
","
2731 2732 2733 2734
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
2735 2736 2737 2738 2739
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2740
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2741
","
2742 2743 2744 2745
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
2746 2747 2748 2749 2750
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2751
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2752
","
2753 2754
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"".
2755
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2756 2757 2758 2759 2760
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2761
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2762
","
Thomas Mueller's avatar
Thomas Mueller committed
2763 2764
Calculate the arc cosine.
See also Java ""Math.acos"".
2765
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2766 2767 2768 2769 2770
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2771
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2772
","
Thomas Mueller's avatar
Thomas Mueller committed
2773 2774
Calculate the arc sine.
See also Java ""Math.asin"".
2775
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2776 2777 2778 2779 2780
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2781
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2782
","
Thomas Mueller's avatar
Thomas Mueller committed
2783 2784
Calculate the arc tangent.
See also Java ""Math.atan"".
2785
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2786 2787 2788 2789 2790
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2791
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2792
","
Thomas Mueller's avatar
Thomas Mueller committed
2793 2794
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2795
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2796 2797 2798 2799
","
COS(ANGLE)
"

2800
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2801
COSH(numeric)
2802 2803 2804 2805 2806 2807 2808 2809
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2810
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2811
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2812
","
Thomas Mueller's avatar
Thomas Mueller committed
2813
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2814
See also Java ""Math.*"" functions.
2815
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2816 2817 2818 2819 2820
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2821
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2822
","
Thomas Mueller's avatar
Thomas Mueller committed
2823 2824
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2825
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2826 2827 2828 2829
","
SIN(ANGLE)
"

2830
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2831
SINH(numeric)
2832 2833 2834 2835 2836 2837 2838 2839
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2840
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2841
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2842
","
Thomas Mueller's avatar
Thomas Mueller committed
2843 2844
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2845
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2846 2847 2848 2849
","
TAN(ANGLE)
"

2850
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2851
TANH(numeric)
2852 2853 2854 2855 2856 2857 2858 2859
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2860
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2861
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2862
","
Thomas Mueller's avatar
Thomas Mueller committed
2863
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2864
See also Java ""Math.atan2"".
2865
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2866 2867 2868 2869 2870
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2871
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2872
","
2873 2874
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2875 2876 2877 2878 2879
See also Java operator &.
","
BITAND(A, B)
"

2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890
"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
2891
"Functions (Numeric)","BITOR","
2892
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2893
","
2894 2895
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2896 2897 2898 2899 2900 2901
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2902
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2903
","
2904 2905
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2906 2907 2908 2909 2910 2911
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2912
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2913
","
2914 2915
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2916 2917 2918 2919 2920 2921
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2922
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2923
","
2924
See also Java ""Math.ceil"".
2925
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2926
","
2927
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2928 2929 2930
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2931
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2932
","
2933
See also Java ""Math.toDegrees"".
2934
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2935 2936 2937 2938 2939
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2940
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2941
","
2942
See also Java ""Math.exp"".
2943
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2944 2945 2946 2947 2948
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
2949
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2950
","
2951
See also Java ""Math.floor"".
2952
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2953 2954 2955 2956 2957
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2958
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2959
","
2960
See also Java ""Math.log"".
2961
In the PostgreSQL mode, LOG(x) is base 10.
2962
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2963 2964 2965 2966 2967
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
2968
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2969
","
2970
See also Java ""Math.log10"" (in Java 5).
2971
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2972 2973 2974 2975 2976
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
2977
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2978
","
2979
See also Java ""Math.toRadians"".
2980
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2981 2982 2983 2984 2985
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
2986
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2987
","
2988
See also Java ""Math.sqrt"".
2989
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2990 2991 2992 2993 2994
","
SQRT(A)
"

"Functions (Numeric)","PI","
2995
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2996
","
2997
See also Java ""Math.PI"".
2998
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2999 3000 3001 3002 3003
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
3004
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3005
","
3006
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
3007
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3008 3009 3010 3011 3012
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
3013
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
3014 3015 3016
","
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
3017
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
3018 3019 3020 3021 3022
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
3023
{ RANDOM_UUID | UUID } ()
Thomas Mueller's avatar
Thomas Mueller committed
3024 3025
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
3026 3027 3028 3029 3030

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
3031 3032 3033 3034 3035
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
3036
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
3037
","
3038
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
3039
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
3040 3041 3042 3043 3044
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
3045
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3046
","
3047 3048 3049 3050 3051 3052
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
3053 3054 3055 3056 3057
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
3058
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
3059 3060
","
Generates a number of cryptographically secure random numbers.
3061
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3062 3063 3064 3065 3066
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
3067
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3068 3069 3070 3071 3072 3073 3074
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
3075
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3076
","
3077
Encrypts data using a key.
3078
The supported algorithm is AES.
3079 3080
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3081 3082 3083 3084 3085
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
3086
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3087
","
3088
Decrypts data using a key.
3089
The supported algorithm is AES.
3090 3091
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3092 3093 3094 3095 3096 3097
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3098
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
3099
","
3100 3101 3102
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
3103 3104 3105 3106 3107
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3108
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3109 3110
","
Truncates to a number of digits (to the next value closer to 0).
3111
This method returns a double.
3112
When used with a timestamp, truncates a timestamp to a date (day) value.
3113 3114
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
3115 3116 3117 3118 3119
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3120
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3121
","
3122 3123 3124 3125
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
3126 3127 3128 3129 3130
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3131
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3132 3133
","
Expands data that was compressed using the COMPRESS function.
3134
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3135 3136 3137 3138 3139
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3140
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3141 3142 3143 3144 3145 3146 3147
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3148
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3149 3150
","
Returns the ASCII value of the first character in the string.
3151
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3152 3153 3154 3155
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3156
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3157
","
3158 3159 3160
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
3161 3162 3163 3164 3165
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3166
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3167
","
3168 3169 3170
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
3171 3172 3173 3174 3175
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3176
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3177
","
3178 3179 3180 3181
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
3182 3183 3184 3185 3186
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3187
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3188 3189
","
Returns the character that represents the ASCII value.
3190
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3191 3192 3193 3194 3195
","
CHAR(65)
"

"Functions (String)","CONCAT","
3196
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3197 3198
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3199
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3200
and do not cause the result to become NULL.
3201
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3202 3203 3204 3205
","
CONCAT(NAME, '!')
"

3206 3207 3208 3209
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3210
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3211
and do not cause the result to become NULL.
3212 3213 3214 3215 3216
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3217
"Functions (String)","DIFFERENCE","
3218
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3219 3220
","
Returns the difference between the sounds of two strings.
3221
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3222 3223 3224 3225 3226
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3227
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3228
","
3229 3230
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
3231 3232 3233 3234 3235
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3236
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3237
","
3238 3239 3240
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
3241 3242 3243 3244 3245
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3246
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3247
","
3248
Returns the location of a search string in a string.
3249 3250 3251
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
3252
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3253 3254 3255 3256 3257
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3258
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3259
","
3260 3261 3262
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
3263 3264 3265 3266 3267
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3268
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3269 3270 3271 3272 3273 3274 3275
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3276
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3277 3278 3279 3280 3281 3282 3283
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3284
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3285 3286 3287 3288 3289 3290 3291
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3292
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3293 3294 3295 3296 3297 3298 3299
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3300
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3301
","
3302 3303 3304 3305
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
3306 3307 3308 3309 3310
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3311
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3312 3313 3314 3315 3316 3317 3318
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3319
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3320
","
3321 3322 3323
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
3324 3325 3326 3327 3328
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3329
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3330
","
3331 3332 3333
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
3334 3335 3336 3337 3338
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3339
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3340 3341 3342 3343 3344 3345 3346
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3347
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3348 3349 3350 3351 3352 3353 3354
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3355
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3356
","
3357 3358
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
3359 3360 3361 3362 3363
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3364
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
3365
","
3366
Replaces each substring that matches a regular expression.
3367
For details, see the Java ""String.replaceAll()"" method.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381
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
3382 3383
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
3384
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3385 3386
"

3387 3388 3389 3390
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405
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)

3406 3407
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3408 3409
"

3410

Thomas Mueller's avatar
Thomas Mueller committed
3411
"Functions (String)","REPEAT","
3412
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3413 3414 3415 3416 3417 3418 3419
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3420
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3421
","
3422 3423
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.
3424
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3425 3426 3427 3428 3429
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3430
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3431
","
3432 3433 3434
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
3435 3436 3437 3438 3439
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3440
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3441 3442 3443 3444 3445 3446 3447
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3448
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3449
","
3450 3451 3452
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
3453 3454 3455 3456 3457
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3458
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3459
","
3460 3461 3462
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
3463 3464 3465 3466 3467
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3468
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3469 3470
","
Encodes a string to a byte array using the UTF8 encoding format.
3471
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3472 3473 3474 3475 3476
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3477
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3478
","
3479
Returns a substring of a string starting at a position.
3480
If the start index is negative, then the start index is relative to the end of the string.
3481
The length is optional.
3482
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3483
","
3484 3485
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3486 3487 3488
"

"Functions (String)","UTF8TOSTRING","
3489
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3490 3491 3492 3493 3494 3495 3496
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3497
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3498
","
3499
Creates an XML attribute element of the form ""name=value"".
3500 3501
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3502 3503 3504 3505 3506
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3507
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3508 3509
","
Create an XML node element.
3510 3511 3512
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.
3513
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3514 3515 3516 3517 3518
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3519
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3520
","
3521
Creates an XML comment.
3522
Two dashes (""--"") are converted to ""- -"".
3523
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3524 3525 3526 3527 3528
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3529
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3530
","
3531
Creates an XML CDATA element.
3532
If the value contains ""]]>"", an XML text element is created instead.
3533
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3534 3535 3536 3537 3538
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3539
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3540
","
Thomas Mueller's avatar
Thomas Mueller committed
3541
Returns the XML declaration.
3542
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3543 3544 3545 3546 3547
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3548
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3549 3550
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3551
If enabled, newline and linefeed is converted to an XML entity (&#).
3552
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3553 3554 3555 3556
","
CALL XMLTEXT('test')
"

3557
"Functions (String)","TO_CHAR","
3558
TO_CHAR(value [, formatString[, nlsParamString]])
3559 3560 3561 3562 3563 3564
","
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')
"

3565 3566 3567 3568 3569 3570 3571 3572
"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
3573
"Functions (Time and Date)","CURRENT_DATE","
3574
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3575 3576
","
Returns the current date.
3577
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3578 3579 3580 3581 3582
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3583
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3584 3585
","
Returns the current time.
3586
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3587 3588 3589 3590 3591
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3592
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3593
","
3594 3595
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3596
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3597 3598 3599 3600 3601
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3602
{ DATEADD| TIMESTAMPADD } (unitString, addIntLong, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3603
","
3604 3605
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
3606 3607
addIntLong may be a long value when manipulating milliseconds,
otherwise it's range is restricted to int.
3608
The same units as in the EXTRACT function are supported.
3609
DATEADD method returns a timestamp. TIMESTAMPADD method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3610 3611 3612 3613 3614
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3615
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3616
","
Thomas Mueller's avatar
Thomas Mueller committed
3617
Returns the the number of crossed unit boundaries between two timestamps.
3618 3619
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3620 3621 3622 3623 3624 3625
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3626
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3627 3628 3629 3630 3631 3632 3633
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3634
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3635 3636 3637 3638 3639 3640 3641
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3642
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3643 3644 3645 3646 3647 3648 3649
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3650
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3651 3652 3653 3654 3655 3656 3657
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3658
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3659
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3660
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3661 3662
","
Returns a specific value from a timestamps.
3663
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3664 3665 3666 3667 3668
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3669
FORMATDATETIME ( timestamp, formatString
3670
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3671
","
3672 3673 3674
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.
3675
For details of the format, see ""java.text.SimpleDateFormat"".
3676
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3677 3678 3679 3680 3681 3682
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3683
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3684 3685 3686 3687 3688 3689 3690
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3691
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3692 3693 3694 3695 3696 3697 3698
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3699
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3700 3701 3702 3703 3704 3705 3706
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3707
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3708 3709 3710 3711 3712 3713 3714
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3715
PARSEDATETIME(string, formatString
3716
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3717
","
3718 3719 3720
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.
3721
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3722 3723 3724 3725 3726 3727
","
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","
3728
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3729 3730 3731 3732 3733 3734 3735
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3736
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3737 3738 3739 3740 3741 3742 3743
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3744
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3745
","
3746 3747
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3748 3749 3750 3751 3752
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3753
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3754 3755 3756 3757 3758 3759 3760
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3761
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3762 3763
","
Returns one element of an array.
3764
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3765 3766 3767 3768 3769
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3770
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3771 3772 3773 3774 3775 3776
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3777 3778 3779 3780 3781 3782 3783 3784
"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
3785
"Functions (System)","AUTOCOMMIT","
3786
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3787 3788 3789 3790 3791 3792 3793
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3794
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3795
","
3796 3797 3798
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
3799 3800

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3801 3802 3803 3804 3805
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3806
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3807 3808
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3809
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3810 3811 3812 3813 3814
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3815
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3816
","
3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828
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
3829 3830 3831
"

"Functions (System)","COALESCE","
3832
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3833 3834 3835 3836 3837 3838 3839
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3840
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3841 3842 3843 3844 3845 3846 3847
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3848
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3849
","
3850 3851 3852 3853 3854
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
3855 3856 3857 3858 3859
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3860
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3861
","
3862 3863
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
3864 3865

If the column names are specified (a list of column names separated with the
3866
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3867 3868 3869 3870 3871
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
3872 3873 3874 3875 3876

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3886 3887 3888
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
3889 3890 3891 3892
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
3893 3894 3895 3896
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
3897
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3898
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3899 3900 3901
"

"Functions (System)","CSVWRITE","
3902
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3903
","
3904
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3905
If only a file name is specified, it will be written to the current working directory.
3906
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3907
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
3908 3909 3910 3911 3912

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

Thomas Mueller's avatar
Thomas Mueller committed
3915 3916
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3917
","
Thomas Mueller's avatar
Thomas Mueller committed
3918 3919 3920 3921
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
3922 3923 3924
"

"Functions (System)","DATABASE","
3925
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3926 3927 3928 3929 3930 3931 3932
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3933
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3934
","
Thomas Mueller's avatar
Thomas Mueller committed
3935 3936
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
3937 3938 3939 3940
","
CALL DATABASE_PATH();
"

3941
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3942
DECODE(value, whenValue, thenValue [,...])
3943 3944 3945 3946 3947 3948 3949 3950
","
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');
"

3951
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3952
DISK_SPACE_USED(tableNameString)
3953 3954 3955 3956 3957 3958 3959 3960
","
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');
"

Thomas Mueller's avatar
Thomas Mueller committed
3961
"Functions (System)","FILE_READ","
3962
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3963 3964 3965 3966
","
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
3967
default character set for this system.
3968 3969 3970 3971

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

Thomas Mueller's avatar
Thomas Mueller committed
3972
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3973 3974 3975 3976 3977
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

3978
"Functions (System)","FILE_WRITE","
3979
FILE_WRITE(blobValue, fileNameString)
3980 3981 3982 3983 3984 3985 3986 3987
","
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
3988
"Functions (System)","GREATEST","
3989
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3990 3991 3992 3993 3994 3995 3996
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3997
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3998 3999
","
Returns the last inserted identity value for this session.
4000
This value changes whenever a new sequence number was generated,
4001
even within a trigger or Java function. See also SCOPE_IDENTITY.
4002
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4003 4004 4005 4006 4007
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
4008
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4009 4010 4011 4012 4013 4014 4015
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
4016
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4017 4018 4019 4020 4021 4022 4023
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
4024
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
4025 4026
","
Returns the current lock mode. See SET LOCK_MODE.
4027
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4028 4029 4030 4031 4032
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
4033
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
4034 4035 4036 4037 4038 4039 4040 4041
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
4042
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
4043
","
4044 4045 4046 4047 4048
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
4049
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4050 4051 4052 4053 4054
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
4055
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
4056
","
Thomas Mueller's avatar
Thomas Mueller committed
4057
Returns the free memory in KB (where 1024 bytes is a KB).
4058
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4059 4060
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4061 4062 4063 4064 4065
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
4066
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
4067
","
Thomas Mueller's avatar
Thomas Mueller committed
4068
Returns the used memory in KB (where 1024 bytes is a KB).
4069
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4070 4071
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4072 4073 4074 4075 4076
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
4077
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4078
","
4079 4080 4081 4082
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
4083 4084 4085 4086 4087
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
4088
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4089 4090 4091 4092 4093 4094
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4095 4096 4097 4098
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4099
The data type of the returned value is the data type of 'a' if this is a text type.
4100 4101 4102 4103
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4104
"Functions (System)","READONLY","
4105
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4106 4107 4108 4109 4110 4111 4112
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
4113
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
4114
","
4115
Returns the number of the current row.
4116 4117
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4118 4119
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).
4120
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
4121
","
4122 4123
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4124
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4125 4126 4127
"

"Functions (System)","SCHEMA","
4128
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4129 4130 4131 4132 4133 4134
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

4135 4136 4137
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4138
Returns the last inserted identity value for this session for the current scope
Thomas Mueller's avatar
Thomas Mueller committed
4139
(ie. the current statement).
4140 4141 4142 4143 4144 4145
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
4146
"Functions (System)","SESSION_ID","
4147
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4148
","
4149 4150 4151 4152
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
4153 4154 4155 4156 4157
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4158
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4159
","
4160 4161 4162
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
4163
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4164
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4165 4166 4167 4168 4169
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4170
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4171 4172 4173 4174 4175 4176 4177
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4178
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4179
","
4180 4181
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
4182
Otherwise a value of the following form is returned:
4183
""logFileId-position-sessionId"".
4184 4185
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4186 4187 4188 4189
","
CALL TRANSACTION_ID()
"

4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201
"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
4202
"Functions (System)","USER","
4203
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4204 4205 4206 4207 4208 4209
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4210 4211 4212 4213 4214 4215 4216 4217
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232
"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
4233