help.csv 112.2 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.
Thomas Mueller's avatar
Thomas Mueller committed
161
NOSETTINGS turns off dumping the database settings (the SET XXX commands)
162 163

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

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

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

This command locks objects while it is running.
175

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

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

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

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

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

241
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
242 243 244 245 246 247 248 249
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
250
","
251 252
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
253

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
450 451 452 453 454
","
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');
455 456
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
457 458 459 460 461
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
462 463 464
"

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

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

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

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

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

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

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

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

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

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

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

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

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

"Commands (DDL)","CREATE SEQUENCE","
562 563
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
[ INCREMENT BY long ] [ CACHE long ]
Thomas Mueller's avatar
Thomas Mueller committed
564
","
Thomas Mueller's avatar
Thomas Mueller committed
565 566 567
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
568 569 570 571 572

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
573 574

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

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

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

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

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

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

608 609 610
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
611 612
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
613 614 615 616 617
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
618
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
619
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
620
[ QUEUE int ] [ NOWAIT ] CALL triggeredClassName
Thomas Mueller's avatar
Thomas Mueller committed
621
","
Thomas Mueller's avatar
Thomas Mueller committed
622 623 624 625 626
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).
627

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

Thomas Mueller's avatar
Thomas Mueller committed
633
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
634
Only row based AFTER trigger can be called on ROLLBACK.
635
Exceptions that occur within such triggers are ignored.
636 637
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.
638

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

Thomas Mueller's avatar
Thomas Mueller committed
643 644
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.
645 646
The trigger is called with both 'old' and 'new' set to null.

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

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

656 657
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

Thomas Mueller's avatar
Thomas Mueller committed
658 659
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.
660 661

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
686 687 688 689 690
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.

691 692
Views are not updatable except when using 'instead of' triggers.

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

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

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

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

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

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

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
731 732 733 734 735
","
DROP ALL OBJECTS
"

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

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

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

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

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

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

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
790
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
791
","
Thomas Mueller's avatar
Thomas Mueller committed
792
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
793 794
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.
795
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
796 797 798 799 800
","
DROP TABLE TEST
"

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

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

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

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

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
843 844 845 846 847 848 849
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
850
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
851 852

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
853 854 855 856 857 858 859
","
CHECKPOINT
"

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

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
864 865 866 867 868
","
CHECKPOINT SYNC
"

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

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

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

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

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

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

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

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

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

"Commands (Other)","SET @","
980
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
981
","
Thomas Mueller's avatar
Thomas Mueller committed
982
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
983
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
984
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
985 986 987 988 989
","
SET @TOTAL=0
"

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

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

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

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

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

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

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

1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
"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
1073
"Commands (Other)","SET COLLATION","
1074 1075
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1076
","
Thomas Mueller's avatar
Thomas Mueller committed
1077 1078
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
1079 1080
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
1081
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1082

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

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

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

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1125 1126
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
1127 1128 1129 1130
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
1131

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
1281
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1282

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

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

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

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

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

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

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

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

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

"Commands (Other)","SET MULTI_THREADED","
1367
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1368 1369 1370
","
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
1371 1372 1373 1374 1375
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
1376
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1377
This command commits an open transaction.
1378
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1379 1380 1381 1382 1383
","
SET MULTI_THREADED 1
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1546 1547
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
1548 1549 1550

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,
1551
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
1552 1553

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1557
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1558
","
1559
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1560 1561
"

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

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

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

1589 1590
"Other Grammar","Boolean","
TRUE | FALSE
1591
","
1592
A boolean value.
1593
","
1594
TRUE
1595 1596
"

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

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

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

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

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

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
1647

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

Thomas Mueller's avatar
Thomas Mueller committed
1650 1651
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
1652 1653
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1654
","
Thomas Mueller's avatar
Thomas Mueller committed
1655 1656 1657
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);
1658 1659
"

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1700 1701 1702 1703 1704
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).
1705 1706 1707
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.
1708

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

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

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

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

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

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

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

1800 1801
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1802
","
1803
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1804
","
1805
0
Thomas Mueller's avatar
Thomas Mueller committed
1806 1807
"

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

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

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

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

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

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

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

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

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

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

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

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

1912 1913
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1914
","
1915
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
1916
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1917
","
1918
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
1919 1920
"

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

1931 1932
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
1933
","
1934 1935 1936
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
1937
","
1938
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
1939 1940
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
"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
"

1967 1968
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
1969
","
1970 1971
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
1972 1973 1974 1975 1976
LZF is faster but uses more space.
","
COMPRESSION LZF
"

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

1985 1986
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
1987
","
1988 1989
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
1990
","
1991
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
1992 1993
"

1994 1995
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1996
","
Thomas Mueller's avatar
Thomas Mueller committed
1997
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
1998

Thomas Mueller's avatar
Thomas Mueller committed
1999
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2000
","
2001
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2002 2003
"

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

2016 2017 2018 2019 2020 2021 2022 2023 2024
"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;
"

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

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

2075
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2076 2077 2078 2079 2080 2081 2082 2083 2084
","
INT
"

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

2085
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2086 2087 2088 2089 2090 2091 2092 2093 2094
","
BOOLEAN
"

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

2095
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2096 2097 2098 2099 2100 2101 2102 2103 2104
","
TINYINT
"

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

2105
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2106 2107 2108 2109 2110 2111 2112 2113 2114
","
SMALLINT
"

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

2115
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126
","
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.

2127
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2128 2129 2130 2131 2132
","
IDENTITY
"

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

2138
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2139 2140 2141 2142 2143
","
DECIMAL(20, 2)
"

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

2149
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2150 2151 2152 2153 2154 2155 2156
","
DOUBLE
"

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

2160
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2161 2162 2163 2164 2165 2166 2167
","
REAL
"

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

2170
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
2171 2172 2173 2174 2175 2176 2177
","
TIME
"

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

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

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

2191
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2192 2193 2194 2195 2196
","
TIMESTAMP
"

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

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2213 2214 2215 2216 2217
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
2218

2219
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2220 2221 2222 2223 2224
","
OTHER
"

"Data Types","VARCHAR Type","
2225 2226
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2227
","
Thomas Mueller's avatar
Thomas Mueller committed
2228
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2229 2230 2231 2232 2233 2234 2235
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
2236

2237
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2238 2239 2240 2241 2242
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2243
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2244
","
Thomas Mueller's avatar
Thomas Mueller committed
2245
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2246 2247 2248 2249 2250 2251 2252
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
2253

2254
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2255 2256 2257 2258 2259
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2260
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2261
","
Thomas Mueller's avatar
Thomas Mueller committed
2262 2263 2264
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
2265

Thomas Mueller's avatar
Thomas Mueller committed
2266 2267
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
2268

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

2272
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2273 2274 2275 2276 2277
","
CHAR(10)
"

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

2285
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2286 2287 2288 2289 2290
","
BLOB
"

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

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.

2303
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2304 2305 2306 2307 2308 2309 2310
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2311 2312 2313 2314
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
2315

Thomas Mueller's avatar
Thomas Mueller committed
2316 2317 2318 2319 2320
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
2321
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2322 2323 2324 2325 2326 2327 2328
","
UUID
"

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


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
2335 2336 2337 2338
","
ARRAY
"

2339 2340 2341 2342 2343 2344
"Data Types","GEOMETRY Type","
GEOMETRY
","
A spatial geometry type, based on the com.vividsolutions.jts library.
Normally represented in textual format using the WKT (Well Known Text) format.

Thomas Mueller's avatar
Thomas Mueller committed
2345
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2346 2347 2348 2349 2350
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
ARRAY
"

Thomas Mueller's avatar
Thomas Mueller committed
2351
"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2352
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2353
","
2354 2355
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2356
Aggregates are only allowed in select statements.
2357
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2358 2359 2360 2361 2362
","
AVG(X)
"

"Functions (Aggregate)","BOOL_AND","
2363
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2364
","
2365 2366 2367
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
2368 2369 2370 2371 2372
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2373
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2374
","
2375 2376 2377
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
2378 2379 2380 2381 2382
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2383
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2384
","
2385 2386 2387 2388
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
2389 2390 2391 2392 2393
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2394 2395
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2396
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2397
","
2398 2399 2400 2401 2402
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
2403 2404 2405 2406 2407
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2408
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2409
","
2410 2411 2412 2413
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
2414 2415 2416 2417 2418
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2419
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2420
","
2421 2422 2423 2424
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
2425 2426 2427 2428 2429
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2430
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2431
","
2432 2433 2434
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2435
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2436
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2437 2438 2439 2440 2441
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2442
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2443
","
2444 2445 2446 2447 2448
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
2449 2450 2451 2452 2453
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2454
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2455
","
2456 2457 2458
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
2459 2460 2461 2462 2463 2464
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2465
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2466
","
2467 2468 2469
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
2470 2471 2472 2473 2474 2475
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2476
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2477
","
2478 2479 2480 2481
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
2482 2483 2484 2485 2486
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2487
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2488
","
2489 2490 2491 2492
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
2493 2494 2495 2496 2497
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2498
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2499
","
2500 2501
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"".
2502
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2503 2504 2505 2506 2507
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2508
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2509
","
Thomas Mueller's avatar
Thomas Mueller committed
2510 2511
Calculate the arc cosine.
See also Java ""Math.acos"".
2512
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2513 2514 2515 2516 2517
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2518
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2519
","
Thomas Mueller's avatar
Thomas Mueller committed
2520 2521
Calculate the arc sine.
See also Java ""Math.asin"".
2522
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2523 2524 2525 2526 2527
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2528
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2529
","
Thomas Mueller's avatar
Thomas Mueller committed
2530 2531
Calculate the arc tangent.
See also Java ""Math.atan"".
2532
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2533 2534 2535 2536 2537
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2538
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2539
","
Thomas Mueller's avatar
Thomas Mueller committed
2540 2541
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2542
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2543 2544 2545 2546
","
COS(ANGLE)
"

2547
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2548
COSH(numeric)
2549 2550 2551 2552 2553 2554 2555 2556
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2557
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2558
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2559
","
Thomas Mueller's avatar
Thomas Mueller committed
2560
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2561
See also Java ""Math.*"" functions.
2562
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2563 2564 2565 2566 2567
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2568
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2569
","
Thomas Mueller's avatar
Thomas Mueller committed
2570 2571
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2572
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2573 2574 2575 2576
","
SIN(ANGLE)
"

2577
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2578
SINH(numeric)
2579 2580 2581 2582 2583 2584 2585 2586
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2587
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2588
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2589
","
Thomas Mueller's avatar
Thomas Mueller committed
2590 2591
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2592
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2593 2594 2595 2596
","
TAN(ANGLE)
"

2597
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2598
TANH(numeric)
2599 2600 2601 2602 2603 2604 2605 2606
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2607
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2608
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2609
","
Thomas Mueller's avatar
Thomas Mueller committed
2610
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2611
See also Java ""Math.atan2"".
2612
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2613 2614 2615 2616 2617
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2618
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2619
","
2620 2621
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2622 2623 2624 2625 2626 2627
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2628
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2629
","
2630 2631
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2632 2633 2634 2635 2636 2637
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2638
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2639
","
2640 2641
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2642 2643 2644 2645 2646 2647
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2648
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2649
","
2650 2651
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2652 2653 2654 2655 2656 2657
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2658
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2659
","
2660
See also Java ""Math.ceil"".
2661
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2662
","
2663
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2664 2665 2666
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2667
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2668
","
2669
See also Java ""Math.toDegrees"".
2670
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2671 2672 2673 2674 2675
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2676
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2677
","
2678
See also Java ""Math.exp"".
2679
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2680 2681 2682 2683 2684
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
2685
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2686
","
2687
See also Java ""Math.floor"".
2688
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2689 2690 2691 2692 2693
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2694
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2695
","
2696
See also Java ""Math.log"".
2697
In the PostgreSQL mode, LOG(x) is base 10.
2698
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2699 2700 2701 2702 2703
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
2704
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2705
","
2706
See also Java ""Math.log10"" (in Java 5).
2707
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2708 2709 2710 2711 2712
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
2713
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2714
","
2715
See also Java ""Math.toRadians"".
2716
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2717 2718 2719 2720 2721
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
2722
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2723
","
2724
See also Java ""Math.sqrt"".
2725
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2726 2727 2728 2729 2730
","
SQRT(A)
"

"Functions (Numeric)","PI","
2731
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2732
","
2733
See also Java ""Math.PI"".
2734
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2735 2736 2737 2738 2739
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
2740
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2741
","
2742
See also Java ""Math.pow"".
2743
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2744 2745 2746 2747 2748
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2749
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2750 2751 2752
","
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
2753
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2754 2755 2756 2757 2758
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2759
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2760 2761
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
2762 2763 2764 2765 2766

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
2767 2768 2769 2770 2771
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2772
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
2773
","
2774
Rounds to a number of digits, or to the nearest long if the number of digits if not set.
2775
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2776 2777 2778 2779 2780
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
2781
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2782
","
2783 2784 2785 2786 2787 2788
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
2789 2790 2791 2792 2793
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2794
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2795 2796
","
Generates a number of cryptographically secure random numbers.
2797
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2798 2799 2800 2801 2802
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
2803
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2804 2805 2806 2807 2808 2809 2810
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2811
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2812
","
2813 2814 2815 2816
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
2817 2818 2819 2820 2821
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2822
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2823
","
2824 2825 2826 2827
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
2828 2829 2830 2831 2832 2833
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2834
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2835
","
2836 2837 2838
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
2839 2840 2841 2842 2843
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
2844
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp } )
Thomas Mueller's avatar
Thomas Mueller committed
2845 2846
","
Truncates to a number of digits (to the next value closer to 0).
2847
This method returns a double.
2848
When used with a timestamp, truncates a timestamp to a date (day) value.
Thomas Mueller's avatar
Thomas Mueller committed
2849 2850 2851 2852 2853
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
2854
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
2855
","
2856 2857 2858 2859
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
2860 2861 2862 2863 2864
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
2865
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2866 2867
","
Expands data that was compressed using the COMPRESS function.
2868
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2869 2870 2871 2872 2873
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
2874
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
2875 2876 2877 2878 2879 2880 2881
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
2882
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
2883 2884
","
Returns the ASCII value of the first character in the string.
2885
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2886 2887 2888 2889
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
2890
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2891
","
2892 2893 2894
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
2895 2896 2897 2898 2899
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
2900
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2901
","
2902 2903 2904
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
2905 2906 2907 2908 2909
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
2910
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2911
","
2912 2913 2914 2915
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
2916 2917 2918 2919 2920
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
2921
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
2922 2923
","
Returns the character that represents the ASCII value.
2924
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2925 2926 2927 2928 2929
","
CHAR(65)
"

"Functions (String)","CONCAT","
2930
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
2931 2932
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
2933 2934
Unlike with the operator ""||"", NULL parameters are ignored, 
and do not cause the result to become NULL.
2935
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2936 2937 2938 2939
","
CONCAT(NAME, '!')
"

2940 2941 2942 2943
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
2944 2945
Unlike with the operator ""||"", NULL parameters are ignored, 
and do not cause the result to become NULL.
2946 2947 2948 2949 2950
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
2951
"Functions (String)","DIFFERENCE","
2952
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
2953 2954
","
Returns the difference between the sounds of two strings.
2955
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2956 2957 2958 2959 2960
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
2961
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
2962
","
2963 2964
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
2965 2966 2967 2968 2969
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
2970
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2971
","
2972 2973 2974
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
2975 2976 2977 2978 2979
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
2980
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2981
","
2982
Returns the location of a search string in a string.
2983 2984 2985
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
2986 2987 2988 2989 2990
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
2991
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
2992
","
2993 2994 2995
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
2996 2997 2998 2999 3000
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3001
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3002 3003 3004 3005 3006 3007 3008
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3009
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3010 3011 3012 3013 3014 3015 3016
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3017
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3018 3019 3020 3021 3022 3023 3024
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3025
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3026 3027 3028 3029 3030 3031 3032
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3033
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3034
","
3035 3036 3037 3038
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
3039 3040 3041 3042 3043
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3044
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3045 3046 3047 3048 3049 3050 3051
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3052
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3053
","
3054 3055 3056
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
3057 3058 3059 3060 3061
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3062
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3063
","
3064 3065 3066
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
3067 3068 3069 3070 3071
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3072
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3073 3074 3075 3076 3077 3078 3079
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3080
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3081 3082 3083 3084 3085 3086 3087
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3088
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3089
","
3090 3091
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
3092 3093 3094 3095 3096
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3097
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
3098
","
3099
Replaces each substring that matches a regular expression.
3100
For details, see the Java ""String.replaceAll()"" method.
3101
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3102 3103 3104 3105 3106
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
3107
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3108 3109 3110 3111 3112 3113 3114
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3115
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3116
","
3117 3118
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.
3119
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3120 3121 3122 3123 3124
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3125
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3126
","
3127 3128 3129
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
3130 3131 3132 3133 3134
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3135
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3136 3137 3138 3139 3140 3141 3142
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3143
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3144
","
3145 3146 3147
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
3148 3149 3150 3151 3152
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3153
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3154
","
3155 3156 3157
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
3158 3159 3160 3161 3162
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

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

"Functions (String)","SUBSTRING","
3172
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3173
","
3174
Returns a substring of a string starting at a position.
3175
If the start index is negative, then the start index is relative to the end of the string.
3176
The length is optional.
3177
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3178
","
3179 3180
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3181 3182 3183
"

"Functions (String)","UTF8TOSTRING","
3184
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3185 3186 3187 3188 3189 3190 3191
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3192
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3193
","
3194
Creates an XML attribute element of the form ""name=value"".
3195 3196
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3197 3198 3199 3200 3201
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3202
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3203 3204
","
Create an XML node element.
3205 3206 3207
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.
3208
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3209 3210 3211 3212 3213
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3214
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3215
","
3216
Creates an XML comment.
3217
Two dashes (""--"") are converted to ""- -"".
3218
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3219 3220 3221 3222 3223
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3224
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3225
","
3226
Creates an XML CDATA element.
3227
If the value contains ""]]>"", an XML text element is created instead.
3228
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3229 3230 3231 3232 3233
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3234
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3235
","
Thomas Mueller's avatar
Thomas Mueller committed
3236
Returns the XML declaration.
3237
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3238 3239 3240 3241 3242
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3243
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3244 3245
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3246
If enabled, newline and linefeed is converted to an XML entity (&#).
3247
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3248 3249 3250 3251 3252
","
CALL XMLTEXT('test')
"

"Functions (Time and Date)","CURRENT_DATE","
3253
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3254 3255
","
Returns the current date.
3256
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3257 3258 3259 3260 3261
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3262
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3263 3264
","
Returns the current time.
3265
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3266 3267 3268 3269 3270
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3271
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3272
","
3273 3274
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3275
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3276 3277 3278 3279 3280
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3281
{ DATEADD| TIMESTAMPADD } (unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3282
","
3283 3284 3285 3286
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
3287 3288 3289 3290 3291
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3292
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3293
","
Thomas Mueller's avatar
Thomas Mueller committed
3294
Returns the the number of crossed unit boundaries between two timestamps.
3295 3296
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3297 3298 3299 3300 3301 3302
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3303
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3304 3305 3306 3307 3308 3309 3310
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3311
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3312 3313 3314 3315 3316 3317 3318
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3319
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3320 3321 3322 3323 3324 3325 3326
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3327
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3328 3329 3330 3331 3332 3333 3334
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3335
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3336
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3337
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3338 3339
","
Returns a specific value from a timestamps.
3340
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3341 3342 3343 3344 3345
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3346
FORMATDATETIME ( timestamp, formatString
3347
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3348
","
3349 3350 3351
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.
3352
For details of the format, see ""java.text.SimpleDateFormat"".
3353
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3354 3355 3356 3357 3358 3359
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3360
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3361 3362 3363 3364 3365 3366 3367
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3368
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3369 3370 3371 3372 3373 3374 3375
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3376
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3377 3378 3379 3380 3381 3382 3383
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3384
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3385 3386 3387 3388 3389 3390 3391
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3392
PARSEDATETIME(string, formatString
3393
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3394
","
3395 3396 3397
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.
3398
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3399 3400 3401 3402 3403 3404
","
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","
3405
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3406 3407 3408 3409 3410 3411 3412
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3413
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3414 3415 3416 3417 3418 3419 3420
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3421
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3422
","
3423 3424
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3425 3426 3427 3428 3429
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3430
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3431 3432 3433 3434 3435 3436 3437
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3438
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3439 3440
","
Returns one element of an array.
3441
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3442 3443 3444 3445 3446
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3447
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3448 3449 3450 3451 3452 3453
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3454 3455 3456 3457 3458 3459 3460 3461
"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
3462
"Functions (System)","AUTOCOMMIT","
3463
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3464 3465 3466 3467 3468 3469 3470
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3471
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3472
","
3473 3474 3475
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
3476 3477

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3478 3479 3480 3481 3482
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3483
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3484 3485
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3486
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3487 3488 3489 3490 3491
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3492
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3493
","
3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505
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
3506 3507 3508
"

"Functions (System)","COALESCE","
3509
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3510 3511 3512 3513 3514 3515 3516
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3517
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3518 3519 3520 3521 3522 3523 3524
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3525
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3526
","
3527 3528 3529 3530 3531
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
3532 3533 3534 3535 3536
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3537
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3538
","
3539 3540
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
3541 3542

If the column names are specified (a list of column names separated with the
3543
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3544 3545 3546 3547 3548
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
3549 3550 3551 3552 3553

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3563 3564 3565
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
3566 3567 3568 3569
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
3570 3571 3572 3573
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
3574
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3575
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3576 3577 3578
"

"Functions (System)","CSVWRITE","
3579
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3580
","
3581
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3582
If only a file name is specified, it will be written to the current working directory.
3583
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3584
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
3585 3586 3587 3588 3589

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

Thomas Mueller's avatar
Thomas Mueller committed
3592 3593
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3594
","
Thomas Mueller's avatar
Thomas Mueller committed
3595 3596 3597 3598
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
3599 3600 3601
"

"Functions (System)","DATABASE","
3602
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3603 3604 3605 3606 3607 3608 3609
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3610
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3611
","
Thomas Mueller's avatar
Thomas Mueller committed
3612 3613
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
3614 3615 3616 3617
","
CALL DATABASE_PATH();
"

3618
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3619
DECODE(value, whenValue, thenValue [,...])
3620 3621 3622 3623 3624 3625 3626 3627
","
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');
"

3628
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3629
DISK_SPACE_USED(tableNameString)
3630 3631 3632 3633 3634 3635 3636 3637
","
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
3638
"Functions (System)","FILE_READ","
3639
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3640 3641 3642 3643
","
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
3644
default character set for this system.
3645 3646 3647 3648

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

Thomas Mueller's avatar
Thomas Mueller committed
3649
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3650 3651 3652 3653 3654 3655
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

"Functions (System)","GREATEST","
3656
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3657 3658 3659 3660 3661 3662 3663
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3664
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3665 3666
","
Returns the last inserted identity value for this session.
3667
This value changes whenever a new sequence number was generated,
3668
even within a trigger or Java function. See also SCOPE_IDENTITY.
3669
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3670 3671 3672 3673 3674
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3675
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3676 3677 3678 3679 3680 3681 3682
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3683
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3684 3685 3686 3687 3688 3689 3690
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3691
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3692 3693
","
Returns the current lock mode. See SET LOCK_MODE.
3694
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3695 3696 3697 3698 3699
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3700
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3701 3702 3703 3704 3705 3706 3707 3708
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3709
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3710
","
3711 3712 3713 3714 3715
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
3716
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3717 3718 3719 3720 3721
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3722
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3723
","
Thomas Mueller's avatar
Thomas Mueller committed
3724
Returns the free memory in KB (where 1024 bytes is a KB).
3725
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3726 3727
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3728 3729 3730 3731 3732
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3733
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3734
","
Thomas Mueller's avatar
Thomas Mueller committed
3735
Returns the used memory in KB (where 1024 bytes is a KB).
3736
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3737 3738
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3739 3740 3741 3742 3743
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3744
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3745
","
3746 3747 3748 3749
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
3750 3751 3752 3753 3754
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3755
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3756 3757 3758 3759 3760 3761
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

3762 3763 3764 3765
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
3766
The data type of the returned value is the data type of 'a' if this is a text type.
3767 3768 3769 3770
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
3771
"Functions (System)","READONLY","
3772
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3773 3774 3775 3776 3777 3778 3779
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
3780
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
3781
","
3782
Returns the number of the current row.
3783 3784
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
3785 3786
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).
3787
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3788
","
3789 3790
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3791
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3792 3793 3794
"

"Functions (System)","SCHEMA","
3795
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3796 3797 3798 3799 3800 3801
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3802 3803 3804 3805 3806 3807 3808 3809 3810 3811
"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
3812
"Functions (System)","SESSION_ID","
3813
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3814
","
3815 3816 3817 3818
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
3819 3820 3821 3822 3823
","
CALL SESSION_ID()
"

"Functions (System)","SET","
3824
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
3825
","
3826 3827 3828
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
3829
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
3830
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
3831 3832 3833 3834 3835
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
3836
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
3837 3838 3839 3840 3841 3842 3843
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
3844
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3845
","
3846 3847
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
3848
Otherwise a value of the following form is returned:
3849
""logFileId-position-sessionId"".
3850 3851
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
3852 3853 3854 3855
","
CALL TRANSACTION_ID()
"

3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867
"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
3868
"Functions (System)","USER","
3869
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
3870 3871 3872 3873 3874 3875
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

3876 3877 3878 3879 3880 3881 3882 3883
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898
"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
3899