help.csv 111.4 KB
Newer Older
Thomas Mueller's avatar
Thomas Mueller committed
1
# Copyright 2004-2013 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 ] [ LIMIT 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","
124 125
RUNSCRIPT FROM fileNameString scriptCompressionEncryption
[ 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:'.

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

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

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

SIMPLE does not use multi-row insert statements.
NODATA will not emit INSERT statements.
If the DROP option is specified, drop statements are created for tables, views,
and sequences. If the block size is set, CLOB and BLOB values larger than this
size are split into separate blocks.
Thomas Mueller's avatar
Thomas Mueller committed
158 159
BLOCKSIZE is used when writing out LOB data, and specifies the point at the
values transition from being inserted as inline values, to be inserted using
160
out-of-line commands.
161 162

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

167
If a file name is specified, then the whole
Thomas Mueller's avatar
Thomas Mueller committed
168
script (including insert statements) is written to this file, and a result set
169
without the insert statements is returned.
Thomas Mueller's avatar
Thomas Mueller committed
170

Thomas Mueller's avatar
Thomas Mueller committed
171 172 173
The password must be in single quotes; it is case sensitive and can contain spaces.

This command locks objects while it is running.
174

175
When using the TABLE or SCHEMA option, only the selected table(s) / schema(s) are included.
Thomas Mueller's avatar
Thomas Mueller committed
176 177 178 179 180
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
181 182
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
183 184 185 186 187 188 189 190 191
","
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
192 193
Renames an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
194 195 196 197
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

198 199 200 201 202 203 204 205 206
"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
207
"Commands (DDL)","ALTER SEQUENCE","
208
ALTER SEQUENCE sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
Thomas Mueller's avatar
Thomas Mueller committed
209
","
Thomas Mueller's avatar
Thomas Mueller committed
210 211
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
212 213 214 215 216 217
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

"Commands (DDL)","ALTER TABLE ADD","
218
ALTER TABLE tableName ADD [ COLUMN ]
Thomas Mueller's avatar
Thomas Mueller committed
219
{ [ IF NOT EXISTS ] columnDefinition [ { BEFORE | AFTER } columnName ]
220
    | ( { columnDefinition } [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
221
","
Thomas Mueller's avatar
Thomas Mueller committed
222 223
Adds a new column to a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
224 225 226 227 228
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

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

240 241 242 243 244 245 246 247 248
"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
249
","
250 251
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
252

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

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

259 260 261 262
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
263

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

266
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
267
Single column indexes on this column are dropped.
268 269 270

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

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

"Commands (DDL)","ALTER TABLE DROP COLUMN","
283
ALTER TABLE tableName DROP COLUMN [ IF EXISTS ] columnName
Thomas Mueller's avatar
Thomas Mueller committed
284 285
","
Removes a column from a table.
286
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
287 288 289 290 291
","
ALTER TABLE TEST DROP COLUMN NAME
"

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

"Commands (DDL)","ALTER TABLE SET","
ALTER TABLE tableName SET REFERENTIAL_INTEGRITY
302
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
303 304 305 306 307 308
","
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.
309 310

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
311 312 313 314 315 316 317
","
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
318 319
Renames a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
320 321 322 323 324
","
ALTER TABLE TEST RENAME TO MY_DATA
"

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

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

"Commands (DDL)","ALTER USER SET PASSWORD","
350
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
351
","
Thomas Mueller's avatar
Thomas Mueller committed
352 353 354 355 356 357
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.
358
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
359 360 361 362 363 364 365 366
","
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
367
This command is used for views created using CREATE FORCE VIEW.
368
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
369 370 371 372 373
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
374
ANALYZE [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
375 376 377 378 379 380 381
","
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.
382 383

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
384 385 386 387 388
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
389 390 391 392 393
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
394
","
Thomas Mueller's avatar
Thomas Mueller committed
395 396 397
Sets the comment of a database object. Use NULL to remove the comment.

Admin rights are required to execute this command.
398
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
399 400 401 402 403
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

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

Admin rights are required to execute this command.
411
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
412 413 414 415 416
","
CREATE AGGREGATE MEDIAN FOR ""com.acme.db.Median""
"

"Commands (DDL)","CREATE ALIAS","
417
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
418
{ FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
419
","
420 421 422 423 424
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
425
""java.lang.Integer.parseInt(java.lang.String, int)"". The class and the method
426
must both be public, and the method must be static. The class must be available
427
in the classpath of the database engine (when using the server mode,
428
it must be in the classpath of the server).
Thomas Mueller's avatar
Thomas Mueller committed
429

430 431
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.
432 433
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
434 435
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
436

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

440
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
441 442 443
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.
444

Thomas Mueller's avatar
Thomas Mueller committed
445
Admin rights are required to execute this command.
446
This command commits an open transaction.
447 448

If you have the Groovy jar in your classpath, it is also possible to write methods using Groovy.
Thomas Mueller's avatar
Thomas Mueller committed
449 450 451 452 453
","
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');
454 455
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
456 457 458 459 460
CREATE ALIAS tr AS $$@groovy.transform.CompileStatic
    static String tr(String str, String sourceSet, String replacementSet){
        return str.tr(sourceSet, replacementSet);
    }
$$
Thomas Mueller's avatar
Thomas Mueller committed
461 462 463
"

"Commands (DDL)","CREATE CONSTANT","
464
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
465
","
Thomas Mueller's avatar
Thomas Mueller committed
466 467
Creates a new constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
468 469 470 471 472
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
473 474 475
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
476 477
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
478
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
479
to the value being tested.
480

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

483
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
484 485 486 487 488
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
489 490
CREATE
{ [ UNIQUE ] [ HASH ] INDEX [ [ IF NOT EXISTS ] newIndexName ]
491 492
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
493
","
Thomas Mueller's avatar
Thomas Mueller committed
494 495
Creates a new index.
This command commits an open transaction.
496

Thomas Mueller's avatar
Thomas Mueller committed
497
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
498 499
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
500
Non-unique keys are supported.
Thomas Mueller's avatar
Thomas Mueller committed
501 502 503 504 505
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
506 507 508
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
509 510 511 512 513 514 515 516
","
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
517
work. Linked tables to the same database share one connection.
518

Thomas Mueller's avatar
Thomas Mueller committed
519 520 521
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).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
529
Admin rights are required to execute this command.
530
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
531 532 533 534 535 536 537 538 539
","
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","
540
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
541
","
Thomas Mueller's avatar
Thomas Mueller committed
542 543
Creates a new role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
544 545 546 547 548
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
549
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
Thomas Mueller's avatar
Thomas Mueller committed
550 551 552
","
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
553
Specifying the owner currently has no effect.
554 555

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
556 557 558 559 560
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
561 562
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
[ INCREMENT BY long ] [ CACHE long ]
Thomas Mueller's avatar
Thomas Mueller committed
563
","
Thomas Mueller's avatar
Thomas Mueller committed
564 565 566
Creates a new sequence.
The data type of a sequence is BIGINT.
Used values are never re-used, even when the transaction is rolled back.
Thomas Mueller's avatar
Thomas Mueller committed
567 568 569 570 571

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
574 575 576 577 578
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
579 580
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
581
[ ( { columnDefinition | constraint } [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
582
[ ENGINE tableEngineName ] [ NOT PERSISTENT ] [ TRANSACTIONAL ]
583
[ AS select ]","
Thomas Mueller's avatar
Thomas Mueller committed
584 585
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
586 587 588 589
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
590
that means memory tables should not get too large.
591

Thomas Mueller's avatar
Thomas Mueller committed
592 593 594 595 596
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,
597
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
598

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

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

605 606 607
The column definition is optional if a query is specified.
In that case the column list of the query is used.

Thomas Mueller's avatar
Thomas Mueller committed
608 609
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
610 611 612 613 614
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
615
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
616
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
617
[ QUEUE int ] [ NOWAIT ] CALL triggeredClassName
Thomas Mueller's avatar
Thomas Mueller committed
618
","
Thomas Mueller's avatar
Thomas Mueller committed
619 620 621 622 623
Creates a new trigger.
The trigger class must be public and implement ""org.h2.api.Trigger"".
Inner classes are not supported.
The class must be available in the classpath of the database engine
(when using the server mode, it must be in the classpath of the server).
624

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

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

636
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
637
Only the first such trigger is called. Such triggers on views are supported.
638
They can be used to make views updatable.
639

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

644 645 646 647
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
648 649
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

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

653 654
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

Thomas Mueller's avatar
Thomas Mueller committed
655 656
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.
657 658

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
659 660 661 662
","
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger""
"
"Commands (DDL)","CREATE USER","
663 664
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
665
","
Thomas Mueller's avatar
Thomas Mueller committed
666 667 668
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.
669

Thomas Mueller's avatar
Thomas Mueller committed
670
Admin rights are required to execute this command.
671
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
672 673 674 675 676
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
677
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
678
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
679 680
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
681
if the underlying table(s) don't exist.
682

Thomas Mueller's avatar
Thomas Mueller committed
683 684 685 686 687
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.

688 689
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
690
Admin rights are required to execute this command.
691
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
692 693 694 695 696
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
697
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
698
","
Thomas Mueller's avatar
Thomas Mueller committed
699 700 701
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
702
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
703
","
Thomas Mueller's avatar
Thomas Mueller committed
704
DROP AGGREGATE MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
705 706 707
"

"Commands (DDL)","DROP ALIAS","
708
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
709
","
Thomas Mueller's avatar
Thomas Mueller committed
710 711 712
Drops an existing function alias.

Admin rights are required to execute this command.
713
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
714
","
Thomas Mueller's avatar
Thomas Mueller committed
715
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
716 717 718
"

"Commands (DDL)","DROP ALL OBJECTS","
719
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
720 721 722 723 724
","
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
725 726 727
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
728 729 730 731 732
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
733
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
734
","
Thomas Mueller's avatar
Thomas Mueller committed
735 736
Drops a constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
737 738 739 740 741
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
742
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
743
","
Thomas Mueller's avatar
Thomas Mueller committed
744 745
Drops a data type (domain).
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
746 747 748 749 750
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
751
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
752
","
Thomas Mueller's avatar
Thomas Mueller committed
753 754
Drops an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
755 756 757 758 759
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
760
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
761
","
Thomas Mueller's avatar
Thomas Mueller committed
762 763
Drops a role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
764 765 766 767 768
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
769
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
770
","
Thomas Mueller's avatar
Thomas Mueller committed
771 772
Drops a schema.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
773 774 775 776 777
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
778
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
779
","
Thomas Mueller's avatar
Thomas Mueller committed
780 781
Drops a sequence.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
782 783 784 785 786
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
787
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
788
","
Thomas Mueller's avatar
Thomas Mueller committed
789
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
790 791
The command will fail if dependent views exist and the RESTRICT clause is used (the default).
All dependent views are dropped as well if the CASCADE clause is used.
792
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
793 794 795 796 797
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
798
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
799
","
Thomas Mueller's avatar
Thomas Mueller committed
800 801
Drops an existing trigger.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
802 803 804 805 806
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
807
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
808
","
Thomas Mueller's avatar
Thomas Mueller committed
809 810
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
811

Thomas Mueller's avatar
Thomas Mueller committed
812
Admin rights are required to execute this command.
813
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
814 815 816 817 818
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
819
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
820
","
Thomas Mueller's avatar
Thomas Mueller committed
821 822 823
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
824
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
825 826 827 828 829 830 831
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
832 833 834 835 836
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).
837
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
838 839

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
840 841 842 843 844 845 846
","
TRUNCATE TABLE TEST
"

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

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
850 851 852 853 854 855 856
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
857
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
858 859 860
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
861 862 863 864 865
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
866
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
867 868 869 870 871 872 873 874 875
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
876 877 878 879
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
880 881 882 883 884
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
885 886
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
887
","
Thomas Mueller's avatar
Thomas Mueller committed
888 889 890 891
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
892 893 894 895 896
","
GRANT SELECT ON TEST TO READONLY
"

"Commands (Other)","GRANT ROLE","
897
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
898
","
Thomas Mueller's avatar
Thomas Mueller committed
899 900 901 902
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
903 904 905 906 907
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
908
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
909 910 911 912 913 914 915 916 917
","
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
918 919
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
920 921 922 923 924
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
925 926
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
927
","
Thomas Mueller's avatar
Thomas Mueller committed
928 929 930 931
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
932 933 934 935 936
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
937
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
938
","
Thomas Mueller's avatar
Thomas Mueller committed
939 940 941 942
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
943 944 945 946 947
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
948
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
949 950 951 952 953 954 955 956 957 958
","
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
959 960 961 962
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
963 964 965 966 967 968 969
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
970 971
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
972 973 974 975 976
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
977
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
978
","
Thomas Mueller's avatar
Thomas Mueller committed
979
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
980
Variables are not persisted and session scoped, that means only visible from within the session in which they are defined.
Thomas Mueller's avatar
Thomas Mueller committed
981
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
982 983 984 985 986
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
987
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
988 989 990 991 992 993 994 995 996 997
","
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
998 999
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1000
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1001 1002
This command commits an open transaction.
This setting is persistent.
1003
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1004 1005 1006 1007 1008
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
1009
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
1010 1011
","
Switches auto commit on or off.
1012
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
1013
however this will not work as expected when using a connection pool
1014 1015
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
1016
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
1017 1018 1019 1020 1021 1022 1023
","
SET AUTOCOMMIT OFF
"

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
1024 1025
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
1026 1027
Depending on the virtual machine, the actual memory required may be higher.

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

Thomas Mueller's avatar
Thomas Mueller committed
1033
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1034 1035
This command commits an open transaction.
This setting is persistent.
1036
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
","
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
1049 1050
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1051
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1052 1053 1054 1055
","
SET CLUSTER ''
"

1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Sets the collation used for comparing BINARY columns, the default is SIGNED.
This command can only be executed if there are no tables defined.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

Thomas Mueller's avatar
Thomas Mueller committed
1070
"Commands (Other)","SET COLLATION","
1071 1072
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1073
","
Thomas Mueller's avatar
Thomas Mueller committed
1074 1075
Sets the collation used for comparing strings.
This command can only be executed if there are no tables defined.
Thomas Mueller's avatar
Thomas Mueller committed
1076 1077
See ""java.text.Collator"" for details about the supported collations and the STRENGTH
(PRIMARY is usually case- and umlaut-insensitive; SECONDARY is case-insensitive but umlaut-sensitive;
Thomas Mueller's avatar
Thomas Mueller committed
1078
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1079

1080 1081 1082 1083 1084 1085
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
1086 1087 1088
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
1089 1090 1091 1092 1093
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1094
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1095 1096 1097
","
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
1098

Thomas Mueller's avatar
Thomas Mueller committed
1099
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1100 1101
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1102 1103 1104 1105 1106 1107 1108 1109
","
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
1110 1111 1112 1113
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).
1114
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1115 1116 1117 1118 1119 1120 1121
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1122 1123
Sets the delay for closing a database if all connections are closed.
The value -1 means the database is never closed until the close delay is set to some other value or SHUTDOWN is called.
Thomas Mueller's avatar
Thomas Mueller committed
1124 1125 1126 1127
The value 0 means no delay (default; the database is closed if the last connection to it is closed).
Values 1 and larger mean the number of seconds the database is left open after closing the last connection.

If the application exits normally or System.exit is called, the database is closed immediately, even if a delay is set.
Thomas Mueller's avatar
Thomas Mueller committed
1128

Thomas Mueller's avatar
Thomas Mueller committed
1129
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1130 1131
This command commits an open transaction.
This setting is persistent.
1132
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1133 1134 1135 1136 1137 1138 1139 1140
","
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
1141 1142
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1143
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1144 1145
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1146 1147 1148 1149 1150
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1151
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1152 1153 1154
","
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
1155
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1156
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1157

Thomas Mueller's avatar
Thomas Mueller committed
1158
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1159 1160
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1161
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1162 1163 1164 1165 1166
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1167
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1168
","
Thomas Mueller's avatar
Thomas Mueller committed
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
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
1179 1180 1181

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1182
","
Thomas Mueller's avatar
Thomas Mueller committed
1183
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1184 1185 1186
"

"Commands (Other)","SET IGNORECASE","
1187
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1188 1189 1190 1191 1192
","
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
1193
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1194

Thomas Mueller's avatar
Thomas Mueller committed
1195
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1196 1197
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1198
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1199 1200 1201 1202
","
SET IGNORECASE TRUE
"

1203
"Commands (Other)","SET LOG","
1204
SET LOG int
1205 1206 1207 1208
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1209
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1210 1211 1212 1213
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.

1214 1215
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
1216 1217
against power failure is required, but the data must be protected against killing the process.

1218 1219
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
1220 1221
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1222
Admin rights are required to execute this command, as it affects all connections.
1223 1224
This command commits an open transaction.
This setting is not persistent.
1225
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1226 1227 1228 1229
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1230 1231 1232 1233
"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
1234
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247

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

This command does not commit a transaction, and rollback does not affect it.
1263
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1264 1265 1266 1267 1268 1269 1270
","
SET LOCK_TIMEOUT 1000
"

"Commands (Other)","SET MAX_LENGTH_INPLACE_LOB","
SET MAX_LENGTH_INPLACE_LOB int
","
Thomas Mueller's avatar
Thomas Mueller committed
1271
Sets the maximum size of an in-place LOB object.
1272 1273 1274 1275 1276 1277

If the 'h2.lobInDatabase' property is true, this is the maximum length of an LOB that is stored with the record itself,
and the default value is 128.
If the 'h2.lobInDatabase' property is false, this is the maximum length of an LOB that is stored in the database file,
and the default value is 4096.

Thomas Mueller's avatar
Thomas Mueller committed
1278
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1279

Thomas Mueller's avatar
Thomas Mueller committed
1280
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1281 1282
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1283 1284 1285 1286 1287 1288 1289
","
SET MAX_LENGTH_INPLACE_LOB 128
"

"Commands (Other)","SET MAX_LOG_SIZE","
SET MAX_LOG_SIZE int
","
Thomas Mueller's avatar
Thomas Mueller committed
1290 1291
Sets the maximum size of the transaction log, in megabytes.
If the log is larger, and if there is no open transaction, the transaction log is truncated.
noelgrandin's avatar
noelgrandin committed
1292
If there is an open transaction, the transaction log will continue to grow however.
Thomas Mueller's avatar
Thomas Mueller committed
1293
The default max size is 16 MB.
Thomas Mueller's avatar
Thomas Mueller committed
1294
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1295

Thomas Mueller's avatar
Thomas Mueller committed
1296
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1297 1298
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1299 1300 1301 1302 1303 1304 1305 1306
","
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
1307 1308
are read, then the rows are buffered to disk. The default value is 10000.

Thomas Mueller's avatar
Thomas Mueller committed
1309
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1310 1311
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1312
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1313 1314 1315 1316 1317 1318 1319
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1326
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1327 1328
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1329
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1330 1331 1332 1333 1334 1335 1336 1337 1338
","
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
1339 1340 1341
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1342
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1343
It has no effect for in-memory databases.
1344
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1345 1346 1347 1348 1349
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1350
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1351 1352
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1353 1354 1355
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1356
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1357
This command commits an open transaction.
1358
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1359 1360 1361 1362 1363
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1364
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1365 1366 1367
","
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
1368 1369 1370 1371 1372
only.

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

Thomas Mueller's avatar
Thomas Mueller committed
1373
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1374
This command commits an open transaction.
1375
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1376 1377 1378 1379 1380
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1381
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1382 1383 1384
","
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
1385 1386
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1387
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1388
This command commits an open transaction.
1389
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1390 1391 1392 1393 1394 1395 1396 1397 1398
","
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
1399 1400

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1401 1402 1403 1404 1405 1406 1407 1408 1409
","
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
1410 1411 1412
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
1413 1414 1415 1416 1417
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1418
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1419 1420 1421
","
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
1422 1423 1424 1425
for one table.

This setting is not persistent.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1426
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1427 1428 1429 1430 1431 1432 1433 1434 1435
","
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
1436 1437

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1438 1439 1440 1441 1442 1443 1444 1445 1446
","
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
1447 1448 1449
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1450
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1451 1452 1453 1454 1455 1456 1457 1458 1459
","
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
1460 1461 1462
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1463
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1464 1465 1466 1467 1468 1469 1470 1471 1472
","
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
1473 1474 1475
disabled).

This command does not commit a transaction, and rollback does not affect it.
1476
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1477 1478 1479 1480 1481
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1482
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1483 1484 1485
","
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.
1486
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1487

Thomas Mueller's avatar
Thomas Mueller committed
1488
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1489
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1490
This command does not commit a transaction, and rollback does not affect it.
1491
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
","
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
1503
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1504
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1505
This command commits an open transaction.
1506
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
","
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
1517 1518

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1519 1520 1521 1522 1523 1524 1525 1526
","
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
1527 1528
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1529
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1530
This command commits an open transaction.
1531
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1532 1533 1534 1535 1536
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1537
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1538
","
1539 1540
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
1541
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1542

1543 1544
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
1545 1546 1547

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1554
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1555
","
1556
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1557 1558
"

1559 1560
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1561
","
1562
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1563
","
1564
A
Thomas Mueller's avatar
Thomas Mueller committed
1565 1566
"

1567 1568
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1569
","
1570
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1571
","
1572
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1573 1574
"

1575
"Other Grammar","Array","
1576
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1577
","
1578 1579
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
1580
","
1581
(1, 2)
1582 1583
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1584 1585
"

1586 1587
"Other Grammar","Boolean","
TRUE | FALSE
1588
","
1589
A boolean value.
1590
","
1591
TRUE
1592 1593
"

1594 1595
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1596
","
1597
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1598
","
1599
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1600 1601
"

1602 1603 1604
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1605
","
1606 1607
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
1608
","
1609
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1610 1611
"

1612 1613 1614
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1615
","
1616 1617
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1618
","
1619 1620 1621 1622 1623 1624
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
{ AES | XTEA }
","
Thomas Mueller's avatar
Thomas Mueller committed
1625
Two algorithms are supported: AES (""AES-128"") and XTEA (using 32 rounds).
1626
XTEA is a bit faster than AES in some environments, but AES is more secure.
1627 1628
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1629 1630
"

1631
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1632 1633
columnName dataType
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1634
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1635 1636
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1637 1638
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1639
The computed column expression is evaluated and assigned whenever the row changes.
1640 1641 1642 1643

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
1644

Thomas Mueller's avatar
Thomas Mueller committed
1645 1646
The options PRIMARY KEY, UNIQUE, and CHECK are not supported for ALTER statements.

Thomas Mueller's avatar
Thomas Mueller committed
1647 1648
Check constraints can reference columns of the table,
and they can reference objects that exist while the statement is executed.
Thomas Mueller's avatar
Thomas Mueller committed
1649 1650
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1651
","
Thomas Mueller's avatar
Thomas Mueller committed
1652 1653 1654
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);
1655 1656
"

1657 1658
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1659
","
1660 1661 1662
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
1663
","
1664
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1665 1666
"

1667 1668
"Other Grammar","Compare","
<> | <= | >= | = | < | > | !=
Thomas Mueller's avatar
Thomas Mueller committed
1669
","
1670
Comparison operator. The operator != is the same as <>.
Thomas Mueller's avatar
Thomas Mueller committed
1671
","
1672
<>
Thomas Mueller's avatar
Thomas Mueller committed
1673 1674 1675
"

"Other Grammar","Condition","
1676
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1677 1678 1679 1680 1681 1682 1683
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1684 1685
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1686
    | IS [ NOT ] [ DISTINCT FROM ] operand
1687 1688 1689 1690
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1691
","
Thomas Mueller's avatar
Thomas Mueller committed
1692
The right hand side of a condition.
1693

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

Thomas Mueller's avatar
Thomas Mueller committed
1697 1698 1699 1700 1701
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).
1702 1703 1704
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.
1705

Thomas Mueller's avatar
Thomas Mueller committed
1706
When comparing with REGEXP, regular expression matching is used.
1707
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1708 1709 1710 1711
","
LIKE 'Jo%'
"

1712
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
1713 1714 1715 1716 1717
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
1718
","
Thomas Mueller's avatar
Thomas Mueller committed
1719 1720
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1721
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1722 1723
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
1724
","
1725
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1726 1727
"

1728 1729
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1730
","
1731
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1732
","
1733
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1734 1735
"

1736 1737
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1738
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1739
","
1740
Optional parameters for CSVREAD and CSVWRITE.
1741 1742
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
1743 1744
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1745
The following options are supported:
1746
""caseSensitiveColumnNames"" (true or false; disabled by default),
Thomas Mueller's avatar
Thomas Mueller committed
1747
""charset"", ""escape"", ""fieldDelimiter"", ""fieldSeparator"",
1748 1749
""lineComment"" (disabled by default),
""lineSeparator"", ""null"", ""rowSeparator"" (not set by default),
1750
""preserveWhitespace"" (true or false; disabled by default),
1751
""writeColumnHeader"" (true or false; enabled by default).
Thomas Mueller's avatar
Thomas Mueller committed
1752
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1753
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
1754 1755 1756
a backslash needs to be escaped with another backslash (""'\\'"").
All other characters are not to be escaped, that means
newline and tab characters are written as such.
Thomas Mueller's avatar
Thomas Mueller committed
1757
","
1758
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1759 1760
"

1761 1762 1763 1764 1765
"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
1766
","
1767
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1768
","
1769
INT
Thomas Mueller's avatar
Thomas Mueller committed
1770 1771
"

1772 1773
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1774
","
1775
A date literal. The limitations are the same as for the Java data type
1776
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1777
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1778
","
1779
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1780 1781
"

1782
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
1783
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
1784
","
Thomas Mueller's avatar
Thomas Mueller committed
1785 1786 1787 1788 1789 1790
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)"".
1791
","
Thomas Mueller's avatar
Thomas Mueller committed
1792 1793 1794
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
1795 1796
"

1797 1798
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1799
","
1800
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1801
","
1802
0
Thomas Mueller's avatar
Thomas Mueller committed
1803 1804
"

1805 1806
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1807
","
1808 1809 1810
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
1811
","
1812
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1813 1814
"

1815 1816
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1817
","
1818
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1819
","
1820
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1821 1822
"

1823
"Other Grammar","Factor","
1824
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1825
","
1826
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1827
","
1828
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1829 1830
"

1831 1832
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1833
","
1834 1835
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1836
","
1837
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1838 1839
"

1840 1841
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1842
","
1843
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1844
","
1845
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1846 1847
"

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

"Other Grammar","Int","
1859
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1860 1861 1862 1863 1864 1865 1866
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
1867
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1868 1869 1870 1871 1872 1873
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

1874 1875
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
1876
","
1877
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
1878
","
1879
TEST
Thomas Mueller's avatar
Thomas Mueller committed
1880 1881
"

1882 1883
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1884
","
1885
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
1886
","
1887
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1888 1889
"

1890 1891 1892 1893 1894 1895 1896 1897
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
1898
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
1899
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
1900
","
Thomas Mueller's avatar
Thomas Mueller committed
1901
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
1902 1903 1904 1905 1906 1907 1908
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
"

1909 1910
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1911
","
1912
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
1913
","
1914
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
1915 1916
"

1917 1918
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1919
","
1920 1921 1922
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
1923
","
1924
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
1925 1926
"

1927 1928
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
1929
","
1930 1931 1932
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
1933
","
1934
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
1935 1936
"

1937 1938 1939
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
1940
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
1941
","
Thomas Mueller's avatar
Thomas Mueller committed
1942 1943 1944
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
1945 1946 1947
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
1948
","
1949
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
1950 1951
"

Thomas Mueller's avatar
Thomas Mueller committed
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
"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
"

1963 1964
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
1965
","
1966 1967
The compression and encryption algorithm to use for script files.
When using encryption, only DEFLATE and LZF are supported.
Thomas Mueller's avatar
Thomas Mueller committed
1968 1969 1970 1971 1972
LZF is faster but uses more space.
","
COMPRESSION LZF
"

1973 1974
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
1975
","
1976
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
1977
","
1978
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
1979 1980
"

1981 1982
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
1983
","
1984 1985
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
1986
","
1987
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
1988 1989
"

1990 1991
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1992
","
Thomas Mueller's avatar
Thomas Mueller committed
1993
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
1994

Thomas Mueller's avatar
Thomas Mueller committed
1995
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
1996
","
1997
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
1998 1999
"

2000
"Other Grammar","Table Expression","
2001
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
2002 2003
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2004
","
2005 2006 2007
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
2008
","
2009
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2010 2011
"

2012 2013 2014 2015 2016 2017 2018 2019 2020
"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;
"

2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032
"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
2033
","
2034
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2035
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2036
","
2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051
'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
2052
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2053 2054 2055 2056 2057 2058
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
2059
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2060
","
Thomas Mueller's avatar
Thomas Mueller committed
2061
A literal value of any data type, or null.
2062 2063
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2064 2065 2066 2067 2068 2069 2070
"

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

2071
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2072 2073 2074 2075 2076 2077 2078 2079 2080
","
INT
"

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

2081
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2082 2083 2084 2085 2086 2087 2088 2089 2090
","
BOOLEAN
"

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

2091
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2092 2093 2094 2095 2096 2097 2098 2099 2100
","
TINYINT
"

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

2101
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2102 2103 2104 2105 2106 2107 2108 2109 2110
","
SMALLINT
"

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

2111
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122
","
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.

2123
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2124 2125 2126 2127 2128
","
IDENTITY
"

"Data Types","DECIMAL Type","
2129
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2130 2131 2132 2133
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2134
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2135 2136 2137 2138 2139
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2140
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT4 | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2141
","
Thomas Mueller's avatar
Thomas Mueller committed
2142
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2143 2144
of rounding problems.

2145
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2146 2147 2148 2149 2150 2151 2152
","
DOUBLE
"

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

2156
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2157 2158 2159 2160 2161 2162 2163
","
REAL
"

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

2166
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
2167 2168 2169 2170 2171 2172 2173
","
TIME
"

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

2176
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2177
(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
2178 2179 2180 2181 2182
","
DATE
"

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

2187
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2188 2189 2190 2191 2192
","
TIMESTAMP
"

"Data Types","BINARY Type","
2193
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2194
","
2195 2196 2197 2198 2199
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
2200 2201 2202 2203 2204 2205 2206 2207 2208

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

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

2215
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2216 2217 2218 2219 2220
","
OTHER
"

"Data Types","VARCHAR Type","
2221 2222
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2223
","
Thomas Mueller's avatar
Thomas Mueller committed
2224
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2225 2226 2227 2228 2229 2230 2231
Use two single quotes ('') to create a quote.

The maximum precision is ""Integer.MAX_VALUE"".
The precision is a size constraint; only the actual data is persisted.

The whole text is loaded into memory when using this data type.
For large text data CLOB should be used; see there for details.
Thomas Mueller's avatar
Thomas Mueller committed
2232

2233
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2234 2235 2236 2237 2238
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2239
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2240
","
Thomas Mueller's avatar
Thomas Mueller committed
2241
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2242 2243 2244 2245 2246 2247 2248
Stored in mixed case.

The maximum precision is ""Integer.MAX_VALUE"".
The precision is a size constraint; only the actual data is persisted.

The whole text is loaded into memory when using this data type.
For large text data CLOB should be used; see there for details.
Thomas Mueller's avatar
Thomas Mueller committed
2249

2250
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2251 2252 2253 2254 2255
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2256
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2257
","
Thomas Mueller's avatar
Thomas Mueller committed
2258 2259 2260
A Unicode String.
This type is supported for compatibility with other databases and older applications.
The difference to VARCHAR is that trailing spaces are ignored and not persisted.
Thomas Mueller's avatar
Thomas Mueller committed
2261

Thomas Mueller's avatar
Thomas Mueller committed
2262 2263
The maximum precision is ""Integer.MAX_VALUE"".
The precision is a size constraint; only the actual data is persisted.
Thomas Mueller's avatar
Thomas Mueller committed
2264

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

2268
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2269 2270 2271 2272 2273
","
CHAR(10)
"

"Data Types","BLOB Type","
2274
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2275 2276 2277
","
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
2278
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2279 2280
Advanced / Large Objects.

2281
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2282 2283 2284 2285 2286
","
BLOB
"

"Data Types","CLOB Type","
2287
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2288 2289 2290 2291 2292
","
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
2293
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2294 2295 2296 2297 2298

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.

2299
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2300 2301 2302 2303 2304 2305 2306
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2307 2308 2309 2310
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
2311

Thomas Mueller's avatar
Thomas Mueller committed
2312 2313 2314 2315 2316
Please note that using an index on randomly generated data will
result on poor performance once there are millions of rows in a table.
The reason is that the cache behavior is very bad with randomly distributed data.
This is a problem for any database system.

Thomas Mueller's avatar
Thomas Mueller committed
2317
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2318 2319 2320 2321 2322 2323 2324
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2325
An array of values.
2326
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2327 2328 2329 2330


Use a value list (1, 2) or ""PreparedStatement.setObject(.., new Object[] {..})"" to store values,
and ""ResultSet.getObject(..)"" or ""ResultSet.getArray(..)"" to retrieve the values.
Thomas Mueller's avatar
Thomas Mueller committed
2331 2332 2333 2334 2335
","
ARRAY
"

"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2336
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2337
","
2338 2339
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2340
Aggregates are only allowed in select statements.
2341
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2342 2343 2344 2345 2346
","
AVG(X)
"

"Functions (Aggregate)","BOOL_AND","
2347
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2348
","
2349 2350 2351
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
2352 2353 2354 2355 2356
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2357
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2358
","
2359 2360 2361
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
2362 2363 2364 2365 2366
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2367
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2368
","
2369 2370 2371 2372
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
2373 2374 2375 2376 2377
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2378 2379
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2380
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2381
","
2382 2383 2384 2385 2386
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
2387 2388 2389 2390 2391
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2392
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2393
","
2394 2395 2396 2397
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
2398 2399 2400 2401 2402
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2403
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2404
","
2405 2406 2407 2408
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
2409 2410 2411 2412 2413
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2414
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2415
","
2416 2417 2418
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2419
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2420
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2421 2422 2423 2424 2425
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2426
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2427
","
2428 2429 2430 2431 2432
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
2433 2434 2435 2436 2437
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2438
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2439
","
2440 2441 2442
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
2443 2444 2445 2446 2447 2448
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2449
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2450
","
2451 2452 2453
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
2454 2455 2456 2457 2458 2459
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2460
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2461
","
2462 2463 2464 2465
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
2466 2467 2468 2469 2470
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2471
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2472
","
2473 2474 2475 2476
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
2477 2478 2479 2480 2481
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2482
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2483
","
2484 2485
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"".
2486
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2487 2488 2489 2490 2491
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2492
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2493
","
Thomas Mueller's avatar
Thomas Mueller committed
2494 2495
Calculate the arc cosine.
See also Java ""Math.acos"".
2496
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2497 2498 2499 2500 2501
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2502
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2503
","
Thomas Mueller's avatar
Thomas Mueller committed
2504 2505
Calculate the arc sine.
See also Java ""Math.asin"".
2506
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2507 2508 2509 2510 2511
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2512
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2513
","
Thomas Mueller's avatar
Thomas Mueller committed
2514 2515
Calculate the arc tangent.
See also Java ""Math.atan"".
2516
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2517 2518 2519 2520 2521
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2522
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2523
","
Thomas Mueller's avatar
Thomas Mueller committed
2524 2525
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2526
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2527 2528 2529 2530
","
COS(ANGLE)
"

2531
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2532
COSH(numeric)
2533 2534 2535 2536 2537 2538 2539 2540
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2541
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2542
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2543
","
Thomas Mueller's avatar
Thomas Mueller committed
2544
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2545
See also Java ""Math.*"" functions.
2546
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2547 2548 2549 2550 2551
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2552
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2553
","
Thomas Mueller's avatar
Thomas Mueller committed
2554 2555
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2556
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2557 2558 2559 2560
","
SIN(ANGLE)
"

2561
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2562
SINH(numeric)
2563 2564 2565 2566 2567 2568 2569 2570
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2571
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2572
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2573
","
Thomas Mueller's avatar
Thomas Mueller committed
2574 2575
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2576
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2577 2578 2579 2580
","
TAN(ANGLE)
"

2581
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2582
TANH(numeric)
2583 2584 2585 2586 2587 2588 2589 2590
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2591
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2592
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2593
","
Thomas Mueller's avatar
Thomas Mueller committed
2594
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2595
See also Java ""Math.atan2"".
2596
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2597 2598 2599 2600 2601
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2602
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2603
","
2604 2605
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2606 2607 2608 2609 2610 2611
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2612
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2613
","
2614 2615
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2616 2617 2618 2619 2620 2621
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2622
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2623
","
2624 2625
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2626 2627 2628 2629 2630 2631
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2632
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2633
","
2634 2635
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2636 2637 2638 2639 2640 2641
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2642
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2643
","
2644
See also Java ""Math.ceil"".
2645
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2646
","
2647
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2648 2649 2650
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2651
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2652
","
2653
See also Java ""Math.toDegrees"".
2654
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2655 2656 2657 2658 2659
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2660
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2661
","
2662
See also Java ""Math.exp"".
2663
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2664 2665 2666 2667 2668
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
2669
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2670
","
2671
See also Java ""Math.floor"".
2672
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2673 2674 2675 2676 2677
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2678
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2679
","
2680
See also Java ""Math.log"".
2681
In the PostgreSQL mode, LOG(x) is base 10.
2682
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2683 2684 2685 2686 2687
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
2688
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2689
","
2690
See also Java ""Math.log10"" (in Java 5).
2691
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2692 2693 2694 2695 2696
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
2697
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2698
","
2699
See also Java ""Math.toRadians"".
2700
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2701 2702 2703 2704 2705
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
2706
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2707
","
2708
See also Java ""Math.sqrt"".
2709
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2710 2711 2712 2713 2714
","
SQRT(A)
"

"Functions (Numeric)","PI","
2715
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2716
","
2717
See also Java ""Math.PI"".
2718
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2719 2720 2721 2722 2723
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
2724
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2725
","
2726
See also Java ""Math.pow"".
2727
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2728 2729 2730 2731 2732
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2733
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2734 2735 2736
","
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
2737
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2738 2739 2740 2741 2742
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2743
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2744 2745
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
2746 2747 2748 2749 2750

Please note that using an index on randomly generated data will
result on poor performance once there are millions of rows in a table.
The reason is that the cache behavior is very bad with randomly distributed data.
This is a problem for any database system.
Thomas Mueller's avatar
Thomas Mueller committed
2751 2752 2753 2754 2755
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2756
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
2757
","
2758
Rounds to a number of digits, or to the nearest long if the number of digits if not set.
2759
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2760 2761 2762 2763 2764
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
2765
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2766
","
2767 2768 2769 2770 2771 2772
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
2773 2774 2775 2776 2777
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2778
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2779 2780
","
Generates a number of cryptographically secure random numbers.
2781
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2782 2783 2784 2785 2786
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
2787
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2788 2789 2790 2791 2792 2793 2794
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2795
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2796
","
2797 2798 2799 2800
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
2801 2802 2803 2804 2805
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2806
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2807
","
2808 2809 2810 2811
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
2812 2813 2814 2815 2816 2817
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2818
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2819
","
2820 2821 2822
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
2823 2824 2825 2826 2827
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
2828
{ TRUNC | TRUNCATE } ({numeric, digitsInt} | timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
2829 2830
","
Truncates to a number of digits (to the next value closer to 0).
2831
This method returns a double.
2832
When used with a timestamp, truncates a timestamp to a date (day) value.
Thomas Mueller's avatar
Thomas Mueller committed
2833 2834 2835 2836 2837
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
2838
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
2839
","
2840 2841 2842 2843
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
2844 2845 2846 2847 2848
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
2849
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2850 2851
","
Expands data that was compressed using the COMPRESS function.
2852
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2853 2854 2855 2856 2857
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
2858
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
2859 2860 2861 2862 2863 2864 2865
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
2866
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
2867 2868
","
Returns the ASCII value of the first character in the string.
2869
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2870 2871 2872 2873
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
2874
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2875
","
2876 2877 2878
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
2879 2880 2881 2882 2883
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
2884
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2885
","
2886 2887 2888
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
2889 2890 2891 2892 2893
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
2894
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2895
","
2896 2897 2898 2899
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
2900 2901 2902 2903 2904
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
2905
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
2906 2907
","
Returns the character that represents the ASCII value.
2908
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2909 2910 2911 2912 2913
","
CHAR(65)
"

"Functions (String)","CONCAT","
2914
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
2915 2916
","
Combines strings.
2917
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2918 2919 2920 2921
","
CONCAT(NAME, '!')
"

2922 2923 2924 2925 2926 2927 2928 2929 2930
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
2931
"Functions (String)","DIFFERENCE","
2932
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
2933 2934
","
Returns the difference between the sounds of two strings.
2935
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2936 2937 2938 2939 2940
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
2941
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
2942
","
2943 2944
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
2945 2946 2947 2948 2949
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
2950
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2951
","
2952 2953 2954
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
2955 2956 2957 2958 2959
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
2960
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2961
","
2962
Returns the location of a search string in a string.
2963 2964 2965
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
2966 2967 2968 2969 2970
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
2971
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
2972
","
2973 2974 2975
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
2976 2977 2978 2979 2980
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
2981
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2982 2983 2984 2985 2986 2987 2988
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
2989
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2990 2991 2992 2993 2994 2995 2996
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
2997
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2998 2999 3000 3001 3002 3003 3004
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3005
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3006 3007 3008 3009 3010 3011 3012
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3013
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3014
","
3015 3016 3017 3018
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
3019 3020 3021 3022 3023
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3024
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3025 3026 3027 3028 3029 3030 3031
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3032
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3033
","
3034 3035 3036
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
3037 3038 3039 3040 3041
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3042
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3043
","
3044 3045 3046
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
3047 3048 3049 3050 3051
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3052
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3053 3054 3055 3056 3057 3058 3059
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3060
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3061 3062 3063 3064 3065 3066 3067
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3068
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3069
","
3070 3071
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
3072 3073 3074 3075 3076
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3077
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
3078
","
3079
Replaces each substring that matches a regular expression.
3080
For details, see the Java ""String.replaceAll()"" method.
3081
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3082 3083 3084 3085 3086
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
3087
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3088 3089 3090 3091 3092 3093 3094
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3095
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3096
","
3097 3098
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.
3099
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3100 3101 3102 3103 3104
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3105
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3106
","
3107 3108 3109
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
3110 3111 3112 3113 3114
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3115
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3116 3117 3118 3119 3120 3121 3122
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3123
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3124
","
3125 3126 3127
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
3128 3129 3130 3131 3132
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3133
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3134
","
3135 3136 3137
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
3138 3139 3140 3141 3142
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3143
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3144 3145
","
Encodes a string to a byte array using the UTF8 encoding format.
3146
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3147 3148 3149 3150 3151
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3152
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3153
","
3154
Returns a substring of a string starting at a position.
3155
If the start index is negative, then the start index is relative to the end of the string.
3156
The length is optional.
3157
Also supported is: ""SUBSTRING(string FROM start [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3158
","
3159 3160
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3161 3162 3163
"

"Functions (String)","UTF8TOSTRING","
3164
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3165 3166 3167 3168 3169 3170 3171
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3172
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3173
","
3174
Creates an XML attribute element of the form ""name=value"".
3175 3176
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3177 3178 3179 3180 3181
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3182
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3183 3184
","
Create an XML node element.
3185 3186 3187
An empty or null attribute string means no attributes are set.
An empty or null content string means the node is empty.
The content is indented by default if it contains a newline.
3188
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3189 3190 3191 3192 3193
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3194
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3195
","
3196
Creates an XML comment.
3197
Two dashes (""--"") are converted to ""- -"".
3198
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3199 3200 3201 3202 3203
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3204
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3205
","
3206
Creates an XML CDATA element.
3207
If the value contains ""]]>"", an XML text element is created instead.
3208
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3209 3210 3211 3212 3213
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3214
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3215
","
Thomas Mueller's avatar
Thomas Mueller committed
3216
Returns the XML declaration.
3217
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3218 3219 3220 3221 3222
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3223
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3224 3225
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3226
If enabled, newline and linefeed is converted to an XML entity (&#).
3227
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3228 3229 3230 3231 3232
","
CALL XMLTEXT('test')
"

"Functions (Time and Date)","CURRENT_DATE","
3233
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3234 3235
","
Returns the current date.
3236
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3237 3238 3239 3240 3241
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3242
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3243 3244
","
Returns the current time.
3245
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3246 3247 3248 3249 3250
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3251
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3252
","
3253 3254
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3255
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3256 3257 3258 3259 3260
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3261
{ DATEADD| TIMESTAMPADD } (unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3262
","
3263 3264 3265 3266
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
3267 3268 3269 3270 3271
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3272
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3273
","
Thomas Mueller's avatar
Thomas Mueller committed
3274
Returns the the number of crossed unit boundaries between two timestamps.
3275 3276
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3277 3278 3279 3280 3281 3282
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3283
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3284 3285 3286 3287 3288 3289 3290
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3291
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3292 3293 3294 3295 3296 3297 3298
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3299
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3300 3301 3302 3303 3304 3305 3306
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3307
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3308 3309 3310 3311 3312 3313 3314
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3315
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3316
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3317
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3318 3319
","
Returns a specific value from a timestamps.
3320
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3321 3322 3323 3324 3325
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3326
FORMATDATETIME ( timestamp, formatString
3327
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3328
","
3329 3330 3331
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.
3332
For details of the format, see ""java.text.SimpleDateFormat"".
3333
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3334 3335 3336 3337 3338 3339
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3340
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3341 3342 3343 3344 3345 3346 3347
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3348
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3349 3350 3351 3352 3353 3354 3355
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3356
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3357 3358 3359 3360 3361 3362 3363
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3364
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3365 3366 3367 3368 3369 3370 3371
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3372
PARSEDATETIME(string, formatString
3373
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3374
","
3375 3376 3377
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.
3378
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3379 3380 3381 3382 3383 3384
","
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","
3385
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3386 3387 3388 3389 3390 3391 3392
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3393
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3394 3395 3396 3397 3398 3399 3400
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3401
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3402
","
3403 3404
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3405 3406 3407 3408 3409
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3410
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3411 3412 3413 3414 3415 3416 3417
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3418
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3419 3420
","
Returns one element of an array.
3421
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3422 3423 3424 3425 3426
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3427
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3428 3429 3430 3431 3432 3433
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3434 3435 3436 3437 3438 3439 3440 3441
"Functions (System)","ARRAY_CONTAINS","
ARRAY_CONTAINS(arrayExpression, value)
","
Returns a boolean true if the array contains the value.
","
CALL ARRAY_CONTAINS(('Hello', 'World'), 'Hello')
"

Thomas Mueller's avatar
Thomas Mueller committed
3442
"Functions (System)","AUTOCOMMIT","
3443
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3444 3445 3446 3447 3448 3449 3450
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3451
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3452
","
3453 3454 3455
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
3456 3457

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3458 3459 3460 3461 3462
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3463
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3464 3465
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3466
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3467 3468 3469 3470 3471
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3472
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3473
","
3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485
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
3486 3487 3488
"

"Functions (System)","COALESCE","
3489
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3490 3491 3492 3493 3494 3495 3496
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3497
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3498 3499 3500 3501 3502 3503 3504
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3505
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3506
","
3507 3508 3509 3510 3511
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
3512 3513 3514 3515 3516
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3517
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3518
","
3519 3520
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
3521 3522

If the column names are specified (a list of column names separated with the
3523
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3524 3525 3526 3527 3528
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
3529 3530 3531 3532 3533

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.

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3538
Instead of a file, an URL may be used, for example
3539 3540
""jar:file:///c:/temp/example.zip!/org/example/nested.csv"".
To read a stream from the classpath, use the prefix ""classpath:"".
Thomas Mueller's avatar
Thomas Mueller committed
3541
To read from HTTP, use the prefix ""http:"" (as in a browser).
3542

Thomas Mueller's avatar
Thomas Mueller committed
3543 3544 3545
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
3546 3547 3548 3549
Admin rights are required to execute this command.
","
CALL CSVREAD('test.csv');
-- Read a file containing the columns ID, NAME with
Thomas Mueller's avatar
Thomas Mueller committed
3550 3551 3552 3553
CALL CSVREAD('test2.csv', 'ID|NAME', 'charset=UTF-8 fieldSeparator=|');
SELECT * FROM CSVREAD('data/test.csv', null, 'rowSeparator=;');
-- Read a tab-separated file
SELECT * FROM CSVREAD('data/test.tsv', null, 'rowSeparator=' || CHAR(9));
Thomas Mueller's avatar
Thomas Mueller committed
3554
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3555
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3556 3557 3558
"

"Functions (System)","CSVWRITE","
3559
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3560
","
3561
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3562
If only a file name is specified, it will be written to the current working directory.
3563
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3564
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
3565 3566 3567 3568 3569

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

Thomas Mueller's avatar
Thomas Mueller committed
3572 3573
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3574
","
Thomas Mueller's avatar
Thomas Mueller committed
3575 3576 3577 3578
CALL CSVWRITE('data/test.csv', 'SELECT * FROM TEST');
CALL CSVWRITE('data/test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
-- Write a tab-separated file
CALL CSVWRITE('data/test.tsv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=' || CHAR(9));
Thomas Mueller's avatar
Thomas Mueller committed
3579 3580 3581
"

"Functions (System)","DATABASE","
3582
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3583 3584 3585 3586 3587 3588 3589
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3590
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3591
","
Thomas Mueller's avatar
Thomas Mueller committed
3592 3593
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
3594 3595 3596 3597
","
CALL DATABASE_PATH();
"

3598
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3599
DECODE(value, whenValue, thenValue [,...])
3600 3601 3602 3603 3604 3605 3606 3607
","
Returns the first matching value. NULL is considered to match NULL.
If no match was found, then NULL or the last parameter (if the parameter count is even) is returned.
This function is provided for Oracle compatibility (see there for details).
","
CALL DECODE(RAND()>0.5, 0, 'Red', 1, 'Black');
"

3608
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3609
DISK_SPACE_USED(tableNameString)
3610 3611 3612 3613 3614 3615 3616 3617
","
Returns the approximate amount of space used by the table specified.
Does not currently take into account indexes or LOB's.
This function may be expensive since it has to load every page in the table.
","
CALL DISK_SPACE_USED('my_table');
"

Thomas Mueller's avatar
Thomas Mueller committed
3618
"Functions (System)","FILE_READ","
3619
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3620 3621 3622 3623
","
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
3624
default character set for this system.
3625 3626 3627 3628

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

Thomas Mueller's avatar
Thomas Mueller committed
3629
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3630 3631 3632 3633 3634 3635
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

"Functions (System)","GREATEST","
3636
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3637 3638 3639 3640 3641 3642 3643
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3644
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3645 3646
","
Returns the last inserted identity value for this session.
3647
This value changes whenever a new sequence number was generated,
3648
even within a trigger or Java function. See also SCOPE_IDENTITY.
3649
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3650 3651 3652 3653 3654
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3655
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3656 3657 3658 3659 3660 3661 3662
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3663
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3664 3665 3666 3667 3668 3669 3670
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3671
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3672 3673
","
Returns the current lock mode. See SET LOCK_MODE.
3674
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3675 3676 3677 3678 3679
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3680
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3681 3682 3683 3684 3685 3686 3687 3688
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3689
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3690
","
3691 3692 3693 3694 3695
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
3696
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3697 3698 3699 3700 3701
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3702
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3703
","
Thomas Mueller's avatar
Thomas Mueller committed
3704
Returns the free memory in KB (where 1024 bytes is a KB).
3705
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3706 3707
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3708 3709 3710 3711 3712
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3713
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3714
","
Thomas Mueller's avatar
Thomas Mueller committed
3715
Returns the used memory in KB (where 1024 bytes is a KB).
3716
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3717 3718
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3719 3720 3721 3722 3723
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3724
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3725
","
3726 3727 3728 3729
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
3730 3731 3732 3733 3734
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3735
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3736 3737 3738 3739 3740 3741
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

3742 3743 3744 3745
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
3746
The data type of the returned value is the data type of 'a' if this is a text type.
3747 3748 3749 3750
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
3751
"Functions (System)","READONLY","
3752
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3753 3754 3755 3756 3757 3758 3759
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
3760
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
3761
","
3762
Returns the number of the current row.
3763 3764
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
3765 3766
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).
3767
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3768
","
3769 3770
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3771
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3772 3773 3774
"

"Functions (System)","SCHEMA","
3775
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3776 3777 3778 3779 3780 3781
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3782 3783 3784 3785 3786 3787 3788 3789 3790 3791
"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
3792
"Functions (System)","SESSION_ID","
3793
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3794
","
3795 3796 3797 3798
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
3799 3800 3801 3802 3803
","
CALL SESSION_ID()
"

"Functions (System)","SET","
3804
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
3805
","
3806 3807 3808
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
3809
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
3810
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
3811 3812 3813 3814 3815
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
3816
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
3817 3818 3819 3820 3821 3822 3823
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
3824
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3825
","
3826 3827
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
3828
Otherwise a value of the following form is returned:
3829
""logFileId-position-sessionId"".
3830 3831
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
3832 3833 3834 3835
","
CALL TRANSACTION_ID()
"

3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847
"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
3848
"Functions (System)","USER","
3849
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
3850 3851 3852 3853 3854 3855
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

3856 3857 3858 3859 3860 3861 3862 3863
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878
"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
3879