help.csv 115.8 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 file name 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 file name 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","
426
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ] [ NOBUFFER ]
427
{ 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
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","
520
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ] LINKED TABLE [ IF NOT EXISTS ]
521 522
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
523 524 525 526 527
","
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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

"Commands (Other)","SET MAX_LOG_SIZE","
SET MAX_LOG_SIZE int
","
Thomas Mueller's avatar
Thomas Mueller committed
1343 1344
Sets the maximum size of the transaction log, in megabytes.
If the log is larger, and if there is no open transaction, the transaction log is truncated.
noelgrandin's avatar
noelgrandin committed
1345
If there is an open transaction, the transaction log will continue to grow however.
Thomas Mueller's avatar
Thomas Mueller committed
1346
The default max size is 16 MB.
Thomas Mueller's avatar
Thomas Mueller committed
1347
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1348

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1379
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1380 1381
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1382
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1383 1384 1385 1386 1387 1388 1389 1390 1391
","
SET MAX_MEMORY_UNDO 1000
"

"Commands (Other)","SET MAX_OPERATION_MEMORY","
SET MAX_OPERATION_MEMORY int
","
Sets the maximum memory used for large operations (delete and insert), in bytes.
Operations that use more memory are buffered to disk, slowing down the
Thomas Mueller's avatar
Thomas Mueller committed
1392 1393 1394
operation. The default max size is 100000. 0 means no limit.

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

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

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

"Commands (Other)","SET MULTI_THREADED","
1417
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1418 1419 1420
","
Enabled (1) or disabled (0) multi-threading inside the database engine. By
default, this setting is disabled. Currently, enabling this is experimental
Thomas Mueller's avatar
Thomas Mueller committed
1421 1422 1423 1424 1425
only.

This is a global setting, which means it is not possible to open multiple databases with different modes at the same time in the same virtual machine.
This setting is not persistent, however the value is kept until the virtual machine exits or it is changed.

Thomas Mueller's avatar
Thomas Mueller committed
1426
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1427
This command commits an open transaction.
1428
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1429 1430 1431 1432 1433
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1434
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1435 1436 1437
","
Enabled (1) or disabled (0) the result reuse optimization. If enabled,
subqueries and views used as subqueries are only re-run if the data in one of
Thomas Mueller's avatar
Thomas Mueller committed
1438 1439
the tables was changed. This option is enabled by default.

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

"Commands (Other)","SET PASSWORD","
SET PASSWORD string
","
Changes the password of the current user. The password must be in single quotes.
It is case sensitive and can contain spaces.
Thomas Mueller's avatar
Thomas Mueller committed
1452 1453

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

1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
"Commands (Other)","SET QUERY_STATISTICS","
SET QUERY_STATISTICS { TRUE | FALSE }
","
Disabled or enables query statistics gathering for the whole database.
The statistics are reflected in the INFORMATION_SCHEMA.QUERY_STATISTICS meta-table.

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

Thomas Mueller's avatar
Thomas Mueller committed
1471 1472 1473 1474 1475
"Commands (Other)","SET QUERY_TIMEOUT","
SET QUERY_TIMEOUT int
","
Set the query timeout of the current session to the given value. The timeout is
in milliseconds. All kinds of statements will throw an exception if they take
Thomas Mueller's avatar
Thomas Mueller committed
1476 1477 1478
longer than the given value. The default timeout is 0, meaning no timeout.

This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1479 1480 1481 1482 1483
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1484
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1485 1486 1487
","
Disabled or enables referential integrity checking for the whole database.
Enabling it does not check existing data. Use ALTER TABLE SET to disable it only
Thomas Mueller's avatar
Thomas Mueller committed
1488 1489 1490 1491
for one table.

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

1497 1498 1499 1500 1501 1502
"Commands (Other)","SET RETENTION_TIME","
SET RETENTION_TIME int
","
This property is only used when using the MVStore storage engine.
How long to retain old, persisted data, in milliseconds.
The default is 45000 (45 seconds), 0 means overwrite data as early as possible.
1503 1504 1505
It is assumed that a file system and hard disk will flush all write buffers within this time.
Using a lower value might be dangerous, unless the file system and hard disk flush the buffers earlier.
To manually flush the buffers, use CHECKPOINT SYNC,
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
however please note that according to various tests this does not always work as expected
depending on the operating system and hardware.

Admin rights are required to execute this command, as it affects all connections.
This command commits an open transaction.
This setting is persistent.
This setting can be appended to the database URL: ""jdbc:h2:test;RETENTION_TIME=0""
","
SET RETENTION_TIME 0
"

Thomas Mueller's avatar
Thomas Mueller committed
1517 1518 1519 1520 1521
"Commands (Other)","SET SALT HASH","
SET SALT bytes HASH bytes
","
Sets the password salt and hash for the current user. The password must be in
single quotes. It is case sensitive and can contain spaces.
Thomas Mueller's avatar
Thomas Mueller committed
1522 1523

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1524 1525 1526 1527 1528 1529 1530 1531 1532
","
SET SALT '00' HASH '1122'
"

"Commands (Other)","SET SCHEMA","
SET SCHEMA schemaName
","
Changes the default schema of the current connection. The default schema is used
in statements where no schema is set explicitly. The default schema for new
Thomas Mueller's avatar
Thomas Mueller committed
1533 1534 1535
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1536
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1537 1538 1539 1540 1541 1542 1543 1544 1545
","
SET SCHEMA INFORMATION_SCHEMA
"

"Commands (Other)","SET SCHEMA_SEARCH_PATH","
SET SCHEMA_SEARCH_PATH schemaName [,...]
","
Changes the schema search path of the current connection. The default schema is
used in statements where no schema is set explicitly. The default schema for new
Thomas Mueller's avatar
Thomas Mueller committed
1546 1547 1548
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1549
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1550 1551 1552 1553 1554 1555 1556 1557 1558
","
SET SCHEMA_SEARCH_PATH INFORMATION_SCHEMA, PUBLIC
"

"Commands (Other)","SET THROTTLE","
SET THROTTLE int
","
Sets the throttle for the current connection. The value is the number of
milliseconds delay after each 50 ms. The default value is 0 (throttling
Thomas Mueller's avatar
Thomas Mueller committed
1559 1560 1561
disabled).

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

"Commands (Other)","SET TRACE_LEVEL","
1568
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1569 1570 1571
","
Sets the trace level for file the file or system out stream. Levels are: 0=off,
1=error, 2=info, 3=debug. The default level is 1 for file and 0 for system out.
1572
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1573

Thomas Mueller's avatar
Thomas Mueller committed
1574
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1575
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1576
This command does not commit a transaction, and rollback does not affect it.
1577
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
","
SET TRACE_LEVEL_SYSTEM_OUT 3
"

"Commands (Other)","SET TRACE_MAX_FILE_SIZE","
SET TRACE_MAX_FILE_SIZE int
","
Sets the maximum trace file size. If the file exceeds the limit, the file is
renamed to .old and a new file is created. If another .old file exists, it is
deleted. The default max size is 16 MB.

Thomas Mueller's avatar
Thomas Mueller committed
1589
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1590
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1591
This command commits an open transaction.
1592
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
","
SET TRACE_MAX_FILE_SIZE 10
"

"Commands (Other)","SET UNDO_LOG","
SET UNDO_LOG int
","
Enables (1) or disables (0) the per session undo log. The undo log is enabled by
default. When disabled, transactions can not be rolled back. This setting should
only be used for bulk operations that don't need to be atomic.
Thomas Mueller's avatar
Thomas Mueller committed
1603 1604

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1605 1606 1607 1608 1609 1610 1611 1612
","
SET UNDO_LOG 0
"

"Commands (Other)","SET WRITE_DELAY","
SET WRITE_DELAY int
","
Set the maximum delay between a commit and flushing the log, in milliseconds.
Thomas Mueller's avatar
Thomas Mueller committed
1613 1614
This setting is persistent. The default is 500 ms.

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

"Commands (Other)","SHUTDOWN","
1623
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1624
","
1625 1626
This statement closes all open connections to the database and closes the
database. This command is usually not required, as the database is
Thomas Mueller's avatar
Thomas Mueller committed
1627
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1628

1629 1630
If no option is used, then the database is closed normally.
All connections are closed, open transactions are rolled back.
Thomas Mueller's avatar
Thomas Mueller committed
1631 1632 1633

SHUTDOWN COMPACT fully compacts the database (re-creating the database may further reduce the database size).
If the database is closed normally (using SHUTDOWN or by closing all connections), then the database is also compacted,
1634
but only for at most the time defined by the database setting ""h2.maxCompactTime"" in milliseconds (see there).
Thomas Mueller's avatar
Thomas Mueller committed
1635 1636

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

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

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

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

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

1661
"Other Grammar","Array","
1662
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1663
","
1664 1665
An array of values. An empty array is '()'. Trailing commas are ignored.
An array with one element must contain a comma to be parsed as an array.
Thomas Mueller's avatar
Thomas Mueller committed
1666
","
1667
(1, 2)
1668 1669
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1670 1671
"

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

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

1688 1689 1690
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1691
","
1692 1693
Returns the first expression where the value is equal to the test expression. If
no else part is specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1694
","
1695
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1696 1697
"

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

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

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

Identity and auto-increment columns are columns with a sequence as the
default. The column declared as the identity columns is implicitly the
primary key column of this table (unlike auto-increment columns).
Thomas Mueller's avatar
Thomas Mueller committed
1730

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

Thomas Mueller's avatar
Thomas Mueller committed
1733 1734
Check constraints can reference columns of the table,
and they can reference objects that exist while the statement is executed.
Thomas Mueller's avatar
Thomas Mueller committed
1735 1736
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1737
","
Thomas Mueller's avatar
Thomas Mueller committed
1738 1739 1740
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255) DEFAULT '');
CREATE TABLE TEST(ID BIGINT IDENTITY);
CREATE TABLE TEST(QUANTITY INT, PRICE DECIMAL, AMOUNT DECIMAL AS QUANTITY*PRICE);
1741 1742
"

1743 1744
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1745
","
1746 1747 1748
Comments can be used anywhere in a command and are ignored by the database. Line
comments end with a newline. Block comments cannot be nested, but can be
multiple lines long.
Thomas Mueller's avatar
Thomas Mueller committed
1749
","
1750
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1751 1752
"

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

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

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

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

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

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

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

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

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

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

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

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

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

""fieldSeparator"",

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3355
"Functions (String)","TO_CHAR","
3356
TO_CHAR(value [, formatString[, nlsParamString]])
3357 3358 3359 3360 3361 3362
","
Oracle-compatible TO_CHAR function that can format a timestamp, a number, or text.
","
CALL TO_CHAR(TIMESTAMP '2010-01-01 00:00:00', 'DD MON, YYYY')
"

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

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

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

"Functions (Time and Date)","DATEADD","
3392
{ DATEADD| TIMESTAMPADD } (unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3393
","
3394 3395 3396 3397
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
3398 3399 3400 3401 3402
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3913 3914 3915 3916 3917 3918 3919 3920 3921 3922
"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
3923
"Functions (System)","SESSION_ID","
3924
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3925
","
3926 3927 3928 3929
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
3930 3931 3932 3933 3934
","
CALL SESSION_ID()
"

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

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

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

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

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

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