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

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

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

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

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

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

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

"Commands (DML)","UPDATE","
Thomas Mueller's avatar
Thomas Mueller committed
60
UPDATE tableName [ [ AS ] newTableAlias ]
61
SET { columnName = { DEFAULT | expression } } [,...]
62
[ WHERE expression ]
Thomas Mueller's avatar
Thomas Mueller committed
63 64 65
","
Updates data in a table.
","
66 67
UPDATE TEST SET NAME='Hi' WHERE ID=1;
UPDATE PERSON P SET NAME=(SELECT A.NAME FROM ADDRESS A WHERE A.ID=P.ID);
Thomas Mueller's avatar
Thomas Mueller committed
68 69 70
"

"Commands (DML)","DELETE","
71
DELETE [ TOP term ] FROM tableName [ WHERE expression ] [ LIMIT term ]
Thomas Mueller's avatar
Thomas Mueller committed
72 73
","
Deletes rows form a table.
74
If TOP or LIMIT is specified, at most the specified number of rows are deleted (no limit if null or smaller than zero).
Thomas Mueller's avatar
Thomas Mueller committed
75 76 77 78 79 80 81
","
DELETE FROM TEST WHERE ID=2
"

"Commands (DML)","BACKUP","
BACKUP TO fileNameString
","
Thomas Mueller's avatar
Thomas Mueller committed
82 83
Backs up the database files to a .zip file. Objects are not locked, but
the backup is transactionally consistent because the transaction log is also copied.
Thomas Mueller's avatar
Thomas Mueller committed
84
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
85 86 87 88 89 90 91
","
BACKUP TO 'backup.zip'
"

"Commands (DML)","CALL","
CALL expression
","
Thomas Mueller's avatar
Thomas Mueller committed
92 93 94
Calculates a simple expression. This statement returns a result set with one row,
except if the called function returns a result set itself.
If the called function returns an array, then each element in this array is returned as a column.
Thomas Mueller's avatar
Thomas Mueller committed
95 96 97 98 99
","
CALL 15*25
"

"Commands (DML)","EXPLAIN","
Thomas Mueller's avatar
Thomas Mueller committed
100
EXPLAIN { [ PLAN FOR ] | ANALYZE } { select | insert | update | delete | merge }
Thomas Mueller's avatar
Thomas Mueller committed
101 102
","
Shows the execution plan for a statement.
103 104
When using EXPLAIN ANALYZE, the statement is actually executed, and the query plan
will include the actual row scan count for each table.
Thomas Mueller's avatar
Thomas Mueller committed
105 106 107 108 109
","
EXPLAIN SELECT * FROM TEST WHERE ID=1
"

"Commands (DML)","MERGE","
110 111
MERGE INTO tableName [ ( columnName [,...] ) ]
[ KEY ( columnName [,...] ) ]
112
{ VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | select }
Thomas Mueller's avatar
Thomas Mueller committed
113 114 115 116 117 118 119 120 121 122 123
","
Updates existing rows, and insert rows that don't exist. If no key column is
specified, the primary key columns are used to find the row. If more than one
row per new row is affected, an exception is thrown. If the table contains an
auto-incremented key or identity column, and the row was updated, the generated
key is set to 0; otherwise it is set to the new key.
","
MERGE INTO TEST KEY(ID) VALUES(2, 'World')
"

"Commands (DML)","RUNSCRIPT","
Thomas Mueller's avatar
Thomas Mueller committed
124
RUNSCRIPT FROM fileNameString [ scriptCompression ]
125
[ CIPHER cipher PASSWORD string ] [ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
126 127 128 129 130 131
","
Runs a SQL script from a file. The script is a text file containing SQL
statements; each statement must end with ';'. This command can be used to
restore a database from a backup. The password must be in single quotes; it is
case sensitive and can contain spaces.

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

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

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

"Commands (DML)","SCRIPT","
145 146
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
Thomas Mueller's avatar
Thomas Mueller committed
147
[ TO fileNameString [ scriptCompression ]
148
    [ CIPHER cipher PASSWORD string ] ]
149
[ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
150
","
151 152 153 154 155 156 157 158 159
Creates a SQL script from the database.

SIMPLE does not use multi-row insert statements.
NODATA will not emit INSERT statements.
If the DROP option is specified, drop statements are created for tables, views,
and sequences. If the block size is set, CLOB and BLOB values larger than this
size are split into separate blocks.

If no file name is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
160 161 162 163
script is returned as a result set. This command can be used to create a backup
of the database. For long term storage, it is more portable than copying the
database files.

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

Thomas Mueller's avatar
Thomas Mueller committed
169 170 171
The password must be in single quotes; it is case sensitive and can contain spaces.

This command locks objects while it is running.
Thomas Mueller's avatar
Thomas Mueller committed
172 173 174 175 176
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
177 178
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
179 180 181 182 183 184 185 186 187
","
Lists the schemas, tables, or the columns of a table.
","
SHOW TABLES
"

"Commands (DDL)","ALTER INDEX RENAME","
ALTER INDEX indexName RENAME TO newIndexName
","
Thomas Mueller's avatar
Thomas Mueller committed
188 189
Renames an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
190 191 192 193
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

194 195 196 197 198 199 200 201 202
"Commands (DDL)","ALTER SCHEMA RENAME","
ALTER SCHEMA schema RENAME TO newSchemaName
","
Renames a schema.
This command commits an open transaction.
","
ALTER SCHEMA TEST RENAME TO PRODUCTION
"

Thomas Mueller's avatar
Thomas Mueller committed
203
"Commands (DDL)","ALTER SEQUENCE","
204
ALTER SEQUENCE sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
Thomas Mueller's avatar
Thomas Mueller committed
205
","
Thomas Mueller's avatar
Thomas Mueller committed
206 207
Changes the next value and the increment of a sequence.
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
208 209 210 211 212 213
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

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

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
224
ALTER TABLE tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
225 226 227
","
Adds a constraint to a table. If NOCHECK is specified, existing rows are not
checked for consistency (the default is to check consistency for existing rows).
Thomas Mueller's avatar
Thomas Mueller committed
228
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
229
It is not possible to disable checking for unique constraints.
230
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
231 232 233 234
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

235 236 237 238 239 240 241 242 243
"Commands (DDL)","ALTER TABLE ALTER","
ALTER TABLE tableName ALTER COLUMN columnName
{ { dataType [ DEFAULT expression ] [ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] }
    | { RENAME TO name }
    | { RESTART WITH long }
    | { SELECTIVITY int }
    | { SET DEFAULT expression }
    | { SET NULL }
    | { SET NOT NULL } }
Thomas Mueller's avatar
Thomas Mueller committed
244
","
245 246
Changes the data type of a column, rename a column,
change the identity value, or change the selectivity.
Thomas Mueller's avatar
Thomas Mueller committed
247

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

250 251 252
RESTART changes the next value of an auto increment column.
The column must already be an auto increment column.
For RESTART, the same transactional rules as for ALTER SEQUENCE apply.
Thomas Mueller's avatar
Thomas Mueller committed
253

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

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

261
SET NULL sets a column to allow NULL. The row may not be part of a primary key.
Thomas Mueller's avatar
Thomas Mueller committed
262
Single column indexes on this column are dropped.
263 264 265

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

266
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
267
","
268 269 270 271 272 273 274
ALTER TABLE TEST ALTER COLUMN NAME CLOB;
ALTER TABLE TEST ALTER COLUMN NAME RENAME TO TEXT;
ALTER TABLE TEST ALTER COLUMN ID RESTART WITH 10000;
ALTER TABLE TEST ALTER COLUMN NAME SELECTIVITY 100;
ALTER TABLE TEST ALTER COLUMN NAME SET DEFAULT '';
ALTER TABLE TEST ALTER COLUMN NAME SET NOT NULL;
ALTER TABLE TEST ALTER COLUMN NAME SET NULL;
Thomas Mueller's avatar
Thomas Mueller committed
275 276 277 278 279 280
"

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

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

"Commands (DDL)","ALTER TABLE SET","
ALTER TABLE tableName SET REFERENTIAL_INTEGRITY
297
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
298 299 300 301 302 303
","
Disables or enables referential integrity checking for a table. This command can
be used inside a transaction. Enabling referential integrity does not check
existing data, except if CHECK is specified. Use SET REFERENTIAL_INTEGRITY to
disable it for all tables; the global flag and the flag for each table are
independent.
304 305

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
306 307 308 309 310 311 312
","
ALTER TABLE TEST SET REFERENTIAL_INTEGRITY FALSE
"

"Commands (DDL)","ALTER TABLE RENAME","
ALTER TABLE tableName RENAME TO newName
","
Thomas Mueller's avatar
Thomas Mueller committed
313 314
Renames a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
315 316 317 318 319
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
320
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
321
","
Thomas Mueller's avatar
Thomas Mueller committed
322 323 324 325
Switches the admin flag of a user on or off.

Only unquoted or uppercase user names are allowed.
Admin rights are required to execute this command.
326
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
327 328 329 330 331 332 333
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
334 335 336 337
Renames a user.
After renaming a user, the password becomes invalid and needs to be changed as well.

Only unquoted or uppercase user names are allowed.
Thomas Mueller's avatar
Thomas Mueller committed
338
Admin rights are required to execute this command.
339
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
340 341 342 343 344
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
345
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
346
","
Thomas Mueller's avatar
Thomas Mueller committed
347 348 349 350 351 352
Changes the password of a user.
Only unquoted or uppercase user names are allowed.
The password must be enclosed in single quotes. It is case sensitive
and can contain spaces. The salt and hash values are hex strings.

Admin rights are required to execute this command.
353
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
354 355 356 357 358 359 360 361
","
ALTER USER SA SET PASSWORD 'rioyxlgt'
"

"Commands (DDL)","ALTER VIEW","
ALTER VIEW viewName RECOMPILE
","
Recompiles a view after the underlying tables have been changed or created.
Thomas Mueller's avatar
Thomas Mueller committed
362
This command is used for views created using CREATE FORCE VIEW.
363
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
364 365 366 367 368
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
369
ANALYZE [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
370 371 372 373 374 375 376
","
Updates the selectivity statistics of all tables. The selectivity is used by the
cost based optimizer to select the best index for a given query. If no sample
size is set, up to 10000 rows per table are read. The value 0 means all rows are
read. The selectivity can be set manually using ALTER TABLE ALTER COLUMN
SELECTIVITY. Manual values are overwritten by this statement. The selectivity is
available in the INFORMATION_SCHEMA.COLUMNS table.
377 378

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

"Commands (DDL)","COMMENT","
384 385 386 387 388
COMMENT ON
{ { COLUMN [ schemaName. ] tableName.columnName }
    | { { TABLE | VIEW | CONSTANT | CONSTRAINT | ALIAS | INDEX | ROLE
    | SCHEMA | SEQUENCE | TRIGGER | USER | DOMAIN } [ schemaName. ] objectName } }
IS expression
Thomas Mueller's avatar
Thomas Mueller committed
389
","
Thomas Mueller's avatar
Thomas Mueller committed
390 391 392
Sets the comment of a database object. Use NULL to remove the comment.

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

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

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

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

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

425 426
When defining a function alias with source code, the Sun ""javac"" is compiler
is used if the file ""tools.jar"" is in the classpath. If not, ""javac"" is run as a separate process.
427 428
Only the source code is stored in the database; the class is compiled each time
the database is re-opened. Source code is usually passed
429 430
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
431

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

435
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
436 437 438
connection to the database is provided. This connection must not be closed.
If the class contains multiple methods with the given name but different
parameter count, all methods are mapped.
439

Thomas Mueller's avatar
Thomas Mueller committed
440
Admin rights are required to execute this command.
441
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
442 443 444 445 446
","
CREATE ALIAS MY_SQRT FOR ""java.lang.Math.sqrt"";
CREATE ALIAS GET_SYSTEM_PROPERTY FOR ""java.lang.System.getProperty"";
CALL GET_SYSTEM_PROPERTY('java.class.path');
CALL GET_SYSTEM_PROPERTY('com.acme.test', 'true');
447 448
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
Thomas Mueller's avatar
Thomas Mueller committed
449 450 451
"

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

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

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
484
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
485 486
For other tables, or if the index contains multiple columns, the HASH keyword is ignored.
Hash indexes can only test for equality, and do not support range queries (similar to a hash table).
Thomas Mueller's avatar
Thomas Mueller committed
487
Non-unique keys are supported.
Thomas Mueller's avatar
Thomas Mueller committed
488 489 490 491 492
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
493 494 495
CREATE [ [ GLOBAL | LOCAL ] TEMPORARY ] LINKED TABLE [ IF NOT EXISTS ]
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
496 497 498 499 500 501 502 503
","
Creates a table link to an external table. The driver name may be empty if the
driver is already loaded. If the schema name is not set, only one table with
that name may exist in the target database.

Usually, for update statements, the old rows are deleted first and then the new
rows are inserted. It is possible to emit update statements (except on
rollback), however in this case multi-row unique key updates may not always
504
work. Linked tables to the same database share one connection.
505 506

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

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

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

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
540 541 542 543 544
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
554 555 556 557 558
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
559 560 561
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
{ { ( { columnDefinition | constraint } [,...] ) [ AS select ] }
Thomas Mueller's avatar
Thomas Mueller committed
562
    | { AS select } }
Thomas Mueller's avatar
Thomas Mueller committed
563
[ ENGINE tableEngineName ] [ TRANSACTIONAL ] [ NOT PERSISTENT ]
Thomas Mueller's avatar
Thomas Mueller committed
564 565 566
","
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
567 568 569 570
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
571
that means memory tables should not get too large.
572

Thomas Mueller's avatar
Thomas Mueller committed
573 574 575 576 577
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,
578
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
579

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

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

Thomas Mueller's avatar
Thomas Mueller committed
586 587
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
588 589 590 591 592
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
593
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
594
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
595
[ QUEUE int ] [ NOWAIT ] CALL triggeredClassName
Thomas Mueller's avatar
Thomas Mueller committed
596
","
Thomas Mueller's avatar
Thomas Mueller committed
597 598
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
599 600
database engine (when using the server mode, it must be in the classpath of the server).

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

606
Only row based AFTER trigger can be called on rollback.
607 608
Exceptions that occur within such triggers are ignored.

609
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
610
Only the first such trigger is called. Such triggers on views are supported.
611
They can be used to make views updatable.
612

613 614 615 616
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
617 618 619 620
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.
621 622

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
623 624 625 626
","
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger""
"
"Commands (DDL)","CREATE USER","
627 628
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
629
","
Thomas Mueller's avatar
Thomas Mueller committed
630 631 632
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.
633

Thomas Mueller's avatar
Thomas Mueller committed
634
Admin rights are required to execute this command.
635
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
636 637 638 639 640
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
641
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
642
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
643 644
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
645
if the underlying table(s) don't exist.
646

Thomas Mueller's avatar
Thomas Mueller committed
647 648 649 650 651
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.

652 653
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
654
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 VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
661
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
662
","
Thomas Mueller's avatar
Thomas Mueller committed
663 664 665
Drops an existing user-defined aggregate function.

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 AGGREGATE MEDIAN
"

"Commands (DDL)","DROP ALIAS","
672
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
673
","
Thomas Mueller's avatar
Thomas Mueller committed
674 675 676
Drops an existing function alias.

Admin rights are required to execute this command.
677
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
678 679 680 681 682
","
CREATE ALIAS MY_SQRT
"

"Commands (DDL)","DROP ALL OBJECTS","
683
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
684 685 686 687 688
","
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
689 690 691
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
692 693 694 695 696
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
697
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
698
","
Thomas Mueller's avatar
Thomas Mueller committed
699 700
Drops a constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
701 702 703 704 705
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
706
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
707
","
Thomas Mueller's avatar
Thomas Mueller committed
708 709
Drops a data type (domain).
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
710 711 712 713 714
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
715
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
716
","
Thomas Mueller's avatar
Thomas Mueller committed
717 718
Drops an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
719 720 721 722 723
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
724
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
725
","
Thomas Mueller's avatar
Thomas Mueller committed
726 727
Drops a role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
728 729 730 731 732
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
733
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
734
","
Thomas Mueller's avatar
Thomas Mueller committed
735 736
Drops a schema.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
737 738 739 740 741
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
742
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
743
","
Thomas Mueller's avatar
Thomas Mueller committed
744 745
Drops a sequence.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
746 747 748 749 750
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
751
DROP TABLE [ IF EXISTS ] tableName [,...] [ CASCADE | RESTRICT ]
Thomas Mueller's avatar
Thomas Mueller committed
752
","
Thomas Mueller's avatar
Thomas Mueller committed
753 754 755
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.
756
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
757 758 759 760 761
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
762
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
763
","
Thomas Mueller's avatar
Thomas Mueller committed
764 765
Drops an existing trigger.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
766 767 768 769 770
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
771
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
772
","
Thomas Mueller's avatar
Thomas Mueller committed
773 774
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
775

Thomas Mueller's avatar
Thomas Mueller committed
776
Admin rights are required to execute this command.
777
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
778 779 780 781 782
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
783
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
784
","
Thomas Mueller's avatar
Thomas Mueller committed
785 786 787
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
788
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
789 790 791 792 793 794 795
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
796 797 798 799 800
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).
801
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
802 803

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
804 805 806 807 808 809 810
","
TRUNCATE TABLE TEST
"

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

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

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
821
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
822 823 824
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
825 826 827 828 829
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
830
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
831 832 833 834 835 836 837 838 839
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
840 841 842 843
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
844 845 846 847 848
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
849 850
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
851
","
Thomas Mueller's avatar
Thomas Mueller committed
852 853 854 855
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
856 857 858 859 860
","
GRANT SELECT ON TEST TO READONLY
"

"Commands (Other)","GRANT ROLE","
861
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
862
","
Thomas Mueller's avatar
Thomas Mueller committed
863 864 865 866
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
867 868 869 870 871
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
872
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
873 874 875 876 877 878 879 880 881
","
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
882 883
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
884 885 886 887 888
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
889 890
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
891
","
Thomas Mueller's avatar
Thomas Mueller committed
892 893 894 895
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
896 897 898 899 900
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
901
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
902
","
Thomas Mueller's avatar
Thomas Mueller committed
903 904 905 906
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
907 908 909 910 911
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
912
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
913 914 915 916 917 918 919 920 921 922
","
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
923 924 925 926
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
927 928 929 930 931 932 933
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
934 935
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
936 937 938 939 940
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
941
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
942
","
Thomas Mueller's avatar
Thomas Mueller committed
943 944
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
945 946 947 948 949
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
950
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
951 952 953 954 955 956 957 958 959 960
","
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
961 962 963 964 965
See also CREATE CONSTANT.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
966
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
967 968 969 970 971
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
972
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
973 974
","
Switches auto commit on or off.
975
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
976
however this will not work as expected when using a connection pool
977 978
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
979
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
980 981 982 983 984 985 986
","
SET AUTOCOMMIT OFF
"

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
987 988
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
989 990
Depending on the virtual machine, the actual memory required may be higher.

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

Thomas Mueller's avatar
Thomas Mueller committed
996 997 998
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
999
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
","
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
1012 1013
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1014
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1015 1016 1017 1018 1019
","
SET CLUSTER ''
"

"Commands (Other)","SET COLLATION","
1020 1021
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1022
","
Thomas Mueller's avatar
Thomas Mueller committed
1023 1024 1025
Sets the collation used for comparing strings.
This command can only be executed if there are no tables defined.
See ""java.text.Collator"" for details about the supported collations and the STRENGTH.
Thomas Mueller's avatar
Thomas Mueller committed
1026 1027 1028 1029

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
1030 1031 1032 1033 1034
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1035
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1036 1037 1038
","
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
1039 1040 1041 1042

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
1043 1044 1045 1046 1047 1048 1049 1050
","
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
1051 1052 1053 1054
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).
1055
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
","
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
1070 1071 1072 1073 1074
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.
1075
This setting can be appended to the database URL: ""jdbc:h2:test;DB_CLOSE_DELAY=-1""
Thomas Mueller's avatar
Thomas Mueller committed
1076 1077 1078 1079 1080 1081 1082 1083
","
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
1084 1085 1086 1087 1088
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
1089 1090 1091 1092 1093
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1094
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1095 1096 1097
","
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
1098
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1099
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1100

Thomas Mueller's avatar
Thomas Mueller committed
1101 1102 1103
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
1104
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1105 1106 1107 1108 1109
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1110
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1111
","
Thomas Mueller's avatar
Thomas Mueller committed
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
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
1122 1123 1124

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1125
","
Thomas Mueller's avatar
Thomas Mueller committed
1126
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1127 1128 1129
"

"Commands (Other)","SET IGNORECASE","
1130
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1131 1132 1133 1134 1135 1136
","
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
1137 1138 1139
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
1140 1141 1142 1143
","
SET IGNORECASE TRUE
"

1144
"Commands (Other)","SET LOG","
1145
SET LOG int
1146 1147 1148 1149
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1150
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1151 1152 1153 1154
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.

1155 1156
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
1157 1158
against power failure is required, but the data must be protected against killing the process.

1159 1160
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
1161 1162 1163 1164 1165
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.
1166
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1167 1168 1169 1170
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1171 1172 1173 1174
"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
1175
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188

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
1189 1190 1191
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
1192
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1193 1194 1195 1196 1197 1198 1199 1200
","
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
1201 1202 1203
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1204
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1205 1206 1207 1208 1209 1210 1211 1212 1213
","
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
1214
(in-place). The default max size is 1024.
Thomas Mueller's avatar
Thomas Mueller committed
1215
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1216 1217 1218 1219

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
1220 1221 1222 1223 1224 1225 1226
","
SET MAX_LENGTH_INPLACE_LOB 128
"

"Commands (Other)","SET MAX_LOG_SIZE","
SET MAX_LOG_SIZE int
","
Thomas Mueller's avatar
Thomas Mueller committed
1227 1228
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
1229
freed automatically. The default max size is 16 MB.
Thomas Mueller's avatar
Thomas Mueller committed
1230
This setting has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1231 1232 1233 1234

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
1235 1236 1237 1238 1239 1240 1241 1242
","
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
1243 1244 1245 1246 1247
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
1248
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1249 1250 1251 1252 1253 1254 1255
","
SET MAX_MEMORY_ROWS 1000
"

"Commands (Other)","SET MAX_MEMORY_UNDO","
SET MAX_MEMORY_UNDO int
","
1256
The maximum number of undo records per a session that are kept in-memory.
Thomas Mueller's avatar
Thomas Mueller committed
1257 1258
If a transaction is larger, the records are buffered to disk.
The default value is 50000.
Thomas Mueller's avatar
Thomas Mueller committed
1259
Changes to tables without a primary key can not be buffered to disk.
Thomas Mueller's avatar
Thomas Mueller committed
1260 1261 1262 1263 1264
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
1265
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1266 1267 1268 1269 1270 1271 1272 1273 1274
","
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
1275 1276 1277 1278
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
1279
It has no effect for in-memory databases.
1280
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1281 1282 1283 1284 1285
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1286
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1287 1288
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1289 1290 1291 1292 1293
Modes in the feature section.

This setting is not persistent.
Admin rights are required to execute this command.
This command commits an open transaction.
1294
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1295 1296 1297 1298 1299
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1300
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1301 1302 1303
","
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
1304 1305 1306 1307 1308 1309 1310
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.
1311
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1312 1313 1314 1315 1316
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1317
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1318 1319 1320
","
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
1321 1322 1323 1324
the tables was changed. This option is enabled by default.

Admin rights are required to execute this command.
This command commits an open transaction.
1325
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1326 1327 1328 1329 1330 1331 1332 1333 1334
","
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
1335 1336

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1337 1338 1339 1340 1341 1342 1343 1344 1345
","
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
1346 1347 1348
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
1349 1350 1351 1352 1353
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1354
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1355 1356 1357
","
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
1358 1359 1360 1361 1362
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
1363 1364 1365 1366 1367 1368 1369 1370 1371
","
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
1372 1373

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1374 1375 1376 1377 1378 1379 1380 1381 1382
","
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
1383 1384 1385
connections is PUBLIC.

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

This command does not commit a transaction, and rollback does not affect it.
1399
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1400 1401 1402 1403 1404 1405 1406 1407 1408
","
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
1409 1410 1411
disabled).

This command does not commit a transaction, and rollback does not affect it.
1412
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1413 1414 1415 1416 1417
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1418
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1419 1420 1421
","
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.
1422
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1423

Thomas Mueller's avatar
Thomas Mueller committed
1424 1425 1426
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.
1427
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
","
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
1439 1440 1441
This setting is persistent.
Admin rights are required to execute this command.
This command commits an open transaction.
1442
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
","
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
1453 1454

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1455 1456 1457 1458 1459 1460 1461 1462
","
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
1463 1464 1465 1466
This setting is persistent. The default is 500 ms.

Admin rights are required to execute this command.
This command commits an open transaction.
1467
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1468 1469 1470 1471 1472
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1473
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1474
","
1475 1476
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
1477
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1478

1479 1480
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
1481 1482 1483

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1490
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1491
","
1492
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1493 1494
"

1495 1496
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1497
","
1498
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1499
","
1500
A
Thomas Mueller's avatar
Thomas Mueller committed
1501 1502
"

1503 1504
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1505
","
1506
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1507
","
1508
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1509 1510
"

1511
"Other Grammar","Array","
1512
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1513
","
1514 1515
An array of values. An empty array is '()'. Trailing commas are ignored.
An array with one element must contain a comma to be parsed as an array.
Thomas Mueller's avatar
Thomas Mueller committed
1516
","
1517
(1, 2)
1518 1519
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1520 1521
"

1522 1523
"Other Grammar","Boolean","
TRUE | FALSE
1524
","
1525
A boolean value.
1526
","
1527
TRUE
1528 1529
"

1530 1531
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1532
","
1533
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1534
","
1535
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1536 1537
"

1538 1539 1540
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1541
","
1542 1543
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
1544
","
1545
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1546 1547
"

1548 1549 1550
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1551
","
1552 1553
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1554
","
1555 1556 1557 1558 1559 1560
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
{ AES | XTEA }
","
Thomas Mueller's avatar
Thomas Mueller committed
1561
Two algorithms are supported: AES (""AES-128"") and XTEA (using 32 rounds).
1562
XTEA is a bit faster than AES in some environments, but AES is more secure.
1563 1564
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1565 1566
"

1567
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1568 1569
columnName dataType
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1570
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1571 1572
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1573 1574
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1575
The computed column expression is evaluated and assigned whenever the row changes.
1576 1577 1578 1579 1580

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
1581 1582 1583
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);
1584 1585
"

1586 1587
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1588
","
1589 1590 1591
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
1592
","
1593
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1594 1595
"

1596 1597
"Other Grammar","Compare","
<> | <= | >= | = | < | > | !=
Thomas Mueller's avatar
Thomas Mueller committed
1598
","
1599
Comparison operator. The operator != is the same as <>.
Thomas Mueller's avatar
Thomas Mueller committed
1600
","
1601
<>
Thomas Mueller's avatar
Thomas Mueller committed
1602 1603 1604
"

"Other Grammar","Condition","
1605
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1606 1607 1608 1609 1610 1611 1612
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1613 1614
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1615
    | IS [ NOT ] [ DISTINCT FROM ] operand
1616 1617 1618 1619
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1620
","
Thomas Mueller's avatar
Thomas Mueller committed
1621
The right hand side of a condition.
1622

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

Thomas Mueller's avatar
Thomas Mueller committed
1626 1627 1628 1629 1630
When comparing with LIKE, the wildcards characters are ""_"" (any one character)
and ""%"" (any characters). The database uses an index when comparing with LIKE
except if the operand starts with a wildcard. To search for the characters ""%"" and
""_"", the characters need to be escaped. The default escape character is "" \ "" (backslash).
To select no escape character, use ""ESCAPE ''"" (empty string).
1631 1632 1633
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.
1634

Thomas Mueller's avatar
Thomas Mueller committed
1635
When comparing with REGEXP, regular expression matching is used.
1636
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1637 1638 1639 1640
","
LIKE 'Jo%'
"

1641 1642 1643 1644 1645
"Other Grammar","Constraint","
[ constraintNameDefinition ] {
    CHECK expression | UNIQUE ( columnName [,...] )
    | referentialConstraint }
    | PRIMARY KEY [ HASH ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
1646
","
Thomas Mueller's avatar
Thomas Mueller committed
1647 1648
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1649
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1650 1651
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
1652
","
1653
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1654 1655
"

1656 1657
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1658
","
1659
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1660
","
1661
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1662 1663
"

1664 1665
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1666
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1667
","
1668
Optional parameters for CSVREAD and CSVWRITE.
1669 1670
Instead of setting the options one by one, all options can be
combined into a space separated key-value pairs, as follows:
Thomas Mueller's avatar
Thomas Mueller committed
1671 1672
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1673
The following options are supported:
Thomas Mueller's avatar
Thomas Mueller committed
1674 1675 1676
""charset"", ""escape"", ""fieldDelimiter"", ""fieldSeparator"",
""lineComment"" (""#"" for H2 version 1.2, disabled for H2 version 1.3),
""lineSeparator"", ""null"", ""rowSeparator"" (not set by default).
Thomas Mueller's avatar
Thomas Mueller committed
1677
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1678 1679
A space needs to be escaped with a backslash (""'\ '"").
A backslash needs to be escaped with another backslash (""'\\'"").
Thomas Mueller's avatar
Thomas Mueller committed
1680
","
1681
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1682 1683
"

1684 1685 1686 1687 1688
"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
1689
","
1690
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1691
","
1692
INT
Thomas Mueller's avatar
Thomas Mueller committed
1693 1694
"

1695 1696
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1697
","
1698
A date literal. The limitations are the same as for the Java data type
1699
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1700
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1701
","
1702
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1703 1704
"

1705 1706
"Other Grammar","Decimal","
[ + | - ] number [ . number ]
1707
","
1708
Number with fixed precision and scale.
1709
","
1710
-1600.05
1711 1712
"

1713 1714
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1715
","
1716
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1717
","
1718
0
Thomas Mueller's avatar
Thomas Mueller committed
1719 1720
"

1721 1722
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1723
","
1724 1725 1726
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
1727
","
1728
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1729 1730
"

1731 1732
"Other Grammar","Double","
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1733
","
Thomas Mueller's avatar
Thomas Mueller committed
1734
A floating point number with high precision.
1735
The limitations are the same as for the Java data type Double.
Thomas Mueller's avatar
Thomas Mueller committed
1736
To ensure the floating point representation is used, use CAST.
Thomas Mueller's avatar
Thomas Mueller committed
1737 1738 1739
There are some special values: to represent positive infinity, use ""POWER(0, -1)"";
for negative infinity, use ""(-POWER(0, -1))""; for -0.0, use ""(-CAST(0 AS DOUBLE))"";
for ""NaN"" (not a number), use ""SQRT(-1)"".
Thomas Mueller's avatar
Thomas Mueller committed
1740
","
1741
-1.4e-10
Thomas Mueller's avatar
Thomas Mueller committed
1742
CAST(0 AS DOUBLE)
Thomas Mueller's avatar
Thomas Mueller committed
1743 1744
"

1745 1746
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1747
","
1748
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1749
","
1750
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1751 1752
"

1753
"Other Grammar","Factor","
1754
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1755
","
1756
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1757
","
1758
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1759 1760
"

1761 1762
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1763
","
1764 1765
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1766
","
1767
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1768 1769
"

1770 1771
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1772
","
1773
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1774
","
1775
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1776 1777
"

1778 1779
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1780
","
1781 1782 1783
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
1784
","
1785
NAME
Thomas Mueller's avatar
Thomas Mueller committed
1786 1787 1788
"

"Other Grammar","Int","
1789
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1790 1791 1792 1793 1794 1795 1796
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
1797
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1798 1799 1800 1801 1802 1803
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

1804 1805
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
1806
","
1807
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
1808
","
1809
TEST
Thomas Mueller's avatar
Thomas Mueller committed
1810 1811
"

1812 1813
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1814
","
1815
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
1816
","
1817
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1818 1819
"

1820 1821 1822 1823 1824 1825 1826 1827
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

1828 1829
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1830
","
1831
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
1832
","
1833
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
1834 1835
"

1836 1837
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1838
","
1839 1840 1841
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
1842
","
1843
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
1844 1845
"

1846 1847
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
1848
","
1849 1850 1851
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
1852
","
1853
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
1854 1855
"

1856 1857 1858 1859 1860
"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
1861
","
1862
Defines a referential constraint. If the table name is not specified, then the
Thomas Mueller's avatar
Thomas Mueller committed
1863 1864 1865 1866 1867 1868
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
1869
","
1870
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
1871 1872
"

Thomas Mueller's avatar
Thomas Mueller committed
1873 1874 1875 1876 1877 1878 1879 1880 1881
"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
"

1882 1883
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
1884
","
1885
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
1886
","
1887
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
1888 1889
"

1890 1891
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
1892
","
1893 1894
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
1895
","
1896
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
1897 1898
"

1899 1900
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1901
","
Thomas Mueller's avatar
Thomas Mueller committed
1902
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
1903

Thomas Mueller's avatar
Thomas Mueller committed
1904
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
1905
","
1906
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
1907 1908
"

1909 1910 1911 1912
"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
1913
","
1914 1915 1916
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
1917
","
1918
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
1919 1920
"

1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932
"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
1933
","
1934
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
1935
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
1936
","
1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
'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
1952
""java.sql.Timestamp"", but for compatibility with other databases the suggested
1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964
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
1965 1966 1967 1968 1969 1970 1971
"

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

1972
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
1973 1974 1975 1976 1977 1978 1979 1980 1981
","
INT
"

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

1982
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
1983 1984 1985 1986 1987 1988 1989 1990 1991
","
BOOLEAN
"

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

1992
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
1993 1994 1995 1996 1997 1998 1999 2000 2001
","
TINYINT
"

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

2002
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2003 2004 2005 2006 2007 2008 2009 2010 2011
","
SMALLINT
"

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

2012
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
","
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.

2024
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2025 2026 2027 2028 2029
","
IDENTITY
"

"Data Types","DECIMAL Type","
2030
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2031 2032 2033 2034
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2035
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2036 2037 2038 2039 2040
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2041
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT4 | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2042
","
Thomas Mueller's avatar
Thomas Mueller committed
2043
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2044 2045
of rounding problems.

2046
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2047 2048 2049 2050 2051 2052 2053
","
DOUBLE
"

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

2057
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2058 2059 2060 2061 2062 2063 2064
","
REAL
"

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

2067
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
2068 2069 2070 2071 2072 2073 2074
","
TIME
"

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

2077
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2078
(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
2079 2080 2081 2082 2083
","
DATE
"

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

2088
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2089 2090 2091 2092 2093
","
TIMESTAMP
"

"Data Types","BINARY Type","
2094
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2095
","
2096 2097 2098 2099 2100
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
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111

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

2116
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2117 2118 2119 2120 2121
","
OTHER
"

"Data Types","VARCHAR Type","
2122 2123
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2124
","
Thomas Mueller's avatar
Thomas Mueller committed
2125
Unicode String. Use two single quotes ('') to create a quote. The maximum precision
2126
is ""Integer.MAX_VALUE"". The precision is a size constraint; only the actual data is
2127
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
2128 2129
should be used; see there for details.

2130
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2131 2132 2133 2134 2135
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2136
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2137 2138
","
Same as VARCHAR, but not case sensitive when comparing. Stored in mixed case.
2139
The maximum precision is ""Integer.MAX_VALUE"" characters, but the whole text is kept in
2140 2141
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
2142

2143
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2144 2145 2146 2147 2148
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2149
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2150 2151 2152 2153
","
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.
2154
The maximum precision is ""Integer.MAX_VALUE"". The precision is a size constraint;
2155 2156
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
2157

2158
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2159 2160 2161 2162 2163
","
CHAR(10)
"

"Data Types","BLOB Type","
2164
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2165 2166 2167
","
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
2168
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2169 2170
Advanced / Large Objects.

2171
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2172 2173 2174 2175 2176
","
BLOB
"

"Data Types","CLOB Type","
2177
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2178 2179 2180 2181 2182
","
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
2183
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2184 2185 2186 2187 2188

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.

2189
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2190 2191 2192 2193 2194 2195 2196
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2197 2198 2199 2200
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
2201

Thomas Mueller's avatar
Thomas Mueller committed
2202
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2203 2204 2205 2206 2207 2208 2209
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
2210
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
2211

2212
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2213 2214 2215 2216 2217
","
ARRAY
"

"Functions (Aggregate)","AVG","
2218
AVG ( [ DISTINCT ] { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2219
","
2220 2221
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2222
Aggregates are only allowed in select statements.
2223
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2224 2225 2226 2227 2228
","
AVG(X)
"

"Functions (Aggregate)","BOOL_AND","
2229
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2230
","
2231 2232 2233
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
2234 2235 2236 2237 2238
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2239
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2240
","
2241 2242 2243
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
2244 2245 2246 2247 2248
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2249
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2250
","
2251 2252 2253 2254
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
2255 2256 2257 2258 2259
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2260 2261
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2262
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2263
","
2264 2265 2266 2267 2268
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
2269 2270 2271 2272 2273
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2274
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2275
","
2276 2277 2278 2279
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
2280 2281 2282 2283 2284
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2285
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2286
","
2287 2288 2289 2290
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
2291 2292 2293 2294 2295
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
2296
SUM( [ DISTINCT ] { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2297
","
2298 2299 2300 2301
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
2302 2303 2304 2305 2306
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2307
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2308
","
2309 2310 2311 2312 2313
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
2314 2315 2316 2317 2318
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
2319
STDDEV_POP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2320
","
2321 2322 2323
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
2324 2325 2326 2327 2328 2329
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
2330
STDDEV_SAMP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2331
","
2332 2333 2334
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
2335 2336 2337 2338 2339 2340
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
2341
VAR_POP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2342
","
2343 2344 2345 2346
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
2347 2348 2349 2350 2351
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
2352
VAR_SAMP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2353
","
2354 2355 2356 2357
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
2358 2359 2360 2361 2362
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
2363
ABS ( { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2364
","
2365 2366
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"".
2367
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2368 2369 2370 2371 2372
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
2373
ACOS(double)
Thomas Mueller's avatar
Thomas Mueller committed
2374
","
Thomas Mueller's avatar
Thomas Mueller committed
2375 2376
Calculate the arc cosine.
See also Java ""Math.acos"".
2377
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2378 2379 2380 2381 2382
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
2383
ASIN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2384
","
Thomas Mueller's avatar
Thomas Mueller committed
2385 2386
Calculate the arc sine.
See also Java ""Math.asin"".
2387
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2388 2389 2390 2391 2392
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
2393
ATAN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2394
","
Thomas Mueller's avatar
Thomas Mueller committed
2395 2396
Calculate the arc tangent.
See also Java ""Math.atan"".
2397
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2398 2399 2400 2401 2402
","
ATAN(D)
"

"Functions (Numeric)","COS","
2403
COS(double)
Thomas Mueller's avatar
Thomas Mueller committed
2404
","
Thomas Mueller's avatar
Thomas Mueller committed
2405 2406
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2407
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2408 2409 2410 2411
","
COS(ANGLE)
"

2412 2413 2414 2415 2416 2417 2418 2419 2420 2421
"Functions (Numeric)","COSH","
COSH(double)
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2422
"Functions (Numeric)","COT","
2423
COT(double)
Thomas Mueller's avatar
Thomas Mueller committed
2424
","
Thomas Mueller's avatar
Thomas Mueller committed
2425
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2426
See also Java ""Math.*"" functions.
2427
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2428 2429 2430 2431 2432
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
2433
SIN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2434
","
Thomas Mueller's avatar
Thomas Mueller committed
2435 2436
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2437
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2438 2439 2440 2441
","
SIN(ANGLE)
"

2442 2443 2444 2445 2446 2447 2448 2449 2450 2451
"Functions (Numeric)","SINH","
SINH(double)
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2452
"Functions (Numeric)","TAN","
2453
TAN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2454
","
Thomas Mueller's avatar
Thomas Mueller committed
2455 2456
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2457
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2458 2459 2460 2461
","
TAN(ANGLE)
"

2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
"Functions (Numeric)","TANH","
TANH(double)
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2472
"Functions (Numeric)","ATAN2","
2473
ATAN2(double, double)
Thomas Mueller's avatar
Thomas Mueller committed
2474
","
Thomas Mueller's avatar
Thomas Mueller committed
2475
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2476
See also Java ""Math.atan2"".
2477
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2478 2479 2480 2481 2482
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2483
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2484
","
2485 2486
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2487 2488 2489 2490 2491 2492
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2493
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2494
","
2495 2496
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2497 2498 2499 2500 2501 2502
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2503
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2504
","
2505 2506
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2507 2508 2509 2510 2511 2512
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2513
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2514
","
2515 2516
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2517 2518 2519 2520 2521 2522
See also Java operator %.
","
MOD(A, B)
"

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

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

"Functions (Numeric)","EXP","
2541
EXP(double)
Thomas Mueller's avatar
Thomas Mueller committed
2542
","
2543
See also Java ""Math.exp"".
2544
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2545 2546 2547 2548 2549
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
2550
FLOOR(double)
Thomas Mueller's avatar
Thomas Mueller committed
2551
","
2552
See also Java ""Math.floor"".
2553
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2554 2555 2556 2557 2558
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
2559
LOG(double)
Thomas Mueller's avatar
Thomas Mueller committed
2560
","
2561
See also Java ""Math.log"".
2562
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2563 2564 2565 2566 2567
","
LOG(A)
"

"Functions (Numeric)","LOG10","
2568
LOG10(double)
Thomas Mueller's avatar
Thomas Mueller committed
2569
","
2570
See also Java ""Math.log10"" (in Java 5).
2571
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2572 2573 2574 2575 2576
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
2577
RADIANS(double)
Thomas Mueller's avatar
Thomas Mueller committed
2578
","
2579
See also Java ""Math.toRadians"".
2580
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2581 2582 2583 2584 2585
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
2586
SQRT(double)
Thomas Mueller's avatar
Thomas Mueller committed
2587
","
2588
See also Java ""Math.sqrt"".
2589
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2590 2591 2592 2593 2594
","
SQRT(A)
"

"Functions (Numeric)","PI","
2595
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2596
","
2597
See also Java ""Math.PI"".
2598
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2599 2600 2601 2602 2603
","
PI()
"

"Functions (Numeric)","POWER","
2604
POWER(double, double)
Thomas Mueller's avatar
Thomas Mueller committed
2605
","
2606
See also Java ""Math.pow"".
2607
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2608 2609 2610 2611 2612
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2613
RAND( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2614 2615 2616
","
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
2617
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2618 2619 2620 2621 2622
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2623
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2624 2625 2626 2627 2628 2629 2630
","
Returns a new UUID with 122 pseudo random bits.
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2631
ROUND(double, digitsInt)
Thomas Mueller's avatar
Thomas Mueller committed
2632 2633
","
Rounds to a number of digits.
2634
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2635 2636 2637 2638 2639
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
2640
ROUNDMAGIC(double)
Thomas Mueller's avatar
Thomas Mueller committed
2641
","
2642 2643 2644 2645 2646 2647
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
2648 2649 2650 2651 2652
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2653
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2654 2655
","
Generates a number of cryptographically secure random numbers.
2656
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2657 2658 2659 2660 2661
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
2662
SIGN ( { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2663 2664 2665 2666 2667 2668 2669
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2670
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2671
","
2672 2673 2674 2675
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
2676 2677 2678 2679 2680
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2681
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2682
","
2683 2684 2685 2686
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
2687 2688 2689 2690 2691 2692
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2693
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2694
","
2695 2696 2697
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
2698 2699 2700 2701 2702
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
2703
TRUNCATE(double, digitsInt)
Thomas Mueller's avatar
Thomas Mueller committed
2704 2705
","
Truncates to a number of digits (to the next value closer to 0).
2706
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2707 2708 2709 2710 2711
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
2712
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
2713
","
2714 2715 2716 2717
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
2718 2719 2720 2721 2722
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
2723
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2724 2725
","
Expands data that was compressed using the COMPRESS function.
2726
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2727 2728 2729 2730 2731
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
2732
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
2733 2734 2735 2736 2737 2738 2739
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
2740
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
2741 2742
","
Returns the ASCII value of the first character in the string.
2743
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2744 2745 2746 2747
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
2748
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2749
","
2750 2751 2752
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
2753 2754 2755 2756 2757
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
2758
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2759
","
2760 2761 2762
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
2763 2764 2765 2766 2767
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
2768
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2769
","
2770 2771 2772 2773
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
2774 2775 2776 2777 2778
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
2779
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
2780 2781
","
Returns the character that represents the ASCII value.
2782
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2783 2784 2785 2786 2787
","
CHAR(65)
"

"Functions (String)","CONCAT","
2788
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
2789 2790
","
Combines strings.
2791
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2792 2793 2794 2795 2796
","
CONCAT(NAME, '!')
"

"Functions (String)","DIFFERENCE","
2797
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
2798 2799
","
Returns the difference between the sounds of two strings.
2800
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2801 2802 2803 2804 2805
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
2806
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
2807
","
2808 2809
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
2810 2811 2812 2813 2814
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
2815
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2816
","
2817 2818 2819
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
2820 2821 2822 2823 2824
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
2825
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2826
","
2827
Returns the location of a search string in a string.
2828 2829 2830
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
2831 2832 2833 2834 2835
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
2836
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
2837
","
2838 2839 2840
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
2841 2842 2843 2844 2845
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
2846
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2847 2848 2849 2850 2851 2852 2853
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
2854
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2855 2856 2857 2858 2859 2860 2861
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
2862
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2863 2864 2865 2866 2867 2868 2869
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
2870
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2871 2872 2873 2874 2875 2876 2877
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
2878
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2879
","
2880 2881 2882 2883
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
2884 2885 2886 2887 2888
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
2889
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
2890 2891 2892 2893 2894 2895 2896
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
2897
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2898
","
2899 2900 2901
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
2902 2903 2904 2905 2906
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
2907
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2908
","
2909 2910 2911
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
2912 2913 2914 2915 2916
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
2917
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2918 2919 2920 2921 2922 2923 2924
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
2925
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2926 2927 2928 2929 2930 2931 2932
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
2933
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
2934
","
2935 2936
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
2937 2938 2939 2940 2941
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
2942
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
2943
","
2944
Replaces each substring that matches a regular expression.
2945
For details, see the Java ""String.replaceAll()"" method.
2946
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
2947 2948 2949 2950 2951
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
2952
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2953 2954 2955 2956 2957 2958 2959
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
2960
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
2961
","
2962 2963
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.
2964
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
2965 2966 2967 2968 2969
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
2970
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2971
","
2972 2973 2974
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
2975 2976 2977 2978 2979
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
2980
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
2981 2982 2983 2984 2985 2986 2987
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
2988
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
2989
","
2990 2991 2992
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
2993 2994 2995 2996 2997
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
2998
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
2999
","
3000 3001 3002
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
3003 3004 3005 3006 3007
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3008
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3009 3010
","
Encodes a string to a byte array using the UTF8 encoding format.
3011
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3012 3013 3014 3015 3016
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3017
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3018
","
3019 3020
Returns a substring of a string starting at a position.
The length is optional.
3021
Also supported is: ""SUBSTRING(string FROM start [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3022 3023 3024 3025 3026
","
SUBSTR(NAME, 1)
"

"Functions (String)","UTF8TOSTRING","
3027
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3028 3029 3030 3031 3032 3033 3034
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3035
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3036
","
3037
Creates an XML attribute element of the form ""name=value"".
3038 3039
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3040 3041 3042 3043 3044
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3045
XMLNODE(elementString [, attributesString [, contentString]])
Thomas Mueller's avatar
Thomas Mueller committed
3046 3047
","
Create an XML node element.
3048
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3049 3050 3051 3052 3053
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3054
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3055
","
3056
Creates an XML comment.
3057
Two dashes (""--"") are converted to ""- -"".
3058
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3059 3060 3061 3062 3063
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3064
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3065
","
3066
Creates an XML CDATA element.
3067
If the value contains ""]]>"", an XML text element is created instead.
3068
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3069 3070 3071 3072 3073
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3074
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3075
","
3076
The string ""<?xml version='1.0'?>"" is returned.
Thomas Mueller's avatar
Thomas Mueller committed
3077 3078 3079 3080 3081
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3082
XMLTEXT(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3083 3084
","
Creates an XML text element.
3085
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3086 3087 3088 3089 3090
","
CALL XMLTEXT('test')
"

"Functions (Time and Date)","CURRENT_DATE","
3091
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3092 3093 3094 3095 3096 3097 3098
","
Returns the current date.
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3099
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3100 3101 3102 3103 3104 3105 3106
","
Returns the current time.
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3107
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3108
","
3109 3110
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
Thomas Mueller's avatar
Thomas Mueller committed
3111 3112 3113 3114 3115
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3116
DATEADD(unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3117
","
3118 3119 3120 3121
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
3122 3123 3124 3125 3126
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3127
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3128
","
Thomas Mueller's avatar
Thomas Mueller committed
3129
Returns the the number of crossed unit boundaries between two timestamps.
3130 3131
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3132
The same units as in the EXTRACT function are supported.
3133
TIMESTAMPDIFF is supported for MySQL compatibility.
Thomas Mueller's avatar
Thomas Mueller committed
3134 3135 3136 3137 3138
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3139
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3140 3141 3142 3143 3144 3145 3146
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3147
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3148 3149 3150 3151 3152 3153 3154
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3155
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3156 3157 3158 3159 3160 3161 3162
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3163
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3164 3165 3166 3167 3168 3169 3170
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3171 3172
EXTRACT ( { YEAR | YY | MONTH | MM | DAY | DD | DAY_OF_YEAR
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3173
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3174 3175
","
Returns a specific value from a timestamps.
3176
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3177 3178 3179 3180 3181
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3182
FORMATDATETIME ( timestamp, formatString
3183
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3184
","
3185 3186 3187
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.
3188
For details of the format, see ""java.text.SimpleDateFormat"".
3189
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3190 3191 3192 3193 3194 3195
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3196
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3197 3198 3199 3200 3201 3202 3203
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3204
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3205 3206 3207 3208 3209 3210 3211
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3212
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3213 3214 3215 3216 3217 3218 3219
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3220
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3221 3222 3223 3224 3225 3226 3227
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3228
PARSEDATETIME(string, formatString
3229
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3230
","
3231 3232 3233
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.
3234
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3235 3236 3237 3238 3239 3240
","
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","
3241
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3242 3243 3244 3245 3246 3247 3248
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3249
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3250 3251 3252 3253 3254 3255 3256
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3257
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3258
","
3259 3260
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3261 3262 3263 3264 3265
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3266
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3267 3268 3269 3270 3271 3272 3273
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3274
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3275 3276
","
Returns one element of an array.
3277
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3278 3279 3280 3281 3282
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
3283
ARRAY_GET(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3284 3285 3286 3287 3288 3289 3290
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

"Functions (System)","AUTOCOMMIT","
3291
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3292 3293 3294 3295 3296 3297 3298
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3299
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3300
","
3301 3302 3303
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
3304 3305

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3306 3307 3308 3309 3310
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3311
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3312 3313
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3314
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3315 3316 3317 3318 3319
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3320
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3321
","
3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333
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
3334 3335 3336
"

"Functions (System)","COALESCE","
3337
COALESCE(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3338 3339 3340 3341 3342 3343 3344
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3345
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3346 3347 3348 3349 3350 3351 3352
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3353
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3354
","
3355 3356 3357 3358 3359
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
3360 3361 3362 3363 3364
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3365
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3366
","
3367 3368
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
3369 3370

If the column names are specified (a list of column names separated with the
3371
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3372 3373 3374 3375 3376
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
3377 3378 3379 3380 3381

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.

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3390 3391 3392 3393 3394 3395 3396 3397 3398
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');
3399
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3400 3401 3402
"

"Functions (System)","CSVWRITE","
3403
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3404
","
3405
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3406
If only a file name is specified, it will be written to the current working directory.
3407
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3408
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
3409 3410 3411 3412 3413

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

Thomas Mueller's avatar
Thomas Mueller committed
3416 3417
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3418 3419 3420 3421 3422 3423 3424
","
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","
3425
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3426 3427 3428 3429 3430 3431 3432
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3433
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3434 3435 3436 3437 3438 3439 3440 3441
","
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","
3442
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3443 3444 3445 3446
","
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
3447
default character set for this system.
3448 3449 3450 3451

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

Thomas Mueller's avatar
Thomas Mueller committed
3452
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3453 3454 3455 3456 3457 3458
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

"Functions (System)","GREATEST","
3459
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3460 3461 3462 3463 3464 3465 3466
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3467
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3468 3469
","
Returns the last inserted identity value for this session.
3470
This value changes whenever a new sequence number was generated,
3471
even within a trigger or Java function. See also SCOPE_IDENTITY.
3472
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3473 3474 3475 3476 3477
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3478
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3479 3480 3481 3482 3483 3484 3485
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3486
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3487 3488 3489 3490 3491 3492 3493
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3494
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3495 3496
","
Returns the current lock mode. See SET LOCK_MODE.
3497
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3498 3499 3500 3501 3502
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3503
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3504 3505 3506 3507 3508 3509 3510 3511
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3512
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3513
","
3514 3515 3516 3517 3518
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
3519
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3520 3521 3522 3523 3524
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3525
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3526
","
Thomas Mueller's avatar
Thomas Mueller committed
3527
Returns the free memory in KB (where 1024 bytes is a KB).
3528
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3529 3530
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3531 3532 3533 3534 3535
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3536
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3537
","
Thomas Mueller's avatar
Thomas Mueller committed
3538
Returns the used memory in KB (where 1024 bytes is a KB).
3539
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3540 3541
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3542 3543 3544 3545 3546
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3547
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3548
","
3549 3550 3551 3552
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
3553 3554 3555 3556 3557
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3558
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3559 3560 3561 3562 3563 3564 3565
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

"Functions (System)","READONLY","
3566
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3567 3568 3569 3570 3571 3572 3573
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
3574
ROWNUM()
Thomas Mueller's avatar
Thomas Mueller committed
3575
","
3576 3577 3578
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.
3579 3580
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).
3581
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3582
","
3583 3584
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3585
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3586 3587 3588
"

"Functions (System)","SCHEMA","
3589
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3590 3591 3592 3593 3594 3595
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3596 3597 3598 3599 3600 3601 3602 3603 3604 3605
"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
3606
"Functions (System)","SESSION_ID","
3607
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3608
","
3609 3610 3611 3612
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
3613 3614 3615 3616 3617
","
CALL SESSION_ID()
"

"Functions (System)","SET","
3618
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
3619
","
3620 3621 3622
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
3623
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
3624 3625 3626 3627 3628
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
3629
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
3630 3631 3632 3633 3634 3635 3636
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
3637
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3638
","
3639 3640
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
3641
Otherwise a value of the following form is returned:
3642
""logFileId-position-sessionId"".
3643 3644
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
3645 3646 3647 3648
","
CALL TRANSACTION_ID()
"

3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660
"Functions (System)","TRUNCATE_VALUE","
TRUNCATE_VALUE(value, precisionInt, forceBoolean)
","
Truncate a value to the required precision.
The precision of the returned value may be a bit larger than requested,
because fixed precision values are not truncated (unlike the numeric TRUNCATE method).
Unlike CAST, the truncating a decimal value may lose precision if the force flag is set to true.
The method returns a value with the same data type as the first parameter.
","
CALL TRUNCATE_VALUE(X, 10, TRUE);
"

Thomas Mueller's avatar
Thomas Mueller committed
3661
"Functions (System)","USER","
3662
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

"System Tables","Information Schema","
INFORMATION_SCHEMA
","
To get the list of system tables, execute the statement SELECT * FROM
INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = 'INFORMATION_SCHEMA'
","

"
"System Tables","Range Table","
SYSTEM_RANGE(start, end)
","
Contains all values from start to end (this is a dynamic table).
","
SYSTEM_RANGE(0, 100)
"
Thomas Mueller's avatar
Thomas Mueller committed
3684