help.csv 99.4 KB
Newer Older
1
# Copyright 2004-2010 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 21 22
LIMIT limits the number of rows returned by the query, OFFSET specified
how many rows to skip. 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
INSERT INTO tableName [ ( columnName [,...] ) ]
46
{ VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | [ DIRECT ] [ SORTED ] select }
Thomas Mueller's avatar
Thomas Mueller committed
47 48
","
Inserts a new row / new rows into a table.
49 50 51 52

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
53 54 55 56 57
","
INSERT INTO TEST VALUES(1, 'Hello')
"

"Commands (DML)","UPDATE","
Thomas Mueller's avatar
Thomas Mueller committed
58 59
UPDATE tableName [ [ AS ] newTableAlias ]
SET { columnName= { DEFAULT | expression } } [,...]
60
[ WHERE expression ]
Thomas Mueller's avatar
Thomas Mueller committed
61 62 63
","
Updates data in a table.
","
64 65
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
66 67 68
"

"Commands (DML)","DELETE","
69
DELETE FROM tableName [ WHERE expression ]
Thomas Mueller's avatar
Thomas Mueller committed
70 71 72 73 74 75 76 77 78
","
Deletes rows form a table.
","
DELETE FROM TEST WHERE ID=2
"

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

"Commands (DML)","CALL","
CALL expression
","
Calculates a simple expression.
","
CALL 15*25
"

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

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

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
129 130 131
Instead of a file, an URL may be used.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
132 133 134 135 136
","
RUNSCRIPT FROM 'backup'
"

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

156
If a file name is specified, then the whole
Thomas Mueller's avatar
Thomas Mueller committed
157 158 159 160
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
161 162 163
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
164 165 166 167 168
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
169 170
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
171 172 173 174 175 176 177 178 179
","
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
180 181
Renames an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
182 183 184 185
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

186 187 188 189 190 191 192 193 194
"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
195
"Commands (DDL)","ALTER SEQUENCE","
196
ALTER SEQUENCE sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
Thomas Mueller's avatar
Thomas Mueller committed
197
","
Thomas Mueller's avatar
Thomas Mueller committed
198 199
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
200 201 202 203 204 205
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

"Commands (DDL)","ALTER TABLE ADD","
206 207
ALTER TABLE tableName ADD name dataType [ DEFAULT expression ]
[ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] [ BEFORE columnName ]
Thomas Mueller's avatar
Thomas Mueller committed
208
","
Thomas Mueller's avatar
Thomas Mueller committed
209 210
Adds a new column to a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
211 212 213 214 215
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

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

227 228 229 230 231 232 233 234 235
"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
236
","
237 238
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
239

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

242 243 244
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
245

246 247 248 249
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
250

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

253
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
254
Single column indexes on this column are dropped.
255 256 257

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

258
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
259
","
260 261 262 263 264 265 266
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
267 268 269 270 271 272
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
ALTER TABLE tableName DROP COLUMN columnName
","
Removes a column from a table.
273
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
274 275 276 277 278
","
ALTER TABLE TEST DROP COLUMN NAME
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
279
ALTER TABLE tableName DROP { CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
280 281
","
Removes a constraint or a primary key from a table.
282
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
283 284 285 286 287 288
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
ALTER TABLE tableName SET REFERENTIAL_INTEGRITY
289
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
290 291 292 293 294 295
","
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.
296 297

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
298 299 300 301 302 303 304
","
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
305 306
Renames a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
307 308 309 310 311
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
312
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
313
","
Thomas Mueller's avatar
Thomas Mueller committed
314 315 316 317
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.
318
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
319 320 321 322 323 324 325
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
326 327 328 329
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
330
Admin rights are required to execute this command.
331
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
332 333 334 335 336
","
ALTER USER TOM RENAME TO THOMAS
"

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

"Commands (DDL)","ANALYZE","
361
ANALYZE [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
362 363 364 365 366 367 368
","
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.
369 370

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
371 372 373 374 375
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
376 377 378 379 380
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
381
","
Thomas Mueller's avatar
Thomas Mueller committed
382 383 384
Sets the comment of a database object. Use NULL to remove the comment.

Admin rights are required to execute this command.
385
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
386 387 388 389 390
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
391
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
392 393 394
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
395
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
396 397

Admin rights are required to execute this command.
398
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
399 400 401 402 403
","
CREATE AGGREGATE MEDIAN FOR ""com.acme.db.Median""
"

"Commands (DDL)","CREATE ALIAS","
404
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
405
{ FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
406
","
407 408 409 410 411
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
412
""java.lang.Integer.parseInt(java.lang.String, int)"". The class and the method
413
must both be public, and the method must be static. The class must be available
414
in the classpath of the database engine (when using the server mode,
415
it must be in the classpath of the server).
Thomas Mueller's avatar
Thomas Mueller committed
416

417 418
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.
419 420
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
421 422
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
423

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

427
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
428 429 430
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.
431

Thomas Mueller's avatar
Thomas Mueller committed
432
Admin rights are required to execute this command.
433
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
434 435 436 437 438
","
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');
439 440
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
Thomas Mueller's avatar
Thomas Mueller committed
441 442 443
"

"Commands (DDL)","CREATE CONSTANT","
444
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
445
","
Thomas Mueller's avatar
Thomas Mueller committed
446 447
Creates a new constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
448 449 450 451 452
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
453 454 455
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
456 457 458 459
","
Creates a new data type (domain). The check condition must evaluate to true or
to NULL (to prevent NULL, use NOT NULL). In the condition, the term VALUE refers
to the value being tested.
460

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

463
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
464 465 466 467 468
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
469 470 471
CREATE { [ UNIQUE ] [ HASH ] INDEX [ IF NOT EXISTS ] newIndexName
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
472
","
Thomas Mueller's avatar
Thomas Mueller committed
473 474
Creates a new index.
This command commits an open transaction.
475

Thomas Mueller's avatar
Thomas Mueller committed
476
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
477 478
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
479
Non-unique keys are supported.
Thomas Mueller's avatar
Thomas Mueller committed
480 481 482 483 484
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
485 486 487
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
488 489 490 491 492 493 494 495
","
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
496
work. Linked tables to the same database share one connection.
497 498

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

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

Thomas Mueller's avatar
Thomas Mueller committed
505
Admin rights are required to execute this command.
506
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
507 508 509 510 511 512 513 514 515
","
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","
516
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
517
","
Thomas Mueller's avatar
Thomas Mueller committed
518 519
Creates a new role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
520 521 522 523 524
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
525
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
Thomas Mueller's avatar
Thomas Mueller committed
526 527 528
","
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
529
Specifying the owner currently has no effect.
530 531

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
532 533 534 535 536
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
537 538
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
[ INCREMENT BY long ] [ CACHE long ]
Thomas Mueller's avatar
Thomas Mueller committed
539 540 541 542 543
","
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. 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.
Thomas Mueller's avatar
Thomas Mueller committed
544 545

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
546 547 548 549 550
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
551 552 553
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
{ { ( { columnDefinition | constraint } [,...] ) [ AS select ] }
Thomas Mueller's avatar
Thomas Mueller committed
554
    | { AS select } }
Thomas Mueller's avatar
Thomas Mueller committed
555
[ ENGINE tableEngineName ] [ TRANSACTIONAL ] [ NOT PERSISTENT ]
Thomas Mueller's avatar
Thomas Mueller committed
556 557 558
","
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
559 560 561 562
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
563
that means memory tables should not get too large.
564

Thomas Mueller's avatar
Thomas Mueller committed
565 566 567 568 569
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,
570
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
571

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

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

Thomas Mueller's avatar
Thomas Mueller committed
578 579
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
580 581 582 583 584
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
585
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
586
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
587
[ QUEUE int ] [ NOWAIT ] CALL triggeredClassName
Thomas Mueller's avatar
Thomas Mueller committed
588
","
Thomas Mueller's avatar
Thomas Mueller committed
589 590
Creates a new trigger. The trigger class must be public. Inner classes are not supported.
The class must be available in the classpath of the
591 592
database engine (when using the server mode, it must be in the classpath of the server).

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

598
Only row based AFTER trigger can be called on rollback.
599 600
Exceptions that occur within such triggers are ignored.

601
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
602 603
Only the first such trigger is called. Such triggers on views are supported.

604 605 606 607
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
608 609 610 611
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.
612 613

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
614 615 616 617
","
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger""
"
"Commands (DDL)","CREATE USER","
618 619
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
620
","
Thomas Mueller's avatar
Thomas Mueller committed
621 622 623
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.
624

Thomas Mueller's avatar
Thomas Mueller committed
625
Admin rights are required to execute this command.
626
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
627 628 629 630 631
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
632
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
633
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
634 635
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
636
if the underlying table(s) don't exist.
637

Thomas Mueller's avatar
Thomas Mueller committed
638 639 640 641 642
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.

Thomas Mueller's avatar
Thomas Mueller committed
643
Admin rights are required to execute this command.
644
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
645 646 647 648 649
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
650
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
651
","
Thomas Mueller's avatar
Thomas Mueller committed
652 653 654
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
655
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
656 657 658 659 660
","
CREATE AGGREGATE MEDIAN
"

"Commands (DDL)","DROP ALIAS","
661
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
662
","
Thomas Mueller's avatar
Thomas Mueller committed
663 664 665
Drops an existing function alias.

Admin rights are required to execute this command.
666
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
667 668 669 670 671
","
CREATE ALIAS MY_SQRT
"

"Commands (DDL)","DROP ALL OBJECTS","
672
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
673 674 675 676 677
","
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
678 679 680
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
681 682 683 684 685
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
686
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
687
","
Thomas Mueller's avatar
Thomas Mueller committed
688 689
Drops a constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
690 691 692 693 694
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
695
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
696
","
Thomas Mueller's avatar
Thomas Mueller committed
697 698
Drops a data type (domain).
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
699 700 701 702 703
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
704
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
705
","
Thomas Mueller's avatar
Thomas Mueller committed
706 707
Drops an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
708 709 710 711 712
","
DROP INDEX IF EXISTS IDXNAME
"

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

"Commands (DDL)","DROP SCHEMA","
722
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
723
","
Thomas Mueller's avatar
Thomas Mueller committed
724 725
Drops a schema.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
726 727 728 729 730
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
731
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
732
","
Thomas Mueller's avatar
Thomas Mueller committed
733 734
Drops a sequence.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
735 736 737 738 739
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
740
DROP TABLE [ IF EXISTS ] tableName [,...] [ CASCADE | RESTRICT ]
Thomas Mueller's avatar
Thomas Mueller committed
741
","
Thomas Mueller's avatar
Thomas Mueller committed
742 743 744
Drops an existing table, or a list of tables.
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.
745
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
746 747 748 749 750
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
751
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
752
","
Thomas Mueller's avatar
Thomas Mueller committed
753 754
Drops an existing trigger.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
755 756 757 758 759
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
760
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
761
","
Thomas Mueller's avatar
Thomas Mueller committed
762 763
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
764

Thomas Mueller's avatar
Thomas Mueller committed
765
Admin rights are required to execute this command.
766
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
767 768 769 770 771
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
772
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
773
","
Thomas Mueller's avatar
Thomas Mueller committed
774 775 776
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
777
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
778 779 780 781 782 783 784
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
785 786 787 788 789
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).
790
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
791 792

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
793 794 795 796 797 798 799
","
TRUNCATE TABLE TEST
"

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

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
803 804 805 806 807 808 809
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
810
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
811 812 813
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
814 815 816 817 818
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
819
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
820 821 822 823 824 825 826 827 828
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
829 830 831 832
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
833 834 835 836 837
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
838 839
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
840
","
Thomas Mueller's avatar
Thomas Mueller committed
841 842 843 844
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
845 846 847 848 849
","
GRANT SELECT ON TEST TO READONLY
"

"Commands (Other)","GRANT ROLE","
850
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
851
","
Thomas Mueller's avatar
Thomas Mueller committed
852 853 854 855
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
856 857 858 859 860
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
861
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
862 863 864 865 866 867 868 869 870
","
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
871 872
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
873 874 875 876 877
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
878 879
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
880
","
Thomas Mueller's avatar
Thomas Mueller committed
881 882 883 884
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
885 886 887 888 889
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
890
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
891
","
Thomas Mueller's avatar
Thomas Mueller committed
892 893 894 895
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
896 897 898 899 900
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
901
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
902 903 904 905 906 907 908 909 910 911
","
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
912 913 914 915
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
916 917 918 919 920 921 922
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
923 924
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
925 926 927 928 929
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
930
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
931
","
Thomas Mueller's avatar
Thomas Mueller committed
932 933
Updates a user-defined variable.
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
934 935 936 937 938
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
939
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
940 941 942 943 944 945 946 947 948 949
","
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
950 951 952 953 954
See also CREATE CONSTANT.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
955
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
956 957 958 959 960
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
961
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
962 963
","
Switches auto commit on or off.
964
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
965
however this will not work as expected when using a connection pool
966 967
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
968
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
969 970 971 972 973 974 975
","
SET AUTOCOMMIT OFF
"

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
976 977
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
978 979
Depending on the virtual machine, the actual memory required may be higher.

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

Thomas Mueller's avatar
Thomas Mueller committed
985 986 987
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
988
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
989 990 991 992 993 994 995 996 997 998 999 1000
","
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
1001 1002
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1003
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1004 1005 1006 1007 1008
","
SET CLUSTER ''
"

"Commands (Other)","SET COLLATION","
1009 1010
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1011 1012
","
Sets the collation used for comparing strings. This command can only be executed
1013
if there are no tables defined. See ""java.text.Collator"" for details about
Thomas Mueller's avatar
Thomas Mueller committed
1014 1015 1016 1017 1018
STRENGTH.

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
1019 1020 1021 1022 1023
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1024
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1025 1026 1027
","
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
1028 1029 1030 1031

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
1032 1033 1034 1035 1036 1037 1038 1039
","
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
1040 1041 1042 1043
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).
1044
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
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. 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
Thomas Mueller's avatar
Thomas Mueller committed
1059 1060 1061 1062 1063
closed immediately, even if a delay is set.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
1064
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1065 1066 1067 1068 1069 1070 1071 1072
","
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
1073 1074 1075 1076 1077
for the new sessions. The default value for this setting is 1000 (one second).

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
1078 1079 1080 1081 1082
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1083
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1084 1085 1086
","
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
1087
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1088
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1089

Thomas Mueller's avatar
Thomas Mueller committed
1090 1091 1092
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
1093
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1094 1095 1096 1097 1098
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1099
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1100
","
Thomas Mueller's avatar
Thomas Mueller committed
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
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
1111 1112 1113

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1114
","
Thomas Mueller's avatar
Thomas Mueller committed
1115
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1116 1117 1118
"

"Commands (Other)","SET IGNORECASE","
1119
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1120 1121 1122 1123 1124 1125
","
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
1126 1127 1128
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
1129 1130 1131 1132
","
SET IGNORECASE TRUE
"

1133
"Commands (Other)","SET LOG","
1134
SET LOG int
1135 1136 1137 1138
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1139
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1140 1141 1142 1143
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.

1144 1145
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
1146 1147
against power failure is required, but the data must be protected against killing the process.

1148 1149
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
1150 1151 1152 1153 1154
file system, this will also protect against power failure in the majority if cases.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is not persistent.
1155
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1156 1157 1158 1159
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1160 1161 1162 1163
"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
1164
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177

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
1178 1179 1180
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
1181
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1182 1183 1184 1185 1186 1187 1188 1189
","
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
1190 1191 1192
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1193
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1194 1195 1196 1197 1198 1199 1200 1201 1202
","
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
1203
(in-place). The default max size is 1024.
Thomas Mueller's avatar
Thomas Mueller committed
1204
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1205 1206 1207 1208

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
1209 1210 1211 1212 1213 1214 1215
","
SET MAX_LENGTH_INPLACE_LOB 128
"

"Commands (Other)","SET MAX_LOG_SIZE","
SET MAX_LOG_SIZE int
","
Thomas Mueller's avatar
Thomas Mueller committed
1216 1217
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
1218
freed automatically. The default max size is 16 MB.
Thomas Mueller's avatar
Thomas Mueller committed
1219
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1220 1221 1222 1223

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
1224 1225 1226 1227 1228 1229 1230 1231
","
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
1232 1233 1234 1235 1236
are read, then the rows are buffered to disk. The default value is 10000.

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
1237
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1238 1239 1240 1241 1242 1243 1244
","
SET MAX_MEMORY_ROWS 1000
"

"Commands (Other)","SET MAX_MEMORY_UNDO","
SET MAX_MEMORY_UNDO int
","
1245
The maximum number of undo records per a session that are kept in-memory.
Thomas Mueller's avatar
Thomas Mueller committed
1246 1247
If a transaction is larger, the records are buffered to disk.
The default value is 50000.
Thomas Mueller's avatar
Thomas Mueller committed
1248
Changes to tables without a primary key can not be buffered to disk.
Thomas Mueller's avatar
Thomas Mueller committed
1249 1250 1251 1252 1253
This setting is not supported when using multi-version concurrency.

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
1254
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1255 1256 1257 1258 1259 1260 1261 1262 1263
","
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
1264 1265 1266 1267
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1268
It has no effect for in-memory databases.
1269
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1270 1271 1272 1273 1274
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1275
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1276 1277
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1278 1279 1280 1281 1282
Modes in the feature section.

This setting is not persistent.
Admin rights are required to execute this command.
This command commits an open transaction.
1283
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1284 1285 1286 1287 1288
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1289
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1290 1291 1292
","
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
1293 1294 1295 1296 1297 1298 1299
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.

Admin rights are required to execute this command.
This command commits an open transaction.
1300
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1301 1302 1303 1304 1305
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1306
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1307 1308 1309
","
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
1310 1311 1312 1313
the tables was changed. This option is enabled by default.

Admin rights are required to execute this command.
This command commits an open transaction.
1314
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1315 1316 1317 1318 1319 1320 1321 1322 1323
","
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
1324 1325

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1326 1327 1328 1329 1330 1331 1332 1333 1334
","
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
1335 1336 1337
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
1338 1339 1340 1341 1342
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1343
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1344 1345 1346
","
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
1347 1348 1349 1350 1351
for one table.

This setting is not persistent.
This command commits an open transaction.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1352 1353 1354 1355 1356 1357 1358 1359 1360
","
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
1361 1362

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1363 1364 1365 1366 1367 1368 1369 1370 1371
","
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
1372 1373 1374
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1375
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1376 1377 1378 1379 1380 1381 1382 1383 1384
","
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
1385 1386 1387
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1388
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1389 1390 1391 1392 1393 1394 1395 1396 1397
","
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
1398 1399 1400
disabled).

This command does not commit a transaction, and rollback does not affect it.
1401
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1402 1403 1404 1405 1406
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1407
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1408 1409 1410
","
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.
1411
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1412

Thomas Mueller's avatar
Thomas Mueller committed
1413 1414 1415
This setting is not persistent.
Admin rights are required to execute this command.
This command does not commit a transaction, and rollback does not affect it.
1416
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
","
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
1428 1429 1430
This setting is persistent.
Admin rights are required to execute this command.
This command commits an open transaction.
1431
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
","
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
1442 1443

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1444 1445 1446 1447 1448 1449 1450 1451
","
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
1452 1453 1454 1455
This setting is persistent. The default is 500 ms.

Admin rights are required to execute this command.
This command commits an open transaction.
1456
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1457 1458 1459 1460 1461
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1462
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1463
","
1464 1465
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
1466
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1467

1468 1469
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
1470 1471 1472

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,
1473
but only for at most the time defined by the system property ""h2.maxCompactTime"" (see there).
Thomas Mueller's avatar
Thomas Mueller committed
1474 1475

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1479
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1480
","
1481
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1482 1483
"

1484 1485
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1486
","
1487
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1488
","
1489
A
Thomas Mueller's avatar
Thomas Mueller committed
1490 1491
"

1492 1493
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1494
","
1495
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1496
","
1497
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1498 1499
"

1500 1501
"Other Grammar","Array","
( expression [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
1502
","
1503
An array of values.
Thomas Mueller's avatar
Thomas Mueller committed
1504
","
1505
(1, 2)
Thomas Mueller's avatar
Thomas Mueller committed
1506 1507
"

1508 1509
"Other Grammar","Boolean","
TRUE | FALSE
1510
","
1511
A boolean value.
1512
","
1513
TRUE
1514 1515
"

1516 1517
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1518
","
1519
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1520
","
1521
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1522 1523
"

1524 1525 1526
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1527
","
1528 1529
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
1530
","
1531
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1532 1533
"

1534 1535 1536
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1537
","
1538 1539
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1540
","
1541 1542 1543 1544 1545 1546
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
{ AES | XTEA }
","
1547 1548
Two algorithms are supported: AES (AES-128) and XTEA (using 32 rounds).
XTEA is a bit faster than AES in some environments, but AES is more secure.
1549 1550
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1551 1552
"

1553 1554 1555
"Other Grammar","Column Definition","
columnName dataType { DEFAULT expression | AS computedColumnExpression } [ [ NOT ] NULL ]
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1556 1557
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1558 1559
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1560
The computed column expression is evaluated and assigned whenever the row changes.
1561 1562 1563 1564 1565

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
1566 1567 1568
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);
1569 1570
"

1571 1572
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1573
","
1574 1575 1576
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
1577
","
1578
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1579 1580
"

1581 1582
"Other Grammar","Compare","
<> | <= | >= | = | < | > | !=
Thomas Mueller's avatar
Thomas Mueller committed
1583
","
1584
Comparison operator. The operator != is the same as <>.
Thomas Mueller's avatar
Thomas Mueller committed
1585
","
1586
<>
Thomas Mueller's avatar
Thomas Mueller committed
1587 1588 1589
"

"Other Grammar","Condition","
1590
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1591 1592 1593 1594 1595 1596 1597
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1598 1599
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1600
    | IS [ NOT ] [ DISTINCT FROM ] operand
1601 1602 1603 1604
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1605
","
Thomas Mueller's avatar
Thomas Mueller committed
1606
The right hand side of a condition.
1607

1608 1609 1610
The conditions IS [ NOT ] and IS [ NOT ] DISTINCT FROM are NULL-safe, meaning
NULL is considered the same as NULL, and the condition never evaluates to NULL.

Thomas Mueller's avatar
Thomas Mueller committed
1611 1612
When comparing with LIKE, the wildcards characters are _ (any one character)
and % (any characters). The database uses an index when comparing with LIKE
1613
except if the operand starts with a wildcard. To search for the characters % and
Thomas Mueller's avatar
Thomas Mueller committed
1614
_, the characters need to be escaped. The default escape character is \ (backslash).
1615
To select no escape character, use ESCAPE '' (empty string).
1616 1617 1618
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.
1619

Thomas Mueller's avatar
Thomas Mueller committed
1620
When comparing with REGEXP, regular expression matching is used.
1621
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1622 1623 1624 1625
","
LIKE 'Jo%'
"

1626 1627 1628 1629 1630
"Other Grammar","Constraint","
[ constraintNameDefinition ] {
    CHECK expression | UNIQUE ( columnName [,...] )
    | referentialConstraint }
    | PRIMARY KEY [ HASH ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
1631
","
Thomas Mueller's avatar
Thomas Mueller committed
1632 1633
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1634
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1635 1636
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
1637
","
1638
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1639 1640
"

1641 1642
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1643
","
1644
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1645
","
1646
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1647 1648
"

1649 1650
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
Thomas Mueller's avatar
Thomas Mueller committed
1651
","
1652
Optional parameters for CSVREAD and CSVWRITE.
Thomas Mueller's avatar
Thomas Mueller committed
1653
","
1654
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'UTF-8', '|');
Thomas Mueller's avatar
Thomas Mueller committed
1655 1656
"

1657 1658 1659 1660 1661
"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
1662
","
1663
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1664
","
1665
INT
Thomas Mueller's avatar
Thomas Mueller committed
1666 1667
"

1668 1669
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1670
","
1671
A date literal. The limitations are the same as for the Java data type
1672
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1673
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1674
","
1675
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1676 1677
"

1678 1679
"Other Grammar","Decimal","
[ + | - ] number [ . number ]
1680
","
1681
Number with fixed precision and scale.
1682
","
1683
-1600.05
1684 1685
"

1686 1687
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1688
","
1689
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1690
","
1691
0
Thomas Mueller's avatar
Thomas Mueller committed
1692 1693
"

1694 1695
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1696
","
1697 1698 1699
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
1700
","
1701
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1702 1703
"

1704 1705
"Other Grammar","Double","
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1706
","
1707
The limitations are the same as for the Java data type Double.
Thomas Mueller's avatar
Thomas Mueller committed
1708
","
1709
-1.4e-10
Thomas Mueller's avatar
Thomas Mueller committed
1710 1711
"

1712 1713
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1714
","
1715
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1716
","
1717
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1718 1719
"

1720 1721
"Other Grammar","Factor","
term [ { { * | / } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1722
","
1723
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1724
","
1725
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1726 1727
"

1728 1729
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1730
","
1731 1732
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1733
","
1734
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1735 1736
"

1737 1738
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1739
","
1740
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1741
","
1742
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1743 1744
"

1745 1746
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1747
","
1748 1749 1750
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
1751
","
1752
NAME
Thomas Mueller's avatar
Thomas Mueller committed
1753 1754 1755
"

"Other Grammar","Int","
1756
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1757 1758 1759 1760 1761 1762 1763
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
1764
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1765 1766 1767 1768 1769 1770
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

1771 1772
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
1773
","
1774
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
1775
","
1776
TEST
Thomas Mueller's avatar
Thomas Mueller committed
1777 1778
"

1779 1780
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1781
","
1782
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
1783
","
1784
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1785 1786
"

1787 1788 1789 1790 1791 1792 1793 1794
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

1795 1796
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1797
","
1798
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
1799
","
1800
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
1801 1802
"

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

1813 1814
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
1815
","
1816 1817 1818
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
1819
","
1820
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
1821 1822
"

1823 1824 1825 1826 1827
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
[ ON DELETE { CASCADE | RESTRICT | NO ACTION | SET { DEFAULT | NULL } } ]
[ ON UPDATE { CASCADE | SET { DEFAULT | NULL } } ]
Thomas Mueller's avatar
Thomas Mueller committed
1828
","
1829
Defines a referential constraint. If the table name is not specified, then the
Thomas Mueller's avatar
Thomas Mueller committed
1830 1831 1832 1833 1834 1835
same table is referenced. 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.
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
1836
","
1837
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
1838 1839
"

Thomas Mueller's avatar
Thomas Mueller committed
1840 1841 1842 1843 1844 1845 1846 1847 1848
"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
"

1849 1850
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
1851
","
1852
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
1853
","
1854
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
1855 1856
"

1857 1858
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
1859
","
1860 1861
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
1862
","
1863
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
1864 1865
"

1866 1867
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1868
","
Thomas Mueller's avatar
Thomas Mueller committed
1869
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
1870 1871

Please note the text concatenation operator is ||.
Thomas Mueller's avatar
Thomas Mueller committed
1872
","
1873
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
1874 1875
"

1876 1877 1878 1879
"Other Grammar","Table Expression","
{ [ schemaName. ] tableName | ( select ) } [ [ AS ] newTableAlias ]
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1880
","
1881 1882 1883
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
1884
","
1885
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
1886 1887
"

1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899
"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
1900
","
1901
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
1902
","
1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
'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
1918
""java.sql.Timestamp"", but for compatibility with other databases the suggested
1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930
minimum and maximum years are 0001 and 9999.
","
TIMESTAMP '2005-12-31 23:59:59'
"

"Other Grammar","Value","
string | dollarQuotedString | hexNumber | int | long | decimal | double
    | date | time | timestamp | boolean | bytes | array | null
","
A value of any data type, or null.
","
10
Thomas Mueller's avatar
Thomas Mueller committed
1931 1932 1933 1934 1935 1936 1937
"

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

1938
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
1939 1940 1941 1942 1943 1944 1945 1946 1947
","
INT
"

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

1948
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
1949 1950 1951 1952 1953 1954 1955 1956 1957
","
BOOLEAN
"

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

1958
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
1959 1960 1961 1962 1963 1964 1965 1966 1967
","
TINYINT
"

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

1968
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
1969 1970 1971 1972 1973 1974 1975 1976 1977
","
SMALLINT
"

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

1978
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
","
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.

1990
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
1991 1992 1993 1994 1995
","
IDENTITY
"

"Data Types","DECIMAL Type","
1996
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
1997 1998 1999 2000
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2001
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2002 2003 2004 2005 2006
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2007
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT4 | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2008 2009 2010 2011
","
Floating point number. Should not be used to represent currency values, because
of rounding problems.

2012
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022
","
DOUBLE
"

"Data Types","REAL Type","
REAL
","
Single precision floating point number. Should not be used to represent currency
values, because of rounding problems.

2023
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2024 2025 2026 2027 2028 2029 2030 2031 2032
","
REAL
"

"Data Types","TIME Type","
TIME
","
The format is hh:mm:ss.

2033
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
2034 2035 2036 2037 2038 2039 2040 2041 2042
","
TIME
"

"Data Types","DATE Type","
DATE
","
The format is yyyy-MM-dd.

2043
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2044
(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
2045 2046 2047 2048 2049
","
DATE
"

"Data Types","TIMESTAMP Type","
2050
{ TIMESTAMP | DATETIME | SMALLDATETIME }
Thomas Mueller's avatar
Thomas Mueller committed
2051 2052 2053
","
The format is yyyy-MM-dd hh:mm:ss[.nnnnnnnnn].

2054
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2055 2056 2057 2058 2059
","
TIMESTAMP
"

"Data Types","BINARY Type","
2060
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2061
","
2062 2063 2064 2065 2066
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
2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077

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.
2078
Deserialization is only done get ""getObject"" is called. Java operations cannot be
Thomas Mueller's avatar
Thomas Mueller committed
2079
executed inside the database engine for security reasons. Use
2080
""PreparedStatement.setObject"" to store values.
Thomas Mueller's avatar
Thomas Mueller committed
2081

2082
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2083 2084 2085 2086 2087
","
OTHER
"

"Data Types","VARCHAR Type","
2088 2089
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2090
","
Thomas Mueller's avatar
Thomas Mueller committed
2091
Unicode String. Use two single quotes ('') to create a quote. The maximum precision
2092
is ""Integer.MAX_VALUE"". The precision is a size constraint; only the actual data is
2093
persisted. The whole text is kept in memory when using this data type. For large text data CLOB
Thomas Mueller's avatar
Thomas Mueller committed
2094 2095
should be used; see there for details.

2096
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2097 2098 2099 2100 2101
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2102
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2103 2104
","
Same as VARCHAR, but not case sensitive when comparing. Stored in mixed case.
2105
The maximum precision is ""Integer.MAX_VALUE"" characters, but the whole text is kept in
2106 2107
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
2108

2109
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2110 2111 2112 2113 2114
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2115
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2116 2117 2118 2119
","
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. Unicode String. Use two single quotes ('') to create a quote.
2120
The maximum precision is ""Integer.MAX_VALUE"". The precision is a size constraint;
2121 2122
only the actual data is persisted. The whole text is kept in 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
2123

2124
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2125 2126 2127 2128 2129
","
CHAR(10)
"

"Data Types","BLOB Type","
2130
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2131 2132 2133
","
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
2134
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2135 2136
Advanced / Large Objects.

2137
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2138 2139 2140 2141 2142
","
BLOB
"

"Data Types","CLOB Type","
2143
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2144 2145 2146 2147 2148
","
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
2149
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2150 2151 2152 2153 2154

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.

2155
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2156 2157 2158 2159 2160 2161 2162
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2163 2164 2165 2166
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
2167

Thomas Mueller's avatar
Thomas Mueller committed
2168
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2169 2170 2171 2172 2173 2174 2175
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
2176
An array of values. Use a value list (1, 2) or ""PreparedStatement.setObject(.., new Object[] {..})"" to store values.
Thomas Mueller's avatar
Thomas Mueller committed
2177

2178
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2179 2180 2181 2182 2183
","
ARRAY
"

"Functions (Aggregate)","AVG","
2184
AVG ( [ DISTINCT ] { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2185
","
2186 2187
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2188
Aggregates are only allowed in select statements.
2189
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2190 2191 2192 2193 2194
","
AVG(X)
"

"Functions (Aggregate)","BOOL_AND","
2195
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2196
","
2197 2198 2199
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
2200 2201 2202 2203 2204
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2205
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2206
","
2207 2208 2209
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
2210 2211 2212 2213 2214
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2215
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2216
","
2217 2218 2219 2220
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
2221 2222 2223 2224 2225
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2226 2227
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2228
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2229
","
2230 2231 2232 2233 2234
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
2235 2236 2237 2238 2239
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2240
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2241
","
2242 2243 2244 2245
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
2246 2247 2248 2249 2250
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2251
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2252
","
2253 2254 2255 2256
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
2257 2258 2259 2260 2261
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
2262
SUM( [ DISTINCT ] { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2263
","
2264 2265 2266 2267
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
2268 2269 2270 2271 2272
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2273
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2274
","
2275 2276 2277 2278 2279
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
2280 2281 2282 2283 2284
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
2285
STDDEV_POP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2286
","
2287 2288 2289
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
2290 2291 2292 2293 2294 2295
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
2296
STDDEV_SAMP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2297
","
2298 2299 2300
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
2301 2302 2303 2304 2305 2306
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
2307
VAR_POP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2308
","
2309 2310 2311 2312
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
2313 2314 2315 2316 2317
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
2318
VAR_SAMP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2319
","
2320 2321 2322 2323
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
2324 2325 2326 2327 2328
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
2329
ABS ( { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2330
","
2331 2332
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"".
2333
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2334 2335 2336 2337 2338
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
2339
ACOS(double)
Thomas Mueller's avatar
Thomas Mueller committed
2340
","
2341
See also Java ""Math.*"" functions.
2342
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2343 2344 2345 2346 2347
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
2348
ASIN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2349
","
2350
See also Java ""Math.*"" functions.
2351
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2352 2353 2354 2355 2356
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
2357
ATAN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2358
","
2359
See also Java ""Math.*"" functions.
2360
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2361 2362 2363 2364 2365
","
ATAN(D)
"

"Functions (Numeric)","COS","
2366
COS(double)
Thomas Mueller's avatar
Thomas Mueller committed
2367
","
2368
See also Java ""Math.*"" functions.
2369
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2370 2371 2372 2373 2374
","
COS(ANGLE)
"

"Functions (Numeric)","COT","
2375
COT(double)
Thomas Mueller's avatar
Thomas Mueller committed
2376
","
2377
See also Java ""Math.*"" functions.
2378
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2379 2380 2381 2382 2383
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
2384
SIN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2385
","
2386
See also Java ""Math.*"" functions.
2387
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2388 2389 2390 2391 2392
","
SIN(ANGLE)
"

"Functions (Numeric)","TAN","
2393
TAN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2394
","
2395
See also Java ""Math.*"" functions.
2396
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2397 2398 2399 2400 2401
","
TAN(ANGLE)
"

"Functions (Numeric)","ATAN2","
2402
ATAN2(double, double)
Thomas Mueller's avatar
Thomas Mueller committed
2403
","
2404
See also Java ""Math.atan2"".
2405
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2406 2407 2408 2409 2410
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2411
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2412
","
2413 2414
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2415 2416 2417 2418 2419 2420
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2421
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2422
","
2423 2424
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2425 2426 2427 2428 2429 2430
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2431
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2432
","
2433 2434
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2435 2436 2437 2438 2439 2440
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2441
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2442
","
2443 2444
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2445 2446 2447 2448 2449 2450
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
2451
CEILING(double)
Thomas Mueller's avatar
Thomas Mueller committed
2452
","
2453
See also Java ""Math.ceil"".
2454
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2455 2456 2457 2458 2459
","
LOG(A)
"

"Functions (Numeric)","DEGREES","
2460
DEGREES(double)
Thomas Mueller's avatar
Thomas Mueller committed
2461
","
2462
See also Java ""Math.toDegrees"".
2463
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2464 2465 2466 2467 2468
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
2469
EXP(double)
Thomas Mueller's avatar
Thomas Mueller committed
2470
","
2471
See also Java ""Math.exp"".
2472
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2473 2474 2475 2476 2477
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
2478
FLOOR(double)
Thomas Mueller's avatar
Thomas Mueller committed
2479
","
2480
See also Java ""Math.floor"".
2481
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2482 2483 2484 2485 2486
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
2487
LOG(double)
Thomas Mueller's avatar
Thomas Mueller committed
2488
","
2489
See also Java ""Math.log"".
2490
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2491 2492 2493 2494 2495
","
LOG(A)
"

"Functions (Numeric)","LOG10","
2496
LOG10(double)
Thomas Mueller's avatar
Thomas Mueller committed
2497
","
2498
See also Java ""Math.log10"" (in Java 5).
2499
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2500 2501 2502 2503 2504
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
2505
RADIANS(double)
Thomas Mueller's avatar
Thomas Mueller committed
2506
","
2507
See also Java ""Math.toRadians"".
2508
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2509 2510 2511 2512 2513
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
2514
SQRT(double)
Thomas Mueller's avatar
Thomas Mueller committed
2515
","
2516
See also Java ""Math.sqrt"".
2517
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2518 2519 2520 2521 2522
","
SQRT(A)
"

"Functions (Numeric)","PI","
2523
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2524
","
2525
See also Java ""Math.PI"".
2526
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2527 2528 2529 2530 2531
","
PI()
"

"Functions (Numeric)","POWER","
2532
POWER(double, double)
Thomas Mueller's avatar
Thomas Mueller committed
2533
","
2534
See also Java ""Math.pow"".
2535
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2536 2537 2538 2539 2540
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2541
RAND( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2542 2543 2544
","
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
2545
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2546 2547 2548 2549 2550
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2551
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2552 2553 2554 2555 2556 2557 2558
","
Returns a new UUID with 122 pseudo random bits.
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2559
ROUND(double, digitsInt)
Thomas Mueller's avatar
Thomas Mueller committed
2560 2561
","
Rounds to a number of digits.
2562
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2563 2564 2565 2566 2567
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
2568
ROUNDMAGIC(double)
Thomas Mueller's avatar
Thomas Mueller committed
2569
","
2570 2571 2572 2573 2574 2575
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
2576 2577 2578 2579 2580
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2581
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2582 2583
","
Generates a number of cryptographically secure random numbers.
2584
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2585 2586 2587 2588 2589
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
2590
SIGN ( { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2591 2592 2593 2594 2595 2596 2597
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2598
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2599
","
2600 2601 2602 2603
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
2604 2605 2606 2607 2608
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2609
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2610
","
2611 2612 2613 2614
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
2615 2616 2617 2618 2619 2620
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2621
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2622
","
2623 2624 2625
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
2626 2627 2628 2629 2630
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
2631
TRUNCATE(double, digitsInt)
Thomas Mueller's avatar
Thomas Mueller committed
2632 2633
","
Truncates to a number of digits (to the next value closer to 0).
2634
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2635 2636 2637 2638 2639
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
2640
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
2641
","
2642 2643 2644 2645
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
2646 2647 2648 2649 2650
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
2651
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2652 2653
","
Expands data that was compressed using the COMPRESS function.
2654
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2655 2656 2657 2658 2659
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
2660
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
2661 2662 2663 2664 2665 2666 2667
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
2668
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
2669 2670
","
Returns the ASCII value of the first character in the string.
2671
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2672 2673 2674 2675
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
2676
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2677
","
2678 2679 2680
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
2681 2682 2683 2684 2685
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
2686
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2687
","
2688 2689 2690
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
2691 2692 2693 2694 2695
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
2696
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2697
","
2698 2699 2700 2701
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
2702 2703 2704 2705 2706
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
2707
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
2708 2709
","
Returns the character that represents the ASCII value.
2710
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2711 2712 2713 2714 2715
","
CHAR(65)
"

"Functions (String)","CONCAT","
2716
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
2717 2718
","
Combines strings.
2719
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2720 2721 2722 2723 2724
","
CONCAT(NAME, '!')
"

"Functions (String)","DIFFERENCE","
2725
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
2726 2727
","
Returns the difference between the sounds of two strings.
2728
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2729 2730 2731 2732 2733
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
2734
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
2735
","
2736 2737
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
2738 2739 2740 2741 2742
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
2743
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2744
","
2745 2746 2747
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
2748 2749 2750 2751 2752
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
2753
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2754
","
2755
Returns the location of a search string in a string.
2756 2757 2758
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
2759 2760 2761 2762 2763
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
2764
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
2765
","
2766 2767 2768
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
2769 2770 2771 2772 2773
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
2774
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2775 2776 2777 2778 2779 2780 2781
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
2782
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2783 2784 2785 2786 2787 2788 2789
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
2790
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2791 2792 2793 2794 2795 2796 2797
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
2798
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2799 2800 2801 2802 2803 2804 2805
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
2806
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2807
","
2808 2809 2810 2811
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
2812 2813 2814 2815 2816
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
2817
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
2818 2819 2820 2821 2822 2823 2824
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
2825
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2826
","
2827 2828 2829
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
2830 2831 2832 2833 2834
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
2835
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2836
","
2837 2838 2839
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
2840 2841 2842 2843 2844
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
2845
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2846 2847 2848 2849 2850 2851 2852
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
2853
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2854 2855 2856 2857 2858 2859 2860
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
2861
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
2862
","
2863 2864
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
2865 2866 2867 2868 2869
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
2870
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
2871
","
2872
Replaces each substring that matches a regular expression.
2873
For details, see the Java ""String.replaceAll()"" method.
2874
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
2875 2876 2877 2878 2879
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
2880
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2881 2882 2883 2884 2885 2886 2887
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
2888
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
2889
","
2890 2891
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.
2892
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
2893 2894 2895 2896 2897
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
2898
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2899
","
2900 2901 2902
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
2903 2904 2905 2906 2907
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
2908
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
2909 2910 2911 2912 2913 2914 2915
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
2916
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
2917
","
2918 2919 2920
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
2921 2922 2923 2924 2925
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
2926
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
2927
","
2928 2929 2930
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
2931 2932 2933 2934 2935
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
2936
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
2937 2938
","
Encodes a string to a byte array using the UTF8 encoding format.
2939
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2940 2941 2942 2943 2944
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
2945
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2946
","
2947 2948
Returns a substring of a string starting at a position.
The length is optional.
2949
Also supported is: ""SUBSTRING(string FROM start [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
2950 2951 2952 2953 2954
","
SUBSTR(NAME, 1)
"

"Functions (String)","UTF8TOSTRING","
2955
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2956 2957 2958 2959 2960 2961 2962
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
2963
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
2964
","
2965
Creates an XML attribute element of the form ""name=value"".
2966 2967
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2968 2969 2970 2971 2972
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
2973
XMLNODE(elementString [, attributesString [, contentString]])
Thomas Mueller's avatar
Thomas Mueller committed
2974 2975
","
Create an XML node element.
2976
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2977 2978 2979 2980 2981
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
2982
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
2983
","
2984
Creates an XML comment.
2985
Two dashes (""--"") are converted to ""- -"".
2986
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2987 2988 2989 2990 2991
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
2992
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
2993
","
2994
Creates an XML CDATA element.
2995
If the value contains ""]]>"", an XML text element is created instead.
2996
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2997 2998 2999 3000 3001
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3002
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3003
","
3004
The string ""<?xml version='1.0'?>"" is returned.
Thomas Mueller's avatar
Thomas Mueller committed
3005 3006 3007 3008 3009
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3010
XMLTEXT(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3011 3012
","
Creates an XML text element.
3013
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3014 3015 3016 3017 3018
","
CALL XMLTEXT('test')
"

"Functions (Time and Date)","CURRENT_DATE","
3019
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3020 3021 3022 3023 3024 3025 3026
","
Returns the current date.
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3027
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3028 3029 3030 3031 3032 3033 3034
","
Returns the current time.
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3035
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3036
","
3037 3038
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
Thomas Mueller's avatar
Thomas Mueller committed
3039 3040 3041 3042 3043
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3044
DATEADD(unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3045
","
3046 3047 3048 3049
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
3050 3051 3052 3053 3054
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3055
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3056
","
Thomas Mueller's avatar
Thomas Mueller committed
3057
Returns the the number of crossed unit boundaries between two timestamps.
3058 3059
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3060
The same units as in the EXTRACT function are supported.
3061
TIMESTAMPDIFF is supported for MySQL compatibility.
Thomas Mueller's avatar
Thomas Mueller committed
3062 3063 3064 3065 3066
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3067
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3068 3069 3070 3071 3072 3073 3074
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3075
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3076 3077 3078 3079 3080 3081 3082
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3083
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3084 3085 3086 3087 3088 3089 3090
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3091
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3092 3093 3094 3095 3096 3097 3098
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3099 3100
EXTRACT ( { YEAR | YY | MONTH | MM | DAY | DD | DAY_OF_YEAR
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3101
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3102 3103
","
Returns a specific value from a timestamps.
3104
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3105 3106 3107 3108 3109
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3110
FORMATDATETIME ( timestamp, formatString
3111
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3112
","
3113 3114 3115
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.
3116
For details of the format, see ""java.text.SimpleDateFormat"".
3117
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3118 3119 3120 3121 3122 3123
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3124
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3125 3126 3127 3128 3129 3130 3131
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3132
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3133 3134 3135 3136 3137 3138 3139
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3140
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3141 3142 3143 3144 3145 3146 3147
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3148
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3149 3150 3151 3152 3153 3154 3155
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3156
PARSEDATETIME(string, formatString
3157
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3158
","
3159 3160 3161
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.
3162
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3163 3164 3165 3166 3167 3168
","
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","
3169
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3170 3171 3172 3173 3174 3175 3176
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3177
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3178 3179 3180 3181 3182 3183 3184
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3185
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3186
","
3187 3188
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3189 3190 3191 3192 3193
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3194
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3195 3196 3197 3198 3199 3200 3201
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3202
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3203 3204
","
Returns one element of an array.
3205
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3206 3207 3208 3209 3210
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
3211
ARRAY_GET(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3212 3213 3214 3215 3216 3217 3218
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

"Functions (System)","AUTOCOMMIT","
3219
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3220 3221 3222 3223 3224 3225 3226
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3227
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3228
","
3229 3230 3231
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
3232 3233

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3234 3235 3236 3237 3238
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3239
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3240 3241
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3242
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3243 3244 3245 3246 3247
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3248
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3249
","
3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261
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
3262 3263 3264
"

"Functions (System)","COALESCE","
3265
COALESCE(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3266 3267 3268 3269 3270 3271 3272
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3273
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3274 3275 3276 3277 3278 3279 3280
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3281
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3282
","
3283 3284 3285 3286 3287
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
3288 3289 3290 3291 3292
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3293
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3294
","
3295 3296
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
3297 3298

If the column names are specified (a list of column names separated with the
3299
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3300 3301 3302 3303 3304
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
3305 3306 3307 3308 3309

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.

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

3312
This function can be used like a table: ""SELECT * FROM CSVREAD(...)"".
Thomas Mueller's avatar
Thomas Mueller committed
3313
Instead of a file, an URL may be used, for example
3314
""jar:file:///c:/temp/example.zip!/org/example/nested.zip"".
3315

Thomas Mueller's avatar
Thomas Mueller committed
3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327
Admin rights are required to execute this command.
","
CALL CSVREAD('test.csv');
-- Read a file containing the columns ID, NAME with
-- UTF-8 encoding and the pipe (|) as field separator
CALL CSVREAD('test2.csv', 'ID|NAME', 'UTF-8', '|');
-- Read a semicolon-separated file
SELECT * FROM CSVREAD('data/test.csv', NULL, NULL, ';');
SELECT ""Last Name"" FROM CSVREAD('address.csv');
"

"Functions (System)","CSVWRITE","
3328
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3329
","
3330
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3331
If only a file name is specified, it will be written to the current working directory.
3332
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3333
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
3334 3335 3336 3337 3338

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

Thomas Mueller's avatar
Thomas Mueller committed
3341 3342
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3343 3344 3345 3346 3347 3348 3349
","
CALL CSVWRITE('test.csv', 'SELECT * FROM TEST');
-- Write a file with UTF-8 encoding and the pipe (|) as field separator
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'UTF-8', '|');
"

"Functions (System)","DATABASE","
3350
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3351 3352 3353 3354 3355 3356 3357
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3358
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3359 3360 3361 3362 3363 3364 3365 3366
","
Returns the directory of the database files and the database name, if it is file
based. Returns NULL otherwise.
","
CALL DATABASE_PATH();
"

"Functions (System)","FILE_READ","
3367
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3368 3369 3370 3371
","
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
Thomas Mueller's avatar
Thomas Mueller committed
3372 3373
default character set for this system. File names and URLs are supported.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3374 3375 3376 3377 3378 3379
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

"Functions (System)","GREATEST","
3380
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3381 3382 3383 3384 3385 3386 3387
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3388
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3389 3390
","
Returns the last inserted identity value for this session.
3391
This value changes whenever a new sequence number was generated,
3392
even within a trigger or Java function. See also SCOPE_IDENTITY.
3393
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3394 3395 3396 3397 3398
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3399
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3400 3401 3402 3403 3404 3405 3406
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3407
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3408 3409 3410 3411 3412 3413 3414
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3415
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3416 3417
","
Returns the current lock mode. See SET LOCK_MODE.
3418
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3419 3420 3421 3422 3423
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3424
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3425 3426 3427 3428 3429 3430 3431 3432
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3433
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3434
","
3435 3436 3437 3438 3439
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
3440
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3441 3442 3443 3444 3445
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3446
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3447
","
Thomas Mueller's avatar
Thomas Mueller committed
3448
Returns the free memory in KB (where 1024 bytes is a KB).
3449
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3450 3451
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3452 3453 3454 3455 3456
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3457
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3458
","
Thomas Mueller's avatar
Thomas Mueller committed
3459
Returns the used memory in KB (where 1024 bytes is a KB).
3460
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3461 3462
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3463 3464 3465 3466 3467
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3468
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3469
","
3470 3471 3472 3473
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
3474 3475 3476 3477 3478
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3479
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3480 3481 3482 3483 3484 3485 3486
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

"Functions (System)","READONLY","
3487
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3488 3489 3490 3491 3492 3493 3494
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
3495
ROWNUM()
Thomas Mueller's avatar
Thomas Mueller committed
3496
","
3497 3498 3499
Returns the number of the current row.
This method returns an int.
This function is supported for SELECT statements, as well as for DELETE and UPDATE.
3500 3501
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).
3502
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3503
","
3504 3505
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3506
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3507 3508 3509
"

"Functions (System)","SCHEMA","
3510
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3511 3512 3513 3514 3515 3516
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3517 3518 3519 3520 3521 3522 3523 3524 3525 3526
"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
3527
"Functions (System)","SESSION_ID","
3528
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3529
","
3530 3531 3532 3533
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
3534 3535 3536 3537 3538
","
CALL SESSION_ID()
"

"Functions (System)","SET","
3539
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
3540
","
3541 3542 3543
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
3544
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
3545 3546 3547 3548 3549
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
3550
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
3551 3552 3553 3554 3555 3556 3557
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
3558
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3559
","
3560 3561
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
3562
Otherwise a value of the following form is returned:
3563
""logFileId-position-sessionId"".
3564 3565
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
3566 3567 3568 3569 3570
","
CALL TRANSACTION_ID()
"

"Functions (System)","USER","
3571
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592
","
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)
"