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

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

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

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

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

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

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

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

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

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

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

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

"Commands (DML)","MERGE","
112 113
MERGE INTO tableName [ ( columnName [,...] ) ]
[ KEY ( columnName [,...] ) ]
114
{ VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | select }
Thomas Mueller's avatar
Thomas Mueller committed
115 116 117 118 119 120 121 122 123 124 125
","
Updates existing rows, and insert rows that don't exist. If no key column is
specified, the primary key columns are used to find the row. If more than one
row per new row is affected, an exception is thrown. If the table contains an
auto-incremented key or identity column, and the row was updated, the generated
key is set to 0; otherwise it is set to the new key.
","
MERGE INTO TEST KEY(ID) VALUES(2, 'World')
"

"Commands (DML)","RUNSCRIPT","
126 127
RUNSCRIPT FROM fileNameString scriptCompressionEncryption
[ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
128 129 130 131 132 133
","
Runs a SQL script from a file. The script is a text file containing SQL
statements; each statement must end with ';'. This command can be used to
restore a database from a backup. The password must be in single quotes; it is
case sensitive and can contain spaces.

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

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

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

"Commands (DML)","SCRIPT","
148 149
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
150
[ TO fileNameString scriptCompressionEncryption
151
    [ CHARSET charsetString ] ]
152 153
[ TABLE tableName [, ...] ]
[ SCHEMA schemaName [, ...] ]
Thomas Mueller's avatar
Thomas Mueller committed
154
","
155 156 157 158 159 160 161
Creates a SQL script from the database.

SIMPLE does not use multi-row insert statements.
NODATA will not emit INSERT statements.
If the DROP option is specified, drop statements are created for tables, views,
and sequences. If the block size is set, CLOB and BLOB values larger than this
size are split into separate blocks.
Thomas Mueller's avatar
Thomas Mueller committed
162 163
BLOCKSIZE is used when writing out LOB data, and specifies the point at the
values transition from being inserted as inline values, to be inserted using
164
out-of-line commands.
Thomas Mueller's avatar
Thomas Mueller committed
165
NOSETTINGS turns off dumping the database settings (the SET XXX commands)
166

167
If no 'TO fileName' clause is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
168 169 170 171
script is returned as a result set. This command can be used to create a backup
of the database. For long term storage, it is more portable than copying the
database files.

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

Thomas Mueller's avatar
Thomas Mueller committed
176 177 178
The password must be in single quotes; it is case sensitive and can contain spaces.

This command locks objects while it is running.
Thomas Mueller's avatar
Thomas Mueller committed
179
Admin rights are required to execute this command.
180

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

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

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

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

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

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

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

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
266
ALTER TABLE [ IF EXISTS ] tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
267 268 269
","
Adds a constraint to a table. If NOCHECK is specified, existing rows are not
checked for consistency (the default is to check consistency for existing rows).
Thomas Mueller's avatar
Thomas Mueller committed
270
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
271
It is not possible to disable checking for unique constraints.
Thomas Mueller's avatar
Thomas Mueller committed
272
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
273 274 275 276
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

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

286
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
287
ALTER TABLE [ IF EXISTS ] tableName ALTER COLUMN columnName
288
{ { dataType [ VISIBLE | INVISIBLE ] [ DEFAULT expression ] [ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] }
289 290 291 292 293
    | { RENAME TO name }
    | { RESTART WITH long }
    | { SELECTIVITY int }
    | { SET DEFAULT expression }
    | { SET NULL }
294 295
    | { SET NOT NULL }
    | { SET { VISIBLE | INVISIBLE } } }
Thomas Mueller's avatar
Thomas Mueller committed
296
","
297 298
Changes the data type of a column, rename a column,
change the identity value, or change the selectivity.
Thomas Mueller's avatar
Thomas Mueller committed
299

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

302 303 304
RESTART changes the next value of an auto increment column.
The column must already be an auto increment column.
For RESTART, the same transactional rules as for ALTER SEQUENCE apply.
Thomas Mueller's avatar
Thomas Mueller committed
305

306 307 308 309
SELECTIVITY sets the selectivity (1-100) for a column.
Setting the selectivity to 0 means the default value.
Selectivity is used by the cost based optimizer to calculate the estimated cost of an index.
Selectivity 100 means values are unique, 10 means every distinct value appears 10 times on average.
Thomas Mueller's avatar
Thomas Mueller committed
310

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

313
SET NULL sets a column to allow NULL. The row may not be part of a primary key.
Thomas Mueller's avatar
Thomas Mueller committed
314
Single column indexes on this column are dropped.
315 316 317

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

318 319 320
SET INVISIBLE makes the column hidden, i.e. it will not appear in SELECT * results.
SET VISIBLE has the reverse effect.

Thomas Mueller's avatar
Thomas Mueller committed
321
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
322
","
323 324 325 326 327 328 329
ALTER TABLE TEST ALTER COLUMN NAME CLOB;
ALTER TABLE TEST ALTER COLUMN NAME RENAME TO TEXT;
ALTER TABLE TEST ALTER COLUMN ID RESTART WITH 10000;
ALTER TABLE TEST ALTER COLUMN NAME SELECTIVITY 100;
ALTER TABLE TEST ALTER COLUMN NAME SET DEFAULT '';
ALTER TABLE TEST ALTER COLUMN NAME SET NOT NULL;
ALTER TABLE TEST ALTER COLUMN NAME SET NULL;
330 331
ALTER TABLE TEST ALTER COLUMN NAME SET VISIBLE;
ALTER TABLE TEST ALTER COLUMN NAME SET INVISIBLE;
Thomas Mueller's avatar
Thomas Mueller committed
332 333 334
"

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

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

"Commands (DDL)","ALTER TABLE SET","
354
ALTER TABLE [ IF EXISTS ] tableName SET REFERENTIAL_INTEGRITY
355
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
356 357 358 359 360 361
","
Disables or enables referential integrity checking for a table. This command can
be used inside a transaction. Enabling referential integrity does not check
existing data, except if CHECK is specified. Use SET REFERENTIAL_INTEGRITY to
disable it for all tables; the global flag and the flag for each table are
independent.
362

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

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

"Commands (DDL)","ALTER USER ADMIN","
378
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
379
","
Thomas Mueller's avatar
Thomas Mueller committed
380 381 382 383
Switches the admin flag of a user on or off.

Only unquoted or uppercase user names are allowed.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
384
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
385 386 387 388 389 390 391
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
392 393 394 395
Renames a user.
After renaming a user, the password becomes invalid and needs to be changed as well.

Only unquoted or uppercase user names are allowed.
Thomas Mueller's avatar
Thomas Mueller committed
396
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
397
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
398 399 400 401 402
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
403
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
404
","
Thomas Mueller's avatar
Thomas Mueller committed
405 406 407 408 409 410
Changes the password of a user.
Only unquoted or uppercase user names are allowed.
The password must be enclosed in single quotes. It is case sensitive
and can contain spaces. The salt and hash values are hex strings.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
411
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
412 413 414 415 416
","
ALTER USER SA SET PASSWORD 'rioyxlgt'
"

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

"Commands (DDL)","ANALYZE","
427
ANALYZE [ TABLE tableName ] [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
428
","
429 430 431
Updates the selectivity statistics of tables.
If no table name is given, all tables are analyzed.
The selectivity is used by the
Thomas Mueller's avatar
Thomas Mueller committed
432 433 434 435 436
cost based optimizer to select the best index for a given query. If no sample
size is set, up to 10000 rows per table are read. The value 0 means all rows are
read. The selectivity can be set manually using ALTER TABLE ALTER COLUMN
SELECTIVITY. Manual values are overwritten by this statement. The selectivity is
available in the INFORMATION_SCHEMA.COLUMNS table.
437

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

"Commands (DDL)","COMMENT","
444 445 446 447 448
COMMENT ON
{ { COLUMN [ schemaName. ] tableName.columnName }
    | { { TABLE | VIEW | CONSTANT | CONSTRAINT | ALIAS | INDEX | ROLE
    | SCHEMA | SEQUENCE | TRIGGER | USER | DOMAIN } [ schemaName. ] objectName } }
IS expression
Thomas Mueller's avatar
Thomas Mueller committed
449
","
Thomas Mueller's avatar
Thomas Mueller committed
450 451 452
Sets the comment of a database object. Use NULL to remove the comment.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
453
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
454 455 456 457 458
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

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

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

"Commands (DDL)","CREATE ALIAS","
Thomas Mueller's avatar
Thomas Mueller committed
472
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
Thomas Mueller's avatar
Thomas Mueller committed
473
[ NOBUFFER ] { FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
474
","
475 476 477 478 479 480
Creates a new function alias. If this is a ResultSet returning function,
by default the return value is cached in a local temporary file.

NOBUFFER - disables caching of ResultSet return value to temporary file.

DETERMINISTIC - Deterministic functions must always return the same value for the same parameters.
481 482 483

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

489 490
When defining a function alias with source code, the Sun ""javac"" is compiler
is used if the file ""tools.jar"" is in the classpath. If not, ""javac"" is run as a separate process.
491 492
Only the source code is stored in the database; the class is compiled each time
the database is re-opened. Source code is usually passed
493 494
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
495

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

499
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
500 501 502
connection to the database is provided. This connection must not be closed.
If the class contains multiple methods with the given name but different
parameter count, all methods are mapped.
503

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

If you have the Groovy jar in your classpath, it is also possible to write methods using Groovy.
Thomas Mueller's avatar
Thomas Mueller committed
508 509 510 511 512
","
CREATE ALIAS MY_SQRT FOR ""java.lang.Math.sqrt"";
CREATE ALIAS GET_SYSTEM_PROPERTY FOR ""java.lang.System.getProperty"";
CALL GET_SYSTEM_PROPERTY('java.class.path');
CALL GET_SYSTEM_PROPERTY('com.acme.test', 'true');
513 514
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
515 516 517 518 519
CREATE ALIAS tr AS $$@groovy.transform.CompileStatic
    static String tr(String str, String sourceSet, String replacementSet){
        return str.tr(sourceSet, replacementSet);
    }
$$
Thomas Mueller's avatar
Thomas Mueller committed
520 521 522
"

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
556
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
557 558
For other tables, or if the index contains multiple columns, the HASH keyword is ignored.
Hash indexes can only test for equality, and do not support range queries (similar to a hash table).
Thomas Mueller's avatar
Thomas Mueller committed
559
Non-unique keys are supported.
560
Spatial indexes are supported only on Geometry columns.
Thomas Mueller's avatar
Thomas Mueller committed
561 562 563 564 565
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
566
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ]
Thomas Mueller's avatar
Thomas Mueller committed
567
LINKED TABLE [ IF NOT EXISTS ]
568 569
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
570 571 572 573 574
","
Creates a table link to an external table. The driver name may be empty if the
driver is already loaded. If the schema name is not set, only one table with
that name may exist in the target database.

575 576 577
FORCE - Create the LINKED TABLE even if the remote database/table does not exist.

EMIT UPDATES - Usually, for update statements, the old rows are deleted first and then the new
Thomas Mueller's avatar
Thomas Mueller committed
578 579
rows are inserted. It is possible to emit update statements (except on
rollback), however in this case multi-row unique key updates may not always
580
work. Linked tables to the same database share one connection.
581

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

Thomas Mueller's avatar
Thomas Mueller committed
584 585 586
If the connection to the source database is lost, the connection is re-opened
(this is a workaround for MySQL that disconnects after 8 hours of inactivity by default).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
594
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
595
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
596 597 598 599 600 601 602 603 604
","
CREATE LINKED TABLE LINK('org.h2.Driver', 'jdbc:h2:test2', 'sa', 'sa', 'TEST');
CREATE LINKED TABLE LINK('', 'jdbc:h2:test2', 'sa', 'sa',
    '(SELECT * FROM TEST WHERE ID>0)');
CREATE LINKED TABLE LINK('javax.naming.InitialContext',
    'java:comp/env/jdbc/Test', NULL, NULL, '(SELECT * FROM TEST WHERE ID>0)');
"

"Commands (DDL)","CREATE ROLE","
605
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
606
","
Thomas Mueller's avatar
Thomas Mueller committed
607
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
608
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
609 610 611 612 613
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
614
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
615
[ WITH tableEngineParamName [,...] ]
Thomas Mueller's avatar
Thomas Mueller committed
616 617 618
","
Creates a new schema. If no owner is specified, the current user is used. The
user that executes the command must have admin rights, as well as the owner.
Thomas Mueller's avatar
Thomas Mueller committed
619
Specifying the owner currently has no effect.
620 621
Optional table engine parameters are used when CREATE TABLE command
is run on this schema without having its engine params set.
622

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

"Commands (DDL)","CREATE SEQUENCE","
629
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
630 631 632 633 634
[ INCREMENT BY long ]
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
[ CYCLE long | NOCYCLE |  NO CYCLE ]
[ CACHE long |  NOCACHE |  NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
635
","
Thomas Mueller's avatar
Thomas Mueller committed
636 637 638
Creates a new sequence.
The data type of a sequence is BIGINT.
Used values are never re-used, even when the transaction is rolled back.
Thomas Mueller's avatar
Thomas Mueller committed
639 640 641 642 643

The cache is the number of pre-allocated numbers.
If the system crashes without closing the database, at most this many numbers are lost.
The default cache size is 32.
To disable caching, use the cache size 1 or lower.
Thomas Mueller's avatar
Thomas Mueller committed
644

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

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

Thomas Mueller's avatar
Thomas Mueller committed
660 661 662 663
Cached tables (the default for regular tables) are persistent,
and the number of rows is not limited by the main memory.
Memory tables (the default for temporary tables) are persistent,
but the index data is kept in main memory,
Thomas Mueller's avatar
Thomas Mueller committed
664
that means memory tables should not get too large.
665

Thomas Mueller's avatar
Thomas Mueller committed
666 667 668 669 670
Temporary tables are deleted when closing or opening a database.
Temporary tables can be global (accessible by all connections)
or local (only accessible by the current connection).
The default for temporary tables is global.
Indexes of temporary tables are kept fully in main memory,
671
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
672

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

677 678 679
Either ENGINE, or WITH (table engine params), or both may be specified. If ENGINE is not specified
in CREATE TABLE, then the engine specified by DEFAULT_TABLE_ENGINE option of database params is used.

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

683 684 685
The column definition is optional if a query is specified.
In that case the column list of the query is used.

Thomas Mueller's avatar
Thomas Mueller committed
686 687
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
688 689 690 691 692
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
693
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
694
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
695
[ QUEUE int ] [ NOWAIT ] { CALL triggeredClassName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
696
","
Thomas Mueller's avatar
Thomas Mueller committed
697 698 699 700 701
Creates a new trigger.
The trigger class must be public and implement ""org.h2.api.Trigger"".
Inner classes are not supported.
The class must be available in the classpath of the database engine
(when using the server mode, it must be in the classpath of the server).
702

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

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

Thomas Mueller's avatar
Thomas Mueller committed
711
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
712
Only row based AFTER trigger can be called on ROLLBACK.
713
Exceptions that occur within such triggers are ignored.
714 715
As the operations that occur within a trigger are part of the transaction,
ROLLBACK triggers are only required if an operation communicates outside of the database.
716

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

Thomas Mueller's avatar
Thomas Mueller committed
721 722
A BEFORE SELECT trigger is fired just before the database engine tries to read from the table.
The trigger can be used to update a table on demand.
723 724
The trigger is called with both 'old' and 'new' set to null.

725 726 727 728
The MERGE statement will call both INSERT and UPDATE triggers.
Not supported are SELECT triggers with the option FOR EACH ROW,
and AFTER SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
729 730
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
731 732 733
By default a trigger is called once for each statement, without the old and new rows.
FOR EACH ROW triggers are called once for each inserted, updated, or deleted row.

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

Thomas Mueller's avatar
Thomas Mueller committed
736 737
The trigger need to be created in the same schema as the table.
The schema name does not need to be specified when creating the trigger.
738

Thomas Mueller's avatar
Thomas Mueller committed
739
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
740
","
741
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger"";
Thomas Mueller's avatar
Thomas Mueller committed
742
CREATE TRIGGER TRIG_SRC BEFORE INSERT ON TEST AS $$org.h2.api.Trigger create() { return new MyTrigger(""constructorParam""); } $$;
Thomas Mueller's avatar
Thomas Mueller committed
743 744
"
"Commands (DDL)","CREATE USER","
745 746
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
747
","
Thomas Mueller's avatar
Thomas Mueller committed
748 749 750
Creates a new user. For compatibility, only unquoted or uppercase user names are allowed.
The password must be in single quotes. It is case sensitive and can contain spaces.
The salt and hash values are hex strings.
751

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

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

Thomas Mueller's avatar
Thomas Mueller committed
765 766 767 768 769
If the OR REPLACE clause is used an existing view will be replaced, and any
dependent views will not need to be recreated. If dependent views will become
invalid as a result of the change an error will be generated, but this error
can be ignored if the FORCE clause is also used.

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

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

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

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

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

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

"Commands (DDL)","DROP ALL OBJECTS","
801
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
802 803 804 805 806
","
Drops all existing views, tables, sequences, schemas, function aliases, roles,
user-defined aggregate functions, domains, and users (except the current user).
If DELETE FILES is specified, the database files will be removed when the last
user disconnects from the database. Warning: this command can not be rolled
Thomas Mueller's avatar
Thomas Mueller committed
807 808 809
back.

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

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

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

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

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

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

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

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
869
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
870
","
Thomas Mueller's avatar
Thomas Mueller committed
871
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
872 873
The command will fail if dependent views exist and the RESTRICT clause is used (the default).
All dependent views are dropped as well if the CASCADE clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
874
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
875 876 877 878 879
","
DROP TABLE TEST
"

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

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

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

"Commands (DDL)","DROP VIEW","
901
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
902
","
Thomas Mueller's avatar
Thomas Mueller committed
903 904 905
Drops an existing view.
All dependent views are dropped as well if the CASCADE clause is used (the default).
The command will fail if dependent views exist and the RESTRICT clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
906
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
907 908 909 910 911 912 913
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
914 915 916 917 918
Removes all rows from a table.
Unlike DELETE FROM without where clause, this command can not be rolled back.
This command is faster than DELETE without where clause.
Only regular data tables without foreign key constraints can be truncated
(except if referential integrity is disabled for this database or for this table).
919
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
920

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

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

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

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

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

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

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
958 959 960 961
Sets the resolution of an in-doubt transaction to 'commit'.

Admin rights are required to execute this command.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
962 963 964 965 966
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
967
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
968 969
{ { SCHEMA schemaName } | { tableName [,...] } }
TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
970
","
Thomas Mueller's avatar
Thomas Mueller committed
971 972 973
Grants rights for a table to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
974
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
975 976 977 978
","
GRANT SELECT ON TEST TO READONLY
"

979 980 981 982 983 984
"Commands (Other)","GRANT ALTER ANY SCHEMA","
GRANT ALTER ANY SCHEMA TO userName
","
Grant schema altering rights to a user.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
985
This command commits an open transaction in this connection.
986 987 988 989
","
GRANT ALTER ANY SCHEMA TO Bob
"

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

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

"Commands (Other)","HELP","
1002
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1003 1004 1005 1006 1007 1008 1009 1010 1011
","
Displays the help pages of SQL commands or keywords.
","
HELP SELECT
"

"Commands (Other)","PREPARE COMMIT","
PREPARE COMMIT newTransactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
1012 1013
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
1014 1015 1016 1017 1018
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
1019
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
1020 1021
{ { SCHEMA schemaName } | { tableName [,...] } }
FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
1022
","
Thomas Mueller's avatar
Thomas Mueller committed
1023 1024 1025
Removes rights for a table from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1026
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1027 1028 1029 1030 1031
","
REVOKE SELECT ON TEST FROM READONLY
"

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

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

"Commands (Other)","ROLLBACK","
1043
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
","
Rolls back a transaction. If a savepoint name is used, the transaction is only
rolled back to the specified savepoint.
","
ROLLBACK
"

"Commands (Other)","ROLLBACK TRANSACTION","
ROLLBACK TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
1054 1055 1056 1057
Sets the resolution of an in-doubt transaction to 'rollback'.

Admin rights are required to execute this command.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
1058 1059 1060 1061 1062 1063 1064
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1065 1066
Create a new savepoint. See also ROLLBACK.
Savepoints are only valid until the transaction is committed or rolled back.
Thomas Mueller's avatar
Thomas Mueller committed
1067 1068 1069 1070 1071
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1072
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1073
","
Thomas Mueller's avatar
Thomas Mueller committed
1074
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1075
Variables are not persisted and session scoped, that means only visible from within the session in which they are defined.
Thomas Mueller's avatar
Thomas Mueller committed
1076
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1077 1078 1079 1080 1081
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1082
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
","
This setting can help solve the SQL injection problem. By default, text and
number literals are allowed in SQL statements. However, this enables SQL
injection if the application dynamically builds SQL statements. SQL injection is
not possible if user data is set using parameters ('?').

NONE means literals of any kind are not allowed, only parameters and constants
are allowed. NUMBERS mean only numerical and boolean literals are allowed. ALL
means all literals are allowed (default).

Thomas Mueller's avatar
Thomas Mueller committed
1093 1094
See also CREATE CONSTANT.

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

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

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
1119
Sets the size of the cache in KB (each KB being 1024 bytes) for the current database.
1120 1121
The default is 65536 per available GB of RAM, i.e. 64 MB per GB.
The value is rounded to the next higher power of two.
Thomas Mueller's avatar
Thomas Mueller committed
1122 1123
Depending on the virtual machine, the actual memory required may be higher.

Thomas Mueller's avatar
Thomas Mueller committed
1124
This setting is persistent and affects all connections as there is only one cache per database.
Thomas Mueller's avatar
Thomas Mueller committed
1125
Using a very small value (specially 0) will reduce performance a lot.
Thomas Mueller's avatar
Thomas Mueller committed
1126 1127
This setting only affects the database engine (the server in a client/server environment;
in embedded mode, the database engine is in the same process as the application).
Thomas Mueller's avatar
Thomas Mueller committed
1128
It has no effect for in-memory databases.
1129

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

"Commands (Other)","SET CLUSTER","
SET CLUSTER serverListString
","
This command should not be used directly by an application, the statement is
executed automatically by the system. The behavior may change in future
releases. Sets the cluster server list. An empty string switches off the cluster
mode. Switching on the cluster mode requires admin rights, but any user can
switch it off (this is automatically done when the client detects the other
Thomas Mueller's avatar
Thomas Mueller committed
1146 1147
server is not responding).

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

1153 1154 1155 1156
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1157 1158
Sets the collation used for comparing BINARY columns, the default is SIGNED
for version 1.3 and older, and UNSIGNED for version 1.4 and newer.
1159 1160 1161
This command can only be executed if there are no tables defined.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1162
This command commits an open transaction in this connection.
1163 1164 1165 1166 1167
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

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

1178 1179 1180 1181 1182 1183
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).

Thomas Mueller's avatar
Thomas Mueller committed
1184
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1185
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1186
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1187 1188 1189 1190 1191
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1192
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1193
","
Thomas Mueller's avatar
Thomas Mueller committed
1194 1195 1196 1197
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
1198 1199
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
1200

Thomas Mueller's avatar
Thomas Mueller committed
1201
Admin rights are required to execute this command, as it affects all connections.
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.
Thomas Mueller's avatar
Thomas Mueller committed
1204 1205 1206 1207 1208 1209 1210 1211
","
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
1212 1213 1214 1215
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).
1216
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1217 1218 1219 1220 1221 1222 1223
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1224 1225
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
1226 1227 1228 1229
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
1230

Thomas Mueller's avatar
Thomas Mueller committed
1231
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1232
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1233
This setting is persistent.
1234
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1235 1236 1237 1238 1239 1240 1241 1242
","
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
1243 1244
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1245
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1246
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1247
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1248 1249 1250 1251 1252
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1253
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1254 1255 1256
","
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
1257
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1258
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1259

Thomas Mueller's avatar
Thomas Mueller committed
1260
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1261
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1262
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1263
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1264 1265 1266 1267 1268
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1269
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1270
","
Thomas Mueller's avatar
Thomas Mueller committed
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
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
1281 1282

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1283
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1284
","
Thomas Mueller's avatar
Thomas Mueller committed
1285
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1286 1287 1288
"

"Commands (Other)","SET IGNORECASE","
1289
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1290 1291 1292 1293 1294
","
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
1295
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1296

Thomas Mueller's avatar
Thomas Mueller committed
1297
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1298
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1299
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1300
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1301 1302 1303 1304
","
SET IGNORECASE TRUE
"

1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
"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
1317
This command commits an open transaction in this connection.
1318 1319 1320 1321 1322 1323 1324
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'
"


1325
"Commands (Other)","SET LOG","
1326
SET LOG int
1327 1328 1329 1330
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1331
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1332 1333 1334 1335
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.

1336 1337
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
1338 1339
against power failure is required, but the data must be protected against killing the process.

1340 1341
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
1342 1343
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1344
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1345
This command commits an open transaction in this connection.
1346
This setting is not persistent.
1347
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1348 1349 1350 1351
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1352 1353 1354 1355
"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
1356
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369

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
1370
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1371
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1372
This setting is persistent.
1373
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1374 1375 1376 1377 1378 1379 1380 1381
","
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
1382 1383 1384
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1385
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1386 1387 1388 1389 1390 1391 1392
","
SET LOCK_TIMEOUT 1000
"

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

1395
This is the maximum length of an LOB that is stored with the record itself,
1396 1397
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1398
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1399
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1400
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1401 1402 1403 1404 1405 1406 1407
","
SET MAX_LENGTH_INPLACE_LOB 128
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1414
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1415
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1416
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1417 1418 1419 1420 1421 1422 1423 1424
","
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
1425
are read, then the rows are buffered to disk.
1426
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1427

Thomas Mueller's avatar
Thomas Mueller committed
1428
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1429
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1430
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1431
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1432 1433 1434 1435 1436 1437 1438
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1445
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1446
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1447
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1448
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1449 1450 1451 1452 1453 1454 1455 1456 1457
","
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
1458 1459 1460
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1461
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1462
It has no effect for in-memory databases.
1463
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1464 1465 1466 1467 1468
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1469
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1470 1471
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1472 1473 1474
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1475
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1476
This command commits an open transaction in this connection.
1477
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1478 1479 1480 1481 1482
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1483
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1484 1485 1486
","
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
1487 1488 1489 1490 1491
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
1492
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1493
This command commits an open transaction in this connection.
1494
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1495 1496 1497 1498 1499
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1500
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1501 1502 1503
","
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
1504 1505
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1506
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1507
This command commits an open transaction in this connection.
1508
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1509 1510 1511 1512 1513 1514 1515 1516 1517
","
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
1518

Thomas Mueller's avatar
Thomas Mueller committed
1519
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1520 1521 1522 1523
","
SET PASSWORD 'abcstzri!.5'
"

1524 1525 1526 1527 1528 1529 1530
"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
1531
This command commits an open transaction in this connection.
1532 1533 1534 1535 1536
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
"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
1550 1551 1552 1553 1554
"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
1555 1556 1557
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
1558 1559 1560 1561 1562
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1563
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1564 1565 1566
","
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
1567 1568 1569
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1570
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1571
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1572 1573 1574 1575
","
SET REFERENTIAL_INTEGRITY FALSE
"

1576 1577 1578 1579 1580 1581
"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.
1582 1583 1584
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,
1585 1586 1587 1588
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
1589
This command commits an open transaction in this connection.
1590 1591 1592 1593 1594 1595
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
1596 1597 1598 1599 1600
"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
1601

Thomas Mueller's avatar
Thomas Mueller committed
1602
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1603 1604 1605 1606 1607 1608 1609 1610 1611
","
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
1612 1613 1614
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1615
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1616 1617 1618 1619 1620 1621 1622 1623 1624
","
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
1625 1626 1627
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1628
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1629 1630 1631 1632 1633 1634 1635 1636 1637
","
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
1638 1639 1640
disabled).

This command does not commit a transaction, and rollback does not affect it.
1641
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1642 1643 1644 1645 1646
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1647
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1648 1649 1650
","
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.
1651
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1652

Thomas Mueller's avatar
Thomas Mueller committed
1653
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1654
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1655
This command does not commit a transaction, and rollback does not affect it.
1656
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
","
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
1668
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1669
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1670
This command commits an open transaction in this connection.
1671
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
","
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
1682

Thomas Mueller's avatar
Thomas Mueller committed
1683
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1684 1685 1686 1687 1688 1689 1690 1691
","
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
1692 1693
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1694
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1695
This command commits an open transaction in this connection.
1696
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1697 1698 1699 1700 1701
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1702
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1703
","
1704 1705
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
1706
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1707

1708 1709
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
1710 1711 1712

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,
1713
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
1714 1715

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1719
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1720
","
1721
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1722 1723
"

1724 1725
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1726
","
1727
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1728
","
1729
A
Thomas Mueller's avatar
Thomas Mueller committed
1730 1731
"

1732 1733
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1734
","
1735
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1736
","
1737
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1738 1739
"

1740
"Other Grammar","Array","
1741
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1742
","
1743 1744
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
1745
","
1746
(1, 2)
1747 1748
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1749 1750
"

1751 1752
"Other Grammar","Boolean","
TRUE | FALSE
1753
","
1754
A boolean value.
1755
","
1756
TRUE
1757 1758
"

1759 1760
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1761
","
1762
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1763
","
1764
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1765 1766
"

1767 1768 1769
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1770
","
1771 1772
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
1773
","
1774
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1775 1776
"

1777 1778 1779
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1780
","
1781 1782
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1783
","
1784 1785 1786 1787
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
1788
AES
1789
","
1790
Only the algorithm AES (""AES-128"") is supported currently.
1791 1792
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1793 1794
"

1795
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1796
columnName dataType
1797
[ VISIBLE | INVISIBLE ]
Thomas Mueller's avatar
Thomas Mueller committed
1798
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1799
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1800 1801
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1802 1803
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1804
The computed column expression is evaluated and assigned whenever the row changes.
1805 1806 1807 1808

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
1809

1810 1811 1812
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
1813 1814
The options PRIMARY KEY, UNIQUE, and CHECK are not supported for ALTER statements.

Thomas Mueller's avatar
Thomas Mueller committed
1815 1816
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
1817 1818
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1819

1820
","
Thomas Mueller's avatar
Thomas Mueller committed
1821 1822 1823
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);
1824 1825
"

1826 1827
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1828
","
1829 1830 1831
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
1832
","
1833
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1834 1835
"

1836
"Other Grammar","Compare","
1837
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
1838
","
1839
Comparison operator. The operator != is the same as <>.
1840
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
1841
","
1842
<>
Thomas Mueller's avatar
Thomas Mueller committed
1843 1844 1845
"

"Other Grammar","Condition","
1846
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1847 1848 1849 1850 1851 1852 1853
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1854 1855
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1856
    | IS [ NOT ] [ DISTINCT FROM ] operand
1857 1858
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
1859
    | [ NOT ] [ LIKE | ILIKE ] operand [ ESCAPE string ]
1860
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1861
","
Thomas Mueller's avatar
Thomas Mueller committed
1862
The right hand side of a condition.
1863

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

Thomas Mueller's avatar
Thomas Mueller committed
1867 1868 1869 1870 1871
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).
1872 1873 1874
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.
1875

1876 1877
ILIKE does a case-insensitive compare.

Thomas Mueller's avatar
Thomas Mueller committed
1878
When comparing with REGEXP, regular expression matching is used.
1879
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1880 1881 1882 1883
","
LIKE 'Jo%'
"

1884
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
1885 1886 1887 1888 1889
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
1890
","
Thomas Mueller's avatar
Thomas Mueller committed
1891 1892
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1893
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1894 1895
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
1896
","
1897
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1898 1899
"

1900 1901
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1902
","
1903
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1904
","
1905
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1906 1907
"

1908 1909
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1910
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1911
","
1912
Optional parameters for CSVREAD and CSVWRITE.
1913 1914
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
1915 1916
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1917
The following options are supported:
1918

1919
""caseSensitiveColumnNames"" (true or false; disabled by default),
1920

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1927
""fieldSeparator"" (a comma by default)),
1928

1929
""lineComment"" (disabled by default),
1930

1931
""lineSeparator"" (the line separator used for writing; ignored for reading),
1932

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

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

1938
""writeColumnHeader"" (true or false; enabled by default).
1939

Thomas Mueller's avatar
Thomas Mueller committed
1940
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1941
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
1942 1943 1944
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
1945
","
1946
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1947 1948
"

1949 1950 1951 1952
"Other Grammar","Data Type","
intType | booleanType | tinyintType | smallintType | bigintType | identityType
    | decimalType | doubleType | realType | dateType | timeType | timestampType
    | binaryType | otherType | varcharType | varcharIgnorecaseType | charType
1953
    | blobType | clobType | uuidType | arrayType | enumType
Thomas Mueller's avatar
Thomas Mueller committed
1954
","
1955
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1956
","
1957
INT
Thomas Mueller's avatar
Thomas Mueller committed
1958 1959
"

1960 1961
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1962
","
1963
A date literal. The limitations are the same as for the Java data type
1964
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1965
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1966
","
1967
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1968 1969
"

1970
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
1971
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
1972
","
Thomas Mueller's avatar
Thomas Mueller committed
1973 1974 1975 1976 1977 1978
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)"".
1979
","
Thomas Mueller's avatar
Thomas Mueller committed
1980 1981 1982
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
1983 1984
"

1985 1986
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1987
","
1988
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1989
","
1990
0
Thomas Mueller's avatar
Thomas Mueller committed
1991 1992
"

1993 1994
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1995
","
1996 1997 1998
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
1999
","
2000
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
2001 2002
"

2003 2004
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2005
","
2006
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
2007
","
2008
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
2009 2010
"

2011
"Other Grammar","Factor","
2012
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2013
","
2014
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
2015
","
2016
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
2017 2018
"

2019 2020
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
2021
","
2022 2023
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
2024
","
2025
cafe
Thomas Mueller's avatar
Thomas Mueller committed
2026 2027
"

2028 2029
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
2030
","
2031
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
2032
","
2033
0xff
Thomas Mueller's avatar
Thomas Mueller committed
2034 2035
"

2036 2037
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2038
","
2039 2040 2041
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
2042
","
2043
NAME
Thomas Mueller's avatar
Thomas Mueller committed
2044 2045 2046
"

"Other Grammar","Int","
2047
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2048 2049 2050 2051 2052 2053 2054
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2055
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2056 2057 2058 2059 2060 2061
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2062 2063
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2064
","
2065
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2066
","
2067
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2068 2069
"

2070 2071
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2072
","
2073
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2074
","
2075
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2076 2077
"

2078 2079 2080 2081 2082 2083 2084 2085
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2086
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2087
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2088
","
Thomas Mueller's avatar
Thomas Mueller committed
2089
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2090 2091 2092 2093 2094 2095 2096
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
"

2097 2098
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2099
","
2100
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2101
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2102
","
2103
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2104 2105
"

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

2116 2117
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2118
","
2119 2120 2121
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
2122
","
2123
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2124 2125
"

2126 2127 2128
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2129
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2130
","
Thomas Mueller's avatar
Thomas Mueller committed
2131 2132 2133
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
2134 2135 2136
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
2137
","
2138
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2139 2140
"

Thomas Mueller's avatar
Thomas Mueller committed
2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
"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
"

2152 2153
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2154
","
2155 2156
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
2157 2158 2159 2160 2161
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2162 2163
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2164
","
2165
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2166
","
2167
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2168 2169
"

2170 2171
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2172
","
2173 2174
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
2175
","
2176
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2177 2178
"

2179 2180
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2181
","
Thomas Mueller's avatar
Thomas Mueller committed
2182
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2183

Thomas Mueller's avatar
Thomas Mueller committed
2184
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2185
","
2186
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2187 2188
"

2189
"Other Grammar","Table Expression","
2190
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
2191
[ USE INDEX ([ indexName [,...] ]) ]
2192 2193
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2194
","
2195 2196 2197
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
2198
","
2199
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2200 2201
"

2202 2203 2204 2205 2206 2207 2208 2209 2210
"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;
"

2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2223
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2224
","
2225
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2226
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2227
","
2228 2229 2230 2231 2232 2233
'Hello'
"

"Other Grammar","Time","
TIME 'hh:mm:ss'
","
2234 2235
A time literal. A value is between plus and minus 2 million hours
and has nanosecond resolution.
2236 2237 2238 2239 2240 2241 2242 2243
","
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
2244
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2245 2246 2247 2248 2249 2250
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
2251
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2252
","
Thomas Mueller's avatar
Thomas Mueller committed
2253
A literal value of any data type, or null.
2254 2255
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2256 2257 2258 2259 2260 2261 2262
"

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

2263
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2264 2265 2266 2267 2268 2269 2270 2271 2272
","
INT
"

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

2273
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2274 2275 2276 2277 2278 2279 2280 2281 2282
","
BOOLEAN
"

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

2283
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2284 2285 2286 2287 2288 2289 2290 2291 2292
","
TINYINT
"

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

2293
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2294 2295 2296 2297 2298 2299 2300 2301 2302
","
SMALLINT
"

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

2303
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314
","
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.

2315
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2316 2317 2318 2319 2320
","
IDENTITY
"

"Data Types","DECIMAL Type","
2321
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2322 2323 2324 2325
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2326
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2327 2328 2329 2330 2331
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2332
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2333
","
Thomas Mueller's avatar
Thomas Mueller committed
2334
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2335 2336
of rounding problems.

2337
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2338 2339 2340 2341 2342
","
DOUBLE
"

"Data Types","REAL Type","
2343
{ REAL | FLOAT4 }
Thomas Mueller's avatar
Thomas Mueller committed
2344
","
Thomas Mueller's avatar
Thomas Mueller committed
2345
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2346 2347
values, because of rounding problems.

2348
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2349 2350 2351 2352 2353 2354 2355
","
REAL
"

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

2358
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
2359 2360 2361 2362 2363 2364 2365
","
TIME
"

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

2368
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2369
(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
2370 2371 2372 2373 2374
","
DATE
"

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

2380
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2381 2382 2383 2384
","
TIMESTAMP
"

2385 2386
"Data Types","TIMESTAMP WITH TIME ZONE Type","
TIMESTAMP WITH TIME ZONE
2387 2388
","
VERY MUCH STILL IN TESTING.
2389
The timestamp with time zone data type.
2390 2391 2392 2393 2394
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""
","
2395
TIMESTAMP WITH TIME ZONE
2396 2397
"

Thomas Mueller's avatar
Thomas Mueller committed
2398
"Data Types","BINARY Type","
2399
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2400
","
2401 2402 2403 2404 2405
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
2406 2407 2408 2409 2410 2411 2412 2413 2414

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2415 2416 2417 2418 2419
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
2420

2421
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2422 2423 2424 2425 2426
","
OTHER
"

"Data Types","VARCHAR Type","
2427 2428
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2429
","
Thomas Mueller's avatar
Thomas Mueller committed
2430
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2431 2432 2433 2434 2435 2436 2437
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
2438

2439
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2440 2441 2442 2443 2444
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2445
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2446
","
Thomas Mueller's avatar
Thomas Mueller committed
2447
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2448 2449 2450 2451 2452 2453 2454
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
2455

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

"Data Types","CHAR Type","
2462
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2463
","
Thomas Mueller's avatar
Thomas Mueller committed
2464 2465 2466
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
2467

Thomas Mueller's avatar
Thomas Mueller committed
2468 2469
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
2470

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

2474
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2475 2476 2477 2478 2479
","
CHAR(10)
"

"Data Types","BLOB Type","
2480
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2481 2482 2483
","
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
2484
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2485 2486
Advanced / Large Objects.

2487
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2488 2489 2490 2491 2492
","
BLOB
"

"Data Types","CLOB Type","
2493
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2494 2495 2496 2497 2498
","
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
2499
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2500 2501 2502 2503 2504

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.

2505
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2506 2507 2508 2509 2510 2511 2512
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2513 2514 2515 2516
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
2517

Thomas Mueller's avatar
Thomas Mueller committed
2518 2519 2520 2521 2522
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
2523
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2524 2525 2526 2527 2528 2529 2530
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2531
An array of values.
2532
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2533 2534 2535 2536


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
2537 2538 2539 2540
","
ARRAY
"

2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554
"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')
"
2555 2556 2557
"Data Types","GEOMETRY Type","
GEOMETRY
","
2558 2559
A spatial geometry type, based on the ""com.vividsolutions.jts"" library.
Normally represented in textual format using the WKT (well known text) format.
2560

Thomas Mueller's avatar
Thomas Mueller committed
2561
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2562 2563
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2564
GEOMETRY
2565 2566
"

Thomas Mueller's avatar
Thomas Mueller committed
2567
"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2568
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2569
","
2570 2571
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2572
Aggregates are only allowed in select statements.
2573
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2574 2575 2576 2577
","
AVG(X)
"

2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597
"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
2598
"Functions (Aggregate)","BOOL_AND","
2599
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2600
","
2601 2602 2603
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
2604 2605 2606 2607 2608
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2609
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2610
","
2611 2612 2613
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
2614 2615 2616 2617 2618
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2619
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2620
","
2621 2622 2623 2624
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
2625 2626 2627 2628 2629
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2630 2631
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2632
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2633
","
2634 2635 2636 2637 2638
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
2639 2640 2641 2642 2643
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2644
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2645
","
2646 2647 2648 2649
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
2650 2651 2652 2653 2654
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2655
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2656
","
2657 2658 2659 2660
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
2661 2662 2663 2664 2665
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2666
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2667
","
2668 2669 2670
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2671
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2672
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2673 2674 2675 2676 2677
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2678
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2679
","
2680 2681 2682 2683 2684
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
2685 2686 2687 2688 2689
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2690
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2691
","
2692 2693 2694
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
2695 2696 2697 2698 2699 2700
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2701
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2702
","
2703 2704 2705
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
2706 2707 2708 2709 2710 2711
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2712
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2713
","
2714 2715 2716 2717
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
2718 2719 2720 2721 2722
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2723
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2724
","
2725 2726 2727 2728
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
2729 2730 2731 2732 2733
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2734
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2735
","
2736 2737
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"".
2738
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2739 2740 2741 2742 2743
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2744
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2745
","
Thomas Mueller's avatar
Thomas Mueller committed
2746 2747
Calculate the arc cosine.
See also Java ""Math.acos"".
2748
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2749 2750 2751 2752 2753
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2754
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2755
","
Thomas Mueller's avatar
Thomas Mueller committed
2756 2757
Calculate the arc sine.
See also Java ""Math.asin"".
2758
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2759 2760 2761 2762 2763
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2764
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2765
","
Thomas Mueller's avatar
Thomas Mueller committed
2766 2767
Calculate the arc tangent.
See also Java ""Math.atan"".
2768
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2769 2770 2771 2772 2773
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2774
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2775
","
Thomas Mueller's avatar
Thomas Mueller committed
2776 2777
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2778
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2779 2780 2781 2782
","
COS(ANGLE)
"

2783
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2784
COSH(numeric)
2785 2786 2787 2788 2789 2790 2791 2792
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2793
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2794
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2795
","
Thomas Mueller's avatar
Thomas Mueller committed
2796
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2797
See also Java ""Math.*"" functions.
2798
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2799 2800 2801 2802 2803
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2804
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2805
","
Thomas Mueller's avatar
Thomas Mueller committed
2806 2807
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2808
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2809 2810 2811 2812
","
SIN(ANGLE)
"

2813
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2814
SINH(numeric)
2815 2816 2817 2818 2819 2820 2821 2822
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2823
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2824
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2825
","
Thomas Mueller's avatar
Thomas Mueller committed
2826 2827
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2828
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2829 2830 2831 2832
","
TAN(ANGLE)
"

2833
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2834
TANH(numeric)
2835 2836 2837 2838 2839 2840 2841 2842
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2843
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2844
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2845
","
Thomas Mueller's avatar
Thomas Mueller committed
2846
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2847
See also Java ""Math.atan2"".
2848
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2849 2850 2851 2852 2853
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2854
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2855
","
2856 2857
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2858 2859 2860 2861 2862
See also Java operator &.
","
BITAND(A, B)
"

2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873
"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
2874
"Functions (Numeric)","BITOR","
2875
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2876
","
2877 2878
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2879 2880 2881 2882 2883 2884
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2885
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2886
","
2887 2888
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2889 2890 2891 2892 2893 2894
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2895
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2896
","
2897 2898
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2899 2900 2901 2902 2903 2904
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2905
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2906
","
2907
See also Java ""Math.ceil"".
2908
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2909
","
2910
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2911 2912 2913
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2914
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2915
","
2916
See also Java ""Math.toDegrees"".
2917
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2918 2919 2920 2921 2922
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2923
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2924
","
2925
See also Java ""Math.exp"".
2926
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2927 2928 2929 2930 2931
","
EXP(A)
"

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

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2941
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2942
","
2943
See also Java ""Math.log"".
2944
In the PostgreSQL mode, LOG(x) is base 10.
2945
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2946 2947 2948 2949 2950
","
LOG(A)
"

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

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

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

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

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

"Functions (Numeric)","RAND","
2996
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2997 2998 2999
","
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
3000
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
3001 3002 3003 3004 3005
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
3006
{ RANDOM_UUID | UUID } ()
Thomas Mueller's avatar
Thomas Mueller committed
3007 3008
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
3009 3010 3011 3012 3013

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
3014 3015 3016 3017 3018
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
3019
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
3020
","
3021
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
3022
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
3023 3024 3025 3026 3027
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
3028
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
3029
","
3030 3031 3032 3033 3034 3035
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
3036 3037 3038 3039 3040
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
3041
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
3042 3043
","
Generates a number of cryptographically secure random numbers.
3044
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3045 3046 3047 3048 3049
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
3050
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
3051 3052 3053 3054 3055 3056 3057
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
3058
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3059
","
3060
Encrypts data using a key.
3061
The supported algorithm is AES.
3062 3063
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3064 3065 3066 3067 3068
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
3069
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
3070
","
3071
Decrypts data using a key.
3072
The supported algorithm is AES.
3073 3074
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3075 3076 3077 3078 3079 3080
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3081
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
3082
","
3083 3084 3085
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
3086 3087 3088 3089 3090
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3091
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3092 3093
","
Truncates to a number of digits (to the next value closer to 0).
3094
This method returns a double.
3095
When used with a timestamp, truncates a timestamp to a date (day) value.
3096 3097
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
3098 3099 3100 3101 3102
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3103
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3104
","
3105 3106 3107 3108
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
3109 3110 3111 3112 3113
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3114
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3115 3116
","
Expands data that was compressed using the COMPRESS function.
3117
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3118 3119 3120 3121 3122
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3123
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3124 3125 3126 3127 3128 3129 3130
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3131
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3132 3133
","
Returns the ASCII value of the first character in the string.
3134
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3135 3136 3137 3138
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3139
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3140
","
3141 3142 3143
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
3144 3145 3146 3147 3148
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3149
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3150
","
3151 3152 3153
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
3154 3155 3156 3157 3158
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3159
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3160
","
3161 3162 3163 3164
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
3165 3166 3167 3168 3169
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3170
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3171 3172
","
Returns the character that represents the ASCII value.
3173
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3174 3175 3176 3177 3178
","
CHAR(65)
"

"Functions (String)","CONCAT","
3179
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3180 3181
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3182
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3183
and do not cause the result to become NULL.
3184
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3185 3186 3187 3188
","
CONCAT(NAME, '!')
"

3189 3190 3191 3192
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3193
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3194
and do not cause the result to become NULL.
3195 3196 3197 3198 3199
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3200
"Functions (String)","DIFFERENCE","
3201
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3202 3203
","
Returns the difference between the sounds of two strings.
3204
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3205 3206 3207 3208 3209
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3210
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3211
","
3212 3213
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
3214 3215 3216 3217 3218
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3219
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3220
","
3221 3222 3223
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
3224 3225 3226 3227 3228
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3229
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3230
","
3231
Returns the location of a search string in a string.
3232 3233 3234
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
3235
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3236 3237 3238 3239 3240
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3241
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3242
","
3243 3244 3245
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
3246 3247 3248 3249 3250
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3251
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3252 3253 3254 3255 3256 3257 3258
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3259
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3260 3261 3262 3263 3264 3265 3266
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3267
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3268 3269 3270 3271 3272 3273 3274
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3275
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3276 3277 3278 3279 3280 3281 3282
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3283
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3284
","
3285 3286 3287 3288
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
3289 3290 3291 3292 3293
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3294
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3295 3296 3297 3298 3299 3300 3301
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3302
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3303
","
3304 3305 3306
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
3307 3308 3309 3310 3311
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3312
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3313
","
3314 3315 3316
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
3317 3318 3319 3320 3321
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3322
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3323 3324 3325 3326 3327 3328 3329
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3330
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3331 3332 3333 3334 3335 3336 3337
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3338
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3339
","
3340 3341
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
3342 3343 3344 3345 3346
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3347
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
3348
","
3349
Replaces each substring that matches a regular expression.
3350
For details, see the Java ""String.replaceAll()"" method.
3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364
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
3365 3366
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
3367
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3368 3369
"

3370 3371 3372 3373
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388
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)

3389 3390
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3391 3392
"

3393

Thomas Mueller's avatar
Thomas Mueller committed
3394
"Functions (String)","REPEAT","
3395
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3396 3397 3398 3399 3400 3401 3402
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3403
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3404
","
3405 3406
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.
3407
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3408 3409 3410 3411 3412
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3413
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3414
","
3415 3416 3417
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
3418 3419 3420 3421 3422
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3423
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3424 3425 3426 3427 3428 3429 3430
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3431
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3432
","
3433 3434 3435
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
3436 3437 3438 3439 3440
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3441
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3442
","
3443 3444 3445
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
3446 3447 3448 3449 3450
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3451
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3452 3453
","
Encodes a string to a byte array using the UTF8 encoding format.
3454
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3455 3456 3457 3458 3459
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3460
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3461
","
3462
Returns a substring of a string starting at a position.
3463
If the start index is negative, then the start index is relative to the end of the string.
3464
The length is optional.
3465
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3466
","
3467 3468
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3469 3470 3471
"

"Functions (String)","UTF8TOSTRING","
3472
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3473 3474 3475 3476 3477 3478 3479
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3480
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3481
","
3482
Creates an XML attribute element of the form ""name=value"".
3483 3484
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3485 3486 3487 3488 3489
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3490
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3491 3492
","
Create an XML node element.
3493 3494 3495
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.
3496
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3497 3498 3499 3500 3501
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3502
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3503
","
3504
Creates an XML comment.
3505
Two dashes (""--"") are converted to ""- -"".
3506
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3507 3508 3509 3510 3511
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3512
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3513
","
3514
Creates an XML CDATA element.
3515
If the value contains ""]]>"", an XML text element is created instead.
3516
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3517 3518 3519 3520 3521
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3522
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3523
","
Thomas Mueller's avatar
Thomas Mueller committed
3524
Returns the XML declaration.
3525
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3526 3527 3528 3529 3530
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3531
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3532 3533
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3534
If enabled, newline and linefeed is converted to an XML entity (&#).
3535
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3536 3537 3538 3539
","
CALL XMLTEXT('test')
"

3540
"Functions (String)","TO_CHAR","
3541
TO_CHAR(value [, formatString[, nlsParamString]])
3542 3543 3544 3545 3546 3547
","
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')
"

3548 3549 3550 3551 3552 3553 3554 3555
"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
3556
"Functions (Time and Date)","CURRENT_DATE","
3557
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3558 3559
","
Returns the current date.
3560
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3561 3562 3563 3564 3565
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3566
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3567 3568
","
Returns the current time.
3569
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3570 3571 3572 3573 3574
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3575
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3576
","
3577 3578
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3579
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3580 3581 3582 3583 3584
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3585
{ DATEADD| TIMESTAMPADD } (unitString, addIntLong, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3586
","
3587 3588
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
3589 3590
addIntLong may be a long value when manipulating milliseconds,
otherwise it's range is restricted to int.
3591
The same units as in the EXTRACT function are supported.
3592
DATEADD method returns a timestamp. TIMESTAMPADD method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3593 3594 3595 3596 3597
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3598
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3599
","
Thomas Mueller's avatar
Thomas Mueller committed
3600
Returns the the number of crossed unit boundaries between two timestamps.
3601 3602
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3603 3604 3605 3606 3607 3608
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3609
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3610 3611 3612 3613 3614 3615 3616
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3617
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3618 3619 3620 3621 3622 3623 3624
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3625
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3626 3627 3628 3629 3630 3631 3632
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3633
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3634 3635 3636 3637 3638 3639 3640
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3641
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3642
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3643
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3644 3645
","
Returns a specific value from a timestamps.
3646
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3647 3648 3649 3650 3651
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3652
FORMATDATETIME ( timestamp, formatString
3653
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3654
","
3655 3656 3657
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.
3658
For details of the format, see ""java.text.SimpleDateFormat"".
3659
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3660 3661 3662 3663 3664 3665
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3666
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3667 3668 3669 3670 3671 3672 3673
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3674
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3675 3676 3677 3678 3679 3680 3681
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3682
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3683 3684 3685 3686 3687 3688 3689
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3690
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3691 3692 3693 3694 3695 3696 3697
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3698
PARSEDATETIME(string, formatString
3699
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3700
","
3701 3702 3703
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.
3704
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3705 3706 3707 3708 3709 3710
","
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","
3711
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3712 3713 3714 3715 3716 3717 3718
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3719
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3720 3721 3722 3723 3724 3725 3726
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3727
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3728
","
3729 3730
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3731 3732 3733 3734 3735
","
WEEK(CREATED)
"

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

"Functions (System)","ARRAY_GET","
3744
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3745 3746
","
Returns one element of an array.
3747
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3748 3749 3750 3751 3752
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3753
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3754 3755 3756 3757 3758 3759
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3760 3761 3762 3763 3764 3765 3766 3767
"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
3768
"Functions (System)","AUTOCOMMIT","
3769
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3770 3771 3772 3773 3774 3775 3776
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3777
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3778
","
3779 3780 3781
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
3782 3783

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3784 3785 3786 3787 3788
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3789
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3790 3791
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3792
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3793 3794 3795 3796 3797
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3798
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3799
","
3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811
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
3812 3813 3814
"

"Functions (System)","COALESCE","
3815
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3816 3817 3818 3819 3820 3821 3822
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3823
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3824 3825 3826 3827 3828 3829 3830
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3831
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3832
","
3833 3834 3835 3836 3837
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
3838 3839 3840 3841 3842
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3843
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3844
","
3845 3846
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
3847 3848

If the column names are specified (a list of column names separated with the
3849
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3850 3851 3852 3853 3854
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
3855 3856 3857 3858 3859

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3869 3870 3871
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
3872 3873 3874 3875
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
3876 3877 3878 3879
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
3880
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3881
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3882 3883 3884
"

"Functions (System)","CSVWRITE","
3885
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3886
","
3887
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3888
If only a file name is specified, it will be written to the current working directory.
3889
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3890
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
3891 3892 3893 3894 3895

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

Thomas Mueller's avatar
Thomas Mueller committed
3898 3899
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3900
","
Thomas Mueller's avatar
Thomas Mueller committed
3901 3902 3903 3904
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
3905 3906 3907
"

"Functions (System)","DATABASE","
3908
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3909 3910 3911 3912 3913 3914 3915
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3916
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3917
","
Thomas Mueller's avatar
Thomas Mueller committed
3918 3919
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
3920 3921 3922 3923
","
CALL DATABASE_PATH();
"

3924
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3925
DECODE(value, whenValue, thenValue [,...])
3926 3927 3928 3929 3930 3931 3932 3933
","
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');
"

3934
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3935
DISK_SPACE_USED(tableNameString)
3936 3937 3938 3939 3940 3941 3942 3943
","
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
3944
"Functions (System)","FILE_READ","
3945
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3946 3947 3948 3949
","
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
3950
default character set for this system.
3951 3952 3953 3954

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

Thomas Mueller's avatar
Thomas Mueller committed
3955
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3956 3957 3958 3959 3960
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

3961
"Functions (System)","FILE_WRITE","
3962
FILE_WRITE(blobValue, fileNameString)
3963 3964 3965 3966 3967 3968 3969 3970
","
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
3971
"Functions (System)","GREATEST","
3972
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3973 3974 3975 3976 3977 3978 3979
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3980
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3981 3982
","
Returns the last inserted identity value for this session.
3983
This value changes whenever a new sequence number was generated,
3984
even within a trigger or Java function. See also SCOPE_IDENTITY.
3985
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3986 3987 3988 3989 3990
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3991
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3992 3993 3994 3995 3996 3997 3998
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3999
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
4000 4001 4002 4003 4004 4005 4006
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
4007
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
4008 4009
","
Returns the current lock mode. See SET LOCK_MODE.
4010
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4011 4012 4013 4014 4015
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
4016
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
4017 4018 4019 4020 4021 4022 4023 4024
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
4025
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
4026
","
4027 4028 4029 4030 4031
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
4032
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4033 4034 4035 4036 4037
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
4038
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
4039
","
Thomas Mueller's avatar
Thomas Mueller committed
4040
Returns the free memory in KB (where 1024 bytes is a KB).
4041
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4042 4043
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4044 4045 4046 4047 4048
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
4049
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
4050
","
Thomas Mueller's avatar
Thomas Mueller committed
4051
Returns the used memory in KB (where 1024 bytes is a KB).
4052
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
4053 4054
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
4055 4056 4057 4058 4059
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
4060
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
4061
","
4062 4063 4064 4065
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
4066 4067 4068 4069 4070
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
4071
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
4072 4073 4074 4075 4076 4077
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4078 4079 4080 4081
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4082
The data type of the returned value is the data type of 'a' if this is a text type.
4083 4084 4085 4086
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4087
"Functions (System)","READONLY","
4088
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4089 4090 4091 4092 4093 4094 4095
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
4096
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
4097
","
4098
Returns the number of the current row.
4099 4100
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4101 4102
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).
4103
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
4104
","
4105 4106
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4107
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4108 4109 4110
"

"Functions (System)","SCHEMA","
4111
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4112 4113 4114 4115 4116 4117
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

4118 4119 4120
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4121
Returns the last inserted identity value for this session for the current scope
Thomas Mueller's avatar
Thomas Mueller committed
4122
(ie. the current statement).
4123 4124 4125 4126 4127 4128
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
4129
"Functions (System)","SESSION_ID","
4130
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4131
","
4132 4133 4134 4135
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
4136 4137 4138 4139 4140
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4141
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4142
","
4143 4144 4145
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
4146
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4147
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4148 4149 4150 4151 4152
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4153
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4154 4155 4156 4157 4158 4159 4160
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4161
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4162
","
4163 4164
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
4165
Otherwise a value of the following form is returned:
4166
""logFileId-position-sessionId"".
4167 4168
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4169 4170 4171 4172
","
CALL TRANSACTION_ID()
"

4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184
"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
4185
"Functions (System)","USER","
4186
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4187 4188 4189 4190 4191 4192
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4193 4194 4195 4196 4197 4198 4199 4200
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215
"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
4216