help.csv 119.9 KB
Newer Older
1 2
# Copyright 2004-2014 H2 Group. Multiple-Licensed under the MPL 2.0,
# and the EPL 1.0 (http://h2database.com/html/license.html).
Thomas Mueller's avatar
Thomas Mueller committed
3 4 5
# Initial Developer: H2 Group
"SECTION","TOPIC","SYNTAX","TEXT","EXAMPLE"
"Commands (DML)","SELECT","
6 7 8 9 10
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 ] ]
11
[ FOR UPDATE ]
Thomas Mueller's avatar
Thomas Mueller committed
12 13
","
Selects data from a table or multiple tables.
14 15 16 17
GROUP BY groups the the result by the given expression(s).
HAVING filter rows after grouping.
ORDER BY sorts the result by the given column(s) or expression(s).
UNION combines the result of this query with the results of another query.
Thomas Mueller's avatar
Thomas Mueller committed
18

19
LIMIT limits the number of rows returned by the query (no limit if null or smaller than zero).
Thomas Mueller's avatar
Thomas Mueller committed
20
OFFSET specified how many rows to skip.
21
SAMPLE_SIZE limits the number of rows read for aggregate queries.
22

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

27 28
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
29
In this case, aggregate, GROUP BY, DISTINCT queries or joins
30
are not allowed in this case.
Thomas Mueller's avatar
Thomas Mueller committed
31 32
","
SELECT * FROM TEST;
33 34 35 36 37
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
38 39 40 41 42 43
SELECT * FROM (SELECT ID, COUNT(*) FROM TEST
    GROUP BY ID UNION SELECT NULL, COUNT(*) FROM TEST)
    ORDER BY 1 NULLS LAST;
"

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

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
54 55 56 57 58
","
INSERT INTO TEST VALUES(1, 'Hello')
"

"Commands (DML)","UPDATE","
59 60 61
UPDATE tableName [ [ AS ] newTableAlias ] SET
{ { columnName = { DEFAULT | expression } } [,...] } |
    { ( columnName [,...] ) = ( select ) }
62
[ WHERE expression ] [ ORDER BY order [,...] ] [ LIMIT expression ]
Thomas Mueller's avatar
Thomas Mueller committed
63 64
","
Updates data in a table.
65
ORDER BY is supported for MySQL compatibility, but it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
66
","
67 68
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
69 70 71
"

"Commands (DML)","DELETE","
72
DELETE [ TOP term ] FROM tableName [ WHERE expression ] [ LIMIT term ]
Thomas Mueller's avatar
Thomas Mueller committed
73 74
","
Deletes rows form a table.
75
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
76 77 78 79 80 81 82
","
DELETE FROM TEST WHERE ID=2
"

"Commands (DML)","BACKUP","
BACKUP TO fileNameString
","
Thomas Mueller's avatar
Thomas Mueller committed
83 84
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
85
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
86 87 88 89 90 91 92
","
BACKUP TO 'backup.zip'
"

"Commands (DML)","CALL","
CALL expression
","
Thomas Mueller's avatar
Thomas Mueller committed
93 94 95
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
96 97 98 99 100
","
CALL 15*25
"

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

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

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

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

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

"Commands (DML)","SCRIPT","
147 148
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
149
[ TO fileNameString scriptCompressionEncryption
150
    [ CHARSET charsetString ] ]
151 152
[ TABLE tableName [, ...] ]
[ SCHEMA schemaName [, ...] ]
Thomas Mueller's avatar
Thomas Mueller committed
153
","
154 155 156 157 158 159 160
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
161 162
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
163
out-of-line commands.
Thomas Mueller's avatar
Thomas Mueller committed
164
NOSETTINGS turns off dumping the database settings (the SET XXX commands)
165

166
If no 'TO fileName' clause is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
167 168 169 170
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.

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

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

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

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

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

203 204 205 206
"Commands (DDL)","ALTER SCHEMA RENAME","
ALTER SCHEMA schema RENAME TO newSchemaName
","
Renames a schema.
Thomas Mueller's avatar
Thomas Mueller committed
207
This command commits an open transaction in this connection.
208 209 210 211
","
ALTER SCHEMA TEST RENAME TO PRODUCTION
"

Thomas Mueller's avatar
Thomas Mueller committed
212
"Commands (DDL)","ALTER SEQUENCE","
213
ALTER SEQUENCE sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
214 215 216 217
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
[ CYCLE long | NOCYCLE |  NO CYCLE ]
[ CACHE long |  NOCACHE |  NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
218
","
219
Changes the parameters of a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
220
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
221 222 223 224 225 226
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

"Commands (DDL)","ALTER TABLE ADD","
227
ALTER TABLE tableName ADD [ COLUMN ]
Thomas Mueller's avatar
Thomas Mueller committed
228
{ [ IF NOT EXISTS ] columnDefinition [ { BEFORE | AFTER } columnName ]
229
    | ( { columnDefinition } [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
230
","
Thomas Mueller's avatar
Thomas Mueller committed
231
Adds a new column to a table.
Thomas Mueller's avatar
Thomas Mueller committed
232
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
233 234 235 236 237
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
238
ALTER TABLE tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
239 240 241
","
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
242
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
243
It is not possible to disable checking for unique constraints.
Thomas Mueller's avatar
Thomas Mueller committed
244
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
245 246 247 248
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

249
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
250 251 252 253 254 255 256 257
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
258
","
259 260
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
261

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

264 265 266
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
267

268 269 270 271
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
272

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

275
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
276
Single column indexes on this column are dropped.
277 278 279

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

Thomas Mueller's avatar
Thomas Mueller committed
280
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
281
","
282 283 284 285 286 287 288
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
289 290 291
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
292
ALTER TABLE tableName DROP COLUMN [ IF EXISTS ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
293
","
294
Removes column(s) from a table.
Thomas Mueller's avatar
Thomas Mueller committed
295
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
296 297
","
ALTER TABLE TEST DROP COLUMN NAME
298
ALTER TABLE TEST DROP COLUMN NAME1, NAME2
Thomas Mueller's avatar
Thomas Mueller committed
299 300 301
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
302
ALTER TABLE tableName DROP { CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
303 304
","
Removes a constraint or a primary key from a table.
Thomas Mueller's avatar
Thomas Mueller committed
305
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
306 307 308 309 310 311
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
ALTER TABLE tableName SET REFERENTIAL_INTEGRITY
312
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
313 314 315 316 317 318
","
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.
319

Thomas Mueller's avatar
Thomas Mueller committed
320
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
321 322 323 324 325 326 327
","
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
328
Renames a table.
Thomas Mueller's avatar
Thomas Mueller committed
329
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
330 331 332 333 334
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
335
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
336
","
Thomas Mueller's avatar
Thomas Mueller committed
337 338 339 340
Switches the admin flag of a user on or off.

Only unquoted or uppercase user names are allowed.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
341
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
342 343 344 345 346 347 348
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
349 350 351 352
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
353
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
354
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
355 356 357 358 359
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
360
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
361
","
Thomas Mueller's avatar
Thomas Mueller committed
362 363 364 365 366 367
Changes the password of a user.
Only unquoted or uppercase user names are allowed.
The password must be enclosed in single quotes. It is case sensitive
and can contain spaces. The salt and hash values are hex strings.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
368
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
369 370 371 372 373 374 375 376
","
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
377
This command is used for views created using CREATE FORCE VIEW.
Thomas Mueller's avatar
Thomas Mueller committed
378
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
379 380 381 382 383
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
384
ANALYZE [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
385 386 387 388 389 390 391
","
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.
392

Thomas Mueller's avatar
Thomas Mueller committed
393
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
394 395 396 397 398
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
399 400 401 402 403
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
404
","
Thomas Mueller's avatar
Thomas Mueller committed
405 406 407
Sets the comment of a database object. Use NULL to remove the comment.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
408
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
409 410 411 412 413
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
414
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
415 416 417
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
418
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
419 420

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
421
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
422 423 424 425 426
","
CREATE AGGREGATE MEDIAN FOR ""com.acme.db.Median""
"

"Commands (DDL)","CREATE ALIAS","
Thomas Mueller's avatar
Thomas Mueller committed
427
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
Thomas Mueller's avatar
Thomas Mueller committed
428
[ NOBUFFER ] { FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
429
","
430 431 432 433 434 435
Creates a new function alias. If this is a ResultSet returning function,
by default the return value is cached in a local temporary file.

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

DETERMINISTIC - Deterministic functions must always return the same value for the same parameters.
436 437 438

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

444 445
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.
446 447
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
448 449
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
450

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

454
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
455 456 457
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.
458

Thomas Mueller's avatar
Thomas Mueller committed
459
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
460
This command commits an open transaction in this connection.
461 462

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
463 464 465 466 467
","
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');
468 469
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
470 471 472 473 474
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
475 476 477
"

"Commands (DDL)","CREATE CONSTANT","
478
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
479
","
Thomas Mueller's avatar
Thomas Mueller committed
480
Creates a new constant.
Thomas Mueller's avatar
Thomas Mueller committed
481
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
482 483 484 485 486
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
487 488 489
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
490 491
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
492
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
493
to the value being tested.
494

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

Thomas Mueller's avatar
Thomas Mueller committed
497
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
498 499 500 501 502
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
503
CREATE
Thomas Mueller's avatar
Thomas Mueller committed
504
{ [ UNIQUE ] [ HASH | SPATIAL] INDEX [ [ IF NOT EXISTS ] newIndexName ]
505 506
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
507
","
Thomas Mueller's avatar
Thomas Mueller committed
508
Creates a new index.
Thomas Mueller's avatar
Thomas Mueller committed
509
This command commits an open transaction in this connection.
510

Thomas Mueller's avatar
Thomas Mueller committed
511
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
512 513
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
514
Non-unique keys are supported.
515
Spatial indexes are supported only on Geometry columns.
Thomas Mueller's avatar
Thomas Mueller committed
516 517 518 519 520
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
521
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ]
Thomas Mueller's avatar
Thomas Mueller committed
522
LINKED TABLE [ IF NOT EXISTS ]
523 524
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
525 526 527 528 529
","
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.

530 531 532
FORCE - Create the LINKED TABLE even if the remote database/table does not exist.

EMIT UPDATES - Usually, for update statements, the old rows are deleted first and then the new
Thomas Mueller's avatar
Thomas Mueller committed
533 534
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
535
work. Linked tables to the same database share one connection.
536

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

Thomas Mueller's avatar
Thomas Mueller committed
539 540 541
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).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
549
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
550
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
551 552 553 554 555 556 557 558 559
","
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","
560
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
561
","
Thomas Mueller's avatar
Thomas Mueller committed
562
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
563
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
564 565 566 567 568
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
569
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
Thomas Mueller's avatar
Thomas Mueller committed
570 571 572
","
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
573
Specifying the owner currently has no effect.
574

Thomas Mueller's avatar
Thomas Mueller committed
575
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
576 577 578 579 580
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
581
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
582 583 584 585 586
[ INCREMENT BY long ]
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
[ CYCLE long | NOCYCLE |  NO CYCLE ]
[ CACHE long |  NOCACHE |  NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
587
","
Thomas Mueller's avatar
Thomas Mueller committed
588 589 590
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
591 592 593 594 595

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
596

Thomas Mueller's avatar
Thomas Mueller committed
597
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
598 599 600 601 602
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
603 604
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
605
[ ( { columnDefinition | constraint } [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
606
[ ENGINE tableEngineName [ WITH tableEngineParamName [,...] ] ]
607
[ NOT PERSISTENT ] [ TRANSACTIONAL ]
608
[ AS select ]","
Thomas Mueller's avatar
Thomas Mueller committed
609 610
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
611 612 613 614
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
615
that means memory tables should not get too large.
616

Thomas Mueller's avatar
Thomas Mueller committed
617 618 619 620 621
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,
622
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
623

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

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

631 632 633
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
634 635
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
636 637 638 639 640
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
641
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
642
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
643
[ QUEUE int ] [ NOWAIT ] { CALL triggeredClassName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
644
","
Thomas Mueller's avatar
Thomas Mueller committed
645 646 647 648 649
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).
650

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

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

Thomas Mueller's avatar
Thomas Mueller committed
659
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
660
Only row based AFTER trigger can be called on ROLLBACK.
661
Exceptions that occur within such triggers are ignored.
662 663
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.
664

665
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
666
Only the first such trigger is called. Such triggers on views are supported.
667
They can be used to make views updatable.
668

Thomas Mueller's avatar
Thomas Mueller committed
669 670
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.
671 672
The trigger is called with both 'old' and 'new' set to null.

673 674 675 676
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
677 678
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
679 680 681
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.

682 683
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

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

Thomas Mueller's avatar
Thomas Mueller committed
687
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
688
","
689
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger"";
Thomas Mueller's avatar
Thomas Mueller committed
690
CREATE TRIGGER TRIG_SRC BEFORE INSERT ON TEST AS $$org.h2.api.Trigger create() { return new MyTrigger(""constructorParam""); } $$;
Thomas Mueller's avatar
Thomas Mueller committed
691 692
"
"Commands (DDL)","CREATE USER","
693 694
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
695
","
Thomas Mueller's avatar
Thomas Mueller committed
696 697 698
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.
699

Thomas Mueller's avatar
Thomas Mueller committed
700
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
701
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
702 703 704 705 706
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
707
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
708
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
709 710
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
711
if the underlying table(s) don't exist.
712

Thomas Mueller's avatar
Thomas Mueller committed
713 714 715 716 717
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.

718 719
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
720
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
721
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
722 723 724 725 726
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
727
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
728
","
Thomas Mueller's avatar
Thomas Mueller committed
729 730 731
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
732
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
733
","
Thomas Mueller's avatar
Thomas Mueller committed
734
DROP AGGREGATE MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
735 736 737
"

"Commands (DDL)","DROP ALIAS","
738
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
739
","
Thomas Mueller's avatar
Thomas Mueller committed
740 741 742
Drops an existing function alias.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
743
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
744
","
Thomas Mueller's avatar
Thomas Mueller committed
745
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
746 747 748
"

"Commands (DDL)","DROP ALL OBJECTS","
749
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
750 751 752 753 754
","
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
755 756 757
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
758 759 760 761 762
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
763
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
764
","
Thomas Mueller's avatar
Thomas Mueller committed
765
Drops a constant.
Thomas Mueller's avatar
Thomas Mueller committed
766
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
767 768 769 770 771
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
772
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
773
","
Thomas Mueller's avatar
Thomas Mueller committed
774
Drops a data type (domain).
Thomas Mueller's avatar
Thomas Mueller committed
775
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
776 777 778 779 780
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
781
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
782
","
Thomas Mueller's avatar
Thomas Mueller committed
783
Drops an index.
Thomas Mueller's avatar
Thomas Mueller committed
784
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
785 786 787 788 789
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
790
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
791
","
Thomas Mueller's avatar
Thomas Mueller committed
792
Drops a role.
Thomas Mueller's avatar
Thomas Mueller committed
793
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
794 795 796 797 798
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
799
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
800
","
Thomas Mueller's avatar
Thomas Mueller committed
801
Drops a schema.
Thomas Mueller's avatar
Thomas Mueller committed
802
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
803 804 805 806 807
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
808
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
809
","
Thomas Mueller's avatar
Thomas Mueller committed
810
Drops a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
811
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
812 813 814 815 816
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
817
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
818
","
Thomas Mueller's avatar
Thomas Mueller committed
819
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
820 821
The command will fail if dependent views exist and the RESTRICT clause is used (the default).
All dependent views are dropped as well if the CASCADE clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
822
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
823 824 825 826 827
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
828
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
829
","
Thomas Mueller's avatar
Thomas Mueller committed
830
Drops an existing trigger.
Thomas Mueller's avatar
Thomas Mueller committed
831
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
832 833 834 835 836
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
837
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
838
","
Thomas Mueller's avatar
Thomas Mueller committed
839 840
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
841

Thomas Mueller's avatar
Thomas Mueller committed
842
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
843
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
844 845 846 847 848
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
849
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
850
","
Thomas Mueller's avatar
Thomas Mueller committed
851 852 853
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
854
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
855 856 857 858 859 860 861
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
862 863 864 865 866
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).
867
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
868

Thomas Mueller's avatar
Thomas Mueller committed
869
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
870 871 872 873 874 875 876
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
877
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
878 879

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
880 881 882 883 884 885 886
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
887
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
888 889 890
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
891 892 893 894 895
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
896
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
897 898 899 900 901 902 903 904 905
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
906 907 908 909
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
910 911 912 913 914
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
915
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
916 917
{ { SCHEMA schemaName } | { tableName [,...] } }
TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
918
","
Thomas Mueller's avatar
Thomas Mueller committed
919 920 921
Grants rights for a table to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
922
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
923 924 925 926
","
GRANT SELECT ON TEST TO READONLY
"

927 928 929 930 931 932
"Commands (Other)","GRANT ALTER ANY SCHEMA","
GRANT ALTER ANY SCHEMA TO userName
","
Grant schema altering rights to a user.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
933
This command commits an open transaction in this connection.
934 935 936 937
","
GRANT ALTER ANY SCHEMA TO Bob
"

Thomas Mueller's avatar
Thomas Mueller committed
938
"Commands (Other)","GRANT ROLE","
939
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
940
","
Thomas Mueller's avatar
Thomas Mueller committed
941 942 943
Grants a role to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
944
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
945 946 947 948 949
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
950
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
951 952 953 954 955 956 957 958 959
","
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
960 961
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
962 963 964 965 966
","
PREPARE COMMIT XID_TEST
"

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

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

"Commands (Other)","REVOKE ROLE","
980
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
981
","
Thomas Mueller's avatar
Thomas Mueller committed
982 983 984
Removes a role from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
985
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
986 987 988 989 990
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
991
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
992 993 994 995 996 997 998 999 1000 1001
","
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
1002 1003 1004 1005
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
1006 1007 1008 1009 1010 1011 1012
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1013 1014
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
1015 1016 1017 1018 1019
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1020
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1021
","
Thomas Mueller's avatar
Thomas Mueller committed
1022
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1023
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
1024
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1025 1026 1027 1028 1029
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1030
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
","
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
1041 1042
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1043
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1044
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1045
This setting is persistent.
1046
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1047 1048 1049 1050 1051
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
1052
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
1053 1054
","
Switches auto commit on or off.
1055
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
1056
however this will not work as expected when using a connection pool
1057 1058
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
1059
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
1060 1061 1062 1063 1064 1065 1066
","
SET AUTOCOMMIT OFF
"

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1078
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1079
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1080
This setting is persistent.
1081
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
","
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
1094 1095
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1096
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1097 1098 1099 1100
","
SET CLUSTER ''
"

1101 1102 1103 1104
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1105 1106
Sets the collation used for comparing BINARY columns, the default is SIGNED
for version 1.3 and older, and UNSIGNED for version 1.4 and newer.
1107 1108 1109
This command can only be executed if there are no tables defined.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1110
This command commits an open transaction in this connection.
1111 1112 1113 1114 1115
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

Thomas Mueller's avatar
Thomas Mueller committed
1116
"Commands (Other)","SET COLLATION","
1117 1118
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1119
","
Thomas Mueller's avatar
Thomas Mueller committed
1120 1121
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
1122 1123
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
1124
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1125

1126 1127 1128 1129 1130 1131
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
1132
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1133
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1134
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1135 1136 1137 1138 1139
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1140
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1141
","
Thomas Mueller's avatar
Thomas Mueller committed
1142 1143 1144 1145
This feature is only available for the PageStore storage engine.
For the MVStore engine (the default for H2 version 1.4.x),
append "";COMPRESS=TRUE"" to the database URL instead.

Thomas Mueller's avatar
Thomas Mueller committed
1146 1147
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
1148

Thomas Mueller's avatar
Thomas Mueller committed
1149
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1150
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1151
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1152 1153 1154 1155 1156 1157 1158 1159
","
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
1160 1161 1162 1163
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).
1164
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1165 1166 1167 1168 1169 1170 1171
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1172 1173
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
1174 1175 1176 1177
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
1178

Thomas Mueller's avatar
Thomas Mueller committed
1179
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1180
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1181
This setting is persistent.
1182
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1183 1184 1185 1186 1187 1188 1189 1190
","
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
1191 1192
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1193
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1194
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1195
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1196 1197 1198 1199 1200
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1201
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1202 1203 1204
","
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
1205
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1206
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1207

Thomas Mueller's avatar
Thomas Mueller committed
1208
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1209
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1210
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1211
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1212 1213 1214 1215 1216
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1217
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1218
","
Thomas Mueller's avatar
Thomas Mueller committed
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
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
1229 1230

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1231
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1232
","
Thomas Mueller's avatar
Thomas Mueller committed
1233
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1234 1235 1236
"

"Commands (Other)","SET IGNORECASE","
1237
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1238 1239 1240 1241 1242
","
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
1243
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1244

Thomas Mueller's avatar
Thomas Mueller committed
1245
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1246
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1247
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1248
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1249 1250 1251 1252
","
SET IGNORECASE TRUE
"

1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
"Commands (Other)","SET JAVA_OBJECT_SERIALIZER","
SET JAVA_OBJECT_SERIALIZER
{ null | className }
","
Sets the object used to serialize and deserialize java objects being stored in column of type OTHER.
The serializer class must be public and implement ""org.h2.api.JavaObjectSerializer"".
Inner classes are not supported.
The class must be available in the classpath of the database engine
(when using the server mode, it must be both in the classpath of the server and the client).
This command can only be executed if there are no tables defined.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1265
This command commits an open transaction in this connection.
1266 1267 1268 1269 1270 1271 1272
This setting is persistent.
This setting can be appended to the database URL: ""jdbc:h2:test;JAVA_OBJECT_SERIALIZER='com.acme.SerializerClassName'""
","
SET JAVA_OBJECT_SERIALIZER 'com.acme.SerializerClassName'
"


1273
"Commands (Other)","SET LOG","
1274
SET LOG int
1275 1276 1277 1278
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1279
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1280 1281 1282 1283
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.

1284 1285
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
1286 1287
against power failure is required, but the data must be protected against killing the process.

1288 1289
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
1290 1291
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1292
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1293
This command commits an open transaction in this connection.
1294
This setting is not persistent.
1295
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1296 1297 1298 1299
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1300 1301 1302 1303
"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
1304
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317

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
1318
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1319
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1320
This setting is persistent.
1321
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1322 1323 1324 1325 1326 1327 1328 1329
","
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
1330 1331 1332
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1333
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1334 1335 1336 1337 1338 1339 1340
","
SET LOCK_TIMEOUT 1000
"

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

1343
This is the maximum length of an LOB that is stored with the record itself,
1344 1345
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1346
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1347
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1348
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1349 1350 1351 1352 1353 1354 1355
","
SET MAX_LENGTH_INPLACE_LOB 128
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1362
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1363
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1364
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1365 1366 1367 1368 1369 1370 1371 1372
","
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
1373
are read, then the rows are buffered to disk.
1374
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1375

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 in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1378
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1379
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1380 1381 1382 1383 1384 1385 1386
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1393
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1394
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1395
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1396
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1397 1398 1399 1400 1401 1402 1403 1404 1405
","
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
1406 1407 1408
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1409
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1410
It has no effect for in-memory databases.
1411
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1412 1413 1414 1415 1416
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1417
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1418 1419
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1420 1421 1422
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1423
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1424
This command commits an open transaction in this connection.
1425
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1426 1427 1428 1429 1430
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1431
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1432 1433 1434
","
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
1435 1436 1437 1438 1439
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
1440
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1441
This command commits an open transaction in this connection.
1442
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1443 1444 1445 1446 1447
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1448
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1449 1450 1451
","
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
1452 1453
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1454
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1455
This command commits an open transaction in this connection.
1456
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1457 1458 1459 1460 1461 1462 1463 1464 1465
","
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
1466

Thomas Mueller's avatar
Thomas Mueller committed
1467
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1468 1469 1470 1471
","
SET PASSWORD 'abcstzri!.5'
"

1472 1473 1474 1475 1476 1477 1478
"Commands (Other)","SET QUERY_STATISTICS","
SET QUERY_STATISTICS { TRUE | FALSE }
","
Disabled or enables query statistics gathering for the whole database.
The statistics are reflected in the INFORMATION_SCHEMA.QUERY_STATISTICS meta-table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1479
This command commits an open transaction in this connection.
1480 1481 1482 1483 1484
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
"Commands (Other)","SET QUERY_STATISTICS_MAX_ENTRIES","
SET QUERY_STATISTICS int
","
Set the maximum number of entries in query statistics meta-table.
Default value is 100.

This setting is not persistent.
This command commits an open transaction in this connection.
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS_MAX_ENTRIES 500
"

Thomas Mueller's avatar
Thomas Mueller committed
1498 1499 1500 1501 1502
"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
1503 1504 1505
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
1506 1507 1508 1509 1510
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1511
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1512 1513 1514
","
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
1515 1516 1517
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1518
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1519
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1520 1521 1522 1523
","
SET REFERENTIAL_INTEGRITY FALSE
"

1524 1525 1526 1527 1528 1529
"Commands (Other)","SET RETENTION_TIME","
SET RETENTION_TIME int
","
This property is only used when using the MVStore storage engine.
How long to retain old, persisted data, in milliseconds.
The default is 45000 (45 seconds), 0 means overwrite data as early as possible.
1530 1531 1532
It is assumed that a file system and hard disk will flush all write buffers within this time.
Using a lower value might be dangerous, unless the file system and hard disk flush the buffers earlier.
To manually flush the buffers, use CHECKPOINT SYNC,
1533 1534 1535 1536
however please note that according to various tests this does not always work as expected
depending on the operating system and hardware.

Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1537
This command commits an open transaction in this connection.
1538 1539 1540 1541 1542 1543
This setting is persistent.
This setting can be appended to the database URL: ""jdbc:h2:test;RETENTION_TIME=0""
","
SET RETENTION_TIME 0
"

Thomas Mueller's avatar
Thomas Mueller committed
1544 1545 1546 1547 1548
"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
1549

Thomas Mueller's avatar
Thomas Mueller committed
1550
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1551 1552 1553 1554 1555 1556 1557 1558 1559
","
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
1560 1561 1562
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1563
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1564 1565 1566 1567 1568 1569 1570 1571 1572
","
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
1573 1574 1575
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1576
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1577 1578 1579 1580 1581 1582 1583 1584 1585
","
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
1586 1587 1588
disabled).

This command does not commit a transaction, and rollback does not affect it.
1589
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1590 1591 1592 1593 1594
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1595
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1596 1597 1598
","
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.
1599
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1600

Thomas Mueller's avatar
Thomas Mueller committed
1601
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1602
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1603
This command does not commit a transaction, and rollback does not affect it.
1604
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615
","
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
1616
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1617
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1618
This command commits an open transaction in this connection.
1619
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
","
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
1630

Thomas Mueller's avatar
Thomas Mueller committed
1631
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1632 1633 1634 1635 1636 1637 1638 1639
","
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
1640 1641
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1642
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1643
This command commits an open transaction in this connection.
1644
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1645 1646 1647 1648 1649
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1650
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1651
","
1652 1653
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
1654
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1655

1656 1657
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
1658 1659 1660

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,
1661
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
1662 1663

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1667
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1668
","
1669
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1670 1671
"

1672 1673
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1674
","
1675
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1676
","
1677
A
Thomas Mueller's avatar
Thomas Mueller committed
1678 1679
"

1680 1681
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1682
","
1683
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1684
","
1685
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1686 1687
"

1688
"Other Grammar","Array","
1689
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1690
","
1691 1692
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
1693
","
1694
(1, 2)
1695 1696
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1697 1698
"

1699 1700
"Other Grammar","Boolean","
TRUE | FALSE
1701
","
1702
A boolean value.
1703
","
1704
TRUE
1705 1706
"

1707 1708
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1709
","
1710
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1711
","
1712
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1713 1714
"

1715 1716 1717
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1718
","
1719 1720
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
1721
","
1722
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1723 1724
"

1725 1726 1727
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1728
","
1729 1730
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1731
","
1732 1733 1734 1735
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
1736
AES
1737
","
1738
Only the algorithm AES (""AES-128"") is supported currently.
1739 1740
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1741 1742
"

1743
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1744 1745
columnName dataType
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1746
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1747 1748
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1749 1750
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1751
The computed column expression is evaluated and assigned whenever the row changes.
1752 1753 1754 1755

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
1756

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

Thomas Mueller's avatar
Thomas Mueller committed
1759 1760
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
1761 1762
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1763
","
Thomas Mueller's avatar
Thomas Mueller committed
1764 1765 1766
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);
1767 1768
"

1769 1770
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1771
","
1772 1773 1774
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
1775
","
1776
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1777 1778
"

1779
"Other Grammar","Compare","
1780
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
1781
","
1782
Comparison operator. The operator != is the same as <>.
1783
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
1784
","
1785
<>
Thomas Mueller's avatar
Thomas Mueller committed
1786 1787 1788
"

"Other Grammar","Condition","
1789
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1790 1791 1792 1793 1794 1795 1796
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1797 1798
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1799
    | IS [ NOT ] [ DISTINCT FROM ] operand
1800 1801 1802 1803
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1804
","
Thomas Mueller's avatar
Thomas Mueller committed
1805
The right hand side of a condition.
1806

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

Thomas Mueller's avatar
Thomas Mueller committed
1810 1811 1812 1813 1814
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).
1815 1816 1817
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.
1818

Thomas Mueller's avatar
Thomas Mueller committed
1819
When comparing with REGEXP, regular expression matching is used.
1820
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1821 1822 1823 1824
","
LIKE 'Jo%'
"

1825
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
1826 1827 1828 1829 1830
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
1831
","
Thomas Mueller's avatar
Thomas Mueller committed
1832 1833
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1834
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1835 1836
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
1837
","
1838
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1839 1840
"

1841 1842
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1843
","
1844
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1845
","
1846
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1847 1848
"

1849 1850
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1851
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1852
","
1853
Optional parameters for CSVREAD and CSVWRITE.
1854 1855
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
1856 1857
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1858
The following options are supported:
1859

1860
""caseSensitiveColumnNames"" (true or false; disabled by default),
1861

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1868
""fieldSeparator"" (a comma by default)),
1869

1870
""lineComment"" (disabled by default),
1871

1872
""lineSeparator"" (the line separator used for writing; ignored for reading),
1873

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

1877
""preserveWhitespace"" (true or false; disabled by default),
1878

1879
""writeColumnHeader"" (true or false; enabled by default).
1880

Thomas Mueller's avatar
Thomas Mueller committed
1881
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1882
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
1883 1884 1885
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
1886
","
1887
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1888 1889
"

1890 1891 1892 1893 1894
"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
1895
","
1896
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1897
","
1898
INT
Thomas Mueller's avatar
Thomas Mueller committed
1899 1900
"

1901 1902
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1903
","
1904
A date literal. The limitations are the same as for the Java data type
1905
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1906
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1907
","
1908
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1909 1910
"

1911
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
1912
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
1913
","
Thomas Mueller's avatar
Thomas Mueller committed
1914 1915 1916 1917 1918 1919
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)"".
1920
","
Thomas Mueller's avatar
Thomas Mueller committed
1921 1922 1923
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
1924 1925
"

1926 1927
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1928
","
1929
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1930
","
1931
0
Thomas Mueller's avatar
Thomas Mueller committed
1932 1933
"

1934 1935
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1936
","
1937 1938 1939
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
1940
","
1941
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1942 1943
"

1944 1945
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1946
","
1947
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1948
","
1949
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1950 1951
"

1952
"Other Grammar","Factor","
1953
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1954
","
1955
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1956
","
1957
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1958 1959
"

1960 1961
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1962
","
1963 1964
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1965
","
1966
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1967 1968
"

1969 1970
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1971
","
1972
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1973
","
1974
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1975 1976
"

1977 1978
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1979
","
1980 1981 1982
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
1983
","
1984
NAME
Thomas Mueller's avatar
Thomas Mueller committed
1985 1986 1987
"

"Other Grammar","Int","
1988
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1989 1990 1991 1992 1993 1994 1995
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
1996
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1997 1998 1999 2000 2001 2002
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2003 2004
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2005
","
2006
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2007
","
2008
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2009 2010
"

2011 2012
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2013
","
2014
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2015
","
2016
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2017 2018
"

2019 2020 2021 2022 2023 2024 2025 2026
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2027
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2028
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2029
","
Thomas Mueller's avatar
Thomas Mueller committed
2030
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2031 2032 2033 2034 2035 2036 2037
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
"

2038 2039
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2040
","
2041
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2042
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2043
","
2044
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2045 2046
"

2047 2048
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2049
","
2050 2051 2052
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
2053
","
2054
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2055 2056
"

2057 2058
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2059
","
2060 2061 2062
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
2063
","
2064
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2065 2066
"

2067 2068 2069
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2070
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2071
","
Thomas Mueller's avatar
Thomas Mueller committed
2072 2073 2074
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
2075 2076 2077
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
2078
","
2079
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2080 2081
"

Thomas Mueller's avatar
Thomas Mueller committed
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092
"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
"

2093 2094
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2095
","
2096 2097
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
2098 2099 2100 2101 2102
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2103 2104
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2105
","
2106
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2107
","
2108
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2109 2110
"

2111 2112
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2113
","
2114 2115
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
2116
","
2117
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2118 2119
"

2120 2121
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2122
","
Thomas Mueller's avatar
Thomas Mueller committed
2123
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2124

Thomas Mueller's avatar
Thomas Mueller committed
2125
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2126
","
2127
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2128 2129
"

2130
"Other Grammar","Table Expression","
2131
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
2132 2133
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2134
","
2135 2136 2137
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
2138
","
2139
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2140 2141
"

2142 2143 2144 2145 2146 2147 2148 2149 2150
"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;
"

2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2163
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2164
","
2165
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2166
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2167
","
2168 2169 2170 2171 2172 2173
'Hello'
"

"Other Grammar","Time","
TIME 'hh:mm:ss'
","
2174 2175
A time literal. A value is between plus and minus 2 million hours
and has nanosecond resolution.
2176 2177 2178 2179 2180 2181 2182 2183
","
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
2184
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2185 2186 2187 2188 2189 2190
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
2191
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2192
","
Thomas Mueller's avatar
Thomas Mueller committed
2193
A literal value of any data type, or null.
2194 2195
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2196 2197 2198 2199 2200 2201 2202
"

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

2203
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2204 2205 2206 2207 2208 2209 2210 2211 2212
","
INT
"

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

2213
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2214 2215 2216 2217 2218 2219 2220 2221 2222
","
BOOLEAN
"

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

2223
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2224 2225 2226 2227 2228 2229 2230 2231 2232
","
TINYINT
"

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

2233
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2234 2235 2236 2237 2238 2239 2240 2241 2242
","
SMALLINT
"

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

2243
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254
","
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.

2255
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2256 2257 2258 2259 2260
","
IDENTITY
"

"Data Types","DECIMAL Type","
2261
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2262 2263 2264 2265
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2266
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2267 2268 2269 2270 2271
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2272
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2273
","
Thomas Mueller's avatar
Thomas Mueller committed
2274
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2275 2276
of rounding problems.

2277
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2278 2279 2280 2281 2282
","
DOUBLE
"

"Data Types","REAL Type","
2283
{ REAL | FLOAT4 }
Thomas Mueller's avatar
Thomas Mueller committed
2284
","
Thomas Mueller's avatar
Thomas Mueller committed
2285
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2286 2287
values, because of rounding problems.

2288
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2289 2290 2291 2292 2293 2294 2295
","
REAL
"

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

2298
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
2299 2300 2301 2302 2303 2304 2305
","
TIME
"

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

2308
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2309
(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
2310 2311 2312 2313 2314
","
DATE
"

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

2319
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2320 2321 2322 2323 2324
","
TIMESTAMP
"

"Data Types","BINARY Type","
2325
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2326
","
2327 2328 2329 2330 2331
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
2332 2333 2334 2335 2336 2337 2338 2339 2340

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2341 2342 2343 2344 2345
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
2346

2347
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2348 2349 2350 2351 2352
","
OTHER
"

"Data Types","VARCHAR Type","
2353 2354
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2355
","
Thomas Mueller's avatar
Thomas Mueller committed
2356
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2357 2358 2359 2360 2361 2362 2363
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
2364

2365
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2366 2367 2368 2369 2370
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2371
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2372
","
Thomas Mueller's avatar
Thomas Mueller committed
2373
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2374 2375 2376 2377 2378 2379 2380
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
2381

2382
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2383 2384 2385 2386 2387
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2388
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2389
","
Thomas Mueller's avatar
Thomas Mueller committed
2390 2391 2392
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
2393

Thomas Mueller's avatar
Thomas Mueller committed
2394 2395
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
2396

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

2400
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2401 2402 2403 2404 2405
","
CHAR(10)
"

"Data Types","BLOB Type","
2406
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2407 2408 2409
","
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
2410
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2411 2412
Advanced / Large Objects.

2413
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2414 2415 2416 2417 2418
","
BLOB
"

"Data Types","CLOB Type","
2419
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2420 2421 2422 2423 2424
","
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
2425
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2426 2427 2428 2429 2430

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.

2431
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2432 2433 2434 2435 2436 2437 2438
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2439 2440 2441 2442
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
2443

Thomas Mueller's avatar
Thomas Mueller committed
2444 2445 2446 2447 2448
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
2449
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2450 2451 2452 2453 2454 2455 2456
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2457
An array of values.
2458
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2459 2460 2461 2462


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
2463 2464 2465 2466
","
ARRAY
"

2467 2468 2469
"Data Types","GEOMETRY Type","
GEOMETRY
","
2470 2471
A spatial geometry type, based on the ""com.vividsolutions.jts"" library.
Normally represented in textual format using the WKT (well known text) format.
2472

Thomas Mueller's avatar
Thomas Mueller committed
2473
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2474 2475
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2476
GEOMETRY
2477 2478
"

Thomas Mueller's avatar
Thomas Mueller committed
2479
"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2480
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2481
","
2482 2483
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2484
Aggregates are only allowed in select statements.
2485
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2486 2487 2488 2489
","
AVG(X)
"

2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509
"Functions (Aggregate)","BIT_AND","
BIT_AND(expression)
","
The bitwise AND of all non-null values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
BIT_AND(ID)
"

"Functions (Aggregate)","BIT_OR","
BIT_OR(expression)
","
The bitwise OR of all non-null values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
BIT_OR(ID)
"

Thomas Mueller's avatar
Thomas Mueller committed
2510
"Functions (Aggregate)","BOOL_AND","
2511
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2512
","
2513 2514 2515
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
2516 2517 2518 2519 2520
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2521
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2522
","
2523 2524 2525
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
2526 2527 2528 2529 2530
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2531
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2532
","
2533 2534 2535 2536
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
2537 2538 2539 2540 2541
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2542 2543
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2544
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2545
","
2546 2547 2548 2549 2550
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
2551 2552 2553 2554 2555
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2556
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2557
","
2558 2559 2560 2561
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
2562 2563 2564 2565 2566
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2567
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2568
","
2569 2570 2571 2572
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
2573 2574 2575 2576 2577
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2578
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2579
","
2580 2581 2582
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2583
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2584
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2585 2586 2587 2588 2589
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2590
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2591
","
2592 2593 2594 2595 2596
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
2597 2598 2599 2600 2601
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2602
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2603
","
2604 2605 2606
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
2607 2608 2609 2610 2611 2612
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2613
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2614
","
2615 2616 2617
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
2618 2619 2620 2621 2622 2623
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2624
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2625
","
2626 2627 2628 2629
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
2630 2631 2632 2633 2634
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2635
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2636
","
2637 2638 2639 2640
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
2641 2642 2643 2644 2645
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2646
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2647
","
2648 2649
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"".
2650
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2651 2652 2653 2654 2655
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2656
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2657
","
Thomas Mueller's avatar
Thomas Mueller committed
2658 2659
Calculate the arc cosine.
See also Java ""Math.acos"".
2660
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2661 2662 2663 2664 2665
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2666
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2667
","
Thomas Mueller's avatar
Thomas Mueller committed
2668 2669
Calculate the arc sine.
See also Java ""Math.asin"".
2670
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2671 2672 2673 2674 2675
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2676
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2677
","
Thomas Mueller's avatar
Thomas Mueller committed
2678 2679
Calculate the arc tangent.
See also Java ""Math.atan"".
2680
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2681 2682 2683 2684 2685
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2686
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2687
","
Thomas Mueller's avatar
Thomas Mueller committed
2688 2689
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2690
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2691 2692 2693 2694
","
COS(ANGLE)
"

2695
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2696
COSH(numeric)
2697 2698 2699 2700 2701 2702 2703 2704
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2705
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2706
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2707
","
Thomas Mueller's avatar
Thomas Mueller committed
2708
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2709
See also Java ""Math.*"" functions.
2710
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2711 2712 2713 2714 2715
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2716
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2717
","
Thomas Mueller's avatar
Thomas Mueller committed
2718 2719
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2720
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2721 2722 2723 2724
","
SIN(ANGLE)
"

2725
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2726
SINH(numeric)
2727 2728 2729 2730 2731 2732 2733 2734
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2735
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2736
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2737
","
Thomas Mueller's avatar
Thomas Mueller committed
2738 2739
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2740
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2741 2742 2743 2744
","
TAN(ANGLE)
"

2745
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2746
TANH(numeric)
2747 2748 2749 2750 2751 2752 2753 2754
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2755
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2756
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2757
","
Thomas Mueller's avatar
Thomas Mueller committed
2758
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2759
See also Java ""Math.atan2"".
2760
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2761 2762 2763 2764 2765
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2766
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2767
","
2768 2769
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2770 2771 2772 2773 2774 2775
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2776
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2777
","
2778 2779
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2780 2781 2782 2783 2784 2785
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2786
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2787
","
2788 2789
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2790 2791 2792 2793 2794 2795
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2796
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2797
","
2798 2799
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2800 2801 2802 2803 2804 2805
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2806
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2807
","
2808
See also Java ""Math.ceil"".
2809
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2810
","
2811
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2812 2813 2814
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2815
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2816
","
2817
See also Java ""Math.toDegrees"".
2818
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2819 2820 2821 2822 2823
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2824
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2825
","
2826
See also Java ""Math.exp"".
2827
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2828 2829 2830 2831 2832
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
2833
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2834
","
2835
See also Java ""Math.floor"".
2836
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2837 2838 2839 2840 2841
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2842
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2843
","
2844
See also Java ""Math.log"".
2845
In the PostgreSQL mode, LOG(x) is base 10.
2846
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2847 2848 2849 2850 2851
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
2852
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2853
","
2854
See also Java ""Math.log10"" (in Java 5).
2855
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2856 2857 2858 2859 2860
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
2861
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2862
","
2863
See also Java ""Math.toRadians"".
2864
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2865 2866 2867 2868 2869
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
2870
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2871
","
2872
See also Java ""Math.sqrt"".
2873
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2874 2875 2876 2877 2878
","
SQRT(A)
"

"Functions (Numeric)","PI","
2879
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2880
","
2881
See also Java ""Math.PI"".
2882
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2883 2884 2885 2886 2887
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
2888
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2889
","
2890
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
2891
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2892 2893 2894 2895 2896
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2897
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2898 2899 2900
","
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
2901
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2902 2903 2904 2905 2906
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2907
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2908 2909
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
2910 2911 2912 2913 2914

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
2915 2916 2917 2918 2919
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2920
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
2921
","
2922
Rounds to a number of digits, or to the nearest long if the number of digits if not set.
Thomas Mueller's avatar
Thomas Mueller committed
2923
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
2924 2925 2926 2927 2928
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
2929
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2930
","
2931 2932 2933 2934 2935 2936
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
2937 2938 2939 2940 2941
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2942
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2943 2944
","
Generates a number of cryptographically secure random numbers.
2945
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2946 2947 2948 2949 2950
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
2951
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2952 2953 2954 2955 2956 2957 2958
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2959
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2960
","
2961
Encrypts data using a key.
2962
The supported algorithm is AES.
2963 2964
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2965 2966 2967 2968 2969
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2970
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2971
","
2972
Decrypts data using a key.
2973
The supported algorithm is AES.
2974 2975
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2976 2977 2978 2979 2980 2981
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2982
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2983
","
2984 2985 2986
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
2987 2988 2989 2990 2991
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
2992
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
2993 2994
","
Truncates to a number of digits (to the next value closer to 0).
2995
This method returns a double.
2996
When used with a timestamp, truncates a timestamp to a date (day) value.
2997 2998
When used with a date, truncates a date to a date (day) value less time part.
When used with a timestamp as string, truncates a timestamp to a date (day) value.
Thomas Mueller's avatar
Thomas Mueller committed
2999 3000 3001 3002 3003
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3004
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3005
","
3006 3007 3008 3009
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
3010 3011 3012 3013 3014
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3015
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3016 3017
","
Expands data that was compressed using the COMPRESS function.
3018
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3019 3020 3021 3022 3023
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3024
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3025 3026 3027 3028 3029 3030 3031
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3032
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3033 3034
","
Returns the ASCII value of the first character in the string.
3035
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3036 3037 3038 3039
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3040
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3041
","
3042 3043 3044
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
3045 3046 3047 3048 3049
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3050
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3051
","
3052 3053 3054
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
3055 3056 3057 3058 3059
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3060
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3061
","
3062 3063 3064 3065
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
3066 3067 3068 3069 3070
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3071
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3072 3073
","
Returns the character that represents the ASCII value.
3074
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3075 3076 3077 3078 3079
","
CHAR(65)
"

"Functions (String)","CONCAT","
3080
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3081 3082
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3083
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3084
and do not cause the result to become NULL.
3085
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3086 3087 3088 3089
","
CONCAT(NAME, '!')
"

3090 3091 3092 3093
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3094
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3095
and do not cause the result to become NULL.
3096 3097 3098 3099 3100
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3101
"Functions (String)","DIFFERENCE","
3102
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3103 3104
","
Returns the difference between the sounds of two strings.
3105
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3106 3107 3108 3109 3110
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3111
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3112
","
3113 3114
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
3115 3116 3117 3118 3119
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3120
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3121
","
3122 3123 3124
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
3125 3126 3127 3128 3129
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3130
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3131
","
3132
Returns the location of a search string in a string.
3133 3134 3135
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
3136
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3137 3138 3139 3140 3141
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3142
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3143
","
3144 3145 3146
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
3147 3148 3149 3150 3151
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3152
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3153 3154 3155 3156 3157 3158 3159
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3160
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3161 3162 3163 3164 3165 3166 3167
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3168
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3169 3170 3171 3172 3173 3174 3175
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3176
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3177 3178 3179 3180 3181 3182 3183
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3184
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3185
","
3186 3187 3188 3189
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
3190 3191 3192 3193 3194
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3195
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3196 3197 3198 3199 3200 3201 3202
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3203
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3204
","
3205 3206 3207
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
3208 3209 3210 3211 3212
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3213
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3214
","
3215 3216 3217
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
3218 3219 3220 3221 3222
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3223
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3224 3225 3226 3227 3228 3229 3230
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3231
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3232 3233 3234 3235 3236 3237 3238
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3239
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3240
","
3241 3242
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
3243 3244 3245 3246 3247
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3248
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
3249
","
3250
Replaces each substring that matches a regular expression.
3251
For details, see the Java ""String.replaceAll()"" method.
3252
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3253 3254 3255 3256 3257
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
3258
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3259 3260 3261 3262 3263 3264 3265
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3266
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3267
","
3268 3269
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.
3270
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3271 3272 3273 3274 3275
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3276
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3277
","
3278 3279 3280
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
3281 3282 3283 3284 3285
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3286
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3287 3288 3289 3290 3291 3292 3293
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3294
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3295
","
3296 3297 3298
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
3299 3300 3301 3302 3303
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3304
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3305
","
3306 3307 3308
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
3309 3310 3311 3312 3313
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3314
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3315 3316
","
Encodes a string to a byte array using the UTF8 encoding format.
3317
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3318 3319 3320 3321 3322
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3323
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3324
","
3325
Returns a substring of a string starting at a position.
3326
If the start index is negative, then the start index is relative to the end of the string.
3327
The length is optional.
3328
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3329
","
3330 3331
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3332 3333 3334
"

"Functions (String)","UTF8TOSTRING","
3335
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3336 3337 3338 3339 3340 3341 3342
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3343
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3344
","
3345
Creates an XML attribute element of the form ""name=value"".
3346 3347
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3348 3349 3350 3351 3352
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3353
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3354 3355
","
Create an XML node element.
3356 3357 3358
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.
3359
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3360 3361 3362 3363 3364
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3365
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3366
","
3367
Creates an XML comment.
3368
Two dashes (""--"") are converted to ""- -"".
3369
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3370 3371 3372 3373 3374
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3375
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3376
","
3377
Creates an XML CDATA element.
3378
If the value contains ""]]>"", an XML text element is created instead.
3379
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3380 3381 3382 3383 3384
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3385
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3386
","
Thomas Mueller's avatar
Thomas Mueller committed
3387
Returns the XML declaration.
3388
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3389 3390 3391 3392 3393
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3394
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3395 3396
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3397
If enabled, newline and linefeed is converted to an XML entity (&#).
3398
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3399 3400 3401 3402
","
CALL XMLTEXT('test')
"

3403
"Functions (String)","TO_CHAR","
3404
TO_CHAR(value [, formatString[, nlsParamString]])
3405 3406 3407 3408 3409 3410
","
Oracle-compatible TO_CHAR function that can format a timestamp, a number, or text.
","
CALL TO_CHAR(TIMESTAMP '2010-01-01 00:00:00', 'DD MON, YYYY')
"

3411 3412 3413 3414 3415 3416 3417 3418
"Functions (String)","TRANSLATE","
TRANSLATE(value , searchString, replacementString]])
","
Oracle-compatible TRANSLATE function that replaces a sequence of characters in a string with another set of characters.
","
CALL TRANSLATE('Hello world', 'eo', 'EO')
"

Thomas Mueller's avatar
Thomas Mueller committed
3419
"Functions (Time and Date)","CURRENT_DATE","
3420
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3421 3422
","
Returns the current date.
3423
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3424 3425 3426 3427 3428
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3429
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3430 3431
","
Returns the current time.
3432
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3433 3434 3435 3436 3437
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3438
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3439
","
3440 3441
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3442
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3443 3444 3445 3446 3447
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3448
{ DATEADD| TIMESTAMPADD } (unitString, addIntLong, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3449
","
3450 3451
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
3452 3453
addIntLong may be a long value when manipulating milliseconds,
otherwise it's range is restricted to int.
3454 3455
The same units as in the EXTRACT function are supported.
This method returns a timestamp.
Thomas Mueller's avatar
Thomas Mueller committed
3456 3457 3458 3459 3460
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3461
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3462
","
Thomas Mueller's avatar
Thomas Mueller committed
3463
Returns the the number of crossed unit boundaries between two timestamps.
3464 3465
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3466 3467 3468 3469 3470 3471
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3472
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3473 3474 3475 3476 3477 3478 3479
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3480
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3481 3482 3483 3484 3485 3486 3487
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3488
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3489 3490 3491 3492 3493 3494 3495
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3496
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3497 3498 3499 3500 3501 3502 3503
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3504
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3505
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3506
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3507 3508
","
Returns a specific value from a timestamps.
3509
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3510 3511 3512 3513 3514
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3515
FORMATDATETIME ( timestamp, formatString
3516
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3517
","
3518 3519 3520
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.
3521
For details of the format, see ""java.text.SimpleDateFormat"".
3522
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3523 3524 3525 3526 3527 3528
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3529
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3530 3531 3532 3533 3534 3535 3536
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3537
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3538 3539 3540 3541 3542 3543 3544
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3545
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3546 3547 3548 3549 3550 3551 3552
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3553
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3554 3555 3556 3557 3558 3559 3560
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3561
PARSEDATETIME(string, formatString
3562
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3563
","
3564 3565 3566
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.
3567
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3568 3569 3570 3571 3572 3573
","
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","
3574
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3575 3576 3577 3578 3579 3580 3581
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3582
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3583 3584 3585 3586 3587 3588 3589
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3590
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3591
","
3592 3593
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3594 3595 3596 3597 3598
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3599
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3600 3601 3602 3603 3604 3605 3606
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3607
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3608 3609
","
Returns one element of an array.
3610
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3611 3612 3613 3614 3615
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3616
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3617 3618 3619 3620 3621 3622
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3623 3624 3625 3626 3627 3628 3629 3630
"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
3631
"Functions (System)","AUTOCOMMIT","
3632
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3633 3634 3635 3636 3637 3638 3639
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3640
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3641
","
3642 3643 3644
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
3645 3646

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3647 3648 3649 3650 3651
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3652
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3653 3654
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3655
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3656 3657 3658 3659 3660
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3661
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3662
","
3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674
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
3675 3676 3677
"

"Functions (System)","COALESCE","
3678
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3679 3680 3681 3682 3683 3684 3685
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3686
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3687 3688 3689 3690 3691 3692 3693
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3694
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3695
","
3696 3697 3698 3699 3700
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
3701 3702 3703 3704 3705
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3706
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3707
","
3708 3709
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
3710 3711

If the column names are specified (a list of column names separated with the
3712
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3713 3714 3715 3716 3717
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
3718 3719 3720 3721 3722

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3732 3733 3734
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
3735 3736 3737 3738
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
3739 3740 3741 3742
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
3743
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3744
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3745 3746 3747
"

"Functions (System)","CSVWRITE","
3748
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3749
","
3750
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3751
If only a file name is specified, it will be written to the current working directory.
3752
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3753
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
3754 3755 3756 3757 3758

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

Thomas Mueller's avatar
Thomas Mueller committed
3761 3762
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3763
","
Thomas Mueller's avatar
Thomas Mueller committed
3764 3765 3766 3767
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
3768 3769 3770
"

"Functions (System)","DATABASE","
3771
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3772 3773 3774 3775 3776 3777 3778
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3779
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3780
","
Thomas Mueller's avatar
Thomas Mueller committed
3781 3782
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
3783 3784 3785 3786
","
CALL DATABASE_PATH();
"

3787
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3788
DECODE(value, whenValue, thenValue [,...])
3789 3790 3791 3792 3793 3794 3795 3796
","
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');
"

3797
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3798
DISK_SPACE_USED(tableNameString)
3799 3800 3801 3802 3803 3804 3805 3806
","
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
3807
"Functions (System)","FILE_READ","
3808
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3809 3810 3811 3812
","
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
3813
default character set for this system.
3814 3815 3816 3817

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

Thomas Mueller's avatar
Thomas Mueller committed
3818
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3819 3820 3821 3822 3823
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

3824
"Functions (System)","FILE_WRITE","
3825
FILE_WRITE(blobValue, fileNameString)
3826 3827 3828 3829 3830 3831 3832 3833
","
Write the supplied parameter into a file. Return the number of bytes written.

Write access to folder, and admin rights are required to execute this command.
","
SELECT FILE_WRITE('Hello world', '/tmp/hello.txt')) LEN;
"

Thomas Mueller's avatar
Thomas Mueller committed
3834
"Functions (System)","GREATEST","
3835
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3836 3837 3838 3839 3840 3841 3842
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3843
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3844 3845
","
Returns the last inserted identity value for this session.
3846
This value changes whenever a new sequence number was generated,
3847
even within a trigger or Java function. See also SCOPE_IDENTITY.
3848
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3849 3850 3851 3852 3853
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3854
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3855 3856 3857 3858 3859 3860 3861
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3862
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3863 3864 3865 3866 3867 3868 3869
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3870
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3871 3872
","
Returns the current lock mode. See SET LOCK_MODE.
3873
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3874 3875 3876 3877 3878
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3879
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3880 3881 3882 3883 3884 3885 3886 3887
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3888
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3889
","
3890 3891 3892 3893 3894
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
3895
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3896 3897 3898 3899 3900
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3901
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3902
","
Thomas Mueller's avatar
Thomas Mueller committed
3903
Returns the free memory in KB (where 1024 bytes is a KB).
3904
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3905 3906
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3907 3908 3909 3910 3911
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3912
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3913
","
Thomas Mueller's avatar
Thomas Mueller committed
3914
Returns the used memory in KB (where 1024 bytes is a KB).
3915
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3916 3917
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3918 3919 3920 3921 3922
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3923
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3924
","
3925 3926 3927 3928
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
3929 3930 3931 3932 3933
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3934
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3935 3936 3937 3938 3939 3940
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

3941 3942 3943 3944
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
3945
The data type of the returned value is the data type of 'a' if this is a text type.
3946 3947 3948 3949
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
3950
"Functions (System)","READONLY","
3951
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3952 3953 3954 3955 3956 3957 3958
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
3959
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
3960
","
3961
Returns the number of the current row.
3962 3963
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
3964 3965
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).
3966
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3967
","
3968 3969
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3970
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3971 3972 3973
"

"Functions (System)","SCHEMA","
3974
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3975 3976 3977 3978 3979 3980
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3981 3982 3983
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
3984
Returns the last inserted identity value for this session for the current scope
Thomas Mueller's avatar
Thomas Mueller committed
3985
(ie. the current statement).
3986 3987 3988 3989 3990 3991
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
3992
"Functions (System)","SESSION_ID","
3993
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3994
","
3995 3996 3997 3998
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
3999 4000 4001 4002 4003
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4004
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4005
","
4006 4007 4008
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
4009
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4010
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4011 4012 4013 4014 4015
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4016
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4017 4018 4019 4020 4021 4022 4023
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4024
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4025
","
4026 4027
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
4028
Otherwise a value of the following form is returned:
4029
""logFileId-position-sessionId"".
4030 4031
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4032 4033 4034 4035
","
CALL TRANSACTION_ID()
"

4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047
"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
4048
"Functions (System)","USER","
4049
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4050 4051 4052 4053 4054 4055
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4056 4057 4058 4059 4060 4061 4062 4063
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078
"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
4079