help.csv 104.8 KB
Newer Older
1
# Copyright 2004-2011 H2 Group. Multiple-Licensed under the H2 License,
Thomas Mueller's avatar
Thomas Mueller committed
2 3 4 5 6
# Version 1.0, and under the Eclipse Public License, Version 1.0
# (http://h2database.com/html/license.html).
# Initial Developer: H2 Group
"SECTION","TOPIC","SYNTAX","TEXT","EXAMPLE"
"Commands (DML)","SELECT","
7 8 9 10 11
SELECT [ TOP term ] [ DISTINCT | ALL ] selectExpression [,...]
FROM tableExpression [,...] [ WHERE expression ]
[ GROUP BY expression [,...] ] [ HAVING expression ]
[ { UNION [ ALL ] | MINUS | EXCEPT | INTERSECT } select ] [ ORDER BY order [,...] ]
[ LIMIT expression [ OFFSET expression ] [ SAMPLE_SIZE rowCountInt ] ]
12
[ FOR UPDATE ]
Thomas Mueller's avatar
Thomas Mueller committed
13 14
","
Selects data from a table or multiple tables.
15 16 17 18
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
19

20
LIMIT limits the number of rows returned by the query (no limit if null or smaller than zero).
Thomas Mueller's avatar
Thomas Mueller committed
21
OFFSET specified how many rows to skip.
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","
Thomas Mueller's avatar
Thomas Mueller committed
60
UPDATE tableName [ [ AS ] newTableAlias ]
61
SET { columnName = { DEFAULT | expression } } [,...]
62
[ WHERE expression ]
Thomas Mueller's avatar
Thomas Mueller committed
63 64 65
","
Updates data in a table.
","
66 67
UPDATE TEST SET NAME='Hi' WHERE ID=1;
UPDATE PERSON P SET NAME=(SELECT A.NAME FROM ADDRESS A WHERE A.ID=P.ID);
Thomas Mueller's avatar
Thomas Mueller committed
68 69 70
"

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

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

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

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

"Commands (DML)","MERGE","
110 111
MERGE INTO tableName [ ( columnName [,...] ) ]
[ KEY ( columnName [,...] ) ]
112
{ VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | select }
Thomas Mueller's avatar
Thomas Mueller committed
113 114 115 116 117 118 119 120 121 122 123
","
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","
Thomas Mueller's avatar
Thomas Mueller committed
124
RUNSCRIPT FROM fileNameString [ scriptCompression ]
125
[ CIPHER cipher PASSWORD string ] [ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
126 127 128 129 130 131
","
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.

132
Instead of a file name, an URL may be used.
133 134
To read a stream from the classpath, use the prefix 'classpath:'.

Thomas Mueller's avatar
Thomas Mueller committed
135 136
The compression algorithm must match the one used when creating the script. When
using encryption, only DEFLATE and LZF are supported (LZF is faster but uses more space).
Thomas Mueller's avatar
Thomas Mueller committed
137 138 139
Instead of a file, an URL may be used.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
140
","
141
RUNSCRIPT FROM 'backup.sql'
Thomas Mueller's avatar
Thomas Mueller committed
142 143 144
"

"Commands (DML)","SCRIPT","
145 146
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
Thomas Mueller's avatar
Thomas Mueller committed
147
[ TO fileNameString [ scriptCompression ]
148
    [ CIPHER cipher PASSWORD string ] ]
149
[ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
150
","
151 152 153 154 155 156 157 158 159
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.

If no file name is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
160 161 162 163
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.

164
If a file name is specified, then the whole
Thomas Mueller's avatar
Thomas Mueller committed
165 166 167 168
script (including insert statements) is written to this file, and a result set
without the insert statements is returned. When using encryption, only DEFLATE
and LZF are supported (LZF is faster but uses more space).

Thomas Mueller's avatar
Thomas Mueller committed
169 170 171
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
172 173 174 175 176
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
177 178
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
179 180 181 182 183 184 185 186 187
","
Lists the schemas, tables, or the columns of a table.
","
SHOW TABLES
"

"Commands (DDL)","ALTER INDEX RENAME","
ALTER INDEX indexName RENAME TO newIndexName
","
Thomas Mueller's avatar
Thomas Mueller committed
188 189
Renames an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
190 191 192 193
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

194 195 196 197 198 199 200 201 202
"Commands (DDL)","ALTER SCHEMA RENAME","
ALTER SCHEMA schema RENAME TO newSchemaName
","
Renames a schema.
This command commits an open transaction.
","
ALTER SCHEMA TEST RENAME TO PRODUCTION
"

Thomas Mueller's avatar
Thomas Mueller committed
203
"Commands (DDL)","ALTER SEQUENCE","
204
ALTER SEQUENCE sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
Thomas Mueller's avatar
Thomas Mueller committed
205
","
Thomas Mueller's avatar
Thomas Mueller committed
206 207
Changes the next value and the increment of a sequence.
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
208 209 210 211 212 213
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

"Commands (DDL)","ALTER TABLE ADD","
214
ALTER TABLE tableName ADD [ IF NOT EXISTS ] name dataType [ DEFAULT expression ]
215
[ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] [ BEFORE columnName ]
Thomas Mueller's avatar
Thomas Mueller committed
216
","
Thomas Mueller's avatar
Thomas Mueller committed
217 218
Adds a new column to a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
219 220 221 222 223
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
224
ALTER TABLE tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
225 226 227
","
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
228
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
229
It is not possible to disable checking for unique constraints.
230
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
231 232 233 234
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

235 236 237 238 239 240 241 242 243
"Commands (DDL)","ALTER TABLE ALTER","
ALTER TABLE tableName ALTER COLUMN columnName
{ { dataType [ DEFAULT expression ] [ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] }
    | { RENAME TO name }
    | { RESTART WITH long }
    | { SELECTIVITY int }
    | { SET DEFAULT expression }
    | { SET NULL }
    | { SET NOT NULL } }
Thomas Mueller's avatar
Thomas Mueller committed
244
","
245 246
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
247

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

250 251 252
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
253

254 255 256 257
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
258

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

261
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
262
Single column indexes on this column are dropped.
263 264 265

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

266
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
267
","
268 269 270 271 272 273 274
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;
Thomas Mueller's avatar
Thomas Mueller committed
275 276 277 278 279 280
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
ALTER TABLE tableName DROP COLUMN columnName
","
Removes a column from a table.
281
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
282 283 284 285 286
","
ALTER TABLE TEST DROP COLUMN NAME
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
287
ALTER TABLE tableName DROP { CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
288 289
","
Removes a constraint or a primary key from a table.
290
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
291 292 293 294 295 296
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
ALTER TABLE tableName SET REFERENTIAL_INTEGRITY
297
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
298 299 300 301 302 303
","
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.
304 305

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
306 307 308 309 310 311 312
","
ALTER TABLE TEST SET REFERENTIAL_INTEGRITY FALSE
"

"Commands (DDL)","ALTER TABLE RENAME","
ALTER TABLE tableName RENAME TO newName
","
Thomas Mueller's avatar
Thomas Mueller committed
313 314
Renames a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
315 316 317 318 319
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
320
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
321
","
Thomas Mueller's avatar
Thomas Mueller committed
322 323 324 325
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.
326
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
327 328 329 330 331 332 333
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
334 335 336 337
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
338
Admin rights are required to execute this command.
339
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
340 341 342 343 344
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
345
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
346
","
Thomas Mueller's avatar
Thomas Mueller committed
347 348 349 350 351 352
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.
353
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
354 355 356 357 358 359 360 361
","
ALTER USER SA SET PASSWORD 'rioyxlgt'
"

"Commands (DDL)","ALTER VIEW","
ALTER VIEW viewName RECOMPILE
","
Recompiles a view after the underlying tables have been changed or created.
Thomas Mueller's avatar
Thomas Mueller committed
362
This command is used for views created using CREATE FORCE VIEW.
363
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
364 365 366 367 368
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
369
ANALYZE [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
370 371 372 373 374 375 376
","
Updates the selectivity statistics of all tables. The selectivity is used by the
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.
377 378

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
379 380 381 382 383
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
384 385 386 387 388
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
389
","
Thomas Mueller's avatar
Thomas Mueller committed
390 391 392
Sets the comment of a database object. Use NULL to remove the comment.

Admin rights are required to execute this command.
393
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
394 395 396 397 398
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
399
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
400 401 402
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
403
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
404 405

Admin rights are required to execute this command.
406
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
407 408 409 410 411
","
CREATE AGGREGATE MEDIAN FOR ""com.acme.db.Median""
"

"Commands (DDL)","CREATE ALIAS","
412
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
413
{ FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
414
","
415 416 417 418 419
Creates a new function alias. Deterministic functions must always return the
same value for the same parameters. The result of such functions is cached if possible.

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

425 426
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.
427 428
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
429 430
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
431

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

435
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
436 437 438
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.
439

Thomas Mueller's avatar
Thomas Mueller committed
440
Admin rights are required to execute this command.
441
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
442 443 444 445 446
","
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');
447 448
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
Thomas Mueller's avatar
Thomas Mueller committed
449 450 451
"

"Commands (DDL)","CREATE CONSTANT","
452
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
453
","
Thomas Mueller's avatar
Thomas Mueller committed
454 455
Creates a new constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
456 457 458 459 460
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
461 462 463
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
464 465
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
466
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
467
to the value being tested.
468

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

471
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
472 473 474 475 476
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
477 478 479
CREATE { [ UNIQUE ] [ HASH ] INDEX [ IF NOT EXISTS ] newIndexName
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
480
","
Thomas Mueller's avatar
Thomas Mueller committed
481 482
Creates a new index.
This command commits an open transaction.
483

Thomas Mueller's avatar
Thomas Mueller committed
484
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
485 486
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
487
Non-unique keys are supported.
Thomas Mueller's avatar
Thomas Mueller committed
488 489 490 491 492
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
493 494 495
CREATE [ [ GLOBAL | LOCAL ] TEMPORARY ] LINKED TABLE [ IF NOT EXISTS ]
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
496 497 498 499 500 501 502 503
","
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.

Usually, for update statements, the old rows are deleted first and then the new
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
504
work. Linked tables to the same database share one connection.
505

Thomas Mueller's avatar
Thomas Mueller committed
506 507 508
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).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
516
Admin rights are required to execute this command.
517
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
518 519 520 521 522 523 524 525 526
","
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","
527
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
528
","
Thomas Mueller's avatar
Thomas Mueller committed
529 530
Creates a new role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
531 532 533 534 535
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
536
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
Thomas Mueller's avatar
Thomas Mueller committed
537 538 539
","
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
540
Specifying the owner currently has no effect.
541 542

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
543 544 545 546 547
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
548 549
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
[ INCREMENT BY long ] [ CACHE long ]
Thomas Mueller's avatar
Thomas Mueller committed
550 551 552 553 554
","
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. 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.
Thomas Mueller's avatar
Thomas Mueller committed
555 556

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
557 558 559 560 561
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
562 563 564
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
{ { ( { columnDefinition | constraint } [,...] ) [ AS select ] }
Thomas Mueller's avatar
Thomas Mueller committed
565
    | { AS select } }
Thomas Mueller's avatar
Thomas Mueller committed
566
[ ENGINE tableEngineName ] [ NOT PERSISTENT ] [ TRANSACTIONAL ]
Thomas Mueller's avatar
Thomas Mueller committed
567 568 569
","
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
570 571 572 573
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
574
that means memory tables should not get too large.
575

Thomas Mueller's avatar
Thomas Mueller committed
576 577 578 579 580
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,
581
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
582

583
The ENGINE option is only required when custom table implementations are used.
584
The table engine class must implement the interface ""org.h2.api.TableEngine"".
585

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

Thomas Mueller's avatar
Thomas Mueller committed
589 590
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
591 592 593 594 595
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
596
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
597
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
598
[ QUEUE int ] [ NOWAIT ] CALL triggeredClassName
Thomas Mueller's avatar
Thomas Mueller committed
599
","
Thomas Mueller's avatar
Thomas Mueller committed
600 601
Creates a new trigger. The trigger class must be public. Inner classes are not supported.
The class must be available in the classpath of the
602 603
database engine (when using the server mode, it must be in the classpath of the server).

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

609
Only row based AFTER trigger can be called on rollback.
610 611
Exceptions that occur within such triggers are ignored.

612
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
613
Only the first such trigger is called. Such triggers on views are supported.
614
They can be used to make views updatable.
615

616 617 618 619
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
620 621 622 623
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

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.
624 625

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
626 627 628 629
","
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger""
"
"Commands (DDL)","CREATE USER","
630 631
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
632
","
Thomas Mueller's avatar
Thomas Mueller committed
633 634 635
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.
636

Thomas Mueller's avatar
Thomas Mueller committed
637
Admin rights are required to execute this command.
638
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
639 640 641 642 643
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
644
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
645
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
646 647
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
648
if the underlying table(s) don't exist.
649

Thomas Mueller's avatar
Thomas Mueller committed
650 651 652 653 654
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.

655 656
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
657
Admin rights are required to execute this command.
658
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
659 660 661 662 663
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
664
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
665
","
Thomas Mueller's avatar
Thomas Mueller committed
666 667 668
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
669
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
670 671 672 673 674
","
CREATE AGGREGATE MEDIAN
"

"Commands (DDL)","DROP ALIAS","
675
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
676
","
Thomas Mueller's avatar
Thomas Mueller committed
677 678 679
Drops an existing function alias.

Admin rights are required to execute this command.
680
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
681 682 683 684 685
","
CREATE ALIAS MY_SQRT
"

"Commands (DDL)","DROP ALL OBJECTS","
686
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
687 688 689 690 691
","
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
692 693 694
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
695 696 697 698 699
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
700
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
701
","
Thomas Mueller's avatar
Thomas Mueller committed
702 703
Drops a constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
704 705 706 707 708
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
709
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
710
","
Thomas Mueller's avatar
Thomas Mueller committed
711 712
Drops a data type (domain).
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
713 714 715 716 717
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
718
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
719
","
Thomas Mueller's avatar
Thomas Mueller committed
720 721
Drops an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
722 723 724 725 726
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
727
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
728
","
Thomas Mueller's avatar
Thomas Mueller committed
729 730
Drops a role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
731 732 733 734 735
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
736
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
737
","
Thomas Mueller's avatar
Thomas Mueller committed
738 739
Drops a schema.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
740 741 742 743 744
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
745
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
746
","
Thomas Mueller's avatar
Thomas Mueller committed
747 748
Drops a sequence.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
749 750 751 752 753
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
754
DROP TABLE [ IF EXISTS ] tableName [,...] [ CASCADE | RESTRICT ]
Thomas Mueller's avatar
Thomas Mueller committed
755
","
Thomas Mueller's avatar
Thomas Mueller committed
756 757 758
Drops an existing table, or a list of tables.
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.
759
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
760 761 762 763 764
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
765
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
766
","
Thomas Mueller's avatar
Thomas Mueller committed
767 768
Drops an existing trigger.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
769 770 771 772 773
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
774
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
775
","
Thomas Mueller's avatar
Thomas Mueller committed
776 777
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
778

Thomas Mueller's avatar
Thomas Mueller committed
779
Admin rights are required to execute this command.
780
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
781 782 783 784 785
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
786
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
787
","
Thomas Mueller's avatar
Thomas Mueller committed
788 789 790
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
791
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
792 793 794 795 796 797 798
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
799 800 801 802 803
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).
804
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
805 806

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
807 808 809 810 811 812 813
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
814
Flushes the data to disk and switches to a new transaction log if possible.
Thomas Mueller's avatar
Thomas Mueller committed
815 816

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
817 818 819 820 821 822 823
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
824
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
825 826 827
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
828 829 830 831 832
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
833
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
834 835 836 837 838 839 840 841 842
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
843 844 845 846
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
847 848 849 850 851
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
852 853
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
854
","
Thomas Mueller's avatar
Thomas Mueller committed
855 856 857 858
Grants rights for a table to a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
859 860 861 862 863
","
GRANT SELECT ON TEST TO READONLY
"

"Commands (Other)","GRANT ROLE","
864
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
865
","
Thomas Mueller's avatar
Thomas Mueller committed
866 867 868 869
Grants a role to a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
870 871 872 873 874
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
875
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
876 877 878 879 880 881 882 883 884
","
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
885 886
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
887 888 889 890 891
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
892 893
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
894
","
Thomas Mueller's avatar
Thomas Mueller committed
895 896 897 898
Removes rights for a table from a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
899 900 901 902 903
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
904
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
905
","
Thomas Mueller's avatar
Thomas Mueller committed
906 907 908 909
Removes a role from a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
910 911 912 913 914
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
915
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
916 917 918 919 920 921 922 923 924 925
","
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
926 927 928 929
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
930 931 932 933 934 935 936
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
937 938
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
939 940 941 942 943
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
944
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
945
","
Thomas Mueller's avatar
Thomas Mueller committed
946 947
Updates a user-defined variable.
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
948 949 950 951 952
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
953
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
954 955 956 957 958 959 960 961 962 963
","
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
964 965 966 967 968
See also CREATE CONSTANT.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
969
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
970 971 972 973 974
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
975
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
976 977
","
Switches auto commit on or off.
978
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
979
however this will not work as expected when using a connection pool
980 981
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
982
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
983 984 985 986 987 988 989
","
SET AUTOCOMMIT OFF
"

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
990 991
Sets the size of the cache in KB (each KB being 1024 bytes) for the current database.
The default value is 16384 (16 MB). The value is rounded to the next higher power of two.
Thomas Mueller's avatar
Thomas Mueller committed
992 993
Depending on the virtual machine, the actual memory required may be higher.

Thomas Mueller's avatar
Thomas Mueller committed
994
This setting is persistent and affects all connections as there is only one cache per database.
Thomas Mueller's avatar
Thomas Mueller committed
995
Using a very small value (specially 0) will reduce performance a lot.
996
This setting only affects the database engine (the server in a client/server environment).
Thomas Mueller's avatar
Thomas Mueller committed
997
It has no effect for in-memory databases.
998

Thomas Mueller's avatar
Thomas Mueller committed
999 1000 1001
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
1002
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
","
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
1015 1016
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1017
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1018 1019 1020 1021 1022
","
SET CLUSTER ''
"

"Commands (Other)","SET COLLATION","
1023 1024
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1025
","
Thomas Mueller's avatar
Thomas Mueller committed
1026 1027 1028
Sets the collation used for comparing strings.
This command can only be executed if there are no tables defined.
See ""java.text.Collator"" for details about the supported collations and the STRENGTH.
Thomas Mueller's avatar
Thomas Mueller committed
1029

1030 1031 1032 1033 1034 1035
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
1036 1037 1038
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1039 1040 1041 1042 1043
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1044
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1045 1046 1047
","
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
1048 1049 1050 1051

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1052 1053 1054 1055 1056 1057 1058 1059
","
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
1060 1061 1062 1063
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).
1064
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
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. 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
Thomas Mueller's avatar
Thomas Mueller committed
1079 1080 1081 1082 1083
closed immediately, even if a delay is set.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
1084
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1085 1086 1087 1088 1089 1090 1091 1092
","
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
1093 1094 1095 1096 1097
for the new sessions. The default value for this setting is 1000 (one second).

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1098 1099 1100 1101 1102
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1103
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1104 1105 1106
","
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
1107
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1108
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1109

Thomas Mueller's avatar
Thomas Mueller committed
1110 1111 1112
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1113
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1114 1115 1116 1117 1118
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1119
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1120
","
Thomas Mueller's avatar
Thomas Mueller committed
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
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
1131 1132 1133

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1134
","
Thomas Mueller's avatar
Thomas Mueller committed
1135
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1136 1137 1138
"

"Commands (Other)","SET IGNORECASE","
1139
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1140 1141 1142 1143 1144 1145
","
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
1146 1147 1148
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1149 1150 1151 1152
","
SET IGNORECASE TRUE
"

1153
"Commands (Other)","SET LOG","
1154
SET LOG int
1155 1156 1157 1158
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1159
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1160 1161 1162 1163
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.

1164 1165
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
1166 1167
against power failure is required, but the data must be protected against killing the process.

1168 1169
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
1170 1171 1172 1173 1174
file system, this will also protect against power failure in the majority if cases.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is not persistent.
1175
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1176 1177 1178 1179
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1180 1181 1182 1183
"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
1184
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197

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
1198 1199 1200
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
1201
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1202 1203 1204 1205 1206 1207 1208 1209
","
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
1210 1211 1212
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1213
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1214 1215 1216 1217 1218 1219 1220 1221 1222
","
SET LOCK_TIMEOUT 1000
"

"Commands (Other)","SET MAX_LENGTH_INPLACE_LOB","
SET MAX_LENGTH_INPLACE_LOB int
","
Sets the maximum size of an in-place LOB object. LOB objects larger that this
size are stored in a separate file, otherwise stored directly in the database
Thomas Mueller's avatar
Thomas Mueller committed
1223
(in-place). The default max size is 1024.
Thomas Mueller's avatar
Thomas Mueller committed
1224
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1225 1226 1227 1228

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1229 1230 1231 1232 1233 1234 1235
","
SET MAX_LENGTH_INPLACE_LOB 128
"

"Commands (Other)","SET MAX_LOG_SIZE","
SET MAX_LOG_SIZE int
","
Thomas Mueller's avatar
Thomas Mueller committed
1236 1237
Sets the maximum size of the transaction log, in megabytes. If the log exceeds the
limit, a new stream is created. Old streams (that are not used for recovery) are
Thomas Mueller's avatar
Thomas Mueller committed
1238
freed automatically. The default max size is 16 MB.
Thomas Mueller's avatar
Thomas Mueller committed
1239
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1240 1241 1242 1243

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1244 1245 1246 1247 1248 1249 1250 1251
","
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
Thomas Mueller's avatar
Thomas Mueller committed
1252 1253 1254 1255 1256
are read, then the rows are buffered to disk. The default value is 10000.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1257
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1258 1259 1260 1261 1262 1263 1264
","
SET MAX_MEMORY_ROWS 1000
"

"Commands (Other)","SET MAX_MEMORY_UNDO","
SET MAX_MEMORY_UNDO int
","
1265
The maximum number of undo records per a session that are kept in-memory.
Thomas Mueller's avatar
Thomas Mueller committed
1266 1267
If a transaction is larger, the records are buffered to disk.
The default value is 50000.
Thomas Mueller's avatar
Thomas Mueller committed
1268
Changes to tables without a primary key can not be buffered to disk.
Thomas Mueller's avatar
Thomas Mueller committed
1269 1270 1271 1272 1273
This setting is not supported when using multi-version concurrency.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1274
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1275 1276 1277 1278 1279 1280 1281 1282 1283
","
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
1284 1285 1286 1287
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1288
It has no effect for in-memory databases.
1289
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1290 1291 1292 1293 1294
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1295
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1296 1297
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1298 1299 1300 1301 1302
Modes in the feature section.

This setting is not persistent.
Admin rights are required to execute this command.
This command commits an open transaction.
1303
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1304 1305 1306 1307 1308
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1309
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1310 1311 1312
","
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
1313 1314 1315 1316 1317 1318 1319
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.

Admin rights are required to execute this command.
This command commits an open transaction.
1320
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1321 1322 1323 1324 1325
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1326
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1327 1328 1329
","
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
1330 1331 1332 1333
the tables was changed. This option is enabled by default.

Admin rights are required to execute this command.
This command commits an open transaction.
1334
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1335 1336 1337 1338 1339 1340 1341 1342 1343
","
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
1344 1345

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1346 1347 1348 1349 1350 1351 1352 1353 1354
","
SET PASSWORD 'abcstzri!.5'
"

"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
1355 1356 1357
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
1358 1359 1360 1361 1362
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1363
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1364 1365 1366
","
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
1367 1368 1369 1370 1371
for one table.

This setting is not persistent.
This command commits an open transaction.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1372 1373 1374 1375 1376 1377 1378 1379 1380
","
SET REFERENTIAL_INTEGRITY FALSE
"

"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
1381 1382

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1383 1384 1385 1386 1387 1388 1389 1390 1391
","
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
1392 1393 1394
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1395
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1396 1397 1398 1399 1400 1401 1402 1403 1404
","
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
1405 1406 1407
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1408
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1409 1410 1411 1412 1413 1414 1415 1416 1417
","
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
1418 1419 1420
disabled).

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

"Commands (Other)","SET TRACE_LEVEL","
1427
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1428 1429 1430
","
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.
1431
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1432

Thomas Mueller's avatar
Thomas Mueller committed
1433 1434 1435
This setting is not persistent.
Admin rights are required to execute this command.
This command does not commit a transaction, and rollback does not affect it.
1436
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
","
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
1448 1449 1450
This setting is persistent.
Admin rights are required to execute this command.
This command commits an open transaction.
1451
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
","
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
1462 1463

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1464 1465 1466 1467 1468 1469 1470 1471
","
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
1472 1473 1474 1475
This setting is persistent. The default is 500 ms.

Admin rights are required to execute this command.
This command commits an open transaction.
1476
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1477 1478 1479 1480 1481
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1482
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1483
","
1484 1485
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
1486
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1487

1488 1489
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
1490 1491 1492

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,
Thomas Mueller's avatar
Thomas Mueller committed
1493
but only for at most the time defined by the database setting ""h2.maxCompactTime"" (see there).
Thomas Mueller's avatar
Thomas Mueller committed
1494 1495

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1499
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1500
","
1501
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1502 1503
"

1504 1505
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1506
","
1507
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1508
","
1509
A
Thomas Mueller's avatar
Thomas Mueller committed
1510 1511
"

1512 1513
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1514
","
1515
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1516
","
1517
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1518 1519
"

1520
"Other Grammar","Array","
1521
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1522
","
1523 1524
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
1525
","
1526
(1, 2)
1527 1528
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1529 1530
"

1531 1532
"Other Grammar","Boolean","
TRUE | FALSE
1533
","
1534
A boolean value.
1535
","
1536
TRUE
1537 1538
"

1539 1540
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1541
","
1542
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1543
","
1544
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1545 1546
"

1547 1548 1549
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1550
","
1551 1552
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
1553
","
1554
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1555 1556
"

1557 1558 1559
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1560
","
1561 1562
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1563
","
1564 1565 1566 1567 1568 1569
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
{ AES | XTEA }
","
Thomas Mueller's avatar
Thomas Mueller committed
1570
Two algorithms are supported: AES (""AES-128"") and XTEA (using 32 rounds).
1571
XTEA is a bit faster than AES in some environments, but AES is more secure.
1572 1573
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1574 1575
"

1576
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1577 1578
columnName dataType
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1579
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1580 1581
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1582 1583
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1584
The computed column expression is evaluated and assigned whenever the row changes.
1585 1586 1587 1588 1589

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
1590 1591 1592
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);
1593 1594
"

1595 1596
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1597
","
1598 1599 1600
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
1601
","
1602
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1603 1604
"

1605 1606
"Other Grammar","Compare","
<> | <= | >= | = | < | > | !=
Thomas Mueller's avatar
Thomas Mueller committed
1607
","
1608
Comparison operator. The operator != is the same as <>.
Thomas Mueller's avatar
Thomas Mueller committed
1609
","
1610
<>
Thomas Mueller's avatar
Thomas Mueller committed
1611 1612 1613
"

"Other Grammar","Condition","
1614
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1615 1616 1617 1618 1619 1620 1621
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1622 1623
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1624
    | IS [ NOT ] [ DISTINCT FROM ] operand
1625 1626 1627 1628
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1629
","
Thomas Mueller's avatar
Thomas Mueller committed
1630
The right hand side of a condition.
1631

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

Thomas Mueller's avatar
Thomas Mueller committed
1635 1636 1637 1638 1639
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).
1640 1641 1642
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.
1643

Thomas Mueller's avatar
Thomas Mueller committed
1644
When comparing with REGEXP, regular expression matching is used.
1645
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1646 1647 1648 1649
","
LIKE 'Jo%'
"

1650 1651 1652 1653 1654
"Other Grammar","Constraint","
[ constraintNameDefinition ] {
    CHECK expression | UNIQUE ( columnName [,...] )
    | referentialConstraint }
    | PRIMARY KEY [ HASH ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
1655
","
Thomas Mueller's avatar
Thomas Mueller committed
1656 1657
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1658
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1659 1660
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
1661
","
1662
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1663 1664
"

1665 1666
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1667
","
1668
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1669
","
1670
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1671 1672
"

1673 1674
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1675
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1676
","
1677
Optional parameters for CSVREAD and CSVWRITE.
1678 1679
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
1680 1681
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1682
The following options are supported:
Thomas Mueller's avatar
Thomas Mueller committed
1683 1684 1685
""charset"", ""escape"", ""fieldDelimiter"", ""fieldSeparator"",
""lineComment"" (""#"" for H2 version 1.2, disabled for H2 version 1.3),
""lineSeparator"", ""null"", ""rowSeparator"" (not set by default).
Thomas Mueller's avatar
Thomas Mueller committed
1686
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1687 1688
A space needs to be escaped with a backslash (""'\ '"").
A backslash needs to be escaped with another backslash (""'\\'"").
Thomas Mueller's avatar
Thomas Mueller committed
1689
","
1690
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1691 1692
"

1693 1694 1695 1696 1697
"Other Grammar","Data Type","
intType | booleanType | tinyintType | smallintType | bigintType | identityType
    | decimalType | doubleType | realType | dateType | timeType | timestampType
    | binaryType | otherType | varcharType | varcharIgnorecaseType | charType
    | blobType | clobType | uuidType | arrayType
Thomas Mueller's avatar
Thomas Mueller committed
1698
","
1699
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1700
","
1701
INT
Thomas Mueller's avatar
Thomas Mueller committed
1702 1703
"

1704 1705
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1706
","
1707
A date literal. The limitations are the same as for the Java data type
1708
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1709
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1710
","
1711
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1712 1713
"

1714
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
1715
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
1716
","
Thomas Mueller's avatar
Thomas Mueller committed
1717 1718 1719 1720 1721 1722
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)"".
1723
","
Thomas Mueller's avatar
Thomas Mueller committed
1724 1725 1726
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
1727 1728
"

1729 1730
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1731
","
1732
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1733
","
1734
0
Thomas Mueller's avatar
Thomas Mueller committed
1735 1736
"

1737 1738
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1739
","
1740 1741 1742
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
1743
","
1744
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1745 1746
"

1747 1748
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1749
","
1750
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1751
","
1752
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1753 1754
"

1755
"Other Grammar","Factor","
1756
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1757
","
1758
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1759
","
1760
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1761 1762
"

1763 1764
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1765
","
1766 1767
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1768
","
1769
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1770 1771
"

1772 1773
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1774
","
1775
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1776
","
1777
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1778 1779
"

1780 1781
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1782
","
1783 1784 1785
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
1786
","
1787
NAME
Thomas Mueller's avatar
Thomas Mueller committed
1788 1789 1790
"

"Other Grammar","Int","
1791
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1792 1793 1794 1795 1796 1797 1798
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
1799
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1800 1801 1802 1803 1804 1805
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

1806 1807
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
1808
","
1809
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
1810
","
1811
TEST
Thomas Mueller's avatar
Thomas Mueller committed
1812 1813
"

1814 1815
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1816
","
1817
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
1818
","
1819
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1820 1821
"

1822 1823 1824 1825 1826 1827 1828 1829
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
1830
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
1831
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
1832
","
Thomas Mueller's avatar
Thomas Mueller committed
1833
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
1834 1835 1836 1837 1838 1839 1840
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
"

1841 1842
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1843
","
1844
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
1845
","
1846
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
1847 1848
"

1849 1850
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1851
","
1852 1853 1854
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
1855
","
1856
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
1857 1858
"

1859 1860
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
1861
","
1862 1863 1864
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
1865
","
1866
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
1867 1868
"

1869 1870 1871
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
1872
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
1873
","
Thomas Mueller's avatar
Thomas Mueller committed
1874 1875 1876
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
1877 1878 1879
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
1880
","
1881
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
1882 1883
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1895 1896 1897 1898 1899 1900 1901 1902 1903
"Other Grammar","Script Compression","
COMPRESSION { DEFLATE | LZF | ZIP | GZIP }
","
The compression algorithm to use for script files.
LZF is faster but uses more space.
","
COMPRESSION LZF
"

1904 1905
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
1906
","
1907
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
1908
","
1909
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
1910 1911
"

1912 1913
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
1914
","
1915 1916
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
1917
","
1918
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
1919 1920
"

1921 1922
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1923
","
Thomas Mueller's avatar
Thomas Mueller committed
1924
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
1925

Thomas Mueller's avatar
Thomas Mueller committed
1926
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
1927
","
1928
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
1929 1930
"

1931
"Other Grammar","Table Expression","
1932
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
1933 1934
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1935
","
1936 1937 1938
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
1939
","
1940
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
1941 1942
"

1943 1944 1945 1946 1947 1948 1949 1950 1951
"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;
"

1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
Thomas Mueller's avatar
Thomas Mueller committed
1964
","
1965
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
1966
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
1967
","
1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
'Hello'
"

"Other Grammar","Time","
TIME 'hh:mm:ss'
","
A time literal.
","
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
1983
""java.sql.Timestamp"", but for compatibility with other databases the suggested
1984 1985 1986 1987 1988 1989
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
1990
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
1991
","
Thomas Mueller's avatar
Thomas Mueller committed
1992
A literal value of any data type, or null.
1993 1994
","
10
Thomas Mueller's avatar
Thomas Mueller committed
1995 1996 1997 1998 1999 2000 2001
"

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

2002
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2003 2004 2005 2006 2007 2008 2009 2010 2011
","
INT
"

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

2012
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2013 2014 2015 2016 2017 2018 2019 2020 2021
","
BOOLEAN
"

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

2022
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2023 2024 2025 2026 2027 2028 2029 2030 2031
","
TINYINT
"

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

2032
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2033 2034 2035 2036 2037 2038 2039 2040 2041
","
SMALLINT
"

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

2042
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
","
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.

2054
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2055 2056 2057 2058 2059
","
IDENTITY
"

"Data Types","DECIMAL Type","
2060
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2061 2062 2063 2064
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2065
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2066 2067 2068 2069 2070
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2071
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT4 | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2072
","
Thomas Mueller's avatar
Thomas Mueller committed
2073
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2074 2075
of rounding problems.

2076
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2077 2078 2079 2080 2081 2082 2083
","
DOUBLE
"

"Data Types","REAL Type","
REAL
","
Thomas Mueller's avatar
Thomas Mueller committed
2084
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2085 2086
values, because of rounding problems.

2087
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2088 2089 2090 2091 2092 2093 2094
","
REAL
"

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

2097
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
2098 2099 2100 2101 2102 2103 2104
","
TIME
"

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

2107
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2108
(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
2109 2110 2111 2112 2113
","
DATE
"

"Data Types","TIMESTAMP Type","
2114
{ TIMESTAMP | DATETIME | SMALLDATETIME }
Thomas Mueller's avatar
Thomas Mueller committed
2115
","
Thomas Mueller's avatar
Thomas Mueller committed
2116
The timestamp data type. The format is yyyy-MM-dd hh:mm:ss[.nnnnnnnnn].
Thomas Mueller's avatar
Thomas Mueller committed
2117

2118
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2119 2120 2121 2122 2123
","
TIMESTAMP
"

"Data Types","BINARY Type","
2124
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2125
","
2126 2127 2128 2129 2130
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
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141

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

"Data Types","OTHER Type","
OTHER
","
This type allows storing serialized Java objects. Internally, a byte array is
used. Serialization and deserialization is done on the client side only.
2142
Deserialization is only done get ""getObject"" is called. Java operations cannot be
Thomas Mueller's avatar
Thomas Mueller committed
2143
executed inside the database engine for security reasons. Use
2144
""PreparedStatement.setObject"" to store values.
Thomas Mueller's avatar
Thomas Mueller committed
2145

2146
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2147 2148 2149 2150 2151
","
OTHER
"

"Data Types","VARCHAR Type","
2152 2153
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2154
","
Thomas Mueller's avatar
Thomas Mueller committed
2155
Unicode String. Use two single quotes ('') to create a quote. The maximum precision
2156
is ""Integer.MAX_VALUE"". The precision is a size constraint; only the actual data is
2157
persisted. The whole text is kept in memory when using this data type. For large text data CLOB
Thomas Mueller's avatar
Thomas Mueller committed
2158 2159
should be used; see there for details.

2160
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2161 2162 2163 2164 2165
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2166
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2167 2168
","
Same as VARCHAR, but not case sensitive when comparing. Stored in mixed case.
2169
The maximum precision is ""Integer.MAX_VALUE"" characters, but the whole text is kept in
2170 2171
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
2172

2173
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2174 2175 2176 2177 2178
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2179
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2180 2181 2182 2183
","
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. Unicode String. Use two single quotes ('') to create a quote.
2184
The maximum precision is ""Integer.MAX_VALUE"". The precision is a size constraint;
2185 2186
only the actual data is persisted. The whole text is kept in 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
2187

2188
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2189 2190 2191 2192 2193
","
CHAR(10)
"

"Data Types","BLOB Type","
2194
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2195 2196 2197
","
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
2198
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2199 2200
Advanced / Large Objects.

2201
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2202 2203 2204 2205 2206
","
BLOB
"

"Data Types","CLOB Type","
2207
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2208 2209 2210 2211 2212
","
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
2213
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2214 2215 2216 2217 2218

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.

2219
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2220 2221 2222 2223 2224 2225 2226
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2227 2228 2229 2230
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
2231

Thomas Mueller's avatar
Thomas Mueller committed
2232
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2233 2234 2235 2236 2237 2238 2239
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
2240
An array of values. Use a value list (1, 2) or ""PreparedStatement.setObject(.., new Object[] {..})"" to store values.
Thomas Mueller's avatar
Thomas Mueller committed
2241

2242
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2243 2244 2245 2246 2247
","
ARRAY
"

"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2248
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2249
","
2250 2251
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2252
Aggregates are only allowed in select statements.
2253
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2254 2255 2256 2257 2258
","
AVG(X)
"

"Functions (Aggregate)","BOOL_AND","
2259
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2260
","
2261 2262 2263
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
2264 2265 2266 2267 2268
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2269
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2270
","
2271 2272 2273
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
2274 2275 2276 2277 2278
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2279
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2280
","
2281 2282 2283 2284
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
2285 2286 2287 2288 2289
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2290 2291
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2292
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2293
","
2294 2295 2296 2297 2298
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
2299 2300 2301 2302 2303
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2304
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2305
","
2306 2307 2308 2309
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
2310 2311 2312 2313 2314
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2315
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2316
","
2317 2318 2319 2320
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
2321 2322 2323 2324 2325
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2326
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2327
","
2328 2329 2330 2331
The sum of all values.
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
2332 2333 2334 2335 2336
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2337
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2338
","
2339 2340 2341 2342 2343
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
2344 2345 2346 2347 2348
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2349
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2350
","
2351 2352 2353
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
2354 2355 2356 2357 2358 2359
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2360
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2361
","
2362 2363 2364
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
2365 2366 2367 2368 2369 2370
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2371
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2372
","
2373 2374 2375 2376
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
2377 2378 2379 2380 2381
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2382
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2383
","
2384 2385 2386 2387
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
2388 2389 2390 2391 2392
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2393
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2394
","
2395 2396
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"".
2397
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2398 2399 2400 2401 2402
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2403
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2404
","
Thomas Mueller's avatar
Thomas Mueller committed
2405 2406
Calculate the arc cosine.
See also Java ""Math.acos"".
2407
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2408 2409 2410 2411 2412
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2413
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2414
","
Thomas Mueller's avatar
Thomas Mueller committed
2415 2416
Calculate the arc sine.
See also Java ""Math.asin"".
2417
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2418 2419 2420 2421 2422
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2423
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2424
","
Thomas Mueller's avatar
Thomas Mueller committed
2425 2426
Calculate the arc tangent.
See also Java ""Math.atan"".
2427
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2428 2429 2430 2431 2432
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2433
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2434
","
Thomas Mueller's avatar
Thomas Mueller committed
2435 2436
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2437
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2438 2439 2440 2441
","
COS(ANGLE)
"

2442
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2443
COSH(numeric)
2444 2445 2446 2447 2448 2449 2450 2451
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2452
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2453
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2454
","
Thomas Mueller's avatar
Thomas Mueller committed
2455
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2456
See also Java ""Math.*"" functions.
2457
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2458 2459 2460 2461 2462
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2463
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2464
","
Thomas Mueller's avatar
Thomas Mueller committed
2465 2466
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2467
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2468 2469 2470 2471
","
SIN(ANGLE)
"

2472
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2473
SINH(numeric)
2474 2475 2476 2477 2478 2479 2480 2481
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2482
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2483
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2484
","
Thomas Mueller's avatar
Thomas Mueller committed
2485 2486
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2487
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2488 2489 2490 2491
","
TAN(ANGLE)
"

2492
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2493
TANH(numeric)
2494 2495 2496 2497 2498 2499 2500 2501
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2502
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2503
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2504
","
Thomas Mueller's avatar
Thomas Mueller committed
2505
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2506
See also Java ""Math.atan2"".
2507
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2508 2509 2510 2511 2512
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2513
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2514
","
2515 2516
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2517 2518 2519 2520 2521 2522
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2523
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2524
","
2525 2526
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2527 2528 2529 2530 2531 2532
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2533
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2534
","
2535 2536
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2537 2538 2539 2540 2541 2542
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2543
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2544
","
2545 2546
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2547 2548 2549 2550 2551 2552
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2553
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2554
","
2555
See also Java ""Math.ceil"".
2556
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2557
","
2558
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2559 2560 2561
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2562
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2563
","
2564
See also Java ""Math.toDegrees"".
2565
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2566 2567 2568 2569 2570
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2571
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2572
","
2573
See also Java ""Math.exp"".
2574
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2575 2576 2577 2578 2579
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
2580
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2581
","
2582
See also Java ""Math.floor"".
2583
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2584 2585 2586 2587 2588
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2589
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2590
","
2591
See also Java ""Math.log"".
2592
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2593 2594 2595 2596 2597
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
2598
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2599
","
2600
See also Java ""Math.log10"" (in Java 5).
2601
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2602 2603 2604 2605 2606
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
2607
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2608
","
2609
See also Java ""Math.toRadians"".
2610
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2611 2612 2613 2614 2615
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
2616
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2617
","
2618
See also Java ""Math.sqrt"".
2619
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2620 2621 2622 2623 2624
","
SQRT(A)
"

"Functions (Numeric)","PI","
2625
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2626
","
2627
See also Java ""Math.PI"".
2628
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2629 2630 2631 2632 2633
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
2634
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2635
","
2636
See also Java ""Math.pow"".
2637
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2638 2639 2640 2641 2642
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2643
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2644 2645 2646
","
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
2647
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2648 2649 2650 2651 2652
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2653
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2654 2655 2656 2657 2658 2659 2660
","
Returns a new UUID with 122 pseudo random bits.
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
Thomas Mueller's avatar
Thomas Mueller committed
2661
ROUND(numeric, digitsInt)
Thomas Mueller's avatar
Thomas Mueller committed
2662 2663
","
Rounds to a number of digits.
2664
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2665 2666 2667 2668 2669
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
2670
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2671
","
2672 2673 2674 2675 2676 2677
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
2678 2679 2680 2681 2682
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2683
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2684 2685
","
Generates a number of cryptographically secure random numbers.
2686
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2687 2688 2689 2690 2691
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
2692
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2693 2694 2695 2696 2697 2698 2699
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2700
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2701
","
2702 2703 2704 2705
Encrypts data using a key.
Supported algorithms are XTEA and AES.
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2706 2707 2708 2709 2710
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2711
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2712
","
2713 2714 2715 2716
Decrypts data using a key.
Supported algorithms are XTEA and AES.
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2717 2718 2719 2720 2721 2722
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2723
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2724
","
2725 2726 2727
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
2728 2729 2730 2731 2732
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
Thomas Mueller's avatar
Thomas Mueller committed
2733
TRUNCATE(numeric, digitsInt)
Thomas Mueller's avatar
Thomas Mueller committed
2734 2735
","
Truncates to a number of digits (to the next value closer to 0).
2736
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2737 2738 2739 2740 2741
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
2742
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
2743
","
2744 2745 2746 2747
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
2748 2749 2750 2751 2752
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
2753
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2754 2755
","
Expands data that was compressed using the COMPRESS function.
2756
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2757 2758 2759 2760 2761
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
2762
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
2763 2764 2765 2766 2767 2768 2769
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
2770
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
2771 2772
","
Returns the ASCII value of the first character in the string.
2773
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2774 2775 2776 2777
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
2778
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2779
","
2780 2781 2782
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
2783 2784 2785 2786 2787
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
2788
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2789
","
2790 2791 2792
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
2793 2794 2795 2796 2797
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
2798
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2799
","
2800 2801 2802 2803
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
2804 2805 2806 2807 2808
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
2809
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
2810 2811
","
Returns the character that represents the ASCII value.
2812
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2813 2814 2815 2816 2817
","
CHAR(65)
"

"Functions (String)","CONCAT","
2818
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
2819 2820
","
Combines strings.
2821
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2822 2823 2824 2825 2826
","
CONCAT(NAME, '!')
"

"Functions (String)","DIFFERENCE","
2827
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
2828 2829
","
Returns the difference between the sounds of two strings.
2830
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2831 2832 2833 2834 2835
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
2836
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
2837
","
2838 2839
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
2840 2841 2842 2843 2844
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
2845
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2846
","
2847 2848 2849
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
2850 2851 2852 2853 2854
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
2855
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2856
","
2857
Returns the location of a search string in a string.
2858 2859 2860
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
2861 2862 2863 2864 2865
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
2866
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
2867
","
2868 2869 2870
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
2871 2872 2873 2874 2875
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
2876
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2877 2878 2879 2880 2881 2882 2883
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
2884
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2885 2886 2887 2888 2889 2890 2891
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
2892
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2893 2894 2895 2896 2897 2898 2899
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
2900
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2901 2902 2903 2904 2905 2906 2907
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
2908
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2909
","
2910 2911 2912 2913
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
2914 2915 2916 2917 2918
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
2919
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
2920 2921 2922 2923 2924 2925 2926
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
2927
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2928
","
2929 2930 2931
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
2932 2933 2934 2935 2936
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
2937
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2938
","
2939 2940 2941
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
2942 2943 2944 2945 2946
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
2947
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2948 2949 2950 2951 2952 2953 2954
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
2955
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2956 2957 2958 2959 2960 2961 2962
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
2963
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
2964
","
2965 2966
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
2967 2968 2969 2970 2971
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
2972
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
2973
","
2974
Replaces each substring that matches a regular expression.
2975
For details, see the Java ""String.replaceAll()"" method.
2976
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
2977 2978 2979 2980 2981
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
2982
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2983 2984 2985 2986 2987 2988 2989
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
2990
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
2991
","
2992 2993
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.
2994
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
2995 2996 2997 2998 2999
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3000
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3001
","
3002 3003 3004
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
3005 3006 3007 3008 3009
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3010
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3011 3012 3013 3014 3015 3016 3017
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3018
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3019
","
3020 3021 3022
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
3023 3024 3025 3026 3027
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3028
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3029
","
3030 3031 3032
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
3033 3034 3035 3036 3037
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3038
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3039 3040
","
Encodes a string to a byte array using the UTF8 encoding format.
3041
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3042 3043 3044 3045 3046
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3047
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3048
","
3049 3050
Returns a substring of a string starting at a position.
The length is optional.
3051
Also supported is: ""SUBSTRING(string FROM start [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3052 3053 3054 3055 3056
","
SUBSTR(NAME, 1)
"

"Functions (String)","UTF8TOSTRING","
3057
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3058 3059 3060 3061 3062 3063 3064
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3065
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3066
","
3067
Creates an XML attribute element of the form ""name=value"".
3068 3069
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3070 3071 3072 3073 3074
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3075
XMLNODE(elementString [, attributesString [, contentString]])
Thomas Mueller's avatar
Thomas Mueller committed
3076 3077
","
Create an XML node element.
3078
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3079 3080 3081 3082 3083
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3084
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3085
","
3086
Creates an XML comment.
3087
Two dashes (""--"") are converted to ""- -"".
3088
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3089 3090 3091 3092 3093
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3094
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3095
","
3096
Creates an XML CDATA element.
3097
If the value contains ""]]>"", an XML text element is created instead.
3098
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3099 3100 3101 3102 3103
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3104
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3105
","
3106
The string ""<?xml version='1.0'?>"" is returned.
Thomas Mueller's avatar
Thomas Mueller committed
3107 3108 3109 3110 3111
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3112
XMLTEXT(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3113 3114
","
Creates an XML text element.
3115
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3116 3117 3118 3119 3120
","
CALL XMLTEXT('test')
"

"Functions (Time and Date)","CURRENT_DATE","
3121
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3122 3123
","
Returns the current date.
3124
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3125 3126 3127 3128 3129
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3130
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3131 3132
","
Returns the current time.
3133
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3134 3135 3136 3137 3138
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3139
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3140
","
3141 3142
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3143
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3144 3145 3146 3147 3148
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3149
{ DATEADD| TIMESTAMPADD } (unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3150
","
3151 3152 3153 3154
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
The same units as in the EXTRACT function are supported.
This method returns a timestamp.
Thomas Mueller's avatar
Thomas Mueller committed
3155 3156 3157 3158 3159
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3160
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3161
","
Thomas Mueller's avatar
Thomas Mueller committed
3162
Returns the the number of crossed unit boundaries between two timestamps.
3163 3164
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3165 3166 3167 3168 3169 3170
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3171
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3172 3173 3174 3175 3176 3177 3178
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3179
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3180 3181 3182 3183 3184 3185 3186
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3187
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3188 3189 3190 3191 3192 3193 3194
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3195
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3196 3197 3198 3199 3200 3201 3202
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3203 3204
EXTRACT ( { YEAR | YY | MONTH | MM | DAY | DD | DAY_OF_YEAR
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3205
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3206 3207
","
Returns a specific value from a timestamps.
3208
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3209 3210 3211 3212 3213
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3214
FORMATDATETIME ( timestamp, formatString
3215
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3216
","
3217 3218 3219
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.
3220
For details of the format, see ""java.text.SimpleDateFormat"".
3221
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3222 3223 3224 3225 3226 3227
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3228
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3229 3230 3231 3232 3233 3234 3235
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3236
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3237 3238 3239 3240 3241 3242 3243
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3244
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3245 3246 3247 3248 3249 3250 3251
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3252
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3253 3254 3255 3256 3257 3258 3259
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3260
PARSEDATETIME(string, formatString
3261
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3262
","
3263 3264 3265
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.
3266
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3267 3268 3269 3270 3271 3272
","
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","
3273
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3274 3275 3276 3277 3278 3279 3280
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3281
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3282 3283 3284 3285 3286 3287 3288
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3289
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3290
","
3291 3292
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3293 3294 3295 3296 3297
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3298
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3299 3300 3301 3302 3303 3304 3305
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3306
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3307 3308
","
Returns one element of an array.
3309
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3310 3311 3312 3313 3314
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
3315
ARRAY_GET(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3316 3317 3318 3319 3320 3321 3322
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

"Functions (System)","AUTOCOMMIT","
3323
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3324 3325 3326 3327 3328 3329 3330
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3331
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3332
","
3333 3334 3335
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
3336 3337

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3338 3339 3340 3341 3342
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3343
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3344 3345
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3346
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3347 3348 3349 3350 3351
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3352
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3353
","
3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365
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
3366 3367 3368
"

"Functions (System)","COALESCE","
3369
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3370 3371 3372 3373 3374 3375 3376
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3377
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3378 3379 3380 3381 3382 3383 3384
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3385
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3386
","
3387 3388 3389 3390 3391
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
3392 3393 3394 3395 3396
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3397
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3398
","
3399 3400
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
3401 3402

If the column names are specified (a list of column names separated with the
3403
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3404 3405 3406 3407 3408
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
3409 3410 3411 3412 3413

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.

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3418
Instead of a file, an URL may be used, for example
3419 3420
""jar:file:///c:/temp/example.zip!/org/example/nested.csv"".
To read a stream from the classpath, use the prefix ""classpath:"".
3421

Thomas Mueller's avatar
Thomas Mueller committed
3422 3423 3424
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
3425 3426 3427 3428 3429 3430 3431 3432 3433
Admin rights are required to execute this command.
","
CALL CSVREAD('test.csv');
-- Read a file containing the columns ID, NAME with
-- UTF-8 encoding and the pipe (|) as field separator
CALL CSVREAD('test2.csv', 'ID|NAME', 'UTF-8', '|');
-- Read a semicolon-separated file
SELECT * FROM CSVREAD('data/test.csv', NULL, NULL, ';');
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3434
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3435 3436 3437
"

"Functions (System)","CSVWRITE","
3438
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3439
","
3440
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3441
If only a file name is specified, it will be written to the current working directory.
3442
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3443
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
3444 3445 3446 3447 3448

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

Thomas Mueller's avatar
Thomas Mueller committed
3451 3452
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3453 3454 3455 3456 3457 3458 3459
","
CALL CSVWRITE('test.csv', 'SELECT * FROM TEST');
-- Write a file with UTF-8 encoding and the pipe (|) as field separator
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'UTF-8', '|');
"

"Functions (System)","DATABASE","
3460
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3461 3462 3463 3464 3465 3466 3467
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3468
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3469
","
Thomas Mueller's avatar
Thomas Mueller committed
3470 3471
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
3472 3473 3474 3475 3476
","
CALL DATABASE_PATH();
"

"Functions (System)","FILE_READ","
3477
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3478 3479 3480 3481
","
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
3482
default character set for this system.
3483 3484 3485 3486

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

Thomas Mueller's avatar
Thomas Mueller committed
3487
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3488 3489 3490 3491 3492 3493
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

"Functions (System)","GREATEST","
3494
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3495 3496 3497 3498 3499 3500 3501
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3502
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3503 3504
","
Returns the last inserted identity value for this session.
3505
This value changes whenever a new sequence number was generated,
3506
even within a trigger or Java function. See also SCOPE_IDENTITY.
3507
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3508 3509 3510 3511 3512
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3513
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3514 3515 3516 3517 3518 3519 3520
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3521
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3522 3523 3524 3525 3526 3527 3528
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3529
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3530 3531
","
Returns the current lock mode. See SET LOCK_MODE.
3532
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3533 3534 3535 3536 3537
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3538
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3539 3540 3541 3542 3543 3544 3545 3546
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3547
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3548
","
3549 3550 3551 3552 3553
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
3554
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3555 3556 3557 3558 3559
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3560
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3561
","
Thomas Mueller's avatar
Thomas Mueller committed
3562
Returns the free memory in KB (where 1024 bytes is a KB).
3563
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3564 3565
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3566 3567 3568 3569 3570
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3571
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3572
","
Thomas Mueller's avatar
Thomas Mueller committed
3573
Returns the used memory in KB (where 1024 bytes is a KB).
3574
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3575 3576
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3577 3578 3579 3580 3581
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3582
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3583
","
3584 3585 3586 3587
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
3588 3589 3590 3591 3592
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3593
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3594 3595 3596 3597 3598 3599
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

3600 3601 3602 3603 3604 3605 3606 3607
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
3608
"Functions (System)","READONLY","
3609
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3610 3611 3612 3613 3614 3615 3616
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
3617
ROWNUM()
Thomas Mueller's avatar
Thomas Mueller committed
3618
","
3619 3620 3621
Returns the number of the current row.
This method returns an int.
This function is supported for SELECT statements, as well as for DELETE and UPDATE.
3622 3623
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).
3624
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3625
","
3626 3627
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3628
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3629 3630 3631
"

"Functions (System)","SCHEMA","
3632
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3633 3634 3635 3636 3637 3638
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3639 3640 3641 3642 3643 3644 3645 3646 3647 3648
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
Returns the last inserted identity value for this session for the current scope.
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
3649
"Functions (System)","SESSION_ID","
3650
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3651
","
3652 3653 3654 3655
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
3656 3657 3658 3659 3660
","
CALL SESSION_ID()
"

"Functions (System)","SET","
3661
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
3662
","
3663 3664 3665
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
3666
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
3667 3668 3669 3670 3671
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
3672
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
3673 3674 3675 3676 3677 3678 3679
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
3680
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3681
","
3682 3683
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
3684
Otherwise a value of the following form is returned:
3685
""logFileId-position-sessionId"".
3686 3687
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
3688 3689 3690 3691
","
CALL TRANSACTION_ID()
"

3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703
"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
3704
"Functions (System)","USER","
3705
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

"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
3727