help.csv 120.1 KB
Newer Older
1 2
# Copyright 2004-2014 H2 Group. Multiple-Licensed under the MPL 2.0,
# and the EPL 1.0 (http://h2database.com/html/license.html).
Thomas Mueller's avatar
Thomas Mueller committed
3 4 5
# Initial Developer: H2 Group
"SECTION","TOPIC","SYNTAX","TEXT","EXAMPLE"
"Commands (DML)","SELECT","
6 7 8 9
SELECT [ TOP term ] [ DISTINCT | ALL ] selectExpression [,...]
FROM tableExpression [,...] [ WHERE expression ]
[ GROUP BY expression [,...] ] [ HAVING expression ]
[ { UNION [ ALL ] | MINUS | EXCEPT | INTERSECT } select ] [ ORDER BY order [,...] ]
Thomas Mueller Graf's avatar
Thomas Mueller Graf committed
10
[ [ 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 250 251 252 253 254 255 256 257
"Commands (DDL)","ALTER TABLE RENAME CONSTRAINT","
ALTER TABLE tableName RENAME oldConstraintName TO newConstraintName
","
Renames a constraint.
This command commits an open transaction in this connection.
","
ALTER TABLE TEST RENAME CONSTRAINT FOO TO BAR
"

258
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
259 260 261 262 263 264 265 266
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
267
","
268 269
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
270

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

273 274 275
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
276

277 278 279 280
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
281

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

284
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
285
Single column indexes on this column are dropped.
286 287 288

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
289
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
290
","
291 292 293 294 295 296 297
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
298 299 300
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
301
ALTER TABLE tableName DROP COLUMN [ IF EXISTS ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
302
","
303
Removes column(s) from a table.
Thomas Mueller's avatar
Thomas Mueller committed
304
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
305 306
","
ALTER TABLE TEST DROP COLUMN NAME
307
ALTER TABLE TEST DROP COLUMN NAME1, NAME2
Thomas Mueller's avatar
Thomas Mueller committed
308 309 310
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
311
ALTER TABLE tableName DROP { CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
312 313
","
Removes a constraint or a primary key from a table.
Thomas Mueller's avatar
Thomas Mueller committed
314
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
315 316 317 318 319 320
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
ALTER TABLE tableName SET REFERENTIAL_INTEGRITY
321
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
322 323 324 325 326 327
","
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.
328

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 335 336
","
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
337
Renames a table.
Thomas Mueller's avatar
Thomas Mueller committed
338
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
339 340 341 342 343
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
344
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
345
","
Thomas Mueller's avatar
Thomas Mueller committed
346 347 348 349
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
350
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
351 352 353 354 355 356 357
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
358 359 360 361
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
362
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
363
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
364 365 366 367 368
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
369
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
370
","
Thomas Mueller's avatar
Thomas Mueller committed
371 372 373 374 375 376
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
377
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
378 379 380 381 382 383 384 385
","
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
386
This command is used for views created using CREATE FORCE VIEW.
Thomas Mueller's avatar
Thomas Mueller committed
387
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
388 389 390 391 392
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
393
ANALYZE [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
394 395 396 397 398 399 400
","
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.
401

Thomas Mueller's avatar
Thomas Mueller committed
402
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
403 404 405 406 407
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
408 409 410 411 412
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
413
","
Thomas Mueller's avatar
Thomas Mueller committed
414 415 416
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
417
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
418 419 420 421 422
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
423
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
424 425 426
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
427
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
428 429

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
430
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
431 432 433 434 435
","
CREATE AGGREGATE MEDIAN FOR ""com.acme.db.Median""
"

"Commands (DDL)","CREATE ALIAS","
Thomas Mueller's avatar
Thomas Mueller committed
436
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
Thomas Mueller's avatar
Thomas Mueller committed
437
[ NOBUFFER ] { FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
438
","
439 440 441 442 443 444
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.
445 446 447

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

453 454
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.
455 456
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
457 458
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
459

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

463
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
464 465 466
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.
467

Thomas Mueller's avatar
Thomas Mueller committed
468
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
469
This command commits an open transaction in this connection.
470 471

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
472 473 474 475 476
","
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');
477 478
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
479 480 481 482 483
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
484 485 486
"

"Commands (DDL)","CREATE CONSTANT","
487
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
488
","
Thomas Mueller's avatar
Thomas Mueller committed
489
Creates a new constant.
Thomas Mueller's avatar
Thomas Mueller committed
490
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
491 492 493 494 495
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
496 497 498
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
499 500
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
501
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
502
to the value being tested.
503

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

Thomas Mueller's avatar
Thomas Mueller committed
506
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
507 508 509 510 511
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
512
CREATE
Thomas Mueller's avatar
Thomas Mueller committed
513
{ [ UNIQUE ] [ HASH | SPATIAL] INDEX [ [ IF NOT EXISTS ] newIndexName ]
514 515
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
516
","
Thomas Mueller's avatar
Thomas Mueller committed
517
Creates a new index.
Thomas Mueller's avatar
Thomas Mueller committed
518
This command commits an open transaction in this connection.
519

Thomas Mueller's avatar
Thomas Mueller committed
520
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
521 522
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
523
Non-unique keys are supported.
524
Spatial indexes are supported only on Geometry columns.
Thomas Mueller's avatar
Thomas Mueller committed
525 526 527 528 529
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
530
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ]
Thomas Mueller's avatar
Thomas Mueller committed
531
LINKED TABLE [ IF NOT EXISTS ]
532 533
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
534 535 536 537 538
","
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.

539 540 541
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
542 543
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
544
work. Linked tables to the same database share one connection.
545

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

Thomas Mueller's avatar
Thomas Mueller committed
548 549 550
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).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
558
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
559
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
560 561 562 563 564 565 566 567 568
","
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","
569
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
570
","
Thomas Mueller's avatar
Thomas Mueller committed
571
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
572
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
573 574 575 576 577
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
578
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
Thomas Mueller's avatar
Thomas Mueller committed
579 580 581
","
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
582
Specifying the owner currently has no effect.
583

Thomas Mueller's avatar
Thomas Mueller committed
584
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
585 586 587 588 589
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
590
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
591 592 593 594 595
[ 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
596
","
Thomas Mueller's avatar
Thomas Mueller committed
597 598 599
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
600 601 602 603 604

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
605

Thomas Mueller's avatar
Thomas Mueller committed
606
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
607 608 609 610 611
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
612 613
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
614
[ ( { columnDefinition | constraint } [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
615
[ ENGINE tableEngineName [ WITH tableEngineParamName [,...] ] ]
616
[ NOT PERSISTENT ] [ TRANSACTIONAL ]
617
[ AS select ]","
Thomas Mueller's avatar
Thomas Mueller committed
618 619
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
620 621 622 623
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
624
that means memory tables should not get too large.
625

Thomas Mueller's avatar
Thomas Mueller committed
626 627 628 629 630
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,
631
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
632

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

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

640 641 642
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
643 644
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
645 646 647 648 649
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
650
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
651
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
652
[ QUEUE int ] [ NOWAIT ] { CALL triggeredClassName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
653
","
Thomas Mueller's avatar
Thomas Mueller committed
654 655 656 657 658
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).
659

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

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

Thomas Mueller's avatar
Thomas Mueller committed
668
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
669
Only row based AFTER trigger can be called on ROLLBACK.
670
Exceptions that occur within such triggers are ignored.
671 672
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.
673

674
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
675
Only the first such trigger is called. Such triggers on views are supported.
676
They can be used to make views updatable.
677

Thomas Mueller's avatar
Thomas Mueller committed
678 679
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.
680 681
The trigger is called with both 'old' and 'new' set to null.

682 683 684 685
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
686 687
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

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

691 692
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

Thomas Mueller's avatar
Thomas Mueller committed
693 694
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.
695

Thomas Mueller's avatar
Thomas Mueller committed
696
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
697
","
698
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger"";
Thomas Mueller's avatar
Thomas Mueller committed
699
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
700 701
"
"Commands (DDL)","CREATE USER","
702 703
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
704
","
Thomas Mueller's avatar
Thomas Mueller committed
705 706 707
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.
708

Thomas Mueller's avatar
Thomas Mueller committed
709
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
710
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
711 712 713 714 715
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
716
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
717
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
718 719
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
720
if the underlying table(s) don't exist.
721

Thomas Mueller's avatar
Thomas Mueller committed
722 723 724 725 726
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.

727 728
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
729
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
730
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
731 732 733 734 735
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
736
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
737
","
Thomas Mueller's avatar
Thomas Mueller committed
738 739 740
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
741
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
742
","
Thomas Mueller's avatar
Thomas Mueller committed
743
DROP AGGREGATE MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
744 745 746
"

"Commands (DDL)","DROP ALIAS","
747
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
748
","
Thomas Mueller's avatar
Thomas Mueller committed
749 750 751
Drops an existing function alias.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
752
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
753
","
Thomas Mueller's avatar
Thomas Mueller committed
754
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
755 756 757
"

"Commands (DDL)","DROP ALL OBJECTS","
758
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
759 760 761 762 763
","
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
764 765 766
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
767 768 769 770 771
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
772
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
773
","
Thomas Mueller's avatar
Thomas Mueller committed
774
Drops a constant.
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 CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
781
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
782
","
Thomas Mueller's avatar
Thomas Mueller committed
783
Drops a data type (domain).
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 DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
790
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
791
","
Thomas Mueller's avatar
Thomas Mueller committed
792
Drops an index.
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 INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
799
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
800
","
Thomas Mueller's avatar
Thomas Mueller committed
801
Drops a role.
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 ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
808
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
809
","
Thomas Mueller's avatar
Thomas Mueller committed
810
Drops a schema.
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 SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
817
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
818
","
Thomas Mueller's avatar
Thomas Mueller committed
819
Drops a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
820
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
821 822 823 824 825
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
826
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
827
","
Thomas Mueller's avatar
Thomas Mueller committed
828
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
829 830
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
831
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
832 833 834 835 836
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
837
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
838
","
Thomas Mueller's avatar
Thomas Mueller committed
839
Drops an existing trigger.
Thomas Mueller's avatar
Thomas Mueller committed
840
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
841 842 843 844 845
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
846
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
847
","
Thomas Mueller's avatar
Thomas Mueller committed
848 849
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
850

Thomas Mueller's avatar
Thomas Mueller committed
851
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
852
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
853 854 855 856 857
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
858
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
859
","
Thomas Mueller's avatar
Thomas Mueller committed
860 861 862
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
863
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
864 865 866 867 868 869 870
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
871 872 873 874 875
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).
876
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
877

Thomas Mueller's avatar
Thomas Mueller committed
878
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
879 880 881 882 883 884 885
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
886
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
887 888

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

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
896
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
897 898 899
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
900 901 902 903 904
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
905
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
906 907 908 909 910 911 912 913 914
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
915 916 917 918
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
919 920 921 922 923
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
924
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
925 926
{ { SCHEMA schemaName } | { tableName [,...] } }
TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
927
","
Thomas Mueller's avatar
Thomas Mueller committed
928 929 930
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
931
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
932 933 934 935
","
GRANT SELECT ON TEST TO READONLY
"

936 937 938 939 940 941
"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
942
This command commits an open transaction in this connection.
943 944 945 946
","
GRANT ALTER ANY SCHEMA TO Bob
"

Thomas Mueller's avatar
Thomas Mueller committed
947
"Commands (Other)","GRANT ROLE","
948
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
949
","
Thomas Mueller's avatar
Thomas Mueller committed
950 951 952
Grants a role to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
953
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
954 955 956 957 958
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
959
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
960 961 962 963 964 965 966 967 968
","
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
969 970
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
971 972 973 974 975
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
976
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
977 978
{ { SCHEMA schemaName } | { tableName [,...] } }
FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
979
","
Thomas Mueller's avatar
Thomas Mueller committed
980 981 982
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
983
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
984 985 986 987 988
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
989
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
990
","
Thomas Mueller's avatar
Thomas Mueller committed
991 992 993
Removes a role from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
994
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
995 996 997 998 999
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
1000
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
","
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
1011 1012 1013 1014
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
1015 1016 1017 1018 1019 1020 1021
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1022 1023
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
1024 1025 1026 1027 1028
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1029
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1030
","
Thomas Mueller's avatar
Thomas Mueller committed
1031
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1032
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
1033
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1034 1035 1036 1037 1038
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1039
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
","
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
1050 1051
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1052
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1053
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1054
This setting is persistent.
1055
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1056 1057 1058 1059 1060
","
SET ALLOW_LITERALS NONE
"

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

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
1076
Sets the size of the cache in KB (each KB being 1024 bytes) for the current database.
1077 1078
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
1079 1080
Depending on the virtual machine, the actual memory required may be higher.

Thomas Mueller's avatar
Thomas Mueller committed
1081
This setting is persistent and affects all connections as there is only one cache per database.
Thomas Mueller's avatar
Thomas Mueller committed
1082
Using a very small value (specially 0) will reduce performance a lot.
Thomas Mueller's avatar
Thomas Mueller committed
1083 1084
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
1085
It has no effect for in-memory databases.
1086

Thomas Mueller's avatar
Thomas Mueller committed
1087
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1088
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1089
This setting is persistent.
1090
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
","
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
1103 1104
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1105
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1106 1107 1108 1109
","
SET CLUSTER ''
"

1110 1111 1112 1113
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1114 1115
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.
1116 1117 1118
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
1119
This command commits an open transaction in this connection.
1120 1121 1122 1123 1124
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

Thomas Mueller's avatar
Thomas Mueller committed
1125
"Commands (Other)","SET COLLATION","
1126 1127
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1128
","
Thomas Mueller's avatar
Thomas Mueller committed
1129 1130
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
1131 1132
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
1133
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1134

1135 1136 1137 1138 1139 1140
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
1141
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1142
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1143
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1144 1145 1146 1147 1148
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1149
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1150
","
Thomas Mueller's avatar
Thomas Mueller committed
1151 1152 1153 1154
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
1155 1156
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
1157

Thomas Mueller's avatar
Thomas Mueller committed
1158
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1159
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1160
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1161 1162 1163 1164 1165 1166 1167 1168
","
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
1169 1170 1171 1172
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).
1173
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1174 1175 1176 1177 1178 1179 1180
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1181 1182
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
1183 1184 1185 1186
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
1187

Thomas Mueller's avatar
Thomas Mueller committed
1188
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1189
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1190
This setting is persistent.
1191
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1192 1193 1194 1195 1196 1197 1198 1199
","
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
1200 1201
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1202
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1203
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1204
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1205 1206 1207 1208 1209
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1210
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1211 1212 1213
","
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
1214
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1215
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1216

Thomas Mueller's avatar
Thomas Mueller committed
1217
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1218
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1219
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1220
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1221 1222 1223 1224 1225
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1226
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1227
","
Thomas Mueller's avatar
Thomas Mueller committed
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
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
1238 1239

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1240
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1241
","
Thomas Mueller's avatar
Thomas Mueller committed
1242
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1243 1244 1245
"

"Commands (Other)","SET IGNORECASE","
1246
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1247 1248 1249 1250 1251
","
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
1252
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1253

Thomas Mueller's avatar
Thomas Mueller committed
1254
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1255
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1256
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1257
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1258 1259 1260 1261
","
SET IGNORECASE TRUE
"

1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
"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
1274
This command commits an open transaction in this connection.
1275 1276 1277 1278 1279 1280 1281
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'
"


1282
"Commands (Other)","SET LOG","
1283
SET LOG int
1284 1285 1286 1287
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1288
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1289 1290 1291 1292
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.

1293 1294
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
1295 1296
against power failure is required, but the data must be protected against killing the process.

1297 1298
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
1299 1300
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1301
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1302
This command commits an open transaction in this connection.
1303
This setting is not persistent.
1304
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1305 1306 1307 1308
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1309 1310 1311 1312
"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
1313
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326

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
1327
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1328
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1329
This setting is persistent.
1330
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1331 1332 1333 1334 1335 1336 1337 1338
","
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
1339 1340 1341
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1342
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1343 1344 1345 1346 1347 1348 1349
","
SET LOCK_TIMEOUT 1000
"

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

1352
This is the maximum length of an LOB that is stored with the record itself,
1353 1354
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1355
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1356
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1357
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1358 1359 1360 1361 1362 1363 1364
","
SET MAX_LENGTH_INPLACE_LOB 128
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1371
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1372
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1373
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1374 1375 1376 1377 1378 1379 1380 1381
","
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
1382
are read, then the rows are buffered to disk.
1383
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1384

Thomas Mueller's avatar
Thomas Mueller committed
1385
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1386
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1387
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1388
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1389 1390 1391 1392 1393 1394 1395
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1402
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1403
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1404
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1405
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1406 1407 1408 1409 1410 1411 1412 1413 1414
","
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
1415 1416 1417
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1418
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1419
It has no effect for in-memory databases.
1420
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1421 1422 1423 1424 1425
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1426
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1427 1428
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1429 1430 1431
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1432
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1433
This command commits an open transaction in this connection.
1434
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1435 1436 1437 1438 1439
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1440
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1441 1442 1443
","
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
1444 1445 1446 1447 1448
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
1449
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1450
This command commits an open transaction in this connection.
1451
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1452 1453 1454 1455 1456
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1457
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1458 1459 1460
","
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
1461 1462
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1463
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1464
This command commits an open transaction in this connection.
1465
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1466 1467 1468 1469 1470 1471 1472 1473 1474
","
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
1475

Thomas Mueller's avatar
Thomas Mueller committed
1476
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1477 1478 1479 1480
","
SET PASSWORD 'abcstzri!.5'
"

1481 1482 1483 1484 1485 1486 1487
"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
1488
This command commits an open transaction in this connection.
1489 1490 1491 1492 1493
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506
"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
1507 1508 1509 1510 1511
"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
1512 1513 1514
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
1515 1516 1517 1518 1519
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1520
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1521 1522 1523
","
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
1524 1525 1526
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1527
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1528
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1529 1530 1531 1532
","
SET REFERENTIAL_INTEGRITY FALSE
"

1533 1534 1535 1536 1537 1538
"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.
1539 1540 1541
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,
1542 1543 1544 1545
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
1546
This command commits an open transaction in this connection.
1547 1548 1549 1550 1551 1552
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
1553 1554 1555 1556 1557
"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
1558

Thomas Mueller's avatar
Thomas Mueller committed
1559
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1560 1561 1562 1563 1564 1565 1566 1567 1568
","
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
1569 1570 1571
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1572
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1573 1574 1575 1576 1577 1578 1579 1580 1581
","
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
1582 1583 1584
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1585
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1586 1587 1588 1589 1590 1591 1592 1593 1594
","
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
1595 1596 1597
disabled).

This command does not commit a transaction, and rollback does not affect it.
1598
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1599 1600 1601 1602 1603
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1604
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1605 1606 1607
","
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.
1608
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1609

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

Thomas Mueller's avatar
Thomas Mueller committed
1640
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1641 1642 1643 1644 1645 1646 1647 1648
","
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
1649 1650
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1651
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1652
This command commits an open transaction in this connection.
1653
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1654 1655 1656 1657 1658
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1659
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1660
","
1661 1662
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
1663
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1664

1665 1666
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
1667 1668 1669

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,
1670
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
1671 1672

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1676
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1677
","
1678
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1679 1680
"

1681 1682
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1683
","
1684
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1685
","
1686
A
Thomas Mueller's avatar
Thomas Mueller committed
1687 1688
"

1689 1690
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1691
","
1692
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1693
","
1694
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1695 1696
"

1697
"Other Grammar","Array","
1698
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1699
","
1700 1701
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
1702
","
1703
(1, 2)
1704 1705
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1706 1707
"

1708 1709
"Other Grammar","Boolean","
TRUE | FALSE
1710
","
1711
A boolean value.
1712
","
1713
TRUE
1714 1715
"

1716 1717
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1718
","
1719
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1720
","
1721
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1722 1723
"

1724 1725 1726
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1727
","
1728 1729
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
1730
","
1731
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1732 1733
"

1734 1735 1736
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1737
","
1738 1739
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1740
","
1741 1742 1743 1744
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
1745
AES
1746
","
1747
Only the algorithm AES (""AES-128"") is supported currently.
1748 1749
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1750 1751
"

1752
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1753 1754
columnName dataType
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1755
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1756 1757
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1758 1759
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1760
The computed column expression is evaluated and assigned whenever the row changes.
1761 1762 1763 1764

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
1765

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

Thomas Mueller's avatar
Thomas Mueller committed
1768 1769
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
1770 1771
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1772
","
Thomas Mueller's avatar
Thomas Mueller committed
1773 1774 1775
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);
1776 1777
"

1778 1779
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1780
","
1781 1782 1783
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
1784
","
1785
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1786 1787
"

1788
"Other Grammar","Compare","
1789
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
1790
","
1791
Comparison operator. The operator != is the same as <>.
1792
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
1793
","
1794
<>
Thomas Mueller's avatar
Thomas Mueller committed
1795 1796 1797
"

"Other Grammar","Condition","
1798
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1799 1800 1801 1802 1803 1804 1805
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1806 1807
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1808
    | IS [ NOT ] [ DISTINCT FROM ] operand
1809 1810 1811 1812
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1813
","
Thomas Mueller's avatar
Thomas Mueller committed
1814
The right hand side of a condition.
1815

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

Thomas Mueller's avatar
Thomas Mueller committed
1819 1820 1821 1822 1823
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).
1824 1825 1826
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.
1827

Thomas Mueller's avatar
Thomas Mueller committed
1828
When comparing with REGEXP, regular expression matching is used.
1829
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1830 1831 1832 1833
","
LIKE 'Jo%'
"

1834
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
1835 1836 1837 1838 1839
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
1840
","
Thomas Mueller's avatar
Thomas Mueller committed
1841 1842
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1843
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1844 1845
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
1846
","
1847
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1848 1849
"

1850 1851
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1852
","
1853
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1854
","
1855
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1856 1857
"

1858 1859
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1860
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1861
","
1862
Optional parameters for CSVREAD and CSVWRITE.
1863 1864
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
1865 1866
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1867
The following options are supported:
1868

1869
""caseSensitiveColumnNames"" (true or false; disabled by default),
1870

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1877
""fieldSeparator"" (a comma by default)),
1878

1879
""lineComment"" (disabled by default),
1880

1881
""lineSeparator"" (the line separator used for writing; ignored for reading),
1882

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

1886
""preserveWhitespace"" (true or false; disabled by default),
1887

1888
""writeColumnHeader"" (true or false; enabled by default).
1889

Thomas Mueller's avatar
Thomas Mueller committed
1890
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1891
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
1892 1893 1894
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
1895
","
1896
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1897 1898
"

1899 1900 1901 1902 1903
"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
1904
","
1905
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1906
","
1907
INT
Thomas Mueller's avatar
Thomas Mueller committed
1908 1909
"

1910 1911
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1912
","
1913
A date literal. The limitations are the same as for the Java data type
1914
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1915
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1916
","
1917
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1918 1919
"

1920
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
1921
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
1922
","
Thomas Mueller's avatar
Thomas Mueller committed
1923 1924 1925 1926 1927 1928
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)"".
1929
","
Thomas Mueller's avatar
Thomas Mueller committed
1930 1931 1932
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
1933 1934
"

1935 1936
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1937
","
1938
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1939
","
1940
0
Thomas Mueller's avatar
Thomas Mueller committed
1941 1942
"

1943 1944
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1945
","
1946 1947 1948
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
1949
","
1950
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1951 1952
"

1953 1954
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1955
","
1956
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1957
","
1958
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1959 1960
"

1961
"Other Grammar","Factor","
1962
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1963
","
1964
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1965
","
1966
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1967 1968
"

1969 1970
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1971
","
1972 1973
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1974
","
1975
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1976 1977
"

1978 1979
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1980
","
1981
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1982
","
1983
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1984 1985
"

1986 1987
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1988
","
1989 1990 1991
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
1992
","
1993
NAME
Thomas Mueller's avatar
Thomas Mueller committed
1994 1995 1996
"

"Other Grammar","Int","
1997
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1998 1999 2000 2001 2002 2003 2004
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2005
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2006 2007 2008 2009 2010 2011
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2012 2013
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2014
","
2015
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2016
","
2017
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2018 2019
"

2020 2021
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2022
","
2023
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2024
","
2025
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2026 2027
"

2028 2029 2030 2031 2032 2033 2034 2035
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2036
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2037
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2038
","
Thomas Mueller's avatar
Thomas Mueller committed
2039
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2040 2041 2042 2043 2044 2045 2046
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
"

2047 2048
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2049
","
2050
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2051
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2052
","
2053
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2054 2055
"

2056 2057
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2058
","
2059 2060 2061
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
2062
","
2063
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2064 2065
"

2066 2067
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2068
","
2069 2070 2071
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
2072
","
2073
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2074 2075
"

2076 2077 2078
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2079
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2080
","
Thomas Mueller's avatar
Thomas Mueller committed
2081 2082 2083
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
2084 2085 2086
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
2087
","
2088
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2089 2090
"

Thomas Mueller's avatar
Thomas Mueller committed
2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
"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
"

2102 2103
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2104
","
2105 2106
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
2107 2108 2109 2110 2111
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2112 2113
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2114
","
2115
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2116
","
2117
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2118 2119
"

2120 2121
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2122
","
2123 2124
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
2125
","
2126
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2127 2128
"

2129 2130
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2131
","
Thomas Mueller's avatar
Thomas Mueller committed
2132
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2133

Thomas Mueller's avatar
Thomas Mueller committed
2134
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2135
","
2136
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2137 2138
"

2139
"Other Grammar","Table Expression","
2140
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
2141 2142
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2143
","
2144 2145 2146
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
2147
","
2148
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2149 2150
"

2151 2152 2153 2154 2155 2156 2157 2158 2159
"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;
"

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

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

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

2212
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2213 2214 2215 2216 2217 2218 2219 2220 2221
","
INT
"

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

2222
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2223 2224 2225 2226 2227 2228 2229 2230 2231
","
BOOLEAN
"

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

2232
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2233 2234 2235 2236 2237 2238 2239 2240 2241
","
TINYINT
"

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

2242
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2243 2244 2245 2246 2247 2248 2249 2250 2251
","
SMALLINT
"

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

2252
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263
","
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.

2264
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2265 2266 2267 2268 2269
","
IDENTITY
"

"Data Types","DECIMAL Type","
2270
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2271 2272 2273 2274
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2275
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2276 2277 2278 2279 2280
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2281
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2282
","
Thomas Mueller's avatar
Thomas Mueller committed
2283
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2284 2285
of rounding problems.

2286
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2287 2288 2289 2290 2291
","
DOUBLE
"

"Data Types","REAL Type","
2292
{ REAL | FLOAT4 }
Thomas Mueller's avatar
Thomas Mueller committed
2293
","
Thomas Mueller's avatar
Thomas Mueller committed
2294
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2295 2296
values, because of rounding problems.

2297
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2298 2299 2300 2301 2302 2303 2304
","
REAL
"

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

2307
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
2308 2309 2310 2311 2312 2313 2314
","
TIME
"

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

2317
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2318
(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
2319 2320 2321 2322 2323
","
DATE
"

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

2328
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2329 2330 2331 2332 2333
","
TIMESTAMP
"

"Data Types","BINARY Type","
2334
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2335
","
2336 2337 2338 2339 2340
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
2341 2342 2343 2344 2345 2346 2347 2348 2349

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2350 2351 2352 2353 2354
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
2355

2356
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2357 2358 2359 2360 2361
","
OTHER
"

"Data Types","VARCHAR Type","
2362 2363
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2364
","
Thomas Mueller's avatar
Thomas Mueller committed
2365
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2366 2367 2368 2369 2370 2371 2372
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
2373

2374
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2375 2376 2377 2378 2379
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2380
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2381
","
Thomas Mueller's avatar
Thomas Mueller committed
2382
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2383 2384 2385 2386 2387 2388 2389
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
2390

2391
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2392 2393 2394 2395 2396
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2397
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2398
","
Thomas Mueller's avatar
Thomas Mueller committed
2399 2400 2401
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
2402

Thomas Mueller's avatar
Thomas Mueller committed
2403 2404
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
2405

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

2409
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2410 2411 2412 2413 2414
","
CHAR(10)
"

"Data Types","BLOB Type","
2415
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2416 2417 2418
","
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
2419
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2420 2421
Advanced / Large Objects.

2422
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2423 2424 2425 2426 2427
","
BLOB
"

"Data Types","CLOB Type","
2428
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2429 2430 2431 2432 2433
","
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
2434
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2435 2436 2437 2438 2439

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.

2440
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2441 2442 2443 2444 2445 2446 2447
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2448 2449 2450 2451
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
2452

Thomas Mueller's avatar
Thomas Mueller committed
2453 2454 2455 2456 2457
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
2458
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2459 2460 2461 2462 2463 2464 2465
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2466
An array of values.
2467
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2468 2469 2470 2471


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
2472 2473 2474 2475
","
ARRAY
"

2476 2477 2478
"Data Types","GEOMETRY Type","
GEOMETRY
","
2479 2480
A spatial geometry type, based on the ""com.vividsolutions.jts"" library.
Normally represented in textual format using the WKT (well known text) format.
2481

Thomas Mueller's avatar
Thomas Mueller committed
2482
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2483 2484
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2485
GEOMETRY
2486 2487
"

Thomas Mueller's avatar
Thomas Mueller committed
2488
"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2489
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2490
","
2491 2492
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2493
Aggregates are only allowed in select statements.
2494
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2495 2496 2497 2498
","
AVG(X)
"

2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518
"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
2519
"Functions (Aggregate)","BOOL_AND","
2520
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2521
","
2522 2523 2524
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
2525 2526 2527 2528 2529
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2530
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2531
","
2532 2533 2534
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
2535 2536 2537 2538 2539
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2540
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2541
","
2542 2543 2544 2545
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
2546 2547 2548 2549 2550
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2551 2552
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2553
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2554
","
2555 2556 2557 2558 2559
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
2560 2561 2562 2563 2564
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

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

"Functions (Aggregate)","MIN","
2576
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2577
","
2578 2579 2580 2581
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
2582 2583 2584 2585 2586
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2587
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2588
","
2589 2590 2591
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2592
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2593
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2594 2595 2596 2597 2598
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2599
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2600
","
2601 2602 2603 2604 2605
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
2606 2607 2608 2609 2610
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

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

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2622
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2623
","
2624 2625 2626
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
2627 2628 2629 2630 2631 2632
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

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

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2644
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2645
","
2646 2647 2648 2649
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
2650 2651 2652 2653 2654
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2655
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2656
","
2657 2658
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"".
2659
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2660 2661 2662 2663 2664
","
ABS(ID)
"

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

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

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2685
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2686
","
Thomas Mueller's avatar
Thomas Mueller committed
2687 2688
Calculate the arc tangent.
See also Java ""Math.atan"".
2689
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2690 2691 2692 2693 2694
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2695
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2696
","
Thomas Mueller's avatar
Thomas Mueller committed
2697 2698
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2699
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2700 2701 2702 2703
","
COS(ANGLE)
"

2704
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2705
COSH(numeric)
2706 2707 2708 2709 2710 2711 2712 2713
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2714
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2715
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2716
","
Thomas Mueller's avatar
Thomas Mueller committed
2717
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2718
See also Java ""Math.*"" functions.
2719
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2720 2721 2722 2723 2724
","
COT(ANGLE)
"

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

2734
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2735
SINH(numeric)
2736 2737 2738 2739 2740 2741 2742 2743
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2744
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2745
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2746
","
Thomas Mueller's avatar
Thomas Mueller committed
2747 2748
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2749
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2750 2751 2752 2753
","
TAN(ANGLE)
"

2754
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2755
TANH(numeric)
2756 2757 2758 2759 2760 2761 2762 2763
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2764
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2765
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2766
","
Thomas Mueller's avatar
Thomas Mueller committed
2767
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2768
See also Java ""Math.atan2"".
2769
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2770 2771 2772 2773 2774
","
ATAN2(X, Y)
"

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

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

"Functions (Numeric)","BITXOR","
2795
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2796
","
2797 2798
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2799 2800 2801 2802 2803 2804
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2805
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2806
","
2807 2808
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2809 2810 2811 2812 2813 2814
See also Java operator %.
","
MOD(A, B)
"

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

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

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

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
2842
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2843
","
2844
See also Java ""Math.floor"".
2845
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2846 2847 2848 2849 2850
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2851
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2852
","
2853
See also Java ""Math.log"".
2854
In the PostgreSQL mode, LOG(x) is base 10.
2855
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2856 2857 2858 2859 2860
","
LOG(A)
"

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

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

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

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

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
2897
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2898
","
2899
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
2900
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2901 2902 2903 2904 2905
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2906
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2907 2908 2909
","
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
2910
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2911 2912 2913 2914 2915
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2916
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2917 2918
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
2919 2920 2921 2922 2923

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
2924 2925 2926 2927 2928
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2929
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
2930
","
2931
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
2932
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
2933 2934 2935 2936 2937
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
2938
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2939
","
2940 2941 2942 2943 2944 2945
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
2946 2947 2948 2949 2950
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2951
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2952 2953
","
Generates a number of cryptographically secure random numbers.
2954
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2955 2956 2957 2958 2959
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
2960
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2961 2962 2963 2964 2965 2966 2967
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2968
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2969
","
2970
Encrypts data using a key.
2971
The supported algorithm is AES.
2972 2973
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2974 2975 2976 2977 2978
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2979
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2980
","
2981
Decrypts data using a key.
2982
The supported algorithm is AES.
2983 2984
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2985 2986 2987 2988 2989 2990
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2991
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2992
","
2993 2994 2995
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
2996 2997 2998 2999 3000
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3001
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3002 3003
","
Truncates to a number of digits (to the next value closer to 0).
3004
This method returns a double.
3005
When used with a timestamp, truncates a timestamp to a date (day) value.
3006 3007
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
3008 3009 3010 3011 3012
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3013
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3014
","
3015 3016 3017 3018
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
3019 3020 3021 3022 3023
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3024
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3025 3026
","
Expands data that was compressed using the COMPRESS function.
3027
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3028 3029 3030 3031 3032
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3033
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3034 3035 3036 3037 3038 3039 3040
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3041
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3042 3043
","
Returns the ASCII value of the first character in the string.
3044
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3045 3046 3047 3048
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3049
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3050
","
3051 3052 3053
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
3054 3055 3056 3057 3058
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3059
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3060
","
3061 3062 3063
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
3064 3065 3066 3067 3068
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3069
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3070
","
3071 3072 3073 3074
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
3075 3076 3077 3078 3079
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3080
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3081 3082
","
Returns the character that represents the ASCII value.
3083
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3084 3085 3086 3087 3088
","
CHAR(65)
"

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

3099 3100 3101 3102
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3103
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3104
and do not cause the result to become NULL.
3105 3106 3107 3108 3109
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3110
"Functions (String)","DIFFERENCE","
3111
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3112 3113
","
Returns the difference between the sounds of two strings.
3114
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3115 3116 3117 3118 3119
","
DIFFERENCE(T1.NAME, T2.NAME)
"

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

"Functions (String)","RAWTOHEX","
3129
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3130
","
3131 3132 3133
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
3134 3135 3136 3137 3138
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3139
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3140
","
3141
Returns the location of a search string in a string.
3142 3143 3144
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
3145
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3146 3147 3148 3149 3150
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3151
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3152
","
3153 3154 3155
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
3156 3157 3158 3159 3160
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3161
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3162 3163 3164 3165 3166 3167 3168
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3169
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3170 3171 3172 3173 3174 3175 3176
","
Converts a string to uppercase.
","
UPPER(NAME)
"

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

"Functions (String)","RIGHT","
3185
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3186 3187 3188 3189 3190 3191 3192
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3193
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3194
","
3195 3196 3197 3198
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
3199 3200 3201 3202 3203
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3204
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3205 3206 3207 3208 3209 3210 3211
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

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

"Functions (String)","RPAD","
3222
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3223
","
3224 3225 3226
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
3227 3228 3229 3230 3231
","
RPAD(TEXT, 10, '-')
"

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

"Functions (String)","RTRIM","
3240
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3241 3242 3243 3244 3245 3246 3247
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3248
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3249
","
3250 3251
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
3252 3253 3254 3255 3256
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3257
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
3258
","
3259
Replaces each substring that matches a regular expression.
3260
For details, see the Java ""String.replaceAll()"" method.
3261
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3262 3263 3264 3265 3266
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
3267
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3268 3269 3270 3271 3272 3273 3274
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3275
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3276
","
3277 3278
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.
3279
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3280 3281 3282 3283 3284
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3285
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3286
","
3287 3288 3289
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
3290 3291 3292 3293 3294
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3295
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3296 3297 3298 3299 3300 3301 3302
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

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

"Functions (String)","STRINGENCODE","
3313
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3314
","
3315 3316 3317
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
3318 3319 3320 3321 3322
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3323
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3324 3325
","
Encodes a string to a byte array using the UTF8 encoding format.
3326
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3327 3328 3329 3330 3331
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3332
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3333
","
3334
Returns a substring of a string starting at a position.
3335
If the start index is negative, then the start index is relative to the end of the string.
3336
The length is optional.
3337
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3338
","
3339 3340
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3341 3342 3343
"

"Functions (String)","UTF8TOSTRING","
3344
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3345 3346 3347 3348 3349 3350 3351
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3352
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3353
","
3354
Creates an XML attribute element of the form ""name=value"".
3355 3356
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3357 3358 3359 3360 3361
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3362
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3363 3364
","
Create an XML node element.
3365 3366 3367
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.
3368
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3369 3370 3371 3372 3373
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3374
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3375
","
3376
Creates an XML comment.
3377
Two dashes (""--"") are converted to ""- -"".
3378
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3379 3380 3381 3382 3383
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3384
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3385
","
3386
Creates an XML CDATA element.
3387
If the value contains ""]]>"", an XML text element is created instead.
3388
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3389 3390 3391 3392 3393
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3394
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3395
","
Thomas Mueller's avatar
Thomas Mueller committed
3396
Returns the XML declaration.
3397
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3398 3399 3400 3401 3402
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3403
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3404 3405
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3406
If enabled, newline and linefeed is converted to an XML entity (&#).
3407
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3408 3409 3410 3411
","
CALL XMLTEXT('test')
"

3412
"Functions (String)","TO_CHAR","
3413
TO_CHAR(value [, formatString[, nlsParamString]])
3414 3415 3416 3417 3418 3419
","
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')
"

3420 3421 3422 3423 3424 3425 3426 3427
"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
3428
"Functions (Time and Date)","CURRENT_DATE","
3429
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3430 3431
","
Returns the current date.
3432
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3433 3434 3435 3436 3437
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3438
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3439 3440
","
Returns the current time.
3441
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3442 3443 3444 3445 3446
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3447
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3448
","
3449 3450
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3451
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3452 3453 3454 3455 3456
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3457
{ DATEADD| TIMESTAMPADD } (unitString, addIntLong, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3458
","
3459 3460
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
3461 3462
addIntLong may be a long value when manipulating milliseconds,
otherwise it's range is restricted to int.
3463 3464
The same units as in the EXTRACT function are supported.
This method returns a timestamp.
Thomas Mueller's avatar
Thomas Mueller committed
3465 3466 3467 3468 3469
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3470
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3471
","
Thomas Mueller's avatar
Thomas Mueller committed
3472
Returns the the number of crossed unit boundaries between two timestamps.
3473 3474
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3475 3476 3477 3478 3479 3480
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3481
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3482 3483 3484 3485 3486 3487 3488
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3489
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3490 3491 3492 3493 3494 3495 3496
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3497
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3498 3499 3500 3501 3502 3503 3504
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3505
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3506 3507 3508 3509 3510 3511 3512
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3513
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3514
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3515
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3516 3517
","
Returns a specific value from a timestamps.
3518
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3519 3520 3521 3522 3523
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3524
FORMATDATETIME ( timestamp, formatString
3525
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3526
","
3527 3528 3529
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.
3530
For details of the format, see ""java.text.SimpleDateFormat"".
3531
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3532 3533 3534 3535 3536 3537
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3538
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3539 3540 3541 3542 3543 3544 3545
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3546
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3547 3548 3549 3550 3551 3552 3553
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3554
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3555 3556 3557 3558 3559 3560 3561
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3562
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3563 3564 3565 3566 3567 3568 3569
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3570
PARSEDATETIME(string, formatString
3571
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3572
","
3573 3574 3575
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.
3576
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3577 3578 3579 3580 3581 3582
","
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","
3583
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3584 3585 3586 3587 3588 3589 3590
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3591
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3592 3593 3594 3595 3596 3597 3598
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3599
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3600
","
3601 3602
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3603 3604 3605 3606 3607
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3608
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3609 3610 3611 3612 3613 3614 3615
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3616
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3617 3618
","
Returns one element of an array.
3619
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3620 3621 3622 3623 3624
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3625
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3626 3627 3628 3629 3630 3631
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3632 3633 3634 3635 3636 3637 3638 3639
"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
3640
"Functions (System)","AUTOCOMMIT","
3641
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3642 3643 3644 3645 3646 3647 3648
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3649
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3650
","
3651 3652 3653
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
3654 3655

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3656 3657 3658 3659 3660
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3661
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3662 3663
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3664
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3665 3666 3667 3668 3669
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3670
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3671
","
3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683
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
3684 3685 3686
"

"Functions (System)","COALESCE","
3687
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3688 3689 3690 3691 3692 3693 3694
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3695
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3696 3697 3698 3699 3700 3701 3702
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3703
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3704
","
3705 3706 3707 3708 3709
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
3710 3711 3712 3713 3714
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3715
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3716
","
3717 3718
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
3719 3720

If the column names are specified (a list of column names separated with the
3721
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3722 3723 3724 3725 3726
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
3727 3728 3729 3730 3731

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3741 3742 3743
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
3744 3745 3746 3747
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
3748 3749 3750 3751
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
3752
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3753
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3754 3755 3756
"

"Functions (System)","CSVWRITE","
3757
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3758
","
3759
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3760
If only a file name is specified, it will be written to the current working directory.
3761
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3762
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
3763 3764 3765 3766 3767

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

Thomas Mueller's avatar
Thomas Mueller committed
3770 3771
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3772
","
Thomas Mueller's avatar
Thomas Mueller committed
3773 3774 3775 3776
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
3777 3778 3779
"

"Functions (System)","DATABASE","
3780
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3781 3782 3783 3784 3785 3786 3787
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3788
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3789
","
Thomas Mueller's avatar
Thomas Mueller committed
3790 3791
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
3792 3793 3794 3795
","
CALL DATABASE_PATH();
"

3796
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3797
DECODE(value, whenValue, thenValue [,...])
3798 3799 3800 3801 3802 3803 3804 3805
","
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');
"

3806
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3807
DISK_SPACE_USED(tableNameString)
3808 3809 3810 3811 3812 3813 3814 3815
","
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
3816
"Functions (System)","FILE_READ","
3817
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3818 3819 3820 3821
","
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
3822
default character set for this system.
3823 3824 3825 3826

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

Thomas Mueller's avatar
Thomas Mueller committed
3827
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3828 3829 3830 3831 3832
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

3833
"Functions (System)","FILE_WRITE","
3834
FILE_WRITE(blobValue, fileNameString)
3835 3836 3837 3838 3839 3840 3841 3842
","
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
3843
"Functions (System)","GREATEST","
3844
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3845 3846 3847 3848 3849 3850 3851
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3852
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3853 3854
","
Returns the last inserted identity value for this session.
3855
This value changes whenever a new sequence number was generated,
3856
even within a trigger or Java function. See also SCOPE_IDENTITY.
3857
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3858 3859 3860 3861 3862
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3863
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3864 3865 3866 3867 3868 3869 3870
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3871
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3872 3873 3874 3875 3876 3877 3878
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3879
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3880 3881
","
Returns the current lock mode. See SET LOCK_MODE.
3882
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3883 3884 3885 3886 3887
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3888
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3889 3890 3891 3892 3893 3894 3895 3896
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3897
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3898
","
3899 3900 3901 3902 3903
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
3904
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3905 3906 3907 3908 3909
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

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

"Functions (System)","MEMORY_USED","
3921
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3922
","
Thomas Mueller's avatar
Thomas Mueller committed
3923
Returns the used memory in KB (where 1024 bytes is a KB).
3924
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3925 3926
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3927 3928 3929 3930 3931
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3932
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3933
","
3934 3935 3936 3937
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
3938 3939 3940 3941 3942
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3943
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3944 3945 3946 3947 3948 3949
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

3950 3951 3952 3953
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
3954
The data type of the returned value is the data type of 'a' if this is a text type.
3955 3956 3957 3958
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
3959
"Functions (System)","READONLY","
3960
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3961 3962 3963 3964 3965 3966 3967
","
Returns true if the database is read-only.
","
READONLY()
"

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

"Functions (System)","SCHEMA","
3983
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3984 3985 3986 3987 3988 3989
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3990 3991 3992
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
3993
Returns the last inserted identity value for this session for the current scope
Thomas Mueller's avatar
Thomas Mueller committed
3994
(ie. the current statement).
3995 3996 3997 3998 3999 4000
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
4001
"Functions (System)","SESSION_ID","
4002
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4003
","
4004 4005 4006 4007
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
4008 4009 4010 4011 4012
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4013
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4014
","
4015 4016 4017
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
4018
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4019
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4020 4021 4022 4023 4024
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4025
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4026 4027 4028 4029 4030 4031 4032
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4033
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4034
","
4035 4036
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
4037
Otherwise a value of the following form is returned:
4038
""logFileId-position-sessionId"".
4039 4040
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4041 4042 4043 4044
","
CALL TRANSACTION_ID()
"

4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056
"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
4057
"Functions (System)","USER","
4058
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4059 4060 4061 4062 4063 4064
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4065 4066 4067 4068 4069 4070 4071 4072
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087
"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
4088