help.csv 107.1 KB
Newer Older
1
# Copyright 2004-2011 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","
Thomas Mueller's avatar
Thomas Mueller committed
60
UPDATE tableName [ [ AS ] newTableAlias ]
61
SET { columnName = { DEFAULT | expression } } [,...]
62
[ WHERE expression ]
Thomas Mueller's avatar
Thomas Mueller committed
63 64 65
","
Updates data in a table.
","
66 67
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
68 69 70
"

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

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

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

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

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

132
Instead of a file name, an URL may be used.
133 134
To read a stream from the classpath, use the prefix 'classpath:'.

Thomas Mueller's avatar
Thomas Mueller committed
135 136
The compression algorithm must match the one used when creating the script. When
using encryption, only DEFLATE and LZF are supported (LZF is faster but uses more space).
Thomas Mueller's avatar
Thomas Mueller committed
137 138 139
Instead of a file, an URL may be used.

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

"Commands (DML)","SCRIPT","
145 146
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
Thomas Mueller's avatar
Thomas Mueller committed
147
[ TO fileNameString [ scriptCompression ]
148
    [ CIPHER cipher PASSWORD string ] ]
149
[ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
150
","
151 152 153 154 155 156 157 158 159
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.

If no file name is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
160 161 162 163
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.

164
If a file name is specified, then the whole
Thomas Mueller's avatar
Thomas Mueller committed
165 166 167 168
script (including insert statements) is written to this file, and a result set
without the insert statements is returned. When using encryption, only DEFLATE
and LZF are supported (LZF is faster but uses more space).

Thomas Mueller's avatar
Thomas Mueller committed
169 170 171
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
172 173 174 175 176
","
SCRIPT NODATA
"

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

194 195 196 197 198 199 200 201 202
"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
203
"Commands (DDL)","ALTER SEQUENCE","
204
ALTER SEQUENCE sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
Thomas Mueller's avatar
Thomas Mueller committed
205
","
Thomas Mueller's avatar
Thomas Mueller committed
206 207
Changes the next value and the increment of a sequence.
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
208 209 210 211 212 213
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

"Commands (DDL)","ALTER TABLE ADD","
214
ALTER TABLE tableName ADD [ IF NOT EXISTS ] name dataType [ DEFAULT expression ]
215
[ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] [ BEFORE columnName ]
Thomas Mueller's avatar
Thomas Mueller committed
216
","
Thomas Mueller's avatar
Thomas Mueller committed
217 218
Adds a new column to a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
219 220 221 222 223
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
224
ALTER TABLE tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
225 226 227
","
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
228
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
229
It is not possible to disable checking for unique constraints.
230
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
231 232 233 234
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

235 236 237 238 239 240 241 242 243
"Commands (DDL)","ALTER TABLE ALTER","
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
244
","
245 246
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
247

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

250 251 252
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
253

254 255 256 257
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
258

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

261
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
262
Single column indexes on this column are dropped.
263 264 265

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

266
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
267
","
268 269 270 271 272 273 274
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
275 276 277
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
278
ALTER TABLE tableName DROP COLUMN [ IF EXISTS ] columnName
Thomas Mueller's avatar
Thomas Mueller committed
279 280
","
Removes a column from a table.
281
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
282 283 284 285 286
","
ALTER TABLE TEST DROP COLUMN NAME
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
287
ALTER TABLE tableName DROP { CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
288 289
","
Removes a constraint or a primary key from a table.
290
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
291 292 293 294 295 296
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
ALTER TABLE tableName SET REFERENTIAL_INTEGRITY
297
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
298 299 300 301 302 303
","
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.
304 305

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
306 307 308 309 310 311 312
","
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
313 314
Renames a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
315 316 317 318 319
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
320
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
321
","
Thomas Mueller's avatar
Thomas Mueller committed
322 323 324 325
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.
326
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
327 328 329 330 331 332 333
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
334 335 336 337
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
338
Admin rights are required to execute this command.
339
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
340 341 342 343 344
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
345
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
346
","
Thomas Mueller's avatar
Thomas Mueller committed
347 348 349 350 351 352
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.
353
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
354 355 356 357 358 359 360 361
","
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
362
This command is used for views created using CREATE FORCE VIEW.
363
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
364 365 366 367 368
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
369
ANALYZE [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
370 371 372 373 374 375 376
","
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.
377 378

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
379 380 381 382 383
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
384 385 386 387 388
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
389
","
Thomas Mueller's avatar
Thomas Mueller committed
390 391 392
Sets the comment of a database object. Use NULL to remove the comment.

Admin rights are required to execute this command.
393
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
394 395 396 397 398
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
399
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
400 401 402
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
403
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
404 405

Admin rights are required to execute this command.
406
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
407 408 409 410 411
","
CREATE AGGREGATE MEDIAN FOR ""com.acme.db.Median""
"

"Commands (DDL)","CREATE ALIAS","
412
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
413
{ FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
414
","
415 416 417 418 419
Creates a new function alias. Deterministic functions must always return the
same value for the same parameters. The result of such functions is cached if possible.

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

425 426
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.
427 428
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
429 430
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
431

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

435
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
436 437 438
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.
439

Thomas Mueller's avatar
Thomas Mueller committed
440
Admin rights are required to execute this command.
441
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
442 443 444 445 446
","
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');
447 448
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
Thomas Mueller's avatar
Thomas Mueller committed
449 450 451
"

"Commands (DDL)","CREATE CONSTANT","
452
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
453
","
Thomas Mueller's avatar
Thomas Mueller committed
454 455
Creates a new constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
456 457 458 459 460
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
461 462 463
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
464 465
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
466
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
467
to the value being tested.
468

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

471
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
472 473 474 475 476
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
Thomas Mueller's avatar
Thomas Mueller committed
477
CREATE { [ UNIQUE ] [ HASH ] INDEX [ [ IF NOT EXISTS ] newIndexName ]
478 479
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
480
","
Thomas Mueller's avatar
Thomas Mueller committed
481 482
Creates a new index.
This command commits an open transaction.
483

Thomas Mueller's avatar
Thomas Mueller committed
484
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
485 486
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
487
Non-unique keys are supported.
Thomas Mueller's avatar
Thomas Mueller committed
488 489 490 491 492
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
493 494 495
CREATE [ [ GLOBAL | LOCAL ] TEMPORARY ] LINKED TABLE [ IF NOT EXISTS ]
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
496 497 498 499 500 501 502 503
","
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.

Usually, for update statements, the old rows are deleted first and then the new
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
504
work. Linked tables to the same database share one connection.
505

Thomas Mueller's avatar
Thomas Mueller committed
506 507 508
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).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
516
Admin rights are required to execute this command.
517
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
518 519 520 521 522 523 524 525 526
","
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","
527
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
528
","
Thomas Mueller's avatar
Thomas Mueller committed
529 530
Creates a new role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
531 532 533 534 535
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
536
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
Thomas Mueller's avatar
Thomas Mueller committed
537 538 539
","
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
540
Specifying the owner currently has no effect.
541 542

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
543 544 545 546 547
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
548 549
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
[ INCREMENT BY long ] [ CACHE long ]
Thomas Mueller's avatar
Thomas Mueller committed
550
","
Thomas Mueller's avatar
Thomas Mueller committed
551 552 553
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
554 555 556 557 558

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
559 560

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
561 562 563 564 565
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
566 567
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
568
[ ( { columnDefinition | constraint } [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
569
[ ENGINE tableEngineName ] [ NOT PERSISTENT ] [ TRANSACTIONAL ]
570
[ AS select ]","
Thomas Mueller's avatar
Thomas Mueller committed
571 572
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
573 574 575 576
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
577
that means memory tables should not get too large.
578

Thomas Mueller's avatar
Thomas Mueller committed
579 580 581 582 583
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,
584
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
585

586
The ENGINE option is only required when custom table implementations are used.
587
The table engine class must implement the interface ""org.h2.api.TableEngine"".
588

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

592 593 594
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
595 596
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
597 598 599 600 601
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
602
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
603
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
604
[ QUEUE int ] [ NOWAIT ] CALL triggeredClassName
Thomas Mueller's avatar
Thomas Mueller committed
605
","
Thomas Mueller's avatar
Thomas Mueller committed
606 607 608 609 610
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).
611

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

617
Only row based AFTER trigger can be called on ROLLBACK.
618
Exceptions that occur within such triggers are ignored.
619 620
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.
621

622
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
623
Only the first such trigger is called. Such triggers on views are supported.
624
They can be used to make views updatable.
625

626 627 628
A BEFORE SELECT trigger can be used to update a table on demand.
The trigger is called with both 'old' and 'new' set to null.

629 630 631 632
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
633 634 635 636
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

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.
637 638

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
639 640 641 642
","
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger""
"
"Commands (DDL)","CREATE USER","
643 644
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
645
","
Thomas Mueller's avatar
Thomas Mueller committed
646 647 648
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.
649

Thomas Mueller's avatar
Thomas Mueller committed
650
Admin rights are required to execute this command.
651
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
652 653 654 655 656
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
657
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
658
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
659 660
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
661
if the underlying table(s) don't exist.
662

Thomas Mueller's avatar
Thomas Mueller committed
663 664 665 666 667
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.

668 669
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
670
Admin rights are required to execute this command.
671
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
672 673 674 675 676
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
677
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
678
","
Thomas Mueller's avatar
Thomas Mueller committed
679 680 681
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
682
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
683 684 685 686 687
","
CREATE AGGREGATE MEDIAN
"

"Commands (DDL)","DROP ALIAS","
688
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
689
","
Thomas Mueller's avatar
Thomas Mueller committed
690 691 692
Drops an existing function alias.

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

"Commands (DDL)","DROP ALL OBJECTS","
699
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
700 701 702 703 704
","
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
705 706 707
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
708 709 710 711 712
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
713
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
714
","
Thomas Mueller's avatar
Thomas Mueller committed
715 716
Drops a constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
717 718 719 720 721
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
722
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
723
","
Thomas Mueller's avatar
Thomas Mueller committed
724 725
Drops a data type (domain).
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
726 727 728 729 730
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
731
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
732
","
Thomas Mueller's avatar
Thomas Mueller committed
733 734
Drops an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
735 736 737 738 739
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
740
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
741
","
Thomas Mueller's avatar
Thomas Mueller committed
742 743
Drops a role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
744 745 746 747 748
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
749
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
750
","
Thomas Mueller's avatar
Thomas Mueller committed
751 752
Drops a schema.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
753 754 755 756 757
","
DROP SCHEMA TEST_SCHEMA
"

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

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
767
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
768
","
Thomas Mueller's avatar
Thomas Mueller committed
769
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
770 771
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.
772
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
773 774 775 776 777
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
778
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
779
","
Thomas Mueller's avatar
Thomas Mueller committed
780 781
Drops an existing trigger.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
782 783 784 785 786
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
787
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
788
","
Thomas Mueller's avatar
Thomas Mueller committed
789 790
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
791

Thomas Mueller's avatar
Thomas Mueller committed
792
Admin rights are required to execute this command.
793
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
794 795 796 797 798
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
799
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
800
","
Thomas Mueller's avatar
Thomas Mueller committed
801 802 803
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
804
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
805 806 807 808 809 810 811
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
812 813 814 815 816
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).
817
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
818 819

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
820 821 822 823 824 825 826
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
827
Flushes the data to disk and switches to a new transaction log if possible.
Thomas Mueller's avatar
Thomas Mueller committed
828 829

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
830 831 832 833 834 835 836
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
837
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
838 839 840
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
841 842 843 844 845
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
846
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
847 848 849 850 851 852 853 854 855
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
856 857 858 859
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
860 861 862 863 864
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
865 866
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
867
","
Thomas Mueller's avatar
Thomas Mueller committed
868 869 870 871
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
872 873 874 875 876
","
GRANT SELECT ON TEST TO READONLY
"

"Commands (Other)","GRANT ROLE","
877
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
878
","
Thomas Mueller's avatar
Thomas Mueller committed
879 880 881 882
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
883 884 885 886 887
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
888
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
889 890 891 892 893 894 895 896 897
","
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
898 899
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
900 901 902 903 904
","
PREPARE COMMIT XID_TEST
"

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

"Commands (Other)","REVOKE ROLE","
917
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
918
","
Thomas Mueller's avatar
Thomas Mueller committed
919 920 921 922
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
923 924 925 926 927
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
928
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
929 930 931 932 933 934 935 936 937 938
","
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
939 940 941 942
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
943 944 945 946 947 948 949
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
950 951
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
952 953 954 955 956
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
957
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
958
","
Thomas Mueller's avatar
Thomas Mueller committed
959
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
960
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
961
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
962 963 964 965 966
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
967
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
968 969 970 971 972 973 974 975 976 977
","
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
978 979
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
980
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
981 982
This command commits an open transaction.
This setting is persistent.
983
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
984 985 986 987 988
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
989
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
990 991
","
Switches auto commit on or off.
992
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
993
however this will not work as expected when using a connection pool
994 995
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
996
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
997 998 999 1000 1001 1002 1003
","
SET AUTOCOMMIT OFF
"

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
1004 1005
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
1006 1007
Depending on the virtual machine, the actual memory required may be higher.

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

Thomas Mueller's avatar
Thomas Mueller committed
1013
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1014 1015
This command commits an open transaction.
This setting is persistent.
1016
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
","
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
1029 1030
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1031
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1032 1033 1034 1035 1036
","
SET CLUSTER ''
"

"Commands (Other)","SET COLLATION","
1037 1038
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1039
","
Thomas Mueller's avatar
Thomas Mueller committed
1040 1041
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
1042 1043
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
1044
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1045

1046 1047 1048 1049 1050 1051
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
1052 1053 1054
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
1055 1056 1057 1058 1059
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1060
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1061 1062 1063
","
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
1064

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

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1088 1089
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
1090 1091 1092 1093
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
1094

Thomas Mueller's avatar
Thomas Mueller committed
1095
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1096 1097
This command commits an open transaction.
This setting is persistent.
1098
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1099 1100 1101 1102 1103 1104 1105 1106
","
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
1107 1108
for the new sessions. The default value for this setting is 1000 (one second).

Thomas Mueller's avatar
Thomas Mueller committed
1109
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1110 1111
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1112 1113 1114 1115 1116
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1117
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1118 1119 1120
","
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
1121
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1122
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1123

Thomas Mueller's avatar
Thomas Mueller committed
1124
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1125 1126
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1127
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1128 1129 1130 1131 1132
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1133
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1134
","
Thomas Mueller's avatar
Thomas Mueller committed
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
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
1145 1146 1147

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1148
","
Thomas Mueller's avatar
Thomas Mueller committed
1149
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1150 1151 1152
"

"Commands (Other)","SET IGNORECASE","
1153
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1154 1155 1156 1157 1158
","
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
1159
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1160

Thomas Mueller's avatar
Thomas Mueller committed
1161
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1162 1163
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1164
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1165 1166 1167 1168
","
SET IGNORECASE TRUE
"

1169
"Commands (Other)","SET LOG","
1170
SET LOG int
1171 1172 1173 1174
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1175
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1176 1177 1178 1179
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.

1180 1181
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
1182 1183
against power failure is required, but the data must be protected against killing the process.

1184 1185
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
1186 1187
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1188
Admin rights are required to execute this command, as it affects all connections.
1189 1190
This command commits an open transaction.
This setting is not persistent.
1191
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1192 1193 1194 1195
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1196 1197 1198 1199
"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
1200
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213

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
1214
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1215 1216
This command commits an open transaction.
This setting is persistent.
1217
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1218 1219 1220 1221 1222 1223 1224 1225
","
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
1226 1227 1228
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1229
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1230 1231 1232 1233 1234 1235 1236 1237 1238
","
SET LOCK_TIMEOUT 1000
"

"Commands (Other)","SET MAX_LENGTH_INPLACE_LOB","
SET MAX_LENGTH_INPLACE_LOB int
","
Sets the maximum size of an in-place LOB object. LOB objects larger that this
size are stored in a separate file, otherwise stored directly in the database
Thomas Mueller's avatar
Thomas Mueller committed
1239
(in-place). The default max size is 1024.
Thomas Mueller's avatar
Thomas Mueller committed
1240
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1241

Thomas Mueller's avatar
Thomas Mueller committed
1242
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1243 1244
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1245 1246 1247 1248 1249 1250 1251
","
SET MAX_LENGTH_INPLACE_LOB 128
"

"Commands (Other)","SET MAX_LOG_SIZE","
SET MAX_LOG_SIZE int
","
Thomas Mueller's avatar
Thomas Mueller committed
1252 1253
Sets the maximum size of the transaction log, in megabytes. If the log exceeds the
limit, a new stream is created. Old streams (that are not used for recovery) are
Thomas Mueller's avatar
Thomas Mueller committed
1254
freed automatically. The default max size is 16 MB.
Thomas Mueller's avatar
Thomas Mueller committed
1255
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1256

Thomas Mueller's avatar
Thomas Mueller committed
1257
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1258 1259
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1260 1261 1262 1263 1264 1265 1266 1267
","
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
1268 1269
are read, then the rows are buffered to disk. The default value is 10000.

Thomas Mueller's avatar
Thomas Mueller committed
1270
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1271 1272
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1273
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1274 1275 1276 1277 1278 1279 1280
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1287
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1288 1289
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1290
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1291 1292 1293 1294 1295 1296 1297 1298 1299
","
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
1300 1301 1302
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
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
It has no effect for in-memory databases.
1305
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1306 1307 1308 1309 1310
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1311
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1312 1313
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1314 1315 1316
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1317
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1318
This command commits an open transaction.
1319
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1320 1321 1322 1323 1324
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1325
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1326 1327 1328
","
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
1329 1330 1331 1332 1333
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
1334
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1335
This command commits an open transaction.
1336
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1337 1338 1339 1340 1341
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1342
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1343 1344 1345
","
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
1346 1347
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1348
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1349
This command commits an open transaction.
1350
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1351 1352 1353 1354 1355 1356 1357 1358 1359
","
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
1360 1361

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1362 1363 1364 1365 1366 1367 1368 1369 1370
","
SET PASSWORD 'abcstzri!.5'
"

"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
1371 1372 1373
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
1374 1375 1376 1377 1378
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1379
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1380 1381 1382
","
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
1383 1384 1385 1386
for one table.

This setting is not persistent.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1387
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1388 1389 1390 1391 1392 1393 1394 1395 1396
","
SET REFERENTIAL_INTEGRITY FALSE
"

"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
1397 1398

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1399 1400 1401 1402 1403 1404 1405 1406 1407
","
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
1408 1409 1410
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1411
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1412 1413 1414 1415 1416 1417 1418 1419 1420
","
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
1421 1422 1423
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1424
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1425 1426 1427 1428 1429 1430 1431 1432 1433
","
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
1434 1435 1436
disabled).

This command does not commit a transaction, and rollback does not affect it.
1437
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1438 1439 1440 1441 1442
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1443
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1444 1445 1446
","
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.
1447
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1448

Thomas Mueller's avatar
Thomas Mueller committed
1449
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1450
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1451
This command does not commit a transaction, and rollback does not affect it.
1452
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
","
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
1464
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1465
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1466
This command commits an open transaction.
1467
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
","
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
1478 1479

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1480 1481 1482 1483 1484 1485 1486 1487
","
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
1488 1489
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1490
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1491
This command commits an open transaction.
1492
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1493 1494 1495 1496 1497
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1498
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1499
","
1500 1501
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
1502
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1503

1504 1505
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
1506 1507 1508

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,
Thomas Mueller's avatar
Thomas Mueller committed
1509
but only for at most the time defined by the database setting ""h2.maxCompactTime"" (see there).
Thomas Mueller's avatar
Thomas Mueller committed
1510 1511

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1515
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1516
","
1517
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1518 1519
"

1520 1521
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1522
","
1523
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1524
","
1525
A
Thomas Mueller's avatar
Thomas Mueller committed
1526 1527
"

1528 1529
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1530
","
1531
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1532
","
1533
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1534 1535
"

1536
"Other Grammar","Array","
1537
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1538
","
1539 1540
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
1541
","
1542
(1, 2)
1543 1544
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1545 1546
"

1547 1548
"Other Grammar","Boolean","
TRUE | FALSE
1549
","
1550
A boolean value.
1551
","
1552
TRUE
1553 1554
"

1555 1556
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1557
","
1558
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1559
","
1560
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1561 1562
"

1563 1564 1565
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1566
","
1567 1568
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
1569
","
1570
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1571 1572
"

1573 1574 1575
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1576
","
1577 1578
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1579
","
1580 1581 1582 1583 1584 1585
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
{ AES | XTEA }
","
Thomas Mueller's avatar
Thomas Mueller committed
1586
Two algorithms are supported: AES (""AES-128"") and XTEA (using 32 rounds).
1587
XTEA is a bit faster than AES in some environments, but AES is more secure.
1588 1589
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1590 1591
"

1592
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1593 1594
columnName dataType
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1595
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1596 1597
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1598 1599
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1600
The computed column expression is evaluated and assigned whenever the row changes.
1601 1602 1603 1604

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
1605 1606 1607

Check constraints can reference columns of the table,
and they can reference objects that exist while the statement is executed.
1608
","
Thomas Mueller's avatar
Thomas Mueller committed
1609 1610 1611
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);
1612 1613
"

1614 1615
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1616
","
1617 1618 1619
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
1620
","
1621
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1622 1623
"

1624 1625
"Other Grammar","Compare","
<> | <= | >= | = | < | > | !=
Thomas Mueller's avatar
Thomas Mueller committed
1626
","
1627
Comparison operator. The operator != is the same as <>.
Thomas Mueller's avatar
Thomas Mueller committed
1628
","
1629
<>
Thomas Mueller's avatar
Thomas Mueller committed
1630 1631 1632
"

"Other Grammar","Condition","
1633
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1634 1635 1636 1637 1638 1639 1640
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1641 1642
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1643
    | IS [ NOT ] [ DISTINCT FROM ] operand
1644 1645 1646 1647
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1648
","
Thomas Mueller's avatar
Thomas Mueller committed
1649
The right hand side of a condition.
1650

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

Thomas Mueller's avatar
Thomas Mueller committed
1654 1655 1656 1657 1658
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).
1659 1660 1661
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.
1662

Thomas Mueller's avatar
Thomas Mueller committed
1663
When comparing with REGEXP, regular expression matching is used.
1664
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1665 1666 1667 1668
","
LIKE 'Jo%'
"

1669 1670 1671 1672 1673
"Other Grammar","Constraint","
[ constraintNameDefinition ] {
    CHECK expression | UNIQUE ( columnName [,...] )
    | referentialConstraint }
    | PRIMARY KEY [ HASH ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
1674
","
Thomas Mueller's avatar
Thomas Mueller committed
1675 1676
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1677
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1678 1679
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
1680
","
1681
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1682 1683
"

1684 1685
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1686
","
1687
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1688
","
1689
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1690 1691
"

1692 1693
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1694
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1695
","
1696
Optional parameters for CSVREAD and CSVWRITE.
1697 1698
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
1699 1700
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1701
The following options are supported:
Thomas Mueller's avatar
Thomas Mueller committed
1702
""charset"", ""escape"", ""fieldDelimiter"", ""fieldSeparator"",
1703 1704 1705
""lineComment"" (disabled by default),
""lineSeparator"", ""null"", ""rowSeparator"" (not set by default),
""preserveWhitespace"" (true or false; disabled by default).
Thomas Mueller's avatar
Thomas Mueller committed
1706
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1707
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
1708 1709 1710
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
1711
","
1712
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1713 1714
"

1715 1716 1717 1718 1719
"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
1720
","
1721
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1722
","
1723
INT
Thomas Mueller's avatar
Thomas Mueller committed
1724 1725
"

1726 1727
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1728
","
1729
A date literal. The limitations are the same as for the Java data type
1730
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1731
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1732
","
1733
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1734 1735
"

1736
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
1737
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
1738
","
Thomas Mueller's avatar
Thomas Mueller committed
1739 1740 1741 1742 1743 1744
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)"".
1745
","
Thomas Mueller's avatar
Thomas Mueller committed
1746 1747 1748
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
1749 1750
"

1751 1752
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1753
","
1754
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1755
","
1756
0
Thomas Mueller's avatar
Thomas Mueller committed
1757 1758
"

1759 1760
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1761
","
1762 1763 1764
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
1765
","
1766
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1767 1768
"

1769 1770
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1771
","
1772
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1773
","
1774
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1775 1776
"

1777
"Other Grammar","Factor","
1778
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1779
","
1780
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1781
","
1782
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1783 1784
"

1785 1786
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1787
","
1788 1789
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1790
","
1791
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1792 1793
"

1794 1795
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1796
","
1797
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1798
","
1799
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1800 1801
"

1802 1803
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1804
","
1805 1806 1807
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
1808
","
1809
NAME
Thomas Mueller's avatar
Thomas Mueller committed
1810 1811 1812
"

"Other Grammar","Int","
1813
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1814 1815 1816 1817 1818 1819 1820
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
1821
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1822 1823 1824 1825 1826 1827
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

1828 1829
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
1830
","
1831
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
1832
","
1833
TEST
Thomas Mueller's avatar
Thomas Mueller committed
1834 1835
"

1836 1837
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1838
","
1839
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
1840
","
1841
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1842 1843
"

1844 1845 1846 1847 1848 1849 1850 1851
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
1852
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
1853
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
1854
","
Thomas Mueller's avatar
Thomas Mueller committed
1855
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
1856 1857 1858 1859 1860 1861 1862
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
"

1863 1864
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1865
","
1866
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
1867
","
1868
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
1869 1870
"

1871 1872
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1873
","
1874 1875 1876
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
1877
","
1878
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
1879 1880
"

1881 1882
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
1883
","
1884 1885 1886
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
1887
","
1888
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
1889 1890
"

1891 1892 1893
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
1894
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
1895
","
Thomas Mueller's avatar
Thomas Mueller committed
1896 1897 1898
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
1899 1900 1901
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
1902
","
1903
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
1904 1905
"

Thomas Mueller's avatar
Thomas Mueller committed
1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916
"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
"

Thomas Mueller's avatar
Thomas Mueller committed
1917 1918 1919 1920 1921 1922 1923 1924 1925
"Other Grammar","Script Compression","
COMPRESSION { DEFLATE | LZF | ZIP | GZIP }
","
The compression algorithm to use for script files.
LZF is faster but uses more space.
","
COMPRESSION LZF
"

1926 1927
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
1928
","
1929
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
1930
","
1931
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
1932 1933
"

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

1943 1944
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1945
","
Thomas Mueller's avatar
Thomas Mueller committed
1946
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
1947

Thomas Mueller's avatar
Thomas Mueller committed
1948
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
1949
","
1950
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
1951 1952
"

1953
"Other Grammar","Table Expression","
1954
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
1955 1956
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1957
","
1958 1959 1960
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
1961
","
1962
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
1963 1964
"

1965 1966 1967 1968 1969 1970 1971 1972 1973
"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;
"

1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
"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
1986
","
1987
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
1988
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
1989
","
1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
'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
2005
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2006 2007 2008 2009 2010 2011
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
2012
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2013
","
Thomas Mueller's avatar
Thomas Mueller committed
2014
A literal value of any data type, or null.
2015 2016
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2017 2018 2019 2020 2021 2022 2023
"

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

2024
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2025 2026 2027 2028 2029 2030 2031 2032 2033
","
INT
"

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

2034
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2035 2036 2037 2038 2039 2040 2041 2042 2043
","
BOOLEAN
"

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

2044
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2045 2046 2047 2048 2049 2050 2051 2052 2053
","
TINYINT
"

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

2054
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2055 2056 2057 2058 2059 2060 2061 2062 2063
","
SMALLINT
"

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

2064
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
","
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.

2076
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2077 2078 2079 2080 2081
","
IDENTITY
"

"Data Types","DECIMAL Type","
2082
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2083 2084 2085 2086
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2087
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2088 2089 2090 2091 2092
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2093
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT4 | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2094
","
Thomas Mueller's avatar
Thomas Mueller committed
2095
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2096 2097
of rounding problems.

2098
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2099 2100 2101 2102 2103 2104 2105
","
DOUBLE
"

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

2109
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2110 2111 2112 2113 2114 2115 2116
","
REAL
"

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

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

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

2129
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2130
(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
2131 2132 2133 2134 2135
","
DATE
"

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

2140
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2141 2142 2143 2144 2145
","
TIMESTAMP
"

"Data Types","BINARY Type","
2146
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2147
","
2148 2149 2150 2151 2152
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
2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163

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

"Data Types","OTHER Type","
OTHER
","
This type allows storing serialized Java objects. Internally, a byte array is
used. Serialization and deserialization is done on the client side only.
2164
Deserialization is only done get ""getObject"" is called. Java operations cannot be
Thomas Mueller's avatar
Thomas Mueller committed
2165
executed inside the database engine for security reasons. Use
2166
""PreparedStatement.setObject"" to store values.
Thomas Mueller's avatar
Thomas Mueller committed
2167

2168
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2169 2170 2171 2172 2173
","
OTHER
"

"Data Types","VARCHAR Type","
2174 2175
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2176
","
Thomas Mueller's avatar
Thomas Mueller committed
2177
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2178 2179 2180 2181 2182 2183 2184
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
2185

2186
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2187 2188 2189 2190 2191
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2192
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2193
","
Thomas Mueller's avatar
Thomas Mueller committed
2194
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2195 2196 2197 2198 2199 2200 2201
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
2202

2203
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2204 2205 2206 2207 2208
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2209
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2210
","
Thomas Mueller's avatar
Thomas Mueller committed
2211 2212 2213
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
2214

Thomas Mueller's avatar
Thomas Mueller committed
2215 2216
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
2217

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

2221
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2222 2223 2224 2225 2226
","
CHAR(10)
"

"Data Types","BLOB Type","
2227
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2228 2229 2230
","
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
2231
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2232 2233
Advanced / Large Objects.

2234
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2235 2236 2237 2238 2239
","
BLOB
"

"Data Types","CLOB Type","
2240
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2241 2242 2243 2244 2245
","
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
2246
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2247 2248 2249 2250 2251

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.

2252
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2253 2254 2255 2256 2257 2258 2259
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2260 2261 2262 2263
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
2264

Thomas Mueller's avatar
Thomas Mueller committed
2265
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2266 2267 2268 2269 2270 2271 2272
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2273
An array of values.
2274
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2275 2276 2277 2278


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
2279 2280 2281 2282 2283
","
ARRAY
"

"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2284
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2285
","
2286 2287
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2288
Aggregates are only allowed in select statements.
2289
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2290 2291 2292 2293 2294
","
AVG(X)
"

"Functions (Aggregate)","BOOL_AND","
2295
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2296
","
2297 2298 2299
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
2300 2301 2302 2303 2304
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2305
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2306
","
2307 2308 2309
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
2310 2311 2312 2313 2314
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2315
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2316
","
2317 2318 2319 2320
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
2321 2322 2323 2324 2325
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2326 2327
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2328
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2329
","
2330 2331 2332 2333 2334
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
2335 2336 2337 2338 2339
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2340
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2341
","
2342 2343 2344 2345
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
2346 2347 2348 2349 2350
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2351
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2352
","
2353 2354 2355 2356
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
2357 2358 2359 2360 2361
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2362
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2363
","
2364 2365 2366 2367
The sum of all values.
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
2368 2369 2370 2371 2372
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2373
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2374
","
2375 2376 2377 2378 2379
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
2380 2381 2382 2383 2384
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2385
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2386
","
2387 2388 2389
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
2390 2391 2392 2393 2394 2395
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2396
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2397
","
2398 2399 2400
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
2401 2402 2403 2404 2405 2406
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2407
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2408
","
2409 2410 2411 2412
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
2413 2414 2415 2416 2417
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2418
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2419
","
2420 2421 2422 2423
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
2424 2425 2426 2427 2428
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2429
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2430
","
2431 2432
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"".
2433
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2434 2435 2436 2437 2438
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2439
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2440
","
Thomas Mueller's avatar
Thomas Mueller committed
2441 2442
Calculate the arc cosine.
See also Java ""Math.acos"".
2443
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2444 2445 2446 2447 2448
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2449
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2450
","
Thomas Mueller's avatar
Thomas Mueller committed
2451 2452
Calculate the arc sine.
See also Java ""Math.asin"".
2453
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2454 2455 2456 2457 2458
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
Thomas Mueller's avatar
Thomas Mueller committed
2459
ATAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2460
","
Thomas Mueller's avatar
Thomas Mueller committed
2461 2462
Calculate the arc tangent.
See also Java ""Math.atan"".
2463
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2464 2465 2466 2467 2468
","
ATAN(D)
"

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2469
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2470
","
Thomas Mueller's avatar
Thomas Mueller committed
2471 2472
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2473
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2474 2475 2476 2477
","
COS(ANGLE)
"

2478
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2479
COSH(numeric)
2480 2481 2482 2483 2484 2485 2486 2487
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2488
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2489
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2490
","
Thomas Mueller's avatar
Thomas Mueller committed
2491
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2492
See also Java ""Math.*"" functions.
2493
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2494 2495 2496 2497 2498
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2499
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2500
","
Thomas Mueller's avatar
Thomas Mueller committed
2501 2502
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2503
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2504 2505 2506 2507
","
SIN(ANGLE)
"

2508
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2509
SINH(numeric)
2510 2511 2512 2513 2514 2515 2516 2517
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2518
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2519
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2520
","
Thomas Mueller's avatar
Thomas Mueller committed
2521 2522
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2523
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2524 2525 2526 2527
","
TAN(ANGLE)
"

2528
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2529
TANH(numeric)
2530 2531 2532 2533 2534 2535 2536 2537
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2538
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2539
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2540
","
Thomas Mueller's avatar
Thomas Mueller committed
2541
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2542
See also Java ""Math.atan2"".
2543
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2544 2545 2546 2547 2548
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2549
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2550
","
2551 2552
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2553 2554 2555 2556 2557 2558
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2559
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2560
","
2561 2562
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2563 2564 2565 2566 2567 2568
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2569
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2570
","
2571 2572
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2573 2574 2575 2576 2577 2578
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2579
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2580
","
2581 2582
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2583 2584 2585 2586 2587 2588
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2589
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2590
","
2591
See also Java ""Math.ceil"".
2592
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2593
","
2594
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2595 2596 2597
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2598
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2599
","
2600
See also Java ""Math.toDegrees"".
2601
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2602 2603 2604 2605 2606
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2607
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2608
","
2609
See also Java ""Math.exp"".
2610
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2611 2612 2613 2614 2615
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
2616
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2617
","
2618
See also Java ""Math.floor"".
2619
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2620 2621 2622 2623 2624
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2625
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2626
","
2627
See also Java ""Math.log"".
2628
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2629 2630 2631 2632 2633
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
2634
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2635
","
2636
See also Java ""Math.log10"" (in Java 5).
2637
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2638 2639 2640 2641 2642
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
2643
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2644
","
2645
See also Java ""Math.toRadians"".
2646
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2647 2648 2649 2650 2651
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
2652
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2653
","
2654
See also Java ""Math.sqrt"".
2655
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2656 2657 2658 2659 2660
","
SQRT(A)
"

"Functions (Numeric)","PI","
2661
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2662
","
2663
See also Java ""Math.PI"".
2664
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2665 2666 2667 2668 2669
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
2670
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2671
","
2672
See also Java ""Math.pow"".
2673
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2674 2675 2676 2677 2678
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2679
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2680 2681 2682
","
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
2683
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2684 2685 2686 2687 2688
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2689
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2690 2691 2692 2693 2694 2695 2696
","
Returns a new UUID with 122 pseudo random bits.
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2697
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
2698
","
2699
Rounds to a number of digits, or to the nearest long if the number of digits if not set.
2700
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2701 2702 2703 2704 2705
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
2706
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2707
","
2708 2709 2710 2711 2712 2713
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
2714 2715 2716 2717 2718
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2719
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2720 2721
","
Generates a number of cryptographically secure random numbers.
2722
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2723 2724 2725 2726 2727
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
2728
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2729 2730 2731 2732 2733 2734 2735
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2736
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2737
","
2738 2739 2740 2741
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
2742 2743 2744 2745 2746
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2747
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2748
","
2749 2750 2751 2752
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
2753 2754 2755 2756 2757 2758
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2759
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2760
","
2761 2762 2763
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
2764 2765 2766 2767 2768
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
Thomas Mueller's avatar
Thomas Mueller committed
2769
TRUNCATE(numeric, digitsInt)
Thomas Mueller's avatar
Thomas Mueller committed
2770 2771
","
Truncates to a number of digits (to the next value closer to 0).
2772
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2773 2774 2775 2776 2777
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
2778
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
2779
","
2780 2781 2782 2783
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
2784 2785 2786 2787 2788
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
2789
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2790 2791
","
Expands data that was compressed using the COMPRESS function.
2792
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2793 2794 2795 2796 2797
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
2798
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
2799 2800 2801 2802 2803 2804 2805
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
2806
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
2807 2808
","
Returns the ASCII value of the first character in the string.
2809
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2810 2811 2812 2813
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
2814
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2815
","
2816 2817 2818
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
2819 2820 2821 2822 2823
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
2824
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2825
","
2826 2827 2828
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
2829 2830 2831 2832 2833
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
2834
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2835
","
2836 2837 2838 2839
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
2840 2841 2842 2843 2844
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
2845
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
2846 2847
","
Returns the character that represents the ASCII value.
2848
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2849 2850 2851 2852 2853
","
CHAR(65)
"

"Functions (String)","CONCAT","
2854
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
2855 2856
","
Combines strings.
2857
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2858 2859 2860 2861 2862
","
CONCAT(NAME, '!')
"

"Functions (String)","DIFFERENCE","
2863
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
2864 2865
","
Returns the difference between the sounds of two strings.
2866
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2867 2868 2869 2870 2871
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
2872
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
2873
","
2874 2875
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
2876 2877 2878 2879 2880
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
2881
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2882
","
2883 2884 2885
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
2886 2887 2888 2889 2890
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
2891
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2892
","
2893
Returns the location of a search string in a string.
2894 2895 2896
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
2897 2898 2899 2900 2901
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
2902
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
2903
","
2904 2905 2906
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
2907 2908 2909 2910 2911
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
2912
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2913 2914 2915 2916 2917 2918 2919
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
2920
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2921 2922 2923 2924 2925 2926 2927
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
2928
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2929 2930 2931 2932 2933 2934 2935
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
2936
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2937 2938 2939 2940 2941 2942 2943
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
2944
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2945
","
2946 2947 2948 2949
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
2950 2951 2952 2953 2954
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
2955
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
2956 2957 2958 2959 2960 2961 2962
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
2963
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2964
","
2965 2966 2967
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
2968 2969 2970 2971 2972
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
2973
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2974
","
2975 2976 2977
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
2978 2979 2980 2981 2982
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
2983
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2984 2985 2986 2987 2988 2989 2990
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
2991
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2992 2993 2994 2995 2996 2997 2998
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
2999
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3000
","
3001 3002
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
3003 3004 3005 3006 3007
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3008
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
3009
","
3010
Replaces each substring that matches a regular expression.
3011
For details, see the Java ""String.replaceAll()"" method.
3012
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3013 3014 3015 3016 3017
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
3018
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3019 3020 3021 3022 3023 3024 3025
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3026
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3027
","
3028 3029
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.
3030
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3031 3032 3033 3034 3035
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3036
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3037
","
3038 3039 3040
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
3041 3042 3043 3044 3045
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3046
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3047 3048 3049 3050 3051 3052 3053
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3054
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3055
","
3056 3057 3058
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
3059 3060 3061 3062 3063
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3064
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3065
","
3066 3067 3068
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
3069 3070 3071 3072 3073
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3074
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3075 3076
","
Encodes a string to a byte array using the UTF8 encoding format.
3077
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3078 3079 3080 3081 3082
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3083
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3084
","
3085 3086
Returns a substring of a string starting at a position.
The length is optional.
3087
Also supported is: ""SUBSTRING(string FROM start [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3088 3089 3090 3091 3092
","
SUBSTR(NAME, 1)
"

"Functions (String)","UTF8TOSTRING","
3093
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3094 3095 3096 3097 3098 3099 3100
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3101
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3102
","
3103
Creates an XML attribute element of the form ""name=value"".
3104 3105
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3106 3107 3108 3109 3110
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3111
XMLNODE(elementString [, attributesString [, contentString]])
Thomas Mueller's avatar
Thomas Mueller committed
3112 3113
","
Create an XML node element.
3114
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3115 3116 3117 3118 3119
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3120
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3121
","
3122
Creates an XML comment.
3123
Two dashes (""--"") are converted to ""- -"".
3124
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3125 3126 3127 3128 3129
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3130
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3131
","
3132
Creates an XML CDATA element.
3133
If the value contains ""]]>"", an XML text element is created instead.
3134
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3135 3136 3137 3138 3139
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3140
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3141
","
3142
The string ""<?xml version='1.0'?>"" is returned.
Thomas Mueller's avatar
Thomas Mueller committed
3143 3144 3145 3146 3147
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3148
XMLTEXT(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3149 3150
","
Creates an XML text element.
3151
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3152 3153 3154 3155 3156
","
CALL XMLTEXT('test')
"

"Functions (Time and Date)","CURRENT_DATE","
3157
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3158 3159
","
Returns the current date.
3160
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3161 3162 3163 3164 3165
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3166
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3167 3168
","
Returns the current time.
3169
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3170 3171 3172 3173 3174
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3175
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3176
","
3177 3178
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3179
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3180 3181 3182 3183 3184
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3185
{ DATEADD| TIMESTAMPADD } (unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3186
","
3187 3188 3189 3190
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
3191 3192 3193 3194 3195
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3196
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3197
","
Thomas Mueller's avatar
Thomas Mueller committed
3198
Returns the the number of crossed unit boundaries between two timestamps.
3199 3200
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3201 3202 3203 3204 3205 3206
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3207
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3208 3209 3210 3211 3212 3213 3214
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3215
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3216 3217 3218 3219 3220 3221 3222
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3223
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3224 3225 3226 3227 3228 3229 3230
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3231
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3232 3233 3234 3235 3236 3237 3238
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3239 3240
EXTRACT ( { YEAR | YY | MONTH | MM | DAY | DD | DAY_OF_YEAR
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3241
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3242 3243
","
Returns a specific value from a timestamps.
3244
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3245 3246 3247 3248 3249
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3250
FORMATDATETIME ( timestamp, formatString
3251
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3252
","
3253 3254 3255
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.
3256
For details of the format, see ""java.text.SimpleDateFormat"".
3257
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3258 3259 3260 3261 3262 3263
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3264
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3265 3266 3267 3268 3269 3270 3271
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3272
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3273 3274 3275 3276 3277 3278 3279
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3280
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3281 3282 3283 3284 3285 3286 3287
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3288
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3289 3290 3291 3292 3293 3294 3295
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3296
PARSEDATETIME(string, formatString
3297
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3298
","
3299 3300 3301
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.
3302
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3303 3304 3305 3306 3307 3308
","
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","
3309
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3310 3311 3312 3313 3314 3315 3316
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3317
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3318 3319 3320 3321 3322 3323 3324
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3325
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3326
","
3327 3328
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3329 3330 3331 3332 3333
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3334
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3335 3336 3337 3338 3339 3340 3341
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3342
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3343 3344
","
Returns one element of an array.
3345
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3346 3347 3348 3349 3350
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3351
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3352 3353 3354 3355 3356 3357 3358
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

"Functions (System)","AUTOCOMMIT","
3359
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3360 3361 3362 3363 3364 3365 3366
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3367
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3368
","
3369 3370 3371
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
3372 3373

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3374 3375 3376 3377 3378
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3379
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3380 3381
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3382
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3383 3384 3385 3386 3387
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3388
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3389
","
3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401
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
3402 3403 3404
"

"Functions (System)","COALESCE","
3405
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3406 3407 3408 3409 3410 3411 3412
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3413
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3414 3415 3416 3417 3418 3419 3420
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3421
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3422
","
3423 3424 3425 3426 3427
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
3428 3429 3430 3431 3432
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3433
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3434
","
3435 3436
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
3437 3438

If the column names are specified (a list of column names separated with the
3439
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3440 3441 3442 3443 3444
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
3445 3446 3447 3448 3449

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.

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3454
Instead of a file, an URL may be used, for example
3455 3456
""jar:file:///c:/temp/example.zip!/org/example/nested.csv"".
To read a stream from the classpath, use the prefix ""classpath:"".
3457

Thomas Mueller's avatar
Thomas Mueller committed
3458 3459 3460
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
3461 3462 3463 3464
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
3465 3466 3467 3468
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
3469
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3470
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3471 3472 3473
"

"Functions (System)","CSVWRITE","
3474
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3475
","
3476
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3477
If only a file name is specified, it will be written to the current working directory.
3478
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3479
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
3480 3481 3482 3483 3484

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

Thomas Mueller's avatar
Thomas Mueller committed
3487 3488
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3489
","
Thomas Mueller's avatar
Thomas Mueller committed
3490 3491 3492 3493
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
3494 3495 3496
"

"Functions (System)","DATABASE","
3497
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3498 3499 3500 3501 3502 3503 3504
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3505
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3506
","
Thomas Mueller's avatar
Thomas Mueller committed
3507 3508
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
3509 3510 3511 3512 3513
","
CALL DATABASE_PATH();
"

"Functions (System)","FILE_READ","
3514
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3515 3516 3517 3518
","
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
3519
default character set for this system.
3520 3521 3522 3523

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

Thomas Mueller's avatar
Thomas Mueller committed
3524
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3525 3526 3527 3528 3529 3530
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

"Functions (System)","GREATEST","
3531
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3532 3533 3534 3535 3536 3537 3538
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3539
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3540 3541
","
Returns the last inserted identity value for this session.
3542
This value changes whenever a new sequence number was generated,
3543
even within a trigger or Java function. See also SCOPE_IDENTITY.
3544
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3545 3546 3547 3548 3549
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3550
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3551 3552 3553 3554 3555 3556 3557
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3558
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3559 3560 3561 3562 3563 3564 3565
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3566
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3567 3568
","
Returns the current lock mode. See SET LOCK_MODE.
3569
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3570 3571 3572 3573 3574
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3575
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3576 3577 3578 3579 3580 3581 3582 3583
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3584
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3585
","
3586 3587 3588 3589 3590
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
3591
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3592 3593 3594 3595 3596
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3597
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3598
","
Thomas Mueller's avatar
Thomas Mueller committed
3599
Returns the free memory in KB (where 1024 bytes is a KB).
3600
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3601 3602
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3603 3604 3605 3606 3607
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3608
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3609
","
Thomas Mueller's avatar
Thomas Mueller committed
3610
Returns the used memory in KB (where 1024 bytes is a KB).
3611
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3612 3613
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3614 3615 3616 3617 3618
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3619
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3620
","
3621 3622 3623 3624
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
3625 3626 3627 3628 3629
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3630
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3631 3632 3633 3634 3635 3636
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

3637 3638 3639 3640
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
3641
The data type of the returned value is the data type of 'a' if this is a text type.
3642 3643 3644 3645
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
3646
"Functions (System)","READONLY","
3647
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3648 3649 3650 3651 3652 3653 3654
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
3655
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
3656
","
3657
Returns the number of the current row.
3658 3659
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
3660 3661
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).
3662
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3663
","
3664 3665
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3666
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3667 3668 3669
"

"Functions (System)","SCHEMA","
3670
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3671 3672 3673 3674 3675 3676
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3677 3678 3679 3680 3681 3682 3683 3684 3685 3686
"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
3687
"Functions (System)","SESSION_ID","
3688
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3689
","
3690 3691 3692 3693
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
3694 3695 3696 3697 3698
","
CALL SESSION_ID()
"

"Functions (System)","SET","
3699
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
3700
","
3701 3702 3703
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
3704
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
3705 3706 3707 3708 3709
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
3710
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
3711 3712 3713 3714 3715 3716 3717
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
3718
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3719
","
3720 3721
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
3722
Otherwise a value of the following form is returned:
3723
""logFileId-position-sessionId"".
3724 3725
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
3726 3727 3728 3729
","
CALL TRANSACTION_ID()
"

3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741
"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
3742
"Functions (System)","USER","
3743
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

"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
3765