help.csv 126.0 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
    { select | insert | update | merge | delete | createTable }
199
","
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
The final action in a WITH statement can be a select , insert , update , merge , delete or create table.
205
","
206
WITH RECURSIVE cte(n) AS (
207 208 209
        SELECT 1
    UNION ALL
        SELECT n + 1
210
        FROM cte
211 212
        WHERE n < 100
)
213 214 215 216
SELECT sum(n) FROM cte;

Example 2:
WITH cte1 AS (
217
        SELECT 1 AS FIRST_COLUMN
218 219
), cte2 AS (
        SELECT FIRST_COLUMN+1 AS FIRST_COLUMN FROM cte1
220
)
221
SELECT sum(FIRST_COLUMN) FROM cte2;
222 223
"

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

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

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

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

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

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

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

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

304 305 306
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
307

308 309 310 311
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
312

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
646

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

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

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

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

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

679 680 681
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.

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

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

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

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

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

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

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

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

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

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

736 737
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

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

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

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

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

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

772 773
Views are not updatable except when using 'instead of' triggers.

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

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

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

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

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

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

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

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

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

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

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

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

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

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
871
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
872
","
Thomas Mueller's avatar
Thomas Mueller committed
873
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
874 875
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
876
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
877 878 879 880 881
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
882
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
883
","
Thomas Mueller's avatar
Thomas Mueller committed
884
Drops an existing trigger.
Thomas Mueller's avatar
Thomas Mueller committed
885
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
886 887 888 889 890
","
DROP TRIGGER TRIG_INS
"

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
923
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
924 925 926 927 928 929 930
","
TRUNCATE TABLE TEST
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1201
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1202
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1203
This setting is persistent.
1204
This setting can be appended to the database URL: ""jdbc:h2:test;COLLATION='ENGLISH'""
Thomas Mueller's avatar
Thomas Mueller committed
1205 1206
","
SET COLLATION ENGLISH
1207
SET COLLATION CHARSET_CP500
Thomas Mueller's avatar
Thomas Mueller committed
1208 1209 1210
"

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

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

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

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

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

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

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

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

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

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

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

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


1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
"Commands (Other)","SET LAZY_QUERY_EXECUTION","
SET LAZY_QUERY_EXECUTION int
","
Sets the lazy query execution mode. The values 0, 1 are supported.

If true, then large results are retrieved in chunks.

Note that not all queries support this feature, queries which do not are processed normally.

Admin rights are required to execute this command, as it affects all connections.
This command commits an open transaction in this connection.
This setting is not persistent.
This setting can be appended to the database URL: ""jdbc:h2:test;LAZY_QUERY_EXECUTION=1""
","
SET LAZY_QUERY_EXECUTION 1
"

1361
"Commands (Other)","SET LOG","
1362
SET LOG int
1363 1364 1365 1366
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1367
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1368 1369 1370 1371
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.

1372 1373
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
1374 1375
against power failure is required, but the data must be protected against killing the process.

1376 1377
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
1378 1379
file system, this will also protect against power failure in the majority if cases.

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

Thomas Mueller's avatar
Thomas Mueller committed
1388 1389 1390 1391
"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
1392
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405

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
1406
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1407
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1408
This setting is persistent.
1409
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1410 1411 1412 1413 1414 1415 1416 1417
","
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
1418 1419 1420
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1421
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1422 1423 1424 1425 1426 1427 1428
","
SET LOCK_TIMEOUT 1000
"

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

1431
This is the maximum length of an LOB that is stored with the record itself,
1432 1433
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1434
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1435
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1436
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1437 1438 1439 1440 1441 1442 1443
","
SET MAX_LENGTH_INPLACE_LOB 128
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1450
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1451
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1452
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1453 1454 1455 1456 1457 1458 1459 1460
","
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
1461
are read, then the rows are buffered to disk.
1462
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1463

Thomas Mueller's avatar
Thomas Mueller committed
1464
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1465
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1466
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1467
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1468 1469 1470 1471 1472 1473 1474
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1481
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1482
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1483
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1484
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1485 1486 1487 1488 1489 1490 1491 1492 1493
","
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
1494 1495 1496
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1497
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1498
It has no effect for in-memory databases.
1499
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1500 1501 1502 1503 1504
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1505
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1506 1507
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1508 1509 1510
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1511
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1512
This command commits an open transaction in this connection.
1513
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1514 1515 1516 1517 1518
","
SET MODE HSQLDB
"

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

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1536
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1537 1538 1539
","
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
1540 1541
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1542
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1543
This command commits an open transaction in this connection.
1544
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1545 1546 1547 1548 1549 1550 1551 1552 1553
","
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
1554

Thomas Mueller's avatar
Thomas Mueller committed
1555
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1556 1557 1558 1559
","
SET PASSWORD 'abcstzri!.5'
"

1560 1561 1562 1563 1564 1565 1566
"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
1567
This command commits an open transaction in this connection.
1568 1569 1570 1571 1572
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
"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
1586 1587 1588 1589 1590
"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
1591 1592 1593
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
1594 1595 1596 1597 1598
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1599
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1600 1601 1602
","
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
1603 1604 1605
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1606
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1607
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1608 1609 1610 1611
","
SET REFERENTIAL_INTEGRITY FALSE
"

1612 1613 1614 1615 1616 1617
"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.
1618 1619 1620
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,
1621 1622 1623 1624
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
1625
This command commits an open transaction in this connection.
1626 1627 1628 1629 1630 1631
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
1632 1633 1634 1635 1636
"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
1637

Thomas Mueller's avatar
Thomas Mueller committed
1638
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1639 1640 1641 1642 1643 1644 1645 1646 1647
","
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
1648 1649 1650
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1651
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1652 1653 1654 1655 1656 1657 1658 1659 1660
","
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
1661 1662 1663
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1664
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1665 1666 1667 1668 1669 1670 1671 1672 1673
","
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
1674 1675 1676
disabled).

This command does not commit a transaction, and rollback does not affect it.
1677
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1678 1679 1680 1681 1682
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1683
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1684 1685 1686
","
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.
1687
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1688

Thomas Mueller's avatar
Thomas Mueller committed
1689
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1690
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1691
This command does not commit a transaction, and rollback does not affect it.
1692
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
","
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
1704
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1705
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1706
This command commits an open transaction in this connection.
1707
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717
","
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
1718

Thomas Mueller's avatar
Thomas Mueller committed
1719
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1720 1721 1722 1723 1724 1725 1726 1727
","
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
1728 1729
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1730
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1731
This command commits an open transaction in this connection.
1732
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1733 1734 1735 1736 1737
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1738
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1739
","
1740 1741
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
1742
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1743

1744 1745
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
1746 1747 1748

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,
1749
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
1750 1751

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1755
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1756
","
1757
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1758 1759
"

1760 1761
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1762
","
1763
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1764
","
1765
A
Thomas Mueller's avatar
Thomas Mueller committed
1766 1767
"

1768 1769
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1770
","
1771
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1772
","
1773
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1774 1775
"

1776
"Other Grammar","Array","
1777
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1778
","
1779 1780
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
1781
","
1782
(1, 2)
1783 1784
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1785 1786
"

1787 1788
"Other Grammar","Boolean","
TRUE | FALSE
1789
","
1790
A boolean value.
1791
","
1792
TRUE
1793 1794
"

1795 1796
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1797
","
1798
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1799
","
1800
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1801 1802
"

1803 1804 1805
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1806
","
1807 1808
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
1809
","
1810
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1811 1812
"

1813 1814 1815
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1816
","
1817 1818
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1819
","
1820 1821 1822 1823
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
1824
AES
1825
","
1826
Only the algorithm AES (""AES-128"") is supported currently.
1827 1828
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1829 1830
"

1831
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1832
columnName dataType
1833
[ VISIBLE | INVISIBLE ]
Thomas Mueller's avatar
Thomas Mueller committed
1834
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1835
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1836 1837
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1838 1839
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1840
The computed column expression is evaluated and assigned whenever the row changes.
1841 1842 1843 1844

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
1845

1846 1847 1848
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
1849 1850
The options PRIMARY KEY, UNIQUE, and CHECK are not supported for ALTER statements.

Thomas Mueller's avatar
Thomas Mueller committed
1851 1852
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
1853 1854
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1855

1856
","
Thomas Mueller's avatar
Thomas Mueller committed
1857 1858 1859
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);
1860 1861
"

1862 1863
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1864
","
1865 1866 1867
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
1868
","
1869
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1870 1871
"

1872
"Other Grammar","Compare","
1873
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
1874
","
1875
Comparison operator. The operator != is the same as <>.
1876
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
1877
","
1878
<>
Thomas Mueller's avatar
Thomas Mueller committed
1879 1880 1881
"

"Other Grammar","Condition","
1882
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1883 1884 1885 1886 1887 1888 1889
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1890 1891
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1892
    | IS [ NOT ] [ DISTINCT FROM ] operand
1893 1894
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
1895
    | [ NOT ] [ LIKE | ILIKE ] operand [ ESCAPE string ]
1896
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1897
","
Thomas Mueller's avatar
Thomas Mueller committed
1898
The right hand side of a condition.
1899

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

Thomas Mueller's avatar
Thomas Mueller committed
1903 1904 1905 1906 1907
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).
1908 1909 1910
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.
1911

1912 1913
ILIKE does a case-insensitive compare.

Thomas Mueller's avatar
Thomas Mueller committed
1914
When comparing with REGEXP, regular expression matching is used.
1915
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1916 1917 1918 1919
","
LIKE 'Jo%'
"

1920
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
1921 1922 1923 1924 1925
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
1926
","
Thomas Mueller's avatar
Thomas Mueller committed
1927 1928
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1929
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1930 1931
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
1932
","
1933
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1934 1935
"

1936 1937
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1938
","
1939
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1940
","
1941
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1942 1943
"

1944 1945
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1946
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1947
","
1948
Optional parameters for CSVREAD and CSVWRITE.
1949 1950
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
1951 1952
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1953
The following options are supported:
1954

1955
""caseSensitiveColumnNames"" (true or false; disabled by default),
1956

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1963
""fieldSeparator"" (a comma by default)),
1964

1965
""lineComment"" (disabled by default),
1966

1967
""lineSeparator"" (the line separator used for writing; ignored for reading),
1968

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

1972
""preserveWhitespace"" (true or false; disabled by default),
1973

1974
""writeColumnHeader"" (true or false; enabled by default).
1975

Thomas Mueller's avatar
Thomas Mueller committed
1976
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1977
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
1978 1979 1980
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
1981
","
1982
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1983 1984
"

1985 1986 1987 1988
"Other Grammar","Data Type","
intType | booleanType | tinyintType | smallintType | bigintType | identityType
    | decimalType | doubleType | realType | dateType | timeType | timestampType
    | binaryType | otherType | varcharType | varcharIgnorecaseType | charType
1989
    | blobType | clobType | uuidType | arrayType | enumType
Thomas Mueller's avatar
Thomas Mueller committed
1990
","
1991
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1992
","
1993
INT
Thomas Mueller's avatar
Thomas Mueller committed
1994 1995
"

1996 1997
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1998
","
1999
A date literal. The limitations are the same as for the Java data type
2000
""java.sql.Date"", but for compatibility with other databases the suggested minimum
2001
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
2002
","
2003
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
2004 2005
"

2006
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
2007
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
2008
","
Thomas Mueller's avatar
Thomas Mueller committed
2009 2010 2011 2012 2013 2014
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)"".
2015
","
Thomas Mueller's avatar
Thomas Mueller committed
2016 2017 2018
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
2019 2020
"

2021 2022
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
2023
","
2024
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
2025
","
2026
0
Thomas Mueller's avatar
Thomas Mueller committed
2027 2028
"

2029 2030
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
2031
","
2032 2033 2034
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
2035
","
2036
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
2037 2038
"

2039 2040
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2041
","
2042
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2043
","
2044
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2045 2046
"

2047
"Other Grammar","Factor","
2048
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2049
","
2050
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
2051
","
2052
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
2053 2054
"

2055 2056
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
2057
","
2058 2059
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
2060
","
2061
cafe
Thomas Mueller's avatar
Thomas Mueller committed
2062 2063
"

2064 2065
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
2066
","
2067
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
2068
","
2069
0xff
Thomas Mueller's avatar
Thomas Mueller committed
2070 2071
"

2072 2073
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2074
","
2075 2076 2077
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
2078
","
2079
NAME
Thomas Mueller's avatar
Thomas Mueller committed
2080 2081 2082
"

"Other Grammar","Int","
2083
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2084 2085 2086 2087 2088 2089 2090
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2091
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2092 2093 2094 2095 2096 2097
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2098 2099
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2100
","
2101
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2102
","
2103
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2104 2105
"

2106 2107
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2108
","
2109
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2110
","
2111
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2112 2113
"

2114 2115 2116 2117 2118 2119 2120 2121
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2122
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2123
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2124
","
Thomas Mueller's avatar
Thomas Mueller committed
2125
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2126 2127 2128 2129 2130 2131 2132
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
"

2133 2134
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2135
","
2136
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2137
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2138
","
2139
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2140 2141
"

2142 2143
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2144
","
2145 2146 2147
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
2148
","
2149
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2150 2151
"

2152 2153
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2154
","
2155 2156 2157
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
2158
","
2159
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2160 2161
"

2162 2163 2164
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2165
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2166
","
Thomas Mueller's avatar
Thomas Mueller committed
2167 2168 2169
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
2170 2171 2172
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
2173
","
2174
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2175 2176
"

Thomas Mueller's avatar
Thomas Mueller committed
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187
"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
"

2188 2189
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2190
","
2191 2192
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
2193 2194 2195 2196 2197
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2198 2199
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2200
","
2201
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2202
","
2203
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2204 2205
"

2206 2207
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2208
","
2209 2210
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
2211
","
2212
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2213 2214
"

2215 2216
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2217
","
Thomas Mueller's avatar
Thomas Mueller committed
2218
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2219

Thomas Mueller's avatar
Thomas Mueller committed
2220
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2221
","
2222
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2223 2224
"

2225
"Other Grammar","Table Expression","
2226
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
2227
[ USE INDEX ([ indexName [,...] ]) ]
2228 2229
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2230
","
2231 2232 2233
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
2234
","
2235
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2236 2237
"

2238 2239 2240 2241 2242 2243 2244 2245 2246
"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;
"

2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2259
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2260
","
2261
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2262
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2263
","
2264 2265 2266 2267 2268 2269
'Hello'
"

"Other Grammar","Time","
TIME 'hh:mm:ss'
","
2270 2271
A time literal. A value is between plus and minus 2 million hours
and has nanosecond resolution.
2272 2273 2274 2275 2276 2277 2278 2279
","
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
2280
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2281 2282 2283 2284 2285 2286
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
2287
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2288
","
Thomas Mueller's avatar
Thomas Mueller committed
2289
A literal value of any data type, or null.
2290 2291
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2292 2293 2294 2295 2296 2297 2298
"

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

2299
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2300 2301 2302 2303 2304 2305 2306 2307 2308
","
INT
"

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

2309
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2310 2311 2312 2313 2314 2315 2316 2317 2318
","
BOOLEAN
"

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

2319
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2320 2321 2322 2323 2324 2325 2326 2327 2328
","
TINYINT
"

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

2329
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2330 2331 2332 2333 2334 2335 2336 2337 2338
","
SMALLINT
"

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

2339
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350
","
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.

2351
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2352 2353 2354 2355 2356
","
IDENTITY
"

"Data Types","DECIMAL Type","
2357
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2358 2359 2360 2361
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2362
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2363 2364 2365 2366 2367
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2368
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2369
","
Thomas Mueller's avatar
Thomas Mueller committed
2370
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2371 2372
of rounding problems.

2373
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2374 2375 2376 2377 2378
","
DOUBLE
"

"Data Types","REAL Type","
2379
{ REAL | FLOAT4 }
Thomas Mueller's avatar
Thomas Mueller committed
2380
","
Thomas Mueller's avatar
Thomas Mueller committed
2381
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2382 2383
values, because of rounding problems.

2384
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2385 2386 2387 2388 2389 2390 2391
","
REAL
"

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

2394
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
2395 2396 2397 2398 2399 2400 2401
","
TIME
"

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

2404
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2405
(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
2406 2407 2408 2409 2410
","
DATE
"

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

2416
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2417 2418 2419 2420
","
TIMESTAMP
"

2421 2422
"Data Types","TIMESTAMP WITH TIME ZONE Type","
TIMESTAMP WITH TIME ZONE
2423 2424
","
VERY MUCH STILL IN TESTING.
2425
The timestamp with time zone data type.
2426 2427 2428 2429 2430
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""
","
2431
TIMESTAMP WITH TIME ZONE
2432 2433
"

Thomas Mueller's avatar
Thomas Mueller committed
2434
"Data Types","BINARY Type","
2435
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2436
","
2437 2438 2439 2440 2441
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
2442 2443 2444 2445 2446 2447 2448 2449 2450

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2451 2452 2453 2454 2455
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
2456

2457
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2458 2459 2460 2461 2462
","
OTHER
"

"Data Types","VARCHAR Type","
2463 2464
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2465
","
Thomas Mueller's avatar
Thomas Mueller committed
2466
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2467 2468 2469 2470 2471 2472 2473
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
2474

2475
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2476 2477 2478 2479 2480
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2481
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2482
","
Thomas Mueller's avatar
Thomas Mueller committed
2483
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2484 2485 2486 2487 2488 2489 2490
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
2491

2492
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2493 2494 2495 2496 2497
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2498
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2499
","
Thomas Mueller's avatar
Thomas Mueller committed
2500 2501 2502
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
2503

Thomas Mueller's avatar
Thomas Mueller committed
2504 2505
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
2506

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

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

"Data Types","BLOB Type","
2516
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2517 2518 2519
","
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
2520
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2521 2522
Advanced / Large Objects.

2523
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2524 2525 2526 2527 2528
","
BLOB
"

"Data Types","CLOB Type","
2529
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2530 2531 2532 2533 2534
","
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
2535
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2536 2537 2538 2539 2540

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.

2541
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2542 2543 2544 2545 2546 2547 2548
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2549 2550 2551 2552
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
2553

Thomas Mueller's avatar
Thomas Mueller committed
2554 2555 2556 2557 2558
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
2559
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2560 2561 2562 2563 2564 2565 2566
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2567
An array of values.
2568
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2569 2570 2571 2572


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
2573 2574 2575 2576
","
ARRAY
"

2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590
"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')
"
2591 2592 2593
"Data Types","GEOMETRY Type","
GEOMETRY
","
2594 2595
A spatial geometry type, based on the ""com.vividsolutions.jts"" library.
Normally represented in textual format using the WKT (well known text) format.
2596

Thomas Mueller's avatar
Thomas Mueller committed
2597
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2598 2599
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2600
GEOMETRY
2601 2602
"

Thomas Mueller's avatar
Thomas Mueller committed
2603
"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2604
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2605
","
2606 2607
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2608
Aggregates are only allowed in select statements.
2609
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2610 2611 2612 2613
","
AVG(X)
"

2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633
"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
2634
"Functions (Aggregate)","BOOL_AND","
2635
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2636
","
2637 2638 2639
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
2640 2641 2642 2643 2644
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2645
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2646
","
2647 2648 2649
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
2650 2651 2652 2653 2654
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2655
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2656
","
2657 2658 2659 2660
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
2661 2662 2663 2664 2665
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2666 2667
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2668
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2669
","
2670 2671 2672 2673 2674
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
2675 2676 2677 2678 2679
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2680
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2681
","
2682 2683 2684 2685
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
2686 2687 2688 2689 2690
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2691
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2692
","
2693 2694 2695 2696
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
2697 2698 2699 2700 2701
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2702
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2703
","
2704 2705 2706
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2707
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2708
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2709 2710 2711 2712 2713
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2714
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2715
","
2716 2717 2718 2719 2720
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
2721 2722 2723 2724 2725
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2726
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2727
","
2728 2729 2730
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
2731 2732 2733 2734 2735 2736
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2737
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2738
","
2739 2740 2741
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
2742 2743 2744 2745 2746 2747
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2748
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2749
","
2750 2751 2752 2753
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
2754 2755 2756 2757 2758
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2759
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2760
","
2761 2762 2763 2764
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
2765 2766 2767 2768 2769
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2770
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2771
","
2772 2773
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"".
2774
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2775 2776 2777 2778 2779
","
ABS(ID)
"

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

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2790
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2791
","
Thomas Mueller's avatar
Thomas Mueller committed
2792 2793
Calculate the arc sine.
See also Java ""Math.asin"".
2794
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2795 2796 2797 2798 2799
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2800
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2801
","
Thomas Mueller's avatar
Thomas Mueller committed
2802 2803
Calculate the arc tangent.
See also Java ""Math.atan"".
2804
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2805 2806 2807 2808 2809
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2810
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2811
","
Thomas Mueller's avatar
Thomas Mueller committed
2812 2813
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2814
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2815 2816 2817 2818
","
COS(ANGLE)
"

2819
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2820
COSH(numeric)
2821 2822 2823 2824 2825 2826 2827 2828
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2829
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2830
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2831
","
Thomas Mueller's avatar
Thomas Mueller committed
2832
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2833
See also Java ""Math.*"" functions.
2834
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2835 2836 2837 2838 2839
","
COT(ANGLE)
"

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

2849
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2850
SINH(numeric)
2851 2852 2853 2854 2855 2856 2857 2858
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2859
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2860
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2861
","
Thomas Mueller's avatar
Thomas Mueller committed
2862 2863
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2864
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2865 2866 2867 2868
","
TAN(ANGLE)
"

2869
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2870
TANH(numeric)
2871 2872 2873 2874 2875 2876 2877 2878
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2879
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2880
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2881
","
Thomas Mueller's avatar
Thomas Mueller committed
2882
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2883
See also Java ""Math.atan2"".
2884
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2885 2886 2887 2888 2889
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2890
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2891
","
2892 2893
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2894 2895 2896 2897 2898
See also Java operator &.
","
BITAND(A, B)
"

2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909
"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
2910
"Functions (Numeric)","BITOR","
2911
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2912
","
2913 2914
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2915 2916 2917 2918 2919 2920
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2921
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2922
","
2923 2924
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2925 2926 2927 2928 2929 2930
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2931
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2932
","
2933 2934
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2935 2936 2937 2938 2939 2940
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2941
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2942
","
2943
See also Java ""Math.ceil"".
2944
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2945
","
2946
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2947 2948 2949
"

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

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2959
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2960
","
2961
See also Java ""Math.exp"".
2962
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2963 2964 2965 2966 2967
","
EXP(A)
"

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

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2977
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2978
","
2979
See also Java ""Math.log"".
2980
In the PostgreSQL mode, LOG(x) is base 10.
2981
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2982 2983 2984 2985 2986
","
LOG(A)
"

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

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

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

"Functions (Numeric)","PI","
3014
PI()
Thomas Mueller's avatar
Thomas Mueller committed
3015
","
3016
See also Java ""Math.PI"".
3017
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3018 3019 3020 3021 3022
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
3023
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3024
","
3025
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
3026
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
3027 3028 3029 3030 3031
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
3032
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
3033 3034 3035
","
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
3036
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
3037 3038 3039 3040 3041
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
3042
{ RANDOM_UUID | UUID } ()
Thomas Mueller's avatar
Thomas Mueller committed
3043 3044
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
3045 3046 3047 3048 3049

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
3050 3051 3052 3053 3054
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
3055
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
3056
","
3057
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
3058
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
3059 3060 3061 3062 3063
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
3064
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3065
","
3066 3067 3068 3069 3070 3071
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
3072 3073 3074 3075 3076
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
3077
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
3078 3079
","
Generates a number of cryptographically secure random numbers.
3080
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3081 3082 3083 3084 3085
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
3086
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3087 3088 3089 3090 3091 3092 3093
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
3094
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3095
","
3096
Encrypts data using a key.
3097
The supported algorithm is AES.
3098 3099
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3100 3101 3102 3103 3104
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
3105
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3106
","
3107
Decrypts data using a key.
3108
The supported algorithm is AES.
3109 3110
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3111 3112 3113 3114 3115 3116
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3117
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
3118
","
3119 3120 3121
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
3122 3123 3124 3125 3126
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3127
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3128 3129
","
Truncates to a number of digits (to the next value closer to 0).
3130
This method returns a double.
3131
When used with a timestamp, truncates a timestamp to a date (day) value.
3132 3133
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
3134 3135 3136 3137 3138
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3139
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3140
","
3141 3142 3143 3144
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
3145 3146 3147 3148 3149
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3150
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3151 3152
","
Expands data that was compressed using the COMPRESS function.
3153
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3154 3155 3156 3157 3158
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3159
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3160 3161 3162 3163 3164 3165 3166
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3167
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3168 3169
","
Returns the ASCII value of the first character in the string.
3170
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3171 3172 3173 3174
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3175
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3176
","
3177 3178 3179
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
3180 3181 3182 3183 3184
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3185
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3186
","
3187 3188 3189
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
3190 3191 3192 3193 3194
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3195
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3196
","
3197 3198 3199 3200
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
3201 3202 3203 3204 3205
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3206
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3207 3208
","
Returns the character that represents the ASCII value.
3209
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3210 3211 3212 3213 3214
","
CHAR(65)
"

"Functions (String)","CONCAT","
3215
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3216 3217
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3218
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3219
and do not cause the result to become NULL.
3220
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3221 3222 3223 3224
","
CONCAT(NAME, '!')
"

3225 3226 3227 3228
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3229
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3230
and do not cause the result to become NULL.
3231 3232 3233 3234 3235
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3236
"Functions (String)","DIFFERENCE","
3237
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3238 3239
","
Returns the difference between the sounds of two strings.
3240
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3241 3242 3243 3244 3245
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3246
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3247
","
3248 3249
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
3250 3251 3252 3253 3254
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3255
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3256
","
3257 3258 3259
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
3260 3261 3262 3263 3264
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3265
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3266
","
3267
Returns the location of a search string in a string.
3268 3269 3270
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
3271
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3272 3273 3274 3275 3276
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3277
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3278
","
3279 3280 3281
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
3282 3283 3284 3285 3286
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3287
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3288 3289 3290 3291 3292 3293 3294
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3295
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3296 3297 3298 3299 3300 3301 3302
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3303
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3304 3305 3306 3307 3308 3309 3310
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3311
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3312 3313 3314 3315 3316 3317 3318
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3319
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3320
","
3321 3322 3323 3324
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
3325 3326 3327 3328 3329
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3330
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3331 3332 3333 3334 3335 3336 3337
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3338
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3339
","
3340 3341 3342
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
3343 3344 3345 3346 3347
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3348
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3349
","
3350 3351 3352
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
3353 3354 3355 3356 3357
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3358
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3359 3360 3361 3362 3363 3364 3365
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3366
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3367 3368 3369 3370 3371 3372 3373
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3374
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3375
","
3376 3377
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
3378 3379 3380 3381 3382
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3383
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
3384
","
3385
Replaces each substring that matches a regular expression.
3386
For details, see the Java ""String.replaceAll()"" method.
3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400
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
3401 3402
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
3403
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3404 3405
"

3406 3407 3408 3409
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424
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)

3425 3426
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3427 3428
"

3429

Thomas Mueller's avatar
Thomas Mueller committed
3430
"Functions (String)","REPEAT","
3431
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3432 3433 3434 3435 3436 3437 3438
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3439
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3440
","
3441 3442
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.
3443
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3444 3445 3446 3447 3448
","
REPLACE(NAME, ' ')
"

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

"Functions (String)","SPACE","
3459
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3460 3461 3462 3463 3464 3465 3466
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3467
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3468
","
3469 3470 3471
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
3472 3473 3474 3475 3476
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3477
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3478
","
3479 3480 3481
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
3482 3483 3484 3485 3486
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3487
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3488 3489
","
Encodes a string to a byte array using the UTF8 encoding format.
3490
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3491 3492 3493 3494 3495
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3496
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3497
","
3498
Returns a substring of a string starting at a position.
3499
If the start index is negative, then the start index is relative to the end of the string.
3500
The length is optional.
3501
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3502
","
3503 3504
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3505 3506 3507
"

"Functions (String)","UTF8TOSTRING","
3508
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3509 3510 3511 3512 3513 3514 3515
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3516
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3517
","
3518
Creates an XML attribute element of the form ""name=value"".
3519 3520
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3521 3522 3523 3524 3525
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3526
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3527 3528
","
Create an XML node element.
3529 3530 3531
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.
3532
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3533 3534 3535 3536 3537
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3538
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3539
","
3540
Creates an XML comment.
3541
Two dashes (""--"") are converted to ""- -"".
3542
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3543 3544 3545 3546 3547
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3548
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3549
","
3550
Creates an XML CDATA element.
3551
If the value contains ""]]>"", an XML text element is created instead.
3552
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3553 3554 3555 3556 3557
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3558
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3559
","
Thomas Mueller's avatar
Thomas Mueller committed
3560
Returns the XML declaration.
3561
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3562 3563 3564 3565 3566
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3567
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3568 3569
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3570
If enabled, newline and linefeed is converted to an XML entity (&#).
3571
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3572 3573 3574 3575
","
CALL XMLTEXT('test')
"

3576
"Functions (String)","TO_CHAR","
3577
TO_CHAR(value [, formatString[, nlsParamString]])
3578 3579 3580 3581 3582 3583
","
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')
"

3584 3585 3586 3587 3588 3589 3590 3591
"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
3592
"Functions (Time and Date)","CURRENT_DATE","
3593
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3594 3595
","
Returns the current date.
3596
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3597 3598 3599 3600 3601
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3602
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3603 3604
","
Returns the current time.
3605
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3606 3607 3608 3609 3610
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3611
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3612
","
3613 3614
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3615
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3616 3617 3618 3619 3620
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3621
{ DATEADD| TIMESTAMPADD } (unitString, addIntLong, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3622
","
3623 3624
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
3625 3626
addIntLong may be a long value when manipulating milliseconds,
otherwise it's range is restricted to int.
3627
The same units as in the EXTRACT function are supported.
3628
DATEADD method returns a timestamp. TIMESTAMPADD method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3629 3630 3631 3632 3633
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3634
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3635
","
Thomas Mueller's avatar
Thomas Mueller committed
3636
Returns the the number of crossed unit boundaries between two timestamps.
3637 3638
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3639 3640 3641 3642 3643 3644
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3645
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3646 3647 3648 3649 3650 3651 3652
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3653
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3654 3655 3656 3657 3658 3659 3660
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3661
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3662 3663 3664 3665 3666 3667 3668
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3669
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3670 3671 3672 3673 3674 3675 3676
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3677
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3678
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3679
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3680 3681
","
Returns a specific value from a timestamps.
3682
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3683 3684 3685 3686 3687
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3688
FORMATDATETIME ( timestamp, formatString
3689
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3690
","
3691 3692 3693
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.
3694
For details of the format, see ""java.text.SimpleDateFormat"".
3695
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3696 3697 3698 3699 3700 3701
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3702
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3703 3704 3705 3706 3707 3708 3709
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3710
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3711 3712 3713 3714 3715 3716 3717
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3718
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3719 3720 3721 3722 3723 3724 3725
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3726
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3727 3728 3729 3730 3731 3732 3733
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3734
PARSEDATETIME(string, formatString
3735
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3736
","
3737 3738 3739
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.
3740
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3741 3742 3743 3744 3745 3746
","
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","
3747
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3748 3749 3750 3751 3752 3753 3754
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3755
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3756 3757 3758 3759 3760 3761 3762
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3763
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3764
","
3765 3766
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3767 3768 3769 3770 3771
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3772
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3773 3774 3775 3776 3777 3778 3779
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3780
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3781 3782
","
Returns one element of an array.
3783
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3784 3785 3786 3787 3788
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3789
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3790 3791 3792 3793 3794 3795
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3796 3797 3798 3799 3800 3801 3802 3803
"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
3804
"Functions (System)","AUTOCOMMIT","
3805
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3806 3807 3808 3809 3810 3811 3812
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3813
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3814
","
3815 3816 3817
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
3818 3819

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3820 3821 3822 3823 3824
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3825
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3826 3827
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3828
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3829 3830 3831 3832 3833
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3834
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3835
","
3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847
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
3848 3849 3850
"

"Functions (System)","COALESCE","
3851
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3852 3853 3854 3855 3856 3857 3858
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3859
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3860 3861 3862 3863 3864 3865 3866
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3867
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3868
","
3869 3870 3871 3872 3873
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
3874 3875 3876 3877 3878
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3879
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3880
","
3881 3882
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
3883 3884

If the column names are specified (a list of column names separated with the
3885
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3886 3887 3888 3889 3890
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
3891 3892 3893 3894 3895

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3905 3906 3907
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
3908 3909 3910 3911
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
3912 3913 3914 3915
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
3916
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3917
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3918 3919 3920
"

"Functions (System)","CSVWRITE","
3921
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3922
","
3923
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3924
If only a file name is specified, it will be written to the current working directory.
3925
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3926
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
3927 3928 3929 3930 3931

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

Thomas Mueller's avatar
Thomas Mueller committed
3934 3935
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3936
","
Thomas Mueller's avatar
Thomas Mueller committed
3937 3938 3939 3940
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
3941 3942 3943
"

"Functions (System)","DATABASE","
3944
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3945 3946 3947 3948 3949 3950 3951
","
Returns the name of the database.
","
CALL DATABASE();
"

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

3960
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3961
DECODE(value, whenValue, thenValue [,...])
3962 3963 3964 3965 3966 3967 3968 3969
","
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');
"

3970
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3971
DISK_SPACE_USED(tableNameString)
3972 3973 3974 3975 3976 3977 3978 3979
","
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
3980
"Functions (System)","FILE_READ","
3981
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3982 3983 3984 3985
","
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
3986
default character set for this system.
3987 3988 3989 3990

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

Thomas Mueller's avatar
Thomas Mueller committed
3991
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3992 3993 3994 3995 3996
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

3997
"Functions (System)","FILE_WRITE","
3998
FILE_WRITE(blobValue, fileNameString)
3999 4000 4001 4002 4003 4004 4005 4006
","
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
4007
"Functions (System)","GREATEST","
4008
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4009 4010 4011 4012 4013 4014 4015
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
4016
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
4017 4018
","
Returns the last inserted identity value for this session.
4019
This value changes whenever a new sequence number was generated,
4020
even within a trigger or Java function. See also SCOPE_IDENTITY.
4021
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
4022 4023 4024 4025 4026
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
4027
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4028 4029 4030 4031 4032 4033 4034
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
4035
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4036 4037 4038 4039 4040 4041 4042
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
4043
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
4044 4045
","
Returns the current lock mode. See SET LOCK_MODE.
4046
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4047 4048 4049 4050 4051
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
4052
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
4053 4054 4055 4056 4057 4058 4059 4060
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
4061
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
4062
","
4063 4064 4065 4066 4067
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
4068
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4069 4070 4071 4072 4073
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
4074
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
4075
","
Thomas Mueller's avatar
Thomas Mueller committed
4076
Returns the free memory in KB (where 1024 bytes is a KB).
4077
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4078 4079
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4080 4081 4082 4083 4084
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
4085
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
4086
","
Thomas Mueller's avatar
Thomas Mueller committed
4087
Returns the used memory in KB (where 1024 bytes is a KB).
4088
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4089 4090
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4091 4092 4093 4094 4095
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
4096
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4097
","
4098 4099 4100 4101
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
4102 4103 4104 4105 4106
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
4107
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4108 4109 4110 4111 4112 4113
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4114 4115 4116 4117
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4118
The data type of the returned value is the data type of 'a' if this is a text type.
4119 4120 4121 4122
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4123
"Functions (System)","READONLY","
4124
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4125 4126 4127 4128 4129 4130 4131
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
4132
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
4133
","
4134
Returns the number of the current row.
4135 4136
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4137 4138
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).
4139
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
4140
","
4141 4142
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4143
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4144 4145 4146
"

"Functions (System)","SCHEMA","
4147
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4148 4149 4150 4151 4152 4153
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

4154 4155 4156
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4157
Returns the last inserted identity value for this session for the current scope
Thomas Mueller's avatar
Thomas Mueller committed
4158
(ie. the current statement).
4159 4160 4161 4162 4163 4164
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
4165
"Functions (System)","SESSION_ID","
4166
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4167
","
4168 4169 4170 4171
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
4172 4173 4174 4175 4176
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4177
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4178
","
4179 4180 4181
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
4182
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4183
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4184 4185 4186 4187 4188
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4189
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4190 4191 4192 4193 4194 4195 4196
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4197
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4198
","
4199 4200
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
4201
Otherwise a value of the following form is returned:
4202
""logFileId-position-sessionId"".
4203 4204
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4205 4206 4207 4208
","
CALL TRANSACTION_ID()
"

4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220
"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
4221
"Functions (System)","USER","
4222
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4223 4224 4225 4226 4227 4228
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4229 4230 4231 4232 4233 4234 4235 4236
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251
"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
4252