help.csv 116.1 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
To read a stream from the classpath, use the prefix 'classpath:'.
135
See the Pluggable File System section on the Advanced page.
136

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

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

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

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

166
If no 'TO fileName' clause is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
167 168 169 170
script is returned as a result set. This command can be used to create a backup
of the database. For long term storage, it is more portable than copying the
database files.

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

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

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

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

"Commands (DML)","SHOW","
186 187
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
188 189 190 191 192 193 194 195 196
","
Lists the schemas, tables, or the columns of a table.
","
SHOW TABLES
"

"Commands (DDL)","ALTER INDEX RENAME","
ALTER INDEX indexName RENAME TO newIndexName
","
Thomas Mueller's avatar
Thomas Mueller committed
197 198
Renames an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
199 200 201 202
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

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

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

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
238
ALTER TABLE tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
239 240 241
","
Adds a constraint to a table. If NOCHECK is specified, existing rows are not
checked for consistency (the default is to check consistency for existing rows).
Thomas Mueller's avatar
Thomas Mueller committed
242
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
243
It is not possible to disable checking for unique constraints.
244
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
245 246 247 248
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

249
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
250 251 252 253 254 255 256 257
ALTER TABLE tableName ALTER COLUMN columnName
{ { dataType [ DEFAULT expression ] [ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] }
    | { RENAME TO name }
    | { RESTART WITH long }
    | { SELECTIVITY int }
    | { SET DEFAULT expression }
    | { SET NULL }
    | { SET NOT NULL } }
Thomas Mueller's avatar
Thomas Mueller committed
258
","
259 260
Changes the data type of a column, rename a column,
change the identity value, or change the selectivity.
Thomas Mueller's avatar
Thomas Mueller committed
261

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

264 265 266
RESTART changes the next value of an auto increment column.
The column must already be an auto increment column.
For RESTART, the same transactional rules as for ALTER SEQUENCE apply.
Thomas Mueller's avatar
Thomas Mueller committed
267

268 269 270 271
SELECTIVITY sets the selectivity (1-100) for a column.
Setting the selectivity to 0 means the default value.
Selectivity is used by the cost based optimizer to calculate the estimated cost of an index.
Selectivity 100 means values are unique, 10 means every distinct value appears 10 times on average.
Thomas Mueller's avatar
Thomas Mueller committed
272

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

275
SET NULL sets a column to allow NULL. The row may not be part of a primary key.
Thomas Mueller's avatar
Thomas Mueller committed
276
Single column indexes on this column are dropped.
277 278 279

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

280
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
281
","
282 283 284 285 286 287 288
ALTER TABLE TEST ALTER COLUMN NAME CLOB;
ALTER TABLE TEST ALTER COLUMN NAME RENAME TO TEXT;
ALTER TABLE TEST ALTER COLUMN ID RESTART WITH 10000;
ALTER TABLE TEST ALTER COLUMN NAME SELECTIVITY 100;
ALTER TABLE TEST ALTER COLUMN NAME SET DEFAULT '';
ALTER TABLE TEST ALTER COLUMN NAME SET NOT NULL;
ALTER TABLE TEST ALTER COLUMN NAME SET NULL;
Thomas Mueller's avatar
Thomas Mueller committed
289 290 291
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

529 530 531
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
532 533
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
534
work. Linked tables to the same database share one connection.
535

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

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

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

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

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

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

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

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

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
595 596

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

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

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

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

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

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

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

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

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
675 676 677
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.

678 679
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
708 709 710 711 712
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.

713 714
Views are not updatable except when using 'instead of' triggers.

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

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

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

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

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

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

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
753 754 755 756 757
","
DROP ALL OBJECTS
"

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

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

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

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

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

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

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

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

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

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

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

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
865 866 867 868 869 870 871
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
872
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
873 874

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
875 876 877 878 879 880 881
","
CHECKPOINT
"

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

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
886 887 888 889 890
","
CHECKPOINT SYNC
"

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

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

"Commands (Other)","GRANT RIGHT","
910 911
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
912
","
Thomas Mueller's avatar
Thomas Mueller committed
913 914 915 916
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
917 918 919 920
","
GRANT SELECT ON TEST TO READONLY
"

921 922 923 924 925 926 927 928 929 930 931
"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
932
"Commands (Other)","GRANT ROLE","
933
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
934
","
Thomas Mueller's avatar
Thomas Mueller committed
935 936 937 938
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
939 940 941 942 943
","
GRANT READONLY TO PUBLIC
"

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

"Commands (Other)","REVOKE RIGHT","
961 962
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
963
","
Thomas Mueller's avatar
Thomas Mueller committed
964 965 966 967
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
968 969 970 971 972
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
973
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
974
","
Thomas Mueller's avatar
Thomas Mueller committed
975 976 977 978
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
979 980 981 982 983
","
REVOKE READONLY FROM TOM
"

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

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

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

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

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

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

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
1060 1061
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
1062 1063
Depending on the virtual machine, the actual memory required may be higher.

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

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

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

1092 1093 1094 1095
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1096 1097
Sets the collation used for comparing BINARY columns, the default is SIGNED
for version 1.3 and older, and UNSIGNED for version 1.4 and newer.
1098 1099 1100 1101 1102 1103 1104 1105 1106
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
1107
"Commands (Other)","SET COLLATION","
1108 1109
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1110
","
Thomas Mueller's avatar
Thomas Mueller committed
1111 1112
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
1113 1114
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
1115
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1116

1117 1118 1119 1120 1121 1122
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
1123 1124 1125
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
1126 1127 1128 1129 1130
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1131
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1132 1133 1134
","
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
1135

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

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1159 1160
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
1161 1162 1163 1164
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
1165

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

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

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

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

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

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1219
","
Thomas Mueller's avatar
Thomas Mueller committed
1220
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1221 1222 1223
"

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

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

1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
"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'
"


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

1266
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1267 1268 1269 1270
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.

1271 1272
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
1273 1274
against power failure is required, but the data must be protected against killing the process.

1275 1276
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
1277 1278
file system, this will also protect against power failure in the majority if cases.

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

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

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

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

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

1330
This is the maximum length of an LOB that is stored with the record itself,
1331 1332
and the default value is 128.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1351
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1352 1353
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1354 1355 1356 1357 1358 1359 1360 1361
","
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
1362 1363
are read, then the rows are buffered to disk. The default value is 10000.

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

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

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

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

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

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

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

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

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

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

1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
"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
1473 1474 1475 1476 1477
"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
1478 1479 1480
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
1481 1482 1483 1484 1485
","
SET QUERY_TIMEOUT 10000
"

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

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

1499 1500 1501 1502 1503 1504
"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.
1505 1506 1507
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,
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
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
1519 1520 1521 1522 1523
"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
1524 1525

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

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

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

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

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

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

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

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

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

1631 1632
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
1633 1634 1635

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,
1636
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
1637 1638

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

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

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

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

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

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

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

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

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

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

"Other Grammar","Cipher","
1711
AES
1712
","
1713
Only the algorithm AES (""AES-128"") is supported currently.
1714 1715
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1716 1717
"

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

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
1731

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

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

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

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

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

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

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

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

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

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

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

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

1835
""caseSensitiveColumnNames"" (true or false; disabled by default),
1836

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

Thomas Mueller's avatar
Thomas Mueller committed
1839
""escape"",
1840

Thomas Mueller's avatar
Thomas Mueller committed
1841
""fieldDelimiter"",
1842 1843 1844

""fieldSeparator"",

1845
""lineComment"" (disabled by default),
1846

Thomas Mueller's avatar
Thomas Mueller committed
1847
""lineSeparator"",
1848 1849

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

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

1855
""preserveWhitespace"" (true or false; disabled by default),
1856

1857
""writeColumnHeader"" (true or false; enabled by default).
1858

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140
"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
2141
","
2142
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2143
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2144
","
2145 2146 2147 2148 2149 2150
'Hello'
"

"Other Grammar","Time","
TIME 'hh:mm:ss'
","
2151 2152
A time literal. A value is between plus and minus 2 million hours
and has nanosecond resolution.
2153 2154 2155 2156 2157 2158 2159 2160
","
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
2161
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2162 2163 2164 2165 2166 2167
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
2168
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2169
","
Thomas Mueller's avatar
Thomas Mueller committed
2170
A literal value of any data type, or null.
2171 2172
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2173 2174 2175 2176 2177 2178 2179
"

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

2180
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2181 2182 2183 2184 2185 2186 2187 2188 2189
","
INT
"

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

2190
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2191 2192 2193 2194 2195 2196 2197 2198 2199
","
BOOLEAN
"

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

2200
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2201 2202 2203 2204 2205 2206 2207 2208 2209
","
TINYINT
"

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

2210
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2211 2212 2213 2214 2215 2216 2217 2218 2219
","
SMALLINT
"

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

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

2232
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2233 2234 2235 2236 2237
","
IDENTITY
"

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

2243
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2244 2245 2246 2247 2248
","
DECIMAL(20, 2)
"

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

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

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

2265
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2266 2267 2268 2269 2270 2271 2272
","
REAL
"

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

2275
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
2276 2277 2278 2279 2280 2281 2282
","
TIME
"

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

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

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

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

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

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

"Data Types","OTHER Type","
OTHER
","
Thomas Mueller's avatar
Thomas Mueller committed
2318 2319 2320 2321 2322
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
2323

2324
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2325 2326 2327 2328 2329
","
OTHER
"

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

2342
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2343 2344 2345 2346 2347
","
VARCHAR(255)
"

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

2359
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2360 2361 2362 2363 2364
","
VARCHAR_IGNORECASE
"

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

Thomas Mueller's avatar
Thomas Mueller committed
2371 2372
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
2373

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

2377
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2378 2379 2380 2381 2382
","
CHAR(10)
"

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

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

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

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.

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

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2416 2417 2418 2419
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
2420

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

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


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
2440 2441 2442 2443
","
ARRAY
"

2444 2445 2446
"Data Types","GEOMETRY Type","
GEOMETRY
","
2447 2448
A spatial geometry type, based on the ""com.vividsolutions.jts"" library.
Normally represented in textual format using the WKT (well known text) format.
2449

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
2872 2873 2874 2875 2876
","
RANDOM_UUID()
"

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

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

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

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

"Functions (Numeric)","ENCRYPT","
2916
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2917
","
2918
Encrypts data using a key.
2919
The supported algorithm is AES.
2920 2921
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2922 2923 2924 2925 2926
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2927
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2928
","
2929
Decrypts data using a key.
2930
The supported algorithm is AES.
2931 2932
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2933 2934 2935 2936 2937 2938
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3365 3366 3367 3368 3369 3370 3371 3372
"Functions (String)","TRANSLATE","
TRANSLATE(value , searchString, replacementString]])
","
Oracle-compatible TRANSLATE function that replaces a sequence of characters in a string with another set of characters.
","
CALL TRANSLATE('Hello world', 'eo', 'EO')
"

Thomas Mueller's avatar
Thomas Mueller committed
3373
"Functions (Time and Date)","CURRENT_DATE","
3374
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3375 3376
","
Returns the current date.
3377
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3378 3379 3380 3381 3382
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3383
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3384 3385
","
Returns the current time.
3386
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3387 3388 3389 3390 3391
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3392
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3393
","
3394 3395
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3396
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3397 3398 3399 3400 3401
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3402
{ DATEADD| TIMESTAMPADD } (unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3403
","
3404 3405 3406 3407
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
3408 3409 3410 3411 3412
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3413
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3414
","
Thomas Mueller's avatar
Thomas Mueller committed
3415
Returns the the number of crossed unit boundaries between two timestamps.
3416 3417
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3418 3419 3420 3421 3422 3423
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3424
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3425 3426 3427 3428 3429 3430 3431
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3432
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3433 3434 3435 3436 3437 3438 3439
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3440
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3441 3442 3443 3444 3445 3446 3447
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3448
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3449 3450 3451 3452 3453 3454 3455
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3456
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3457
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3458
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3459 3460
","
Returns a specific value from a timestamps.
3461
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3462 3463 3464 3465 3466
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3467
FORMATDATETIME ( timestamp, formatString
3468
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3469
","
3470 3471 3472
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.
3473
For details of the format, see ""java.text.SimpleDateFormat"".
3474
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3475 3476 3477 3478 3479 3480
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3481
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3482 3483 3484 3485 3486 3487 3488
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3489
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3490 3491 3492 3493 3494 3495 3496
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3497
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3498 3499 3500 3501 3502 3503 3504
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3505
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3506 3507 3508 3509 3510 3511 3512
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3513
PARSEDATETIME(string, formatString
3514
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3515
","
3516 3517 3518
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.
3519
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3520 3521 3522 3523 3524 3525
","
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","
3526
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3527 3528 3529 3530 3531 3532 3533
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3534
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3535 3536 3537 3538 3539 3540 3541
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3542
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3543
","
3544 3545
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3546 3547 3548 3549 3550
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3551
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3552 3553 3554 3555 3556 3557 3558
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3559
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3560 3561
","
Returns one element of an array.
3562
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3563 3564 3565 3566 3567
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3568
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3569 3570 3571 3572 3573 3574
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3575 3576 3577 3578 3579 3580 3581 3582
"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
3583
"Functions (System)","AUTOCOMMIT","
3584
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3585 3586 3587 3588 3589 3590 3591
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3592
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3593
","
3594 3595 3596
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
3597 3598

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3599 3600 3601 3602 3603
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3604
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3605 3606
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3607
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3608 3609 3610 3611 3612
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3613
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3614
","
3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626
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
3627 3628 3629
"

"Functions (System)","COALESCE","
3630
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3631 3632 3633 3634 3635 3636 3637
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3638
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3639 3640 3641 3642 3643 3644 3645
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3646
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3647
","
3648 3649 3650 3651 3652
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
3653 3654 3655 3656 3657
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3658
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3659
","
3660 3661
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
3662 3663

If the column names are specified (a list of column names separated with the
3664
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3665 3666 3667 3668 3669
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
3670 3671 3672 3673 3674

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3684 3685 3686
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
3687 3688 3689 3690
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
3691 3692 3693 3694
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
3695
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3696
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3697 3698 3699
"

"Functions (System)","CSVWRITE","
3700
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3701
","
3702
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3703
If only a file name is specified, it will be written to the current working directory.
3704
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3705
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
3706 3707 3708 3709 3710

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

Thomas Mueller's avatar
Thomas Mueller committed
3713 3714
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3715
","
Thomas Mueller's avatar
Thomas Mueller committed
3716 3717 3718 3719
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
3720 3721 3722
"

"Functions (System)","DATABASE","
3723
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3724 3725 3726 3727 3728 3729 3730
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3731
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3732
","
Thomas Mueller's avatar
Thomas Mueller committed
3733 3734
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
3735 3736 3737 3738
","
CALL DATABASE_PATH();
"

3739
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3740
DECODE(value, whenValue, thenValue [,...])
3741 3742 3743 3744 3745 3746 3747 3748
","
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');
"

3749
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3750
DISK_SPACE_USED(tableNameString)
3751 3752 3753 3754 3755 3756 3757 3758
","
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
3759
"Functions (System)","FILE_READ","
3760
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3761 3762 3763 3764
","
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
3765
default character set for this system.
3766 3767 3768 3769

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

Thomas Mueller's avatar
Thomas Mueller committed
3770
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3771 3772 3773 3774 3775 3776
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

"Functions (System)","GREATEST","
3777
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3778 3779 3780 3781 3782 3783 3784
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3785
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3786 3787
","
Returns the last inserted identity value for this session.
3788
This value changes whenever a new sequence number was generated,
3789
even within a trigger or Java function. See also SCOPE_IDENTITY.
3790
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3791 3792 3793 3794 3795
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3796
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3797 3798 3799 3800 3801 3802 3803
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3804
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3805 3806 3807 3808 3809 3810 3811
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3812
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3813 3814
","
Returns the current lock mode. See SET LOCK_MODE.
3815
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3816 3817 3818 3819 3820
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3821
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3822 3823 3824 3825 3826 3827 3828 3829
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3830
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3831
","
3832 3833 3834 3835 3836
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
3837
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3838 3839 3840 3841 3842
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3843
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3844
","
Thomas Mueller's avatar
Thomas Mueller committed
3845
Returns the free 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_FREE()
"

"Functions (System)","MEMORY_USED","
3854
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3855
","
Thomas Mueller's avatar
Thomas Mueller committed
3856
Returns the used memory in KB (where 1024 bytes is a KB).
3857
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3858 3859
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3860 3861 3862 3863 3864
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3865
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3866
","
3867 3868 3869 3870
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
3871 3872 3873 3874 3875
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3876
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3877 3878 3879 3880 3881 3882
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

3883 3884 3885 3886
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
3887
The data type of the returned value is the data type of 'a' if this is a text type.
3888 3889 3890 3891
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
3892
"Functions (System)","READONLY","
3893
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3894 3895 3896 3897 3898 3899 3900
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
3901
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
3902
","
3903
Returns the number of the current row.
3904 3905
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
3906 3907
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).
3908
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3909
","
3910 3911
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3912
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3913 3914 3915
"

"Functions (System)","SCHEMA","
3916
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3917 3918 3919 3920 3921 3922
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3923 3924 3925 3926 3927 3928 3929 3930 3931 3932
"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
3933
"Functions (System)","SESSION_ID","
3934
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3935
","
3936 3937 3938 3939
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
3940 3941 3942 3943 3944
","
CALL SESSION_ID()
"

"Functions (System)","SET","
3945
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
3946
","
3947 3948 3949
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
3950
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
3951
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
3952 3953 3954 3955 3956
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
3957
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
3958 3959 3960 3961 3962 3963 3964
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
3965
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3966
","
3967 3968
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
3969
Otherwise a value of the following form is returned:
3970
""logFileId-position-sessionId"".
3971 3972
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
3973 3974 3975 3976
","
CALL TRANSACTION_ID()
"

3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988
"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
3989
"Functions (System)","USER","
3990
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
3991 3992 3993 3994 3995 3996
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

3997 3998 3999 4000 4001 4002 4003 4004
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019
"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
4020