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

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

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

28 29
If FOR UPDATE is specified, the tables are locked for writing. When using
MVCC, only the selected rows are locked as in an UPDATE statement.
Thomas Mueller's avatar
Thomas Mueller committed
30
In this case, aggregate, GROUP BY, DISTINCT queries or joins
31
are not allowed in this case.
Thomas Mueller's avatar
Thomas Mueller committed
32 33
","
SELECT * FROM TEST;
34 35 36 37 38
SELECT * FROM TEST ORDER BY NAME;
SELECT ID, COUNT(*) FROM TEST GROUP BY ID;
SELECT NAME, COUNT(*) FROM TEST GROUP BY NAME HAVING COUNT(*) > 2;
SELECT 'ID' COL, MAX(ID) AS MAX FROM TEST UNION SELECT 'NAME', MAX(NAME) FROM TEST;
SELECT * FROM TEST LIMIT 1000;
Thomas Mueller's avatar
Thomas Mueller committed
39 40 41 42 43 44
SELECT * FROM (SELECT ID, COUNT(*) FROM TEST
    GROUP BY ID UNION SELECT NULL, COUNT(*) FROM TEST)
    ORDER BY 1 NULLS LAST;
"

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

When using DIRECT, then the results from the query are directly applied in the target table without any intermediate step.

When using SORTED, b-tree pages are split at the insertion point. This can improve performance and reduce disk usage.
Thomas Mueller's avatar
Thomas Mueller committed
55 56 57 58 59
","
INSERT INTO TEST VALUES(1, 'Hello')
"

"Commands (DML)","UPDATE","
60 61 62
UPDATE tableName [ [ AS ] newTableAlias ] SET
{ { columnName = { DEFAULT | expression } } [,...] } |
    { ( columnName [,...] ) = ( select ) }
63
[ WHERE expression ] [ LIMIT expression ]
Thomas Mueller's avatar
Thomas Mueller committed
64 65 66
","
Updates data in a table.
","
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 135
To read a stream from the classpath, use the prefix 'classpath:'.

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
173 174 175
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
176
Admin rights are required to execute this command.
177

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

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

201 202 203 204 205 206 207 208 209
"Commands (DDL)","ALTER SCHEMA RENAME","
ALTER SCHEMA schema RENAME TO newSchemaName
","
Renames a schema.
This command commits an open transaction.
","
ALTER SCHEMA TEST RENAME TO PRODUCTION
"

Thomas Mueller's avatar
Thomas Mueller committed
210
"Commands (DDL)","ALTER SEQUENCE","
211
ALTER SEQUENCE sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
212 213 214 215
[ 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
216
","
217
Changes the parameters of a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
218
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
219 220 221 222 223 224
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

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

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

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

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

262 263 264
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
265

266 267 268 269
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
270

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

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

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

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

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

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

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

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

"Commands (DDL)","ALTER USER ADMIN","
332
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
333
","
Thomas Mueller's avatar
Thomas Mueller committed
334 335 336 337
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.
338
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
339 340 341 342 343 344 345
","
ALTER USER TOM ADMIN TRUE
"

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

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

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
391 392 393 394 395
","
ANALYZE SAMPLE_SIZE 1000
"

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

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

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

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

"Commands (DDL)","CREATE ALIAS","
424
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ] [ NOBUFFER ]
425
{ FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
426
","
427 428 429 430 431 432
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.
433 434 435

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
456
Admin rights are required to execute this command.
457
This command commits an open transaction.
458 459

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

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

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

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

494
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
495 496 497 498 499
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

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

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

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

526 527 528
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
529 530
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
531
work. Linked tables to the same database share one connection.
532

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

Thomas Mueller's avatar
Thomas Mueller committed
535 536 537
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).

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

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

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

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
572 573 574 575 576
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
577
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
578 579 580 581 582
[ 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
583
","
Thomas Mueller's avatar
Thomas Mueller committed
584 585 586
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
587 588 589 590 591

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
592 593

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
594 595 596 597 598
","
CREATE SEQUENCE SEQ_ID
"

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

Thomas Mueller's avatar
Thomas Mueller committed
607 608 609 610
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
611
that means memory tables should not get too large.
612

Thomas Mueller's avatar
Thomas Mueller committed
613 614 615 616 617
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,
618
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
619

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
652
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
653
Only row based AFTER trigger can be called on ROLLBACK.
654
Exceptions that occur within such triggers are ignored.
655 656
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.
657

658
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
659
Only the first such trigger is called. Such triggers on views are supported.
660
They can be used to make views updatable.
661

Thomas Mueller's avatar
Thomas Mueller committed
662 663
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.
664 665
The trigger is called with both 'old' and 'new' set to null.

666 667 668 669
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
670 671
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
672 673 674
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.

675 676
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
681 682 683 684
","
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger""
"
"Commands (DDL)","CREATE USER","
685 686
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
687
","
Thomas Mueller's avatar
Thomas Mueller committed
688 689 690
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.
691

Thomas Mueller's avatar
Thomas Mueller committed
692
Admin rights are required to execute this command.
693
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
694 695 696 697 698
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
699
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
700
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
701 702
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
703
if the underlying table(s) don't exist.
704

Thomas Mueller's avatar
Thomas Mueller committed
705 706 707 708 709
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.

710 711
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
712
Admin rights are required to execute this command.
713
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
714 715 716 717 718
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
719
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
720
","
Thomas Mueller's avatar
Thomas Mueller committed
721 722 723
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
724
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
725
","
Thomas Mueller's avatar
Thomas Mueller committed
726
DROP AGGREGATE MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
727 728 729
"

"Commands (DDL)","DROP ALIAS","
730
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
731
","
Thomas Mueller's avatar
Thomas Mueller committed
732 733 734
Drops an existing function alias.

Admin rights are required to execute this command.
735
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
736
","
Thomas Mueller's avatar
Thomas Mueller committed
737
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
738 739 740
"

"Commands (DDL)","DROP ALL OBJECTS","
741
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
742 743 744 745 746
","
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
747 748 749
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
750 751 752 753 754
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
755
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
756
","
Thomas Mueller's avatar
Thomas Mueller committed
757 758
Drops a constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
759 760 761 762 763
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
764
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
765
","
Thomas Mueller's avatar
Thomas Mueller committed
766 767
Drops a data type (domain).
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
768 769 770 771 772
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
773
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
774
","
Thomas Mueller's avatar
Thomas Mueller committed
775 776
Drops an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
777 778 779 780 781
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
782
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
783
","
Thomas Mueller's avatar
Thomas Mueller committed
784 785
Drops a role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
786 787 788 789 790
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
791
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
792
","
Thomas Mueller's avatar
Thomas Mueller committed
793 794
Drops a schema.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
795 796 797 798 799
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
800
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
801
","
Thomas Mueller's avatar
Thomas Mueller committed
802 803
Drops a sequence.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
804 805 806 807 808
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
809
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
810
","
Thomas Mueller's avatar
Thomas Mueller committed
811
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
812 813
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.
814
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
815 816 817 818 819
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
820
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
821
","
Thomas Mueller's avatar
Thomas Mueller committed
822 823
Drops an existing trigger.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
824 825 826 827 828
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
829
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
830
","
Thomas Mueller's avatar
Thomas Mueller committed
831 832
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
833

Thomas Mueller's avatar
Thomas Mueller committed
834
Admin rights are required to execute this command.
835
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
836 837 838 839 840
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
841
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
842
","
Thomas Mueller's avatar
Thomas Mueller committed
843 844 845
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
846
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
847 848 849 850 851 852 853
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
854 855 856 857 858
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).
859
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
860 861

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
862 863 864 865 866 867 868
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
869
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
870 871

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
872 873 874 875 876 877 878
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
879
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
880 881 882
to the underlying device.

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

"Commands (Other)","COMMIT","
888
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
889 890 891 892 893 894 895 896 897
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
898 899 900 901
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
902 903 904 905 906
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
907 908
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
909
","
Thomas Mueller's avatar
Thomas Mueller committed
910 911 912 913
Grants rights for a table to a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
914 915 916 917
","
GRANT SELECT ON TEST TO READONLY
"

918 919 920 921 922 923 924 925 926 927 928
"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.
This command commits an open transaction.
","
GRANT ALTER ANY SCHEMA TO Bob
"

Thomas Mueller's avatar
Thomas Mueller committed
929
"Commands (Other)","GRANT ROLE","
930
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
931
","
Thomas Mueller's avatar
Thomas Mueller committed
932 933 934 935
Grants a role to a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
936 937 938 939 940
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
941
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
942 943 944 945 946 947 948 949 950
","
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
951 952
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
953 954 955 956 957
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
958 959
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
960
","
Thomas Mueller's avatar
Thomas Mueller committed
961 962 963 964
Removes rights for a table from a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
965 966 967 968 969
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
970
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
971
","
Thomas Mueller's avatar
Thomas Mueller committed
972 973 974 975
Removes a role from a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
976 977 978 979 980
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
981
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
982 983 984 985 986 987 988 989 990 991
","
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
992 993 994 995
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
996 997 998 999 1000 1001 1002
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1003 1004
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
1005 1006 1007 1008 1009
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1010
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1011
","
Thomas Mueller's avatar
Thomas Mueller committed
1012
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1013
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
1014
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1015 1016 1017 1018 1019
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1020
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
","
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
1031 1032
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1033
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1034 1035
This command commits an open transaction.
This setting is persistent.
1036
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1037 1038 1039 1040 1041
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
1042
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
1043 1044
","
Switches auto commit on or off.
1045
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
1046
however this will not work as expected when using a connection pool
1047 1048
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
1049
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
1050 1051 1052 1053 1054 1055 1056
","
SET AUTOCOMMIT OFF
"

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1066
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1067 1068
This command commits an open transaction.
This setting is persistent.
1069
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
","
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
1082 1083
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1084
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1085 1086 1087 1088
","
SET CLUSTER ''
"

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Sets the collation used for comparing BINARY columns, the default is SIGNED.
This command can only be executed if there are no tables defined.

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

Thomas Mueller's avatar
Thomas Mueller committed
1103
"Commands (Other)","SET COLLATION","
1104 1105
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1106
","
Thomas Mueller's avatar
Thomas Mueller committed
1107 1108
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
1109 1110
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
1111
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1112

1113 1114 1115 1116 1117 1118
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
1119 1120 1121
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1122 1123 1124 1125 1126
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1127
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1128 1129 1130
","
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
1131

Thomas Mueller's avatar
Thomas Mueller committed
1132
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1133 1134
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1135 1136 1137 1138 1139 1140 1141 1142
","
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
1143 1144 1145 1146
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).
1147
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1148 1149 1150 1151 1152 1153 1154
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1155 1156
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
1157 1158 1159 1160
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
1161

Thomas Mueller's avatar
Thomas Mueller committed
1162
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1163 1164
This command commits an open transaction.
This setting is persistent.
1165
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1166 1167 1168 1169 1170 1171 1172 1173
","
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
1174 1175
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1176
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1177 1178
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1179 1180 1181 1182 1183
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1184
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1185 1186 1187
","
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
1188
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1189
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1190

Thomas Mueller's avatar
Thomas Mueller committed
1191
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1192 1193
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1194
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1195 1196 1197 1198 1199
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1200
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1201
","
Thomas Mueller's avatar
Thomas Mueller committed
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
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
1212 1213 1214

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1215
","
Thomas Mueller's avatar
Thomas Mueller committed
1216
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1217 1218 1219
"

"Commands (Other)","SET IGNORECASE","
1220
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1221 1222 1223 1224 1225
","
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
1226
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1227

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

1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
"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.
This command commits an open transaction.
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'
"


1256
"Commands (Other)","SET LOG","
1257
SET LOG int
1258 1259 1260 1261
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1262
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1263 1264 1265 1266
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.

1267 1268
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
1269 1270
against power failure is required, but the data must be protected against killing the process.

1271 1272
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
1273 1274
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1275
Admin rights are required to execute this command, as it affects all connections.
1276 1277
This command commits an open transaction.
This setting is not persistent.
1278
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1279 1280 1281 1282
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1283 1284 1285 1286
"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
1287
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300

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
1301
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1302 1303
This command commits an open transaction.
This setting is persistent.
1304
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1305 1306 1307 1308 1309 1310 1311 1312
","
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
1313 1314 1315
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1316
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1317 1318 1319 1320 1321 1322 1323
","
SET LOCK_TIMEOUT 1000
"

"Commands (Other)","SET MAX_LENGTH_INPLACE_LOB","
SET MAX_LENGTH_INPLACE_LOB int
","
Thomas Mueller's avatar
Thomas Mueller committed
1324
Sets the maximum size of an in-place LOB object.
1325 1326 1327 1328 1329 1330

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1333
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1334 1335
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1336 1337 1338 1339 1340 1341 1342
","
SET MAX_LENGTH_INPLACE_LOB 128
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1349
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1350 1351
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1352 1353 1354 1355 1356 1357 1358 1359
","
SET MAX_LOG_SIZE 2
"

"Commands (Other)","SET MAX_MEMORY_ROWS","
SET MAX_MEMORY_ROWS int
","
The maximum number of rows in a result set that are kept in-memory. If more rows
Thomas Mueller's avatar
Thomas Mueller committed
1360 1361
are read, then the rows are buffered to disk. The default value is 10000.

Thomas Mueller's avatar
Thomas Mueller committed
1362
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1363 1364
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1365
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1366 1367 1368 1369 1370 1371 1372
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1379
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1380 1381
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1382
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1383 1384 1385 1386 1387 1388 1389 1390 1391
","
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
1392 1393 1394
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1395
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1396
It has no effect for in-memory databases.
1397
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1398 1399 1400 1401 1402
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1403
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1404 1405
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1406 1407 1408
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1409
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1410
This command commits an open transaction.
1411
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1412 1413 1414 1415 1416
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1417
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1418 1419 1420
","
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
1421 1422 1423 1424 1425
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
1426
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1427
This command commits an open transaction.
1428
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1429 1430 1431 1432 1433
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1434
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1435 1436 1437
","
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
1438 1439
the tables was changed. This option is enabled by default.

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1454 1455 1456 1457
","
SET PASSWORD 'abcstzri!.5'
"

1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
"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.
This command commits an open transaction.
Admin rights are required to execute this command, as it affects all connections.
","
SET QUERY_STATISTICS FALSE
"

Thomas Mueller's avatar
Thomas Mueller committed
1471 1472 1473 1474 1475
"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
1476 1477 1478
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
1479 1480 1481 1482 1483
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1484
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1485 1486 1487
","
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
1488 1489 1490 1491
for one table.

This setting is not persistent.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1492
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1493 1494 1495 1496
","
SET REFERENTIAL_INTEGRITY FALSE
"

1497 1498 1499 1500 1501 1502
"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.
1503 1504 1505
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,
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
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.
This command commits an open transaction.
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
1517 1518 1519 1520 1521
"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
1522 1523

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1524 1525 1526 1527 1528 1529 1530 1531 1532
","
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
1533 1534 1535
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1536
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1537 1538 1539 1540 1541 1542 1543 1544 1545
","
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
1546 1547 1548
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1549
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1550 1551 1552 1553 1554 1555 1556 1557 1558
","
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
1559 1560 1561
disabled).

This command does not commit a transaction, and rollback does not affect it.
1562
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1563 1564 1565 1566 1567
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1568
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1569 1570 1571
","
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.
1572
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1573

Thomas Mueller's avatar
Thomas Mueller committed
1574
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1575
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1576
This command does not commit a transaction, and rollback does not affect it.
1577
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
","
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
1589
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1590
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1591
This command commits an open transaction.
1592
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
","
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
1603 1604

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1605 1606 1607 1608 1609 1610 1611 1612
","
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
1613 1614
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1615
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1616
This command commits an open transaction.
1617
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1618 1619 1620 1621 1622
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1623
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1624
","
1625 1626
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
1627
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1628

1629 1630
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
1631 1632 1633

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,
1634
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
1635 1636

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1640
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1641
","
1642
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1643 1644
"

1645 1646
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1647
","
1648
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1649
","
1650
A
Thomas Mueller's avatar
Thomas Mueller committed
1651 1652
"

1653 1654
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1655
","
1656
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1657
","
1658
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1659 1660
"

1661
"Other Grammar","Array","
1662
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1663
","
1664 1665
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
1666
","
1667
(1, 2)
1668 1669
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1670 1671
"

1672 1673
"Other Grammar","Boolean","
TRUE | FALSE
1674
","
1675
A boolean value.
1676
","
1677
TRUE
1678 1679
"

1680 1681
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1682
","
1683
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1684
","
1685
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1686 1687
"

1688 1689 1690
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1691
","
1692 1693
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
1694
","
1695
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1696 1697
"

1698 1699 1700
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1701
","
1702 1703
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1704
","
1705 1706 1707 1708 1709 1710
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
{ AES | XTEA }
","
Thomas Mueller's avatar
Thomas Mueller committed
1711
Two algorithms are supported: AES (""AES-128"") and XTEA (using 32 rounds).
1712
XTEA is a bit faster than AES in some environments, but AES is more secure.
1713 1714
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1715 1716
"

1717
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1718 1719
columnName dataType
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1720
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1721 1722
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1723 1724
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1725
The computed column expression is evaluated and assigned whenever the row changes.
1726 1727 1728 1729

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
1730

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

Thomas Mueller's avatar
Thomas Mueller committed
1733 1734
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
1735 1736
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1737
","
Thomas Mueller's avatar
Thomas Mueller committed
1738 1739 1740
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);
1741 1742
"

1743 1744
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1745
","
1746 1747 1748
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
1749
","
1750
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1751 1752
"

1753
"Other Grammar","Compare","
1754
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
1755
","
1756
Comparison operator. The operator != is the same as <>. && means overlapping, can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
1757
","
1758
<>
Thomas Mueller's avatar
Thomas Mueller committed
1759 1760 1761
"

"Other Grammar","Condition","
1762
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1763 1764 1765 1766 1767 1768 1769
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1770 1771
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1772
    | IS [ NOT ] [ DISTINCT FROM ] operand
1773 1774 1775 1776
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1777
","
Thomas Mueller's avatar
Thomas Mueller committed
1778
The right hand side of a condition.
1779

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

Thomas Mueller's avatar
Thomas Mueller committed
1783 1784 1785 1786 1787
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).
1788 1789 1790
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.
1791

Thomas Mueller's avatar
Thomas Mueller committed
1792
When comparing with REGEXP, regular expression matching is used.
1793
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1794 1795 1796 1797
","
LIKE 'Jo%'
"

1798
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
1799 1800 1801 1802 1803
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
1804
","
Thomas Mueller's avatar
Thomas Mueller committed
1805 1806
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1807
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1808 1809
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
1810
","
1811
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1812 1813
"

1814 1815
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1816
","
1817
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1818
","
1819
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1820 1821
"

1822 1823
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1824
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1825
","
1826
Optional parameters for CSVREAD and CSVWRITE.
1827 1828
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
1829 1830
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1831
The following options are supported:
1832

1833
""caseSensitiveColumnNames"" (true or false; disabled by default),
1834

Thomas Mueller's avatar
Thomas Mueller committed
1835
""charset"",
1836

Thomas Mueller's avatar
Thomas Mueller committed
1837
""escape"",
1838

Thomas Mueller's avatar
Thomas Mueller committed
1839
""fieldDelimiter"",
1840 1841 1842

""fieldSeparator"",

1843
""lineComment"" (disabled by default),
1844

Thomas Mueller's avatar
Thomas Mueller committed
1845
""lineSeparator"",
1846 1847

""null"", Note that an empty value is always treated as null.
Thomas Mueller's avatar
Thomas Mueller committed
1848
This feature for compatibility, it is only here to support reading existing CSV files
Thomas Mueller's avatar
Thomas Mueller committed
1849
that contain explicit ""null"" delimiters.
1850 1851 1852

""rowSeparator"" (not set by default),

1853
""preserveWhitespace"" (true or false; disabled by default),
1854

1855
""writeColumnHeader"" (true or false; enabled by default).
1856

Thomas Mueller's avatar
Thomas Mueller committed
1857
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1858
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
1859 1860 1861
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
1862
","
1863
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1864 1865
"

1866 1867 1868 1869 1870
"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
1871
","
1872
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1873
","
1874
INT
Thomas Mueller's avatar
Thomas Mueller committed
1875 1876
"

1877 1878
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1879
","
1880
A date literal. The limitations are the same as for the Java data type
1881
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1882
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1883
","
1884
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1885 1886
"

1887
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
1888
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
1889
","
Thomas Mueller's avatar
Thomas Mueller committed
1890 1891 1892 1893 1894 1895
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)"".
1896
","
Thomas Mueller's avatar
Thomas Mueller committed
1897 1898 1899
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
1900 1901
"

1902 1903
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1904
","
1905
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1906
","
1907
0
Thomas Mueller's avatar
Thomas Mueller committed
1908 1909
"

1910 1911
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1912
","
1913 1914 1915
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
1916
","
1917
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1918 1919
"

1920 1921
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1922
","
1923
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1924
","
1925
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1926 1927
"

1928
"Other Grammar","Factor","
1929
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1930
","
1931
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1932
","
1933
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1934 1935
"

1936 1937
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1938
","
1939 1940
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1941
","
1942
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1943 1944
"

1945 1946
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1947
","
1948
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1949
","
1950
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1951 1952
"

1953 1954
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1955
","
1956 1957 1958
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
1959
","
1960
NAME
Thomas Mueller's avatar
Thomas Mueller committed
1961 1962 1963
"

"Other Grammar","Int","
1964
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1965 1966 1967 1968 1969 1970 1971
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
1972
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1973 1974 1975 1976 1977 1978
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

1979 1980
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
1981
","
1982
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
1983
","
1984
TEST
Thomas Mueller's avatar
Thomas Mueller committed
1985 1986
"

1987 1988
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1989
","
1990
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
1991
","
1992
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1993 1994
"

1995 1996 1997 1998 1999 2000 2001 2002
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2003
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2004
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2005
","
Thomas Mueller's avatar
Thomas Mueller committed
2006
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2007 2008 2009 2010 2011 2012 2013
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
"

2014 2015
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2016
","
2017
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2018
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2019
","
2020
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2021 2022
"

2023 2024
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2025
","
2026 2027 2028
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
2029
","
2030
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2031 2032
"

2033 2034
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2035
","
2036 2037 2038
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
2039
","
2040
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2041 2042
"

2043 2044 2045
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2046
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2047
","
Thomas Mueller's avatar
Thomas Mueller committed
2048 2049 2050
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
2051 2052 2053
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
2054
","
2055
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2056 2057
"

Thomas Mueller's avatar
Thomas Mueller committed
2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068
"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
"

2069 2070
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2071
","
2072 2073
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
2074 2075 2076 2077 2078
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2079 2080
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2081
","
2082
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2083
","
2084
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2085 2086
"

2087 2088
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2089
","
2090 2091
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
2092
","
2093
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2094 2095
"

2096 2097
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2098
","
Thomas Mueller's avatar
Thomas Mueller committed
2099
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2100

Thomas Mueller's avatar
Thomas Mueller committed
2101
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2102
","
2103
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2104 2105
"

2106
"Other Grammar","Table Expression","
2107
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
2108 2109
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2110
","
2111 2112 2113
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
2114
","
2115
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2116 2117
"

2118 2119 2120 2121 2122 2123 2124 2125 2126
"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;
"

2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
Thomas Mueller's avatar
Thomas Mueller committed
2139
","
2140
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2141
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2142
","
2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157
'Hello'
"

"Other Grammar","Time","
TIME 'hh:mm:ss'
","
A time literal.
","
TIME '23:59:59'
"

"Other Grammar","Timestamp","
TIMESTAMP 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]'
","
A timestamp literal. The limitations are the same as for the Java data type
2158
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2159 2160 2161 2162 2163 2164
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
2165
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2166
","
Thomas Mueller's avatar
Thomas Mueller committed
2167
A literal value of any data type, or null.
2168 2169
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2170 2171 2172 2173 2174 2175 2176
"

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

2177
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2178 2179 2180 2181 2182 2183 2184 2185 2186
","
INT
"

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

2187
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2188 2189 2190 2191 2192 2193 2194 2195 2196
","
BOOLEAN
"

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

2197
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2198 2199 2200 2201 2202 2203 2204 2205 2206
","
TINYINT
"

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

2207
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2208 2209 2210 2211 2212 2213 2214 2215 2216
","
SMALLINT
"

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

2217
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228
","
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.

2229
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2230 2231 2232 2233 2234
","
IDENTITY
"

"Data Types","DECIMAL Type","
2235
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2236 2237 2238 2239
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2240
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2241 2242 2243 2244 2245
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2246
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT4 | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2247
","
Thomas Mueller's avatar
Thomas Mueller committed
2248
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2249 2250
of rounding problems.

2251
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2252 2253 2254 2255 2256 2257 2258
","
DOUBLE
"

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

2262
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2263 2264 2265 2266 2267 2268 2269
","
REAL
"

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

2272
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
2273 2274 2275 2276 2277 2278 2279
","
TIME
"

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

2282
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2283
(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
2284 2285 2286 2287 2288
","
DATE
"

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

2293
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2294 2295 2296 2297 2298
","
TIMESTAMP
"

"Data Types","BINARY Type","
2299
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2300
","
2301 2302 2303 2304 2305
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
2306 2307 2308 2309 2310 2311 2312 2313 2314

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2315 2316 2317 2318 2319
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
2320

2321
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2322 2323 2324 2325 2326
","
OTHER
"

"Data Types","VARCHAR Type","
2327 2328
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2329
","
Thomas Mueller's avatar
Thomas Mueller committed
2330
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2331 2332 2333 2334 2335 2336 2337
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
2338

2339
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2340 2341 2342 2343 2344
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2345
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2346
","
Thomas Mueller's avatar
Thomas Mueller committed
2347
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2348 2349 2350 2351 2352 2353 2354
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
2355

2356
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2357 2358 2359 2360 2361
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2362
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2363
","
Thomas Mueller's avatar
Thomas Mueller committed
2364 2365 2366
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
2367

Thomas Mueller's avatar
Thomas Mueller committed
2368 2369
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
2370

Thomas Mueller's avatar
Thomas Mueller committed
2371
The whole text is kept in memory when using this data type.
Thomas Mueller's avatar
Thomas Mueller committed
2372
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
","
CHAR(10)
"

"Data Types","BLOB Type","
2380
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2381 2382 2383
","
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
2384
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2385 2386
Advanced / Large Objects.

2387
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2388 2389 2390 2391 2392
","
BLOB
"

"Data Types","CLOB Type","
2393
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2394 2395 2396 2397 2398
","
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
2399
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2400 2401 2402 2403 2404

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.

2405
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2406 2407 2408 2409 2410 2411 2412
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2413 2414 2415 2416
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
2417

Thomas Mueller's avatar
Thomas Mueller committed
2418 2419 2420 2421 2422
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
2423
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2424 2425 2426 2427 2428 2429 2430
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2431
An array of values.
2432
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2433 2434 2435 2436


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
2437 2438 2439 2440
","
ARRAY
"

2441 2442 2443 2444 2445 2446
"Data Types","GEOMETRY Type","
GEOMETRY
","
A spatial geometry type, based on the com.vividsolutions.jts library.
Normally represented in textual format using the WKT (Well Known Text) format.

Thomas Mueller's avatar
Thomas Mueller committed
2447
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2448 2449 2450 2451 2452
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
ARRAY
"

Thomas Mueller's avatar
Thomas Mueller committed
2453
"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2454
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2455
","
2456 2457
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2458
Aggregates are only allowed in select statements.
2459
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2460 2461 2462 2463 2464
","
AVG(X)
"

"Functions (Aggregate)","BOOL_AND","
2465
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2466
","
2467 2468 2469
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
2470 2471 2472 2473 2474
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2475
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2476
","
2477 2478 2479
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
2480 2481 2482 2483 2484
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2485
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2486
","
2487 2488 2489 2490
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
2491 2492 2493 2494 2495
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2496 2497
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2498
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2499
","
2500 2501 2502 2503 2504
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
2505 2506 2507 2508 2509
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

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

"Functions (Aggregate)","MIN","
2521
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2522
","
2523 2524 2525 2526
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
2527 2528 2529 2530 2531
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2532
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2533
","
2534 2535 2536
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2537
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2538
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2539 2540 2541 2542 2543
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2544
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2545
","
2546 2547 2548 2549 2550
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
2551 2552 2553 2554 2555
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2556
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2557
","
2558 2559 2560
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
2561 2562 2563 2564 2565 2566
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2567
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2568
","
2569 2570 2571
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
2572 2573 2574 2575 2576 2577
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2578
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2579
","
2580 2581 2582 2583
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
2584 2585 2586 2587 2588
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2589
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2590
","
2591 2592 2593 2594
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
2595 2596 2597 2598 2599
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2600
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2601
","
2602 2603
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"".
2604
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2605 2606 2607 2608 2609
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2610
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2611
","
Thomas Mueller's avatar
Thomas Mueller committed
2612 2613
Calculate the arc cosine.
See also Java ""Math.acos"".
2614
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2615 2616 2617 2618 2619
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2620
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2621
","
Thomas Mueller's avatar
Thomas Mueller committed
2622 2623
Calculate the arc sine.
See also Java ""Math.asin"".
2624
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2625 2626 2627 2628 2629
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2630
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2631
","
Thomas Mueller's avatar
Thomas Mueller committed
2632 2633
Calculate the arc tangent.
See also Java ""Math.atan"".
2634
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2635 2636 2637 2638 2639
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2640
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2641
","
Thomas Mueller's avatar
Thomas Mueller committed
2642 2643
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2644
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2645 2646 2647 2648
","
COS(ANGLE)
"

2649
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2650
COSH(numeric)
2651 2652 2653 2654 2655 2656 2657 2658
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2659
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2660
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2661
","
Thomas Mueller's avatar
Thomas Mueller committed
2662
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2663
See also Java ""Math.*"" functions.
2664
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2665 2666 2667 2668 2669
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2670
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2671
","
Thomas Mueller's avatar
Thomas Mueller committed
2672 2673
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2674
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2675 2676 2677 2678
","
SIN(ANGLE)
"

2679
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2680
SINH(numeric)
2681 2682 2683 2684 2685 2686 2687 2688
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2689
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2690
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2691
","
Thomas Mueller's avatar
Thomas Mueller committed
2692 2693
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2694
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2695 2696 2697 2698
","
TAN(ANGLE)
"

2699
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2700
TANH(numeric)
2701 2702 2703 2704 2705 2706 2707 2708
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2709
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2710
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2711
","
Thomas Mueller's avatar
Thomas Mueller committed
2712
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2713
See also Java ""Math.atan2"".
2714
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2715 2716 2717 2718 2719
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2720
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2721
","
2722 2723
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2724 2725 2726 2727 2728 2729
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2730
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2731
","
2732 2733
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2734 2735 2736 2737 2738 2739
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2740
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2741
","
2742 2743
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2744 2745 2746 2747 2748 2749
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2750
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2751
","
2752 2753
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2754 2755 2756 2757 2758 2759
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2760
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2761
","
2762
See also Java ""Math.ceil"".
2763
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2764
","
2765
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2766 2767 2768
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2769
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2770
","
2771
See also Java ""Math.toDegrees"".
2772
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2773 2774 2775 2776 2777
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2778
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2779
","
2780
See also Java ""Math.exp"".
2781
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2782 2783 2784 2785 2786
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
2787
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2788
","
2789
See also Java ""Math.floor"".
2790
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2791 2792 2793 2794 2795
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2796
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2797
","
2798
See also Java ""Math.log"".
2799
In the PostgreSQL mode, LOG(x) is base 10.
2800
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2801 2802 2803 2804 2805
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
2806
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2807
","
2808
See also Java ""Math.log10"" (in Java 5).
2809
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2810 2811 2812 2813 2814
","
LOG10(A)
"

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

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

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

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

"Functions (Numeric)","RAND","
2851
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2852 2853 2854
","
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
2855
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2856 2857 2858 2859 2860
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2861
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2862 2863
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
2864 2865 2866 2867 2868

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
2869 2870 2871 2872 2873
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2874
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
2875
","
2876
Rounds to a number of digits, or to the nearest long if the number of digits if not set.
2877
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2878 2879 2880 2881 2882
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
2883
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2884
","
2885 2886 2887 2888 2889 2890
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
2891 2892 2893 2894 2895
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2896
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2897 2898
","
Generates a number of cryptographically secure random numbers.
2899
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2900 2901 2902 2903 2904
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
2905
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2906 2907 2908 2909 2910 2911 2912
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2913
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2914
","
2915 2916 2917 2918
Encrypts data using a key.
Supported algorithms are XTEA and AES.
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2919 2920 2921 2922 2923
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2924
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2925
","
2926 2927 2928 2929
Decrypts data using a key.
Supported algorithms are XTEA and AES.
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2930 2931 2932 2933 2934 2935
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2936
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2937
","
2938 2939 2940
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
2941 2942 2943 2944 2945
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
2946
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp } )
Thomas Mueller's avatar
Thomas Mueller committed
2947 2948
","
Truncates to a number of digits (to the next value closer to 0).
2949
This method returns a double.
2950
When used with a timestamp, truncates a timestamp to a date (day) value.
Thomas Mueller's avatar
Thomas Mueller committed
2951 2952 2953 2954 2955
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
2956
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
2957
","
2958 2959 2960 2961
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
2962 2963 2964 2965 2966
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
2967
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2968 2969
","
Expands data that was compressed using the COMPRESS function.
2970
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2971 2972 2973 2974 2975
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
2976
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
2977 2978 2979 2980 2981 2982 2983
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
2984
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
2985 2986
","
Returns the ASCII value of the first character in the string.
2987
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2988 2989 2990 2991
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
2992
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2993
","
2994 2995 2996
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
2997 2998 2999 3000 3001
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3002
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3003
","
3004 3005 3006
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
3007 3008 3009 3010 3011
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3012
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3013
","
3014 3015 3016 3017
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
3018 3019 3020 3021 3022
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3023
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3024 3025
","
Returns the character that represents the ASCII value.
3026
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3027 3028 3029 3030 3031
","
CHAR(65)
"

"Functions (String)","CONCAT","
3032
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3033 3034
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3035
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3036
and do not cause the result to become NULL.
3037
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3038 3039 3040 3041
","
CONCAT(NAME, '!')
"

3042 3043 3044 3045
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3046
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3047
and do not cause the result to become NULL.
3048 3049 3050 3051 3052
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3053
"Functions (String)","DIFFERENCE","
3054
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3055 3056
","
Returns the difference between the sounds of two strings.
3057
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3058 3059 3060 3061 3062
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3063
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3064
","
3065 3066
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
3067 3068 3069 3070 3071
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3072
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3073
","
3074 3075 3076
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
3077 3078 3079 3080 3081
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3082
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3083
","
3084
Returns the location of a search string in a string.
3085 3086 3087
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
3088 3089 3090 3091 3092
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3093
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3094
","
3095 3096 3097
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
3098 3099 3100 3101 3102
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3103
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3104 3105 3106 3107 3108 3109 3110
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3111
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3112 3113 3114 3115 3116 3117 3118
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3119
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3120 3121 3122 3123 3124 3125 3126
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3127
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3128 3129 3130 3131 3132 3133 3134
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3135
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3136
","
3137 3138 3139 3140
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
3141 3142 3143 3144 3145
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3146
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3147 3148 3149 3150 3151 3152 3153
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3154
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3155
","
3156 3157 3158
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
3159 3160 3161 3162 3163
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3164
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3165
","
3166 3167 3168
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
3169 3170 3171 3172 3173
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3174
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3175 3176 3177 3178 3179 3180 3181
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3182
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3183 3184 3185 3186 3187 3188 3189
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3190
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3191
","
3192 3193
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
3194 3195 3196 3197 3198
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3199
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
3200
","
3201
Replaces each substring that matches a regular expression.
3202
For details, see the Java ""String.replaceAll()"" method.
3203
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3204 3205 3206 3207 3208
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
3209
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3210 3211 3212 3213 3214 3215 3216
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3217
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3218
","
3219 3220
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.
3221
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3222 3223 3224 3225 3226
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3227
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3228
","
3229 3230 3231
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
3232 3233 3234 3235 3236
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3237
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3238 3239 3240 3241 3242 3243 3244
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3245
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3246
","
3247 3248 3249
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
3250 3251 3252 3253 3254
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3255
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3256
","
3257 3258 3259
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
3260 3261 3262 3263 3264
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3265
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3266 3267
","
Encodes a string to a byte array using the UTF8 encoding format.
3268
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3269 3270 3271 3272 3273
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3274
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3275
","
3276
Returns a substring of a string starting at a position.
3277
If the start index is negative, then the start index is relative to the end of the string.
3278
The length is optional.
3279
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3280
","
3281 3282
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3283 3284 3285
"

"Functions (String)","UTF8TOSTRING","
3286
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3287 3288 3289 3290 3291 3292 3293
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3294
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3295
","
3296
Creates an XML attribute element of the form ""name=value"".
3297 3298
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3299 3300 3301 3302 3303
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3304
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3305 3306
","
Create an XML node element.
3307 3308 3309
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.
3310
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3311 3312 3313 3314 3315
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3316
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3317
","
3318
Creates an XML comment.
3319
Two dashes (""--"") are converted to ""- -"".
3320
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3321 3322 3323 3324 3325
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3326
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3327
","
3328
Creates an XML CDATA element.
3329
If the value contains ""]]>"", an XML text element is created instead.
3330
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3331 3332 3333 3334 3335
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3336
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3337
","
Thomas Mueller's avatar
Thomas Mueller committed
3338
Returns the XML declaration.
3339
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3340 3341 3342 3343 3344
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3345
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3346 3347
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3348
If enabled, newline and linefeed is converted to an XML entity (&#).
3349
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3350 3351 3352 3353
","
CALL XMLTEXT('test')
"

3354
"Functions (String)","TO_CHAR","
3355
TO_CHAR(value [, formatString[, nlsParamString]])
3356 3357 3358 3359 3360 3361
","
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')
"

Thomas Mueller's avatar
Thomas Mueller committed
3362
"Functions (Time and Date)","CURRENT_DATE","
3363
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3364 3365
","
Returns the current date.
3366
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3367 3368 3369 3370 3371
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3372
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3373 3374
","
Returns the current time.
3375
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3376 3377 3378 3379 3380
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3381
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3382
","
3383 3384
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3385
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3386 3387 3388 3389 3390
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3391
{ DATEADD| TIMESTAMPADD } (unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3392
","
3393 3394 3395 3396
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
The same units as in the EXTRACT function are supported.
This method returns a timestamp.
Thomas Mueller's avatar
Thomas Mueller committed
3397 3398 3399 3400 3401
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3402
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3403
","
Thomas Mueller's avatar
Thomas Mueller committed
3404
Returns the the number of crossed unit boundaries between two timestamps.
3405 3406
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3407 3408 3409 3410 3411 3412
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3413
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3414 3415 3416 3417 3418 3419 3420
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3421
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3422 3423 3424 3425 3426 3427 3428
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3429
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3430 3431 3432 3433 3434 3435 3436
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3437
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3438 3439 3440 3441 3442 3443 3444
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3445
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3446
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3447
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3448 3449
","
Returns a specific value from a timestamps.
3450
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3451 3452 3453 3454 3455
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3456
FORMATDATETIME ( timestamp, formatString
3457
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3458
","
3459 3460 3461
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.
3462
For details of the format, see ""java.text.SimpleDateFormat"".
3463
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3464 3465 3466 3467 3468 3469
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3470
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3471 3472 3473 3474 3475 3476 3477
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3478
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3479 3480 3481 3482 3483 3484 3485
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3486
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3487 3488 3489 3490 3491 3492 3493
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3494
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3495 3496 3497 3498 3499 3500 3501
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3502
PARSEDATETIME(string, formatString
3503
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3504
","
3505 3506 3507
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.
3508
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3509 3510 3511 3512 3513 3514
","
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","
3515
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3516 3517 3518 3519 3520 3521 3522
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3523
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3524 3525 3526 3527 3528 3529 3530
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3531
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3532
","
3533 3534
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3535 3536 3537 3538 3539
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3540
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3541 3542 3543 3544 3545 3546 3547
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3548
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3549 3550
","
Returns one element of an array.
3551
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3552 3553 3554 3555 3556
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3557
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3558 3559 3560 3561 3562 3563
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3564 3565 3566 3567 3568 3569 3570 3571
"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
3572
"Functions (System)","AUTOCOMMIT","
3573
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3574 3575 3576 3577 3578 3579 3580
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3581
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3582
","
3583 3584 3585
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
3586 3587

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3588 3589 3590 3591 3592
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3593
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3594 3595
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3596
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3597 3598 3599 3600 3601
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3602
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3603
","
3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615
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
3616 3617 3618
"

"Functions (System)","COALESCE","
3619
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3620 3621 3622 3623 3624 3625 3626
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3627
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3628 3629 3630 3631 3632 3633 3634
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3635
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3636
","
3637 3638 3639 3640 3641
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
3642 3643 3644 3645 3646
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3647
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3648
","
3649 3650
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
3651 3652

If the column names are specified (a list of column names separated with the
3653
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3654 3655 3656 3657 3658
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
3659 3660 3661 3662 3663

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3673 3674 3675
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
3676 3677 3678 3679
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
3680 3681 3682 3683
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
3684
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3685
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3686 3687 3688
"

"Functions (System)","CSVWRITE","
3689
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3690
","
3691
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3692
If only a file name is specified, it will be written to the current working directory.
3693
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3694
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
3695 3696 3697 3698 3699

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

Thomas Mueller's avatar
Thomas Mueller committed
3702 3703
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3704
","
Thomas Mueller's avatar
Thomas Mueller committed
3705 3706 3707 3708
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
3709 3710 3711
"

"Functions (System)","DATABASE","
3712
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3713 3714 3715 3716 3717 3718 3719
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3720
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3721
","
Thomas Mueller's avatar
Thomas Mueller committed
3722 3723
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
3724 3725 3726 3727
","
CALL DATABASE_PATH();
"

3728
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3729
DECODE(value, whenValue, thenValue [,...])
3730 3731 3732 3733 3734 3735 3736 3737
","
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');
"

3738
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3739
DISK_SPACE_USED(tableNameString)
3740 3741 3742 3743 3744 3745 3746 3747
","
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
3748
"Functions (System)","FILE_READ","
3749
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3750 3751 3752 3753
","
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
3754
default character set for this system.
3755 3756 3757 3758

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

Thomas Mueller's avatar
Thomas Mueller committed
3759
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3760 3761 3762 3763 3764 3765
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

"Functions (System)","GREATEST","
3766
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3767 3768 3769 3770 3771 3772 3773
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3774
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3775 3776
","
Returns the last inserted identity value for this session.
3777
This value changes whenever a new sequence number was generated,
3778
even within a trigger or Java function. See also SCOPE_IDENTITY.
3779
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3780 3781 3782 3783 3784
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3785
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3786 3787 3788 3789 3790 3791 3792
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3793
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3794 3795 3796 3797 3798 3799 3800
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3801
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3802 3803
","
Returns the current lock mode. See SET LOCK_MODE.
3804
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3805 3806 3807 3808 3809
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3810
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3811 3812 3813 3814 3815 3816 3817 3818
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3819
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3820
","
3821 3822 3823 3824 3825
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
3826
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3827 3828 3829 3830 3831
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3832
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3833
","
Thomas Mueller's avatar
Thomas Mueller committed
3834
Returns the free memory in KB (where 1024 bytes is a KB).
3835
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3836 3837
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3838 3839 3840 3841 3842
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3843
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3844
","
Thomas Mueller's avatar
Thomas Mueller committed
3845
Returns the used memory in KB (where 1024 bytes is a KB).
3846
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3847 3848
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3849 3850 3851 3852 3853
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3854
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3855
","
3856 3857 3858 3859
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
3860 3861 3862 3863 3864
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3865
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3866 3867 3868 3869 3870 3871
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

3872 3873 3874 3875
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
3876
The data type of the returned value is the data type of 'a' if this is a text type.
3877 3878 3879 3880
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
3881
"Functions (System)","READONLY","
3882
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3883 3884 3885 3886 3887 3888 3889
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
3890
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
3891
","
3892
Returns the number of the current row.
3893 3894
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
3895 3896
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).
3897
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3898
","
3899 3900
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3901
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3902 3903 3904
"

"Functions (System)","SCHEMA","
3905
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3906 3907 3908 3909 3910 3911
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3912 3913 3914 3915 3916 3917 3918 3919 3920 3921
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
Returns the last inserted identity value for this session for the current scope.
Changes within triggers and Java functions are ignored. See also IDENTITY().
This method returns a long.
","
CALL SCOPE_IDENTITY();
"

Thomas Mueller's avatar
Thomas Mueller committed
3922
"Functions (System)","SESSION_ID","
3923
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3924
","
3925 3926 3927 3928
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
3929 3930 3931 3932 3933
","
CALL SESSION_ID()
"

"Functions (System)","SET","
3934
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
3935
","
3936 3937 3938
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
3939
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
3940
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
3941 3942 3943 3944 3945
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
3946
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
3947 3948 3949 3950 3951 3952 3953
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
3954
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3955
","
3956 3957
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
3958
Otherwise a value of the following form is returned:
3959
""logFileId-position-sessionId"".
3960 3961
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
3962 3963 3964 3965
","
CALL TRANSACTION_ID()
"

3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977
"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
3978
"Functions (System)","USER","
3979
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
3980 3981 3982 3983 3984 3985
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

3986 3987 3988 3989 3990 3991 3992 3993
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008
"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
4009