help.csv 122.3 KB
Newer Older
1 2
# Copyright 2004-2014 H2 Group. Multiple-Licensed under the MPL 2.0,
# and the EPL 1.0 (http://h2database.com/html/license.html).
Thomas Mueller's avatar
Thomas Mueller committed
3 4 5
# Initial Developer: H2 Group
"SECTION","TOPIC","SYNTAX","TEXT","EXAMPLE"
"Commands (DML)","SELECT","
6 7 8 9
SELECT [ TOP term ] [ DISTINCT | ALL ] selectExpression [,...]
FROM tableExpression [,...] [ WHERE expression ]
[ GROUP BY expression [,...] ] [ HAVING expression ]
[ { UNION [ ALL ] | MINUS | EXCEPT | INTERSECT } select ] [ ORDER BY order [,...] ]
Thomas Mueller Graf's avatar
Thomas Mueller Graf committed
10
[ [ LIMIT expression ] [ OFFSET expression ] [ SAMPLE_SIZE rowCountInt ] ]
11
[ FOR UPDATE ]
Thomas Mueller's avatar
Thomas Mueller committed
12 13
","
Selects data from a table or multiple tables.
14 15 16 17
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
18

19
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
20
OFFSET specified how many rows to skip.
21
Please note using high offset values should be avoided because it can cause performance problems.
22
SAMPLE_SIZE limits the number of rows read for aggregate queries.
23

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

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

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

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

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

"Commands (DML)","UPDATE","
60 61 62
UPDATE tableName [ [ AS ] newTableAlias ] SET
{ { columnName = { DEFAULT | expression } } [,...] } |
    { ( columnName [,...] ) = ( select ) }
63
[ WHERE expression ] [ ORDER BY order [,...] ] [ LIMIT expression ]
Thomas Mueller's avatar
Thomas Mueller committed
64 65
","
Updates data in a table.
66
ORDER BY is supported for MySQL compatibility, but it is ignored.
Thomas Mueller's avatar
Thomas Mueller committed
67
","
68 69
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
70 71 72
"

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

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

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

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

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

134
Instead of a file name, an URL may be used.
135
To read a stream from the classpath, use the prefix 'classpath:'.
136
See the Pluggable File System section on the Advanced page.
137

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

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

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

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

167
If no 'TO fileName' clause is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
168 169 170 171
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.

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

Thomas Mueller's avatar
Thomas Mueller committed
176 177 178
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
179
Admin rights are required to execute this command.
180

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

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

"Commands (DDL)","ALTER INDEX RENAME","
196
ALTER INDEX [ IF EXISTS ] indexName RENAME TO newIndexName
Thomas Mueller's avatar
Thomas Mueller committed
197
","
Thomas Mueller's avatar
Thomas Mueller committed
198
Renames an index.
Thomas Mueller's avatar
Thomas Mueller committed
199
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
200 201 202 203
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

204
"Commands (DDL)","ALTER SCHEMA RENAME","
205
ALTER SCHEMA [ IF EXISTS ] schema RENAME TO newSchemaName
206 207
","
Renames a schema.
Thomas Mueller's avatar
Thomas Mueller committed
208
This command commits an open transaction in this connection.
209 210 211 212
","
ALTER SCHEMA TEST RENAME TO PRODUCTION
"

Thomas Mueller's avatar
Thomas Mueller committed
213
"Commands (DDL)","ALTER SEQUENCE","
214
ALTER SEQUENCE [ IF EXISTS ] sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
215 216 217 218
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
[ CYCLE long | NOCYCLE |  NO CYCLE ]
[ CACHE long |  NOCACHE |  NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
219
","
220
Changes the parameters of a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
221
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
222 223 224 225 226 227
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

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

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
239
ALTER TABLE [ IF EXISTS ] tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
240 241 242
","
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
243
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
244
It is not possible to disable checking for unique constraints.
Thomas Mueller's avatar
Thomas Mueller committed
245
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
246 247 248 249
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

250
"Commands (DDL)","ALTER TABLE RENAME CONSTRAINT","
251
ALTER TABLE [ IF EXISTS ] tableName RENAME oldConstraintName TO newConstraintName
252 253 254 255 256 257 258
","
Renames a constraint.
This command commits an open transaction in this connection.
","
ALTER TABLE TEST RENAME CONSTRAINT FOO TO BAR
"

259
"Commands (DDL)","ALTER TABLE ALTER COLUMN","
260
ALTER TABLE [ IF EXISTS ] tableName ALTER COLUMN columnName
261 262 263 264 265 266 267
{ { 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
268
","
269 270
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
271

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

274 275 276
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
277

278 279 280 281
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
282

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

285
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
286
Single column indexes on this column are dropped.
287 288 289

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

Thomas Mueller's avatar
Thomas Mueller committed
290
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
291
","
292 293 294 295 296 297 298
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
299 300 301
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
302
ALTER TABLE [ IF EXISTS ] tableName DROP COLUMN [ IF EXISTS ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
303
","
304
Removes column(s) from a table.
Thomas Mueller's avatar
Thomas Mueller committed
305
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
306 307
","
ALTER TABLE TEST DROP COLUMN NAME
308
ALTER TABLE TEST DROP COLUMN NAME1, NAME2
Thomas Mueller's avatar
Thomas Mueller committed
309 310 311
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
312
ALTER TABLE [ IF EXISTS ] tableName DROP { CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
313 314
","
Removes a constraint or a primary key from a table.
Thomas Mueller's avatar
Thomas Mueller committed
315
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
316 317 318 319 320
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
321
ALTER TABLE [ IF EXISTS ] tableName SET REFERENTIAL_INTEGRITY
322
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
323 324 325 326 327 328
","
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.
329

Thomas Mueller's avatar
Thomas Mueller committed
330
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
331 332 333 334 335
","
ALTER TABLE TEST SET REFERENTIAL_INTEGRITY FALSE
"

"Commands (DDL)","ALTER TABLE RENAME","
336
ALTER TABLE [ IF EXISTS ] tableName RENAME TO newName
Thomas Mueller's avatar
Thomas Mueller committed
337
","
Thomas Mueller's avatar
Thomas Mueller committed
338
Renames a table.
Thomas Mueller's avatar
Thomas Mueller committed
339
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
340 341 342 343 344
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
345
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
346
","
Thomas Mueller's avatar
Thomas Mueller committed
347 348 349 350
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.
Thomas Mueller's avatar
Thomas Mueller committed
351
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
352 353 354 355 356 357 358
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
359 360 361 362
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
363
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
364
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
365 366 367 368 369
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
370
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
371
","
Thomas Mueller's avatar
Thomas Mueller committed
372 373 374 375 376 377
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.
Thomas Mueller's avatar
Thomas Mueller committed
378
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
379 380 381 382 383
","
ALTER USER SA SET PASSWORD 'rioyxlgt'
"

"Commands (DDL)","ALTER VIEW","
384
ALTER VIEW [ IF EXISTS ] viewName RECOMPILE
Thomas Mueller's avatar
Thomas Mueller committed
385 386
","
Recompiles a view after the underlying tables have been changed or created.
Thomas Mueller's avatar
Thomas Mueller committed
387
This command is used for views created using CREATE FORCE VIEW.
Thomas Mueller's avatar
Thomas Mueller committed
388
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
389 390 391 392 393
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
394
ANALYZE [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
395 396 397 398 399 400 401
","
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.
402

Thomas Mueller's avatar
Thomas Mueller committed
403
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
404 405 406 407 408
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
409 410 411 412 413
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
414
","
Thomas Mueller's avatar
Thomas Mueller committed
415 416 417
Sets the comment of a database object. Use NULL to remove the comment.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
418
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
419 420 421 422 423
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
424
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
425 426 427
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
428
""org.h2.api.AggregateFunction"".
Thomas Mueller's avatar
Thomas Mueller committed
429 430

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
431
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
432 433 434 435 436
","
CREATE AGGREGATE MEDIAN FOR ""com.acme.db.Median""
"

"Commands (DDL)","CREATE ALIAS","
Thomas Mueller's avatar
Thomas Mueller committed
437
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
Thomas Mueller's avatar
Thomas Mueller committed
438
[ NOBUFFER ] { FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
439
","
440 441 442 443 444 445
Creates a new function alias. If this is a ResultSet returning function,
by default the return value is cached in a local temporary file.

NOBUFFER - disables caching of ResultSet return value to temporary file.

DETERMINISTIC - Deterministic functions must always return the same value for the same parameters.
446 447 448

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

454 455
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.
456 457
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
458 459
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
460

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

464
If the first parameter of the Java function is a ""java.sql.Connection"", then a
Thomas Mueller's avatar
Thomas Mueller committed
465 466 467
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.
468

Thomas Mueller's avatar
Thomas Mueller committed
469
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
470
This command commits an open transaction in this connection.
471 472

If you have the Groovy jar in your classpath, it is also possible to write methods using Groovy.
Thomas Mueller's avatar
Thomas Mueller committed
473 474 475 476 477
","
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');
478 479
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
480 481 482 483 484
CREATE ALIAS tr AS $$@groovy.transform.CompileStatic
    static String tr(String str, String sourceSet, String replacementSet){
        return str.tr(sourceSet, replacementSet);
    }
$$
Thomas Mueller's avatar
Thomas Mueller committed
485 486 487
"

"Commands (DDL)","CREATE CONSTANT","
488
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
489
","
Thomas Mueller's avatar
Thomas Mueller committed
490
Creates a new constant.
Thomas Mueller's avatar
Thomas Mueller committed
491
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
492 493 494 495 496
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
497 498 499
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
500 501
","
Creates a new data type (domain). The check condition must evaluate to true or
Thomas Mueller's avatar
Thomas Mueller committed
502
to NULL (to prevent NULL, use ""NOT NULL""). In the condition, the term VALUE refers
Thomas Mueller's avatar
Thomas Mueller committed
503
to the value being tested.
504

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

Thomas Mueller's avatar
Thomas Mueller committed
507
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
508 509 510 511 512
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
513
CREATE
Thomas Mueller's avatar
Thomas Mueller committed
514
{ [ UNIQUE ] [ HASH | SPATIAL] INDEX [ [ IF NOT EXISTS ] newIndexName ]
515 516
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
517
","
Thomas Mueller's avatar
Thomas Mueller committed
518
Creates a new index.
Thomas Mueller's avatar
Thomas Mueller committed
519
This command commits an open transaction in this connection.
520

Thomas Mueller's avatar
Thomas Mueller committed
521
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
522 523
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
524
Non-unique keys are supported.
525
Spatial indexes are supported only on Geometry columns.
Thomas Mueller's avatar
Thomas Mueller committed
526 527 528 529 530
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
531
CREATE [ FORCE ] [ [ GLOBAL | LOCAL ] TEMPORARY ]
Thomas Mueller's avatar
Thomas Mueller committed
532
LINKED TABLE [ IF NOT EXISTS ]
533 534
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
535 536 537 538 539
","
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.

540 541 542
FORCE - Create the LINKED TABLE even if the remote database/table does not exist.

EMIT UPDATES - Usually, for update statements, the old rows are deleted first and then the new
Thomas Mueller's avatar
Thomas Mueller committed
543 544
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
545
work. Linked tables to the same database share one connection.
546

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

Thomas Mueller's avatar
Thomas Mueller committed
549 550 551
If the connection to the source database is lost, the connection is re-opened
(this is a workaround for MySQL that disconnects after 8 hours of inactivity by default).

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

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

Thomas Mueller's avatar
Thomas Mueller committed
559
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
560
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
561 562 563 564 565 566 567 568 569
","
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","
570
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
571
","
Thomas Mueller's avatar
Thomas Mueller committed
572
Creates a new role.
Thomas Mueller's avatar
Thomas Mueller committed
573
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
574 575 576 577 578
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
579
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
Thomas Mueller's avatar
Thomas Mueller committed
580 581 582
","
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
583
Specifying the owner currently has no effect.
584

Thomas Mueller's avatar
Thomas Mueller committed
585
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
586 587 588 589 590
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
591
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
592 593 594 595 596
[ INCREMENT BY long ]
[ MINVALUE long | NOMINVALUE | NO MINVALUE ]
[ MAXVALUE long | NOMAXVALUE | NO MAXVALUE ]
[ CYCLE long | NOCYCLE |  NO CYCLE ]
[ CACHE long |  NOCACHE |  NO CACHE ]
Thomas Mueller's avatar
Thomas Mueller committed
597
","
Thomas Mueller's avatar
Thomas Mueller committed
598 599 600
Creates a new sequence.
The data type of a sequence is BIGINT.
Used values are never re-used, even when the transaction is rolled back.
Thomas Mueller's avatar
Thomas Mueller committed
601 602 603 604 605

The cache is the number of pre-allocated numbers.
If the system crashes without closing the database, at most this many numbers are lost.
The default cache size is 32.
To disable caching, use the cache size 1 or lower.
Thomas Mueller's avatar
Thomas Mueller committed
606

Thomas Mueller's avatar
Thomas Mueller committed
607
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
608 609 610 611 612
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
613 614
CREATE [ CACHED | MEMORY ] [ TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
TABLE [ IF NOT EXISTS ] name
615
[ ( { columnDefinition | constraint } [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
616
[ ENGINE tableEngineName [ WITH tableEngineParamName [,...] ] ]
617
[ NOT PERSISTENT ] [ TRANSACTIONAL ]
618
[ AS select ]","
Thomas Mueller's avatar
Thomas Mueller committed
619 620
Creates a new table.

Thomas Mueller's avatar
Thomas Mueller committed
621 622 623 624
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
625
that means memory tables should not get too large.
626

Thomas Mueller's avatar
Thomas Mueller committed
627 628 629 630 631
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,
632
unless the temporary table is created using CREATE CACHED TABLE.
Thomas Mueller's avatar
Thomas Mueller committed
633

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

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

641 642 643
The column definition is optional if a query is specified.
In that case the column list of the query is used.

Thomas Mueller's avatar
Thomas Mueller committed
644 645
This command commits an open transaction, except when using
TRANSACTIONAL (only supported for temporary tables).
Thomas Mueller's avatar
Thomas Mueller committed
646 647 648 649 650
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
651
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
652
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
653
[ QUEUE int ] [ NOWAIT ] { CALL triggeredClassName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
654
","
Thomas Mueller's avatar
Thomas Mueller committed
655 656 657 658 659
Creates a new trigger.
The trigger class must be public and implement ""org.h2.api.Trigger"".
Inner classes are not supported.
The class must be available in the classpath of the database engine
(when using the server mode, it must be in the classpath of the server).
660

661 662 663
The sourceCodeString must define a single method with no parameters that returns ""org.h2.api.Trigger"".
See CREATE ALIAS for requirements regarding the compilation.

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

Thomas Mueller's avatar
Thomas Mueller committed
669
ROLLBACK can be specified in combination with INSERT, UPDATE, and DELETE.
670
Only row based AFTER trigger can be called on ROLLBACK.
671
Exceptions that occur within such triggers are ignored.
672 673
As the operations that occur within a trigger are part of the transaction,
ROLLBACK triggers are only required if an operation communicates outside of the database.
674

675
INSTEAD OF triggers are implicitly row based and behave like BEFORE triggers.
676
Only the first such trigger is called. Such triggers on views are supported.
677
They can be used to make views updatable.
678

Thomas Mueller's avatar
Thomas Mueller committed
679 680
A BEFORE SELECT trigger is fired just before the database engine tries to read from the table.
The trigger can be used to update a table on demand.
681 682
The trigger is called with both 'old' and 'new' set to null.

683 684 685 686
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
687 688
Committing or rolling back a transaction within a trigger is not allowed, except for SELECT triggers.

Thomas Mueller's avatar
Thomas Mueller committed
689 690 691
By default a trigger is called once for each statement, without the old and new rows.
FOR EACH ROW triggers are called once for each inserted, updated, or deleted row.

692 693
QUEUE is implemented for syntax compatibility with HSQL and has no effect.

Thomas Mueller's avatar
Thomas Mueller committed
694 695
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.
696

Thomas Mueller's avatar
Thomas Mueller committed
697
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
698
","
699
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger"";
Thomas Mueller's avatar
Thomas Mueller committed
700
CREATE TRIGGER TRIG_SRC BEFORE INSERT ON TEST AS $$org.h2.api.Trigger create() { return new MyTrigger(""constructorParam""); } $$;
Thomas Mueller's avatar
Thomas Mueller committed
701 702
"
"Commands (DDL)","CREATE USER","
703 704
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
705
","
Thomas Mueller's avatar
Thomas Mueller committed
706 707 708
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.
709

Thomas Mueller's avatar
Thomas Mueller committed
710
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
711
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
712 713 714 715 716
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
Thomas Mueller's avatar
Thomas Mueller committed
717
CREATE [ OR REPLACE ] [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
718
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
719 720
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
721
if the underlying table(s) don't exist.
722

Thomas Mueller's avatar
Thomas Mueller committed
723 724 725 726 727
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.

728 729
Views are not updatable except when using 'instead of' triggers.

Thomas Mueller's avatar
Thomas Mueller committed
730
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
731
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
732 733 734 735 736
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
737
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
738
","
Thomas Mueller's avatar
Thomas Mueller committed
739 740 741
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
742
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
743
","
Thomas Mueller's avatar
Thomas Mueller committed
744
DROP AGGREGATE MEDIAN
Thomas Mueller's avatar
Thomas Mueller committed
745 746 747
"

"Commands (DDL)","DROP ALIAS","
748
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
749
","
Thomas Mueller's avatar
Thomas Mueller committed
750 751 752
Drops an existing function alias.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
753
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
754
","
Thomas Mueller's avatar
Thomas Mueller committed
755
DROP ALIAS MY_SQRT
Thomas Mueller's avatar
Thomas Mueller committed
756 757 758
"

"Commands (DDL)","DROP ALL OBJECTS","
759
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
760 761 762 763 764
","
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
765 766 767
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
768 769 770 771 772
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
773
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
774
","
Thomas Mueller's avatar
Thomas Mueller committed
775
Drops a constant.
Thomas Mueller's avatar
Thomas Mueller committed
776
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
777 778 779 780 781
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
782
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
783
","
Thomas Mueller's avatar
Thomas Mueller committed
784
Drops a data type (domain).
Thomas Mueller's avatar
Thomas Mueller committed
785
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
786 787 788 789 790
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
791
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
792
","
Thomas Mueller's avatar
Thomas Mueller committed
793
Drops an index.
Thomas Mueller's avatar
Thomas Mueller committed
794
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
795 796 797 798 799
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
800
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
801
","
Thomas Mueller's avatar
Thomas Mueller committed
802
Drops a role.
Thomas Mueller's avatar
Thomas Mueller committed
803
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
804 805 806 807 808
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
809
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
810
","
Thomas Mueller's avatar
Thomas Mueller committed
811
Drops a schema.
Thomas Mueller's avatar
Thomas Mueller committed
812
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
813 814 815 816 817
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
818
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
819
","
Thomas Mueller's avatar
Thomas Mueller committed
820
Drops a sequence.
Thomas Mueller's avatar
Thomas Mueller committed
821
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
822 823 824 825 826
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
Thomas Mueller's avatar
Thomas Mueller committed
827
DROP TABLE [ IF EXISTS ] tableName [,...] [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
828
","
Thomas Mueller's avatar
Thomas Mueller committed
829
Drops an existing table, or a list of tables.
Thomas Mueller's avatar
Thomas Mueller committed
830 831
The command will fail if dependent views exist and the RESTRICT clause is used (the default).
All dependent views are dropped as well if the CASCADE clause is used.
Thomas Mueller's avatar
Thomas Mueller committed
832
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
833 834 835 836 837
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
838
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
839
","
Thomas Mueller's avatar
Thomas Mueller committed
840
Drops an existing trigger.
Thomas Mueller's avatar
Thomas Mueller committed
841
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
842 843 844 845 846
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
847
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
848
","
Thomas Mueller's avatar
Thomas Mueller committed
849 850
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
851

Thomas Mueller's avatar
Thomas Mueller committed
852
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
853
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
854 855 856 857 858
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
859
DROP VIEW [ IF EXISTS ] viewName [ RESTRICT | CASCADE ]
Thomas Mueller's avatar
Thomas Mueller committed
860
","
Thomas Mueller's avatar
Thomas Mueller committed
861 862 863
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
864
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
865 866 867 868 869 870 871
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
872 873 874 875 876
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).
877
Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
878

Thomas Mueller's avatar
Thomas Mueller committed
879
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
880 881 882 883 884 885 886
","
TRUNCATE TABLE TEST
"

"Commands (Other)","CHECKPOINT","
CHECKPOINT
","
Thomas Mueller's avatar
Thomas Mueller committed
887
Flushes the data to disk.
Thomas Mueller's avatar
Thomas Mueller committed
888 889

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
890 891 892 893 894 895 896
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
897
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
898 899 900
to the underlying device.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
901 902 903 904 905
","
CHECKPOINT SYNC
"

"Commands (Other)","COMMIT","
906
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
907 908 909 910 911 912 913 914 915
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
916 917 918 919
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
920 921 922 923 924
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
925
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
926 927
{ { SCHEMA schemaName } | { tableName [,...] } }
TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
928
","
Thomas Mueller's avatar
Thomas Mueller committed
929 930 931
Grants rights for a table to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
932
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
933 934 935 936
","
GRANT SELECT ON TEST TO READONLY
"

937 938 939 940 941 942
"Commands (Other)","GRANT ALTER ANY SCHEMA","
GRANT ALTER ANY SCHEMA TO userName
","
Grant schema altering rights to a user.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
943
This command commits an open transaction in this connection.
944 945 946 947
","
GRANT ALTER ANY SCHEMA TO Bob
"

Thomas Mueller's avatar
Thomas Mueller committed
948
"Commands (Other)","GRANT ROLE","
949
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
950
","
Thomas Mueller's avatar
Thomas Mueller committed
951 952 953
Grants a role to a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
954
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
955 956 957 958 959
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
960
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
961 962 963 964 965 966 967 968 969
","
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
970 971
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
972 973 974 975 976
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
977
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
978 979
{ { SCHEMA schemaName } | { tableName [,...] } }
FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
980
","
Thomas Mueller's avatar
Thomas Mueller committed
981 982 983
Removes rights for a table from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
984
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
985 986 987 988 989
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
990
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
991
","
Thomas Mueller's avatar
Thomas Mueller committed
992 993 994
Removes a role from a user or role.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
995
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
996 997 998 999 1000
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
1001
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
","
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
1012 1013 1014 1015
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
1016 1017 1018 1019 1020 1021 1022
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
1023 1024
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
1025 1026 1027 1028 1029
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
1030
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
1031
","
Thomas Mueller's avatar
Thomas Mueller committed
1032
Updates a user-defined variable.
Thomas Mueller's avatar
Thomas Mueller committed
1033
Variables are not persisted and session scoped, that means only visible from within the session in which they are defined.
Thomas Mueller's avatar
Thomas Mueller committed
1034
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
1035 1036 1037 1038 1039
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
1040
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
","
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
1051 1052
See also CREATE CONSTANT.

Thomas Mueller's avatar
Thomas Mueller committed
1053
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1054
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1055
This setting is persistent.
1056
This setting can be appended to the database URL: ""jdbc:h2:test;ALLOW_LITERALS=NONE""
Thomas Mueller's avatar
Thomas Mueller committed
1057 1058 1059 1060 1061
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
1062
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
1063 1064
","
Switches auto commit on or off.
1065
This setting can be appended to the database URL: ""jdbc:h2:test;AUTOCOMMIT=OFF"" -
1066
however this will not work as expected when using a connection pool
1067 1068
(the connection pool manager will re-enable autocommit when returning
the connection to the pool, so autocommit will only be disabled the first
1069
time the connection is used.
Thomas Mueller's avatar
Thomas Mueller committed
1070 1071 1072 1073 1074 1075 1076
","
SET AUTOCOMMIT OFF
"

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
1077
Sets the size of the cache in KB (each KB being 1024 bytes) for the current database.
1078 1079
The default is 65536 per available GB of RAM, i.e. 64 MB per GB.
The value is rounded to the next higher power of two.
Thomas Mueller's avatar
Thomas Mueller committed
1080 1081
Depending on the virtual machine, the actual memory required may be higher.

Thomas Mueller's avatar
Thomas Mueller committed
1082
This setting is persistent and affects all connections as there is only one cache per database.
Thomas Mueller's avatar
Thomas Mueller committed
1083
Using a very small value (specially 0) will reduce performance a lot.
Thomas Mueller's avatar
Thomas Mueller committed
1084 1085
This setting only affects the database engine (the server in a client/server environment;
in embedded mode, the database engine is in the same process as the application).
Thomas Mueller's avatar
Thomas Mueller committed
1086
It has no effect for in-memory databases.
1087

Thomas Mueller's avatar
Thomas Mueller committed
1088
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1089
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1090
This setting is persistent.
1091
This setting can be appended to the database URL: ""jdbc:h2:test;CACHE_SIZE=8192""
Thomas Mueller's avatar
Thomas Mueller committed
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
","
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
1104 1105
server is not responding).

Thomas Mueller's avatar
Thomas Mueller committed
1106
This command is effective immediately, but does not commit an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1107 1108 1109 1110
","
SET CLUSTER ''
"

1111 1112 1113 1114
"Commands (Other)","SET BINARY_COLLATION","
SET BINARY_COLLATION
{ UNSIGNED | SIGNED } ] }
","
Thomas Mueller's avatar
Thomas Mueller committed
1115 1116
Sets the collation used for comparing BINARY columns, the default is SIGNED
for version 1.3 and older, and UNSIGNED for version 1.4 and newer.
1117 1118 1119
This command can only be executed if there are no tables defined.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1120
This command commits an open transaction in this connection.
1121 1122 1123 1124 1125
This setting is persistent.
","
SET BINARY_COLLATION SIGNED
"

Thomas Mueller's avatar
Thomas Mueller committed
1126
"Commands (Other)","SET COLLATION","
1127 1128
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
1129
","
Thomas Mueller's avatar
Thomas Mueller committed
1130 1131
Sets the collation used for comparing strings.
This command can only be executed if there are no tables defined.
Thomas Mueller's avatar
Thomas Mueller committed
1132 1133
See ""java.text.Collator"" for details about the supported collations and the STRENGTH
(PRIMARY is usually case- and umlaut-insensitive; SECONDARY is case-insensitive but umlaut-sensitive;
Thomas Mueller's avatar
Thomas Mueller committed
1134
TERTIARY is both case- and umlaut-sensitive; IDENTICAL is sensitive to all differences and only affects ordering).
Thomas Mueller's avatar
Thomas Mueller committed
1135

1136 1137 1138 1139 1140 1141
The ICU4J collator is used if it is in the classpath.
It is also used if the collation name starts with ICU4J_
(in that case, the ICU4J must be in the classpath, otherwise an exception is thrown).
The default collator is used if the collation name starts with DEFAULT_
(even if ICU4J is in the classpath).

Thomas Mueller's avatar
Thomas Mueller committed
1142
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1143
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1144
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1145 1146 1147 1148 1149
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
1150
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
1151
","
Thomas Mueller's avatar
Thomas Mueller committed
1152 1153 1154 1155
This feature is only available for the PageStore storage engine.
For the MVStore engine (the default for H2 version 1.4.x),
append "";COMPRESS=TRUE"" to the database URL instead.

Thomas Mueller's avatar
Thomas Mueller committed
1156 1157
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
1158

Thomas Mueller's avatar
Thomas Mueller committed
1159
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1160
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1161
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1162 1163 1164 1165 1166 1167 1168 1169
","
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
1170 1171 1172 1173
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).
1174
This setting can be appended to the database URL: ""jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'""
Thomas Mueller's avatar
Thomas Mueller committed
1175 1176 1177 1178 1179 1180 1181
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

"Commands (Other)","SET DB_CLOSE_DELAY","
SET DB_CLOSE_DELAY int
","
Thomas Mueller's avatar
Thomas Mueller committed
1182 1183
Sets the delay for closing a database if all connections are closed.
The value -1 means the database is never closed until the close delay is set to some other value or SHUTDOWN is called.
Thomas Mueller's avatar
Thomas Mueller committed
1184 1185 1186 1187
The value 0 means no delay (default; the database is closed if the last connection to it is closed).
Values 1 and larger mean the number of seconds the database is left open after closing the last connection.

If the application exits normally or System.exit is called, the database is closed immediately, even if a delay is set.
Thomas Mueller's avatar
Thomas Mueller committed
1188

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

Thomas Mueller's avatar
Thomas Mueller committed
1203
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1204
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1205
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1206 1207 1208 1209 1210
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1211
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1212 1213 1214
","
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
1215
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1216
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1217

Thomas Mueller's avatar
Thomas Mueller committed
1218
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1219
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1220
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1221
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1222 1223 1224 1225 1226
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
Thomas Mueller's avatar
Thomas Mueller committed
1227
SET EXCLUSIVE { 0 | 1 | 2 }
Thomas Mueller's avatar
Thomas Mueller committed
1228
","
Thomas Mueller's avatar
Thomas Mueller committed
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
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
1239 1240

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1241
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1242
","
Thomas Mueller's avatar
Thomas Mueller committed
1243
SET EXCLUSIVE 1
Thomas Mueller's avatar
Thomas Mueller committed
1244 1245 1246
"

"Commands (Other)","SET IGNORECASE","
1247
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1248 1249 1250 1251 1252
","
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
1253
String literals and parameters are however still considered case sensitive even if this option is set.
Thomas Mueller's avatar
Thomas Mueller committed
1254

Thomas Mueller's avatar
Thomas Mueller committed
1255
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1256
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1257
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1258
This setting can be appended to the database URL: ""jdbc:h2:test;IGNORECASE=TRUE""
Thomas Mueller's avatar
Thomas Mueller committed
1259 1260 1261 1262
","
SET IGNORECASE TRUE
"

1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
"Commands (Other)","SET JAVA_OBJECT_SERIALIZER","
SET JAVA_OBJECT_SERIALIZER
{ null | className }
","
Sets the object used to serialize and deserialize java objects being stored in column of type OTHER.
The serializer class must be public and implement ""org.h2.api.JavaObjectSerializer"".
Inner classes are not supported.
The class must be available in the classpath of the database engine
(when using the server mode, it must be both in the classpath of the server and the client).
This command can only be executed if there are no tables defined.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1275
This command commits an open transaction in this connection.
1276 1277 1278 1279 1280 1281 1282
This setting is persistent.
This setting can be appended to the database URL: ""jdbc:h2:test;JAVA_OBJECT_SERIALIZER='com.acme.SerializerClassName'""
","
SET JAVA_OBJECT_SERIALIZER 'com.acme.SerializerClassName'
"


1283
"Commands (Other)","SET LOG","
1284
SET LOG int
1285 1286 1287 1288
","
Sets the transaction log mode. The values 0, 1, and 2 are supported, the default is 2.
This setting affects all connections.

1289
LOG 0 means the transaction log is disabled completely. It is the fastest mode,
1290 1291 1292 1293
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.

1294 1295
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
1296 1297
against power failure is required, but the data must be protected against killing the process.

1298 1299
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
1300 1301
file system, this will also protect against power failure in the majority if cases.

Thomas Mueller's avatar
Thomas Mueller committed
1302
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1303
This command commits an open transaction in this connection.
1304
This setting is not persistent.
1305
This setting can be appended to the database URL: ""jdbc:h2:test;LOG=0""
1306 1307 1308 1309
","
SET LOG 1
"

Thomas Mueller's avatar
Thomas Mueller committed
1310 1311 1312 1313
"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
1314
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327

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
1328
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1329
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1330
This setting is persistent.
1331
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_MODE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1332 1333 1334 1335 1336 1337 1338 1339
","
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
1340 1341 1342
value for this setting is 1000 (one second).

This command does not commit a transaction, and rollback does not affect it.
1343
This setting can be appended to the database URL: ""jdbc:h2:test;LOCK_TIMEOUT=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1344 1345 1346 1347 1348 1349 1350
","
SET LOCK_TIMEOUT 1000
"

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

1353
This is the maximum length of an LOB that is stored with the record itself,
1354 1355
and the default value is 128.

Thomas Mueller's avatar
Thomas Mueller committed
1356
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1357
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1358
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1359 1360 1361 1362 1363 1364 1365
","
SET MAX_LENGTH_INPLACE_LOB 128
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1372
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1373
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1374
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1375 1376 1377 1378 1379 1380 1381 1382
","
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
1383
are read, then the rows are buffered to disk.
1384
The default is 40000 per GB of available RAM.
Thomas Mueller's avatar
Thomas Mueller committed
1385

Thomas Mueller's avatar
Thomas Mueller committed
1386
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1387
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1388
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1389
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1390 1391 1392 1393 1394 1395 1396
","
SET MAX_MEMORY_ROWS 1000
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1403
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1404
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1405
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1406
It has no effect for in-memory databases.
Thomas Mueller's avatar
Thomas Mueller committed
1407 1408 1409 1410 1411 1412 1413 1414 1415
","
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
1416 1417 1418
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1419
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1420
It has no effect for in-memory databases.
1421
This setting can be appended to the database URL: ""jdbc:h2:test;MAX_OPERATION_MEMORY=10000""
Thomas Mueller's avatar
Thomas Mueller committed
1422 1423 1424 1425 1426
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1427
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1428 1429
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1430 1431 1432
Modes in the feature section.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1433
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1434
This command commits an open transaction in this connection.
1435
This setting can be appended to the database URL: ""jdbc:h2:test;MODE=MYSQL""
Thomas Mueller's avatar
Thomas Mueller committed
1436 1437 1438 1439 1440
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1441
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1442 1443 1444
","
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
1445 1446 1447 1448 1449
only.

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

Thomas Mueller's avatar
Thomas Mueller committed
1450
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1451
This command commits an open transaction in this connection.
1452
This setting can be appended to the database URL: ""jdbc:h2:test;MULTI_THREADED=1""
Thomas Mueller's avatar
Thomas Mueller committed
1453 1454 1455 1456 1457
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1458
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1459 1460 1461
","
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
1462 1463
the tables was changed. This option is enabled by default.

Thomas Mueller's avatar
Thomas Mueller committed
1464
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1465
This command commits an open transaction in this connection.
1466
This setting can be appended to the database URL: ""jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0""
Thomas Mueller's avatar
Thomas Mueller committed
1467 1468 1469 1470 1471 1472 1473 1474 1475
","
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
1476

Thomas Mueller's avatar
Thomas Mueller committed
1477
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1478 1479 1480 1481
","
SET PASSWORD 'abcstzri!.5'
"

1482 1483 1484 1485 1486 1487 1488
"Commands (Other)","SET QUERY_STATISTICS","
SET QUERY_STATISTICS { TRUE | FALSE }
","
Disabled or enables query statistics gathering for the whole database.
The statistics are reflected in the INFORMATION_SCHEMA.QUERY_STATISTICS meta-table.

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

1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
"Commands (Other)","SET QUERY_STATISTICS_MAX_ENTRIES","
SET QUERY_STATISTICS int
","
Set the maximum number of entries in query statistics meta-table.
Default value is 100.

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

Thomas Mueller's avatar
Thomas Mueller committed
1508 1509 1510 1511 1512
"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
1513 1514 1515
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
1516 1517 1518 1519 1520
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1521
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1522 1523 1524
","
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
1525 1526 1527
for one table.

This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1528
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1529
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1530 1531 1532 1533
","
SET REFERENTIAL_INTEGRITY FALSE
"

1534 1535 1536 1537 1538 1539
"Commands (Other)","SET RETENTION_TIME","
SET RETENTION_TIME int
","
This property is only used when using the MVStore storage engine.
How long to retain old, persisted data, in milliseconds.
The default is 45000 (45 seconds), 0 means overwrite data as early as possible.
1540 1541 1542
It is assumed that a file system and hard disk will flush all write buffers within this time.
Using a lower value might be dangerous, unless the file system and hard disk flush the buffers earlier.
To manually flush the buffers, use CHECKPOINT SYNC,
1543 1544 1545 1546
however please note that according to various tests this does not always work as expected
depending on the operating system and hardware.

Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1547
This command commits an open transaction in this connection.
1548 1549 1550 1551 1552 1553
This setting is persistent.
This setting can be appended to the database URL: ""jdbc:h2:test;RETENTION_TIME=0""
","
SET RETENTION_TIME 0
"

Thomas Mueller's avatar
Thomas Mueller committed
1554 1555 1556 1557 1558
"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
1559

Thomas Mueller's avatar
Thomas Mueller committed
1560
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1561 1562 1563 1564 1565 1566 1567 1568 1569
","
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
1570 1571 1572
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1573
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA=ABC""
Thomas Mueller's avatar
Thomas Mueller committed
1574 1575 1576 1577 1578 1579 1580 1581 1582
","
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
1583 1584 1585
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
1586
This setting can be appended to the database URL: ""jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF""
Thomas Mueller's avatar
Thomas Mueller committed
1587 1588 1589 1590 1591 1592 1593 1594 1595
","
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
1596 1597 1598
disabled).

This command does not commit a transaction, and rollback does not affect it.
1599
This setting can be appended to the database URL: ""jdbc:h2:test;THROTTLE=50""
Thomas Mueller's avatar
Thomas Mueller committed
1600 1601 1602 1603 1604
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1605
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1606 1607 1608
","
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.
1609
To use SLF4J, append "";TRACE_LEVEL_FILE=4"" to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1610

Thomas Mueller's avatar
Thomas Mueller committed
1611
This setting is not persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1612
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1613
This command does not commit a transaction, and rollback does not affect it.
1614
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3""
Thomas Mueller's avatar
Thomas Mueller committed
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
","
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
1626
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1627
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1628
This command commits an open transaction in this connection.
1629
This setting can be appended to the database URL: ""jdbc:h2:test;TRACE_MAX_FILE_SIZE=3""
Thomas Mueller's avatar
Thomas Mueller committed
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
","
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
1640

Thomas Mueller's avatar
Thomas Mueller committed
1641
This command commits an open transaction in this connection.
Thomas Mueller's avatar
Thomas Mueller committed
1642 1643 1644 1645 1646 1647 1648 1649
","
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
1650 1651
This setting is persistent. The default is 500 ms.

Thomas Mueller's avatar
Thomas Mueller committed
1652
Admin rights are required to execute this command, as it affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1653
This command commits an open transaction in this connection.
1654
This setting can be appended to the database URL: ""jdbc:h2:test;WRITE_DELAY=0""
Thomas Mueller's avatar
Thomas Mueller committed
1655 1656 1657 1658 1659
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1660
SHUTDOWN [ IMMEDIATELY | COMPACT | DEFRAG ]
Thomas Mueller's avatar
Thomas Mueller committed
1661
","
1662 1663
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
1664
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1665

1666 1667
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
1668 1669 1670

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

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

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

Thomas Mueller's avatar
Thomas Mueller committed
1677
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1678
","
1679
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1680 1681
"

1682 1683
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1684
","
1685
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1686
","
1687
A
Thomas Mueller's avatar
Thomas Mueller committed
1688 1689
"

1690 1691
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1692
","
1693
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1694
","
1695
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1696 1697
"

1698
"Other Grammar","Array","
1699
( [ expression, [ expression [,...] ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
1700
","
1701 1702
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
1703
","
1704
(1, 2)
1705 1706
(1, )
()
Thomas Mueller's avatar
Thomas Mueller committed
1707 1708
"

1709 1710
"Other Grammar","Boolean","
TRUE | FALSE
1711
","
1712
A boolean value.
1713
","
1714
TRUE
1715 1716
"

1717 1718
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1719
","
1720
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1721
","
1722
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1723 1724
"

1725 1726 1727
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1728
","
1729 1730
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
1731
","
1732
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1733 1734
"

1735 1736 1737
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1738
","
1739 1740
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1741
","
1742 1743 1744 1745
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
1746
AES
1747
","
1748
Only the algorithm AES (""AES-128"") is supported currently.
1749 1750
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1751 1752
"

1753
"Other Grammar","Column Definition","
Thomas Mueller's avatar
Thomas Mueller committed
1754 1755
columnName dataType
[ { DEFAULT expression | AS computedColumnExpression } ] [ [ NOT ] NULL ]
1756
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1757 1758
[ SELECTIVITY selectivity ] [ COMMENT expression ]
[ PRIMARY KEY [ HASH ] | UNIQUE ] [ CHECK condition ]
1759 1760
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1761
The computed column expression is evaluated and assigned whenever the row changes.
1762 1763 1764 1765

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
1766

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

Thomas Mueller's avatar
Thomas Mueller committed
1769 1770
Check constraints can reference columns of the table,
and they can reference objects that exist while the statement is executed.
Thomas Mueller's avatar
Thomas Mueller committed
1771 1772
Conditions are only checked when a row is added or modified
in the table where the constraint exists.
1773
","
Thomas Mueller's avatar
Thomas Mueller committed
1774 1775 1776
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);
1777 1778
"

1779 1780
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1781
","
1782 1783 1784
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
1785
","
1786
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1787 1788
"

1789
"Other Grammar","Compare","
1790
<> | <= | >= | = | < | > | != | &&
Thomas Mueller's avatar
Thomas Mueller committed
1791
","
1792
Comparison operator. The operator != is the same as <>.
1793
The operator ""&&"" means overlapping; it can only be used with geometry types.
Thomas Mueller's avatar
Thomas Mueller committed
1794
","
1795
<>
Thomas Mueller's avatar
Thomas Mueller committed
1796 1797 1798
"

"Other Grammar","Condition","
1799
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1800 1801 1802 1803 1804 1805 1806
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1807 1808
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
1809
    | IS [ NOT ] [ DISTINCT FROM ] operand
1810 1811 1812 1813
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1814
","
Thomas Mueller's avatar
Thomas Mueller committed
1815
The right hand side of a condition.
1816

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

Thomas Mueller's avatar
Thomas Mueller committed
1820 1821 1822 1823 1824
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).
1825 1826 1827
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.
1828

Thomas Mueller's avatar
Thomas Mueller committed
1829
When comparing with REGEXP, regular expression matching is used.
1830
See Java ""Matcher.find"" for details.
Thomas Mueller's avatar
Thomas Mueller committed
1831 1832 1833 1834
","
LIKE 'Jo%'
"

1835
"Other Grammar","Constraint","
Thomas Mueller's avatar
Thomas Mueller committed
1836 1837 1838 1839 1840
[ constraintNameDefinition ]
{ CHECK expression
    | UNIQUE ( columnName [,...] )
    | referentialConstraint
    | PRIMARY KEY [ HASH ] ( columnName [,...] ) }
Thomas Mueller's avatar
Thomas Mueller committed
1841
","
Thomas Mueller's avatar
Thomas Mueller committed
1842 1843
Defines a constraint.
The check condition must evaluate to TRUE, FALSE or NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1844
TRUE and NULL mean the operation is to be permitted,
Thomas Mueller's avatar
Thomas Mueller committed
1845 1846
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
1847
","
1848
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1849 1850
"

1851 1852
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1853
","
1854
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1855
","
1856
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1857 1858
"

1859 1860
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
1861
    | optionString
Thomas Mueller's avatar
Thomas Mueller committed
1862
","
1863
Optional parameters for CSVREAD and CSVWRITE.
1864 1865
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
1866 1867
""STRINGDECODE('charset=UTF-8 escape=\"" fieldDelimiter=\"" fieldSeparator=, ' ||""
""'lineComment=# lineSeparator=\n null= rowSeparator=')"".
1868
The following options are supported:
1869

1870
""caseSensitiveColumnNames"" (true or false; disabled by default),
1871

Thomas Mueller's avatar
Thomas Mueller committed
1872
""charset"" (for example 'UTF-8'),
1873

Thomas Mueller's avatar
Thomas Mueller committed
1874
""escape"" (the character that escapes the field delimiter),
1875

Thomas Mueller's avatar
Thomas Mueller committed
1876
""fieldDelimiter"" (a double quote by default),
1877

Thomas Mueller's avatar
Thomas Mueller committed
1878
""fieldSeparator"" (a comma by default)),
1879

1880
""lineComment"" (disabled by default),
1881

1882
""lineSeparator"" (the line separator used for writing; ignored for reading),
1883

Thomas Mueller's avatar
Thomas Mueller committed
1884 1885
""null"", Support reading existing CSV files that contain explicit ""null"" delimiters.
Note that an empty, unquoted values are also treated as null.
1886

1887
""preserveWhitespace"" (true or false; disabled by default),
1888

1889
""writeColumnHeader"" (true or false; enabled by default).
1890

Thomas Mueller's avatar
Thomas Mueller committed
1891
For a newline or other special character, use STRINGDECODE as in the example above.
Thomas Mueller's avatar
Thomas Mueller committed
1892
A space needs to be escaped with a backslash (""'\ '""), and
Thomas Mueller's avatar
Thomas Mueller committed
1893 1894 1895
a backslash needs to be escaped with another backslash (""'\\'"").
All other characters are not to be escaped, that means
newline and tab characters are written as such.
Thomas Mueller's avatar
Thomas Mueller committed
1896
","
1897
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
Thomas Mueller's avatar
Thomas Mueller committed
1898 1899
"

1900 1901 1902 1903 1904
"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
1905
","
1906
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1907
","
1908
INT
Thomas Mueller's avatar
Thomas Mueller committed
1909 1910
"

1911 1912
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1913
","
1914
A date literal. The limitations are the same as for the Java data type
1915
""java.sql.Date"", but for compatibility with other databases the suggested minimum
1916
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1917
","
1918
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1919 1920
"

1921
"Other Grammar","Decimal","
Thomas Mueller's avatar
Thomas Mueller committed
1922
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
1923
","
Thomas Mueller's avatar
Thomas Mueller committed
1924 1925 1926 1927 1928 1929
A decimal number with fixed precision and scale.
Internally, ""java.lang.BigDecimal"" is used.
To ensure the floating point representation is used, use CAST(X AS DOUBLE).
There are some special decimal values: to represent positive infinity, use ""POWER(0, -1)"";
for negative infinity, use ""(-POWER(0, -1))""; for -0.0, use ""(-CAST(0 AS DOUBLE))"";
for ""NaN"" (not a number), use ""SQRT(-1)"".
1930
","
Thomas Mueller's avatar
Thomas Mueller committed
1931 1932 1933
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
1934 1935
"

1936 1937
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1938
","
1939
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1940
","
1941
0
Thomas Mueller's avatar
Thomas Mueller committed
1942 1943
"

1944 1945
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1946
","
1947 1948 1949
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
1950
","
1951
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1952 1953
"

1954 1955
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1956
","
1957
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1958
","
1959
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1960 1961
"

1962
"Other Grammar","Factor","
1963
term [ { { * | / | % } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1964
","
1965
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1966
","
1967
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1968 1969
"

1970 1971
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1972
","
1973 1974
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1975
","
1976
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1977 1978
"

1979 1980
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1981
","
1982
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1983
","
1984
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1985 1986
"

1987 1988
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1989
","
1990 1991 1992
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
1993
","
1994
NAME
Thomas Mueller's avatar
Thomas Mueller committed
1995 1996 1997
"

"Other Grammar","Int","
1998
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1999 2000 2001 2002 2003 2004 2005
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
2006
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
2007 2008 2009 2010 2011 2012
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

2013 2014
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
2015
","
2016
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
2017
","
2018
TEST
Thomas Mueller's avatar
Thomas Mueller committed
2019 2020
"

2021 2022
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2023
","
2024
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
2025
","
2026
NULL
Thomas Mueller's avatar
Thomas Mueller committed
2027 2028
"

2029 2030 2031 2032 2033 2034 2035 2036
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

Thomas Mueller's avatar
Thomas Mueller committed
2037
"Other Grammar","Numeric","
Thomas Mueller's avatar
Thomas Mueller committed
2038
decimal | int | long | hexNumber
Thomas Mueller's avatar
Thomas Mueller committed
2039
","
Thomas Mueller's avatar
Thomas Mueller committed
2040
The data type of a numeric value is always the lowest possible for the given value.
Thomas Mueller's avatar
Thomas Mueller committed
2041 2042 2043 2044 2045 2046 2047
If the number contains a dot this is decimal; otherwise it is int, long, or decimal (depending on the value).
","
SELECT -1600.05
SELECT CAST(0 AS DOUBLE)
SELECT -1.4e-10
"

2048 2049
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2050
","
2051
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
2052
In the default mode, the result is NULL if either parameter is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2053
","
2054
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
2055 2056
"

2057 2058
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
2059
","
2060 2061 2062
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
2063
","
2064
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
2065 2066
"

2067 2068
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
2069
","
2070 2071 2072
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
2073
","
2074
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
2075 2076
"

2077 2078 2079
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2080
[ ON DELETE referentialAction ] [ ON UPDATE referentialAction ]
Thomas Mueller's avatar
Thomas Mueller committed
2081
","
Thomas Mueller's avatar
Thomas Mueller committed
2082 2083 2084
Defines a referential constraint.
If the table name is not specified, then the same table is referenced.
RESTRICT is the default action.
Thomas Mueller's avatar
Thomas Mueller committed
2085 2086 2087
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
2088
","
2089
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
2090 2091
"

Thomas Mueller's avatar
Thomas Mueller committed
2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102
"Other Grammar","Referential Action","
CASCADE | RESTRICT | NO ACTION | SET { DEFAULT | NULL }
","
The action CASCADE will cause conflicting rows in the referencing (child) table to be deleted or updated.
RESTRICT is the default action.
As this database does not support deferred checking, RESTRICT and NO ACTION will both throw an exception if the constraint is violated.
The action SET DEFAULT will set the column in the referencing (child) table to the default value, while SET NULL will set it to NULL.
","
FOREIGN KEY(ID) REFERENCES TEST(ID) ON UPDATE CASCADE
"

2103 2104
"Other Grammar","Script Compression Encryption","
[ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ] [ CIPHER cipher PASSWORD string ]
Thomas Mueller's avatar
Thomas Mueller committed
2105
","
2106 2107
The compression and encryption algorithm to use for script files.
When using encryption, only DEFLATE and LZF are supported.
Thomas Mueller's avatar
Thomas Mueller committed
2108 2109 2110 2111 2112
LZF is faster but uses more space.
","
COMPRESSION LZF
"

2113 2114
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
2115
","
2116
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
2117
","
2118
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
2119 2120
"

2121 2122
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
2123
","
2124 2125
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
2126
","
2127
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
2128 2129
"

2130 2131
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
2132
","
Thomas Mueller's avatar
Thomas Mueller committed
2133
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
2134

Thomas Mueller's avatar
Thomas Mueller committed
2135
Please note the text concatenation operator is ""||"".
Thomas Mueller's avatar
Thomas Mueller committed
2136
","
2137
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
2138 2139
"

2140
"Other Grammar","Table Expression","
2141
{ [ schemaName. ] tableName | ( select ) | valuesExpression } [ [ AS ] newTableAlias ]
2142 2143
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
2144
","
2145 2146 2147
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
2148
","
2149
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
2150 2151
"

2152 2153 2154 2155 2156 2157 2158 2159 2160
"Other Grammar","Values Expression","
VALUES { ( expression [,...] ) } [,...]
","
A list of rows that can be used like a table.
The column list of the resulting table is C1, C2, and so on.
","
SELECT * FROM (VALUES(1, 'Hello'), (2, 'World')) AS V;
"

2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
2173
    | userDefinedFunctionName
Thomas Mueller's avatar
Thomas Mueller committed
2174
","
2175
A value. Parameters can be indexed, for example ""?1"" meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2176
Each table has a pseudo-column named ""_ROWID_"" that contains the unique row identifier.
Thomas Mueller's avatar
Thomas Mueller committed
2177
","
2178 2179 2180 2181 2182 2183
'Hello'
"

"Other Grammar","Time","
TIME 'hh:mm:ss'
","
2184 2185
A time literal. A value is between plus and minus 2 million hours
and has nanosecond resolution.
2186 2187 2188 2189 2190 2191 2192 2193
","
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
2194
""java.sql.Timestamp"", but for compatibility with other databases the suggested
2195 2196 2197 2198 2199 2200
minimum and maximum years are 0001 and 9999.
","
TIMESTAMP '2005-12-31 23:59:59'
"

"Other Grammar","Value","
Thomas Mueller's avatar
Thomas Mueller committed
2201
string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
2202
","
Thomas Mueller's avatar
Thomas Mueller committed
2203
A literal value of any data type, or null.
2204 2205
","
10
Thomas Mueller's avatar
Thomas Mueller committed
2206 2207 2208 2209 2210 2211 2212
"

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

2213
Mapped to ""java.lang.Integer"".
Thomas Mueller's avatar
Thomas Mueller committed
2214 2215 2216 2217 2218 2219 2220 2221 2222
","
INT
"

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

2223
Mapped to ""java.lang.Boolean"".
Thomas Mueller's avatar
Thomas Mueller committed
2224 2225 2226 2227 2228 2229 2230 2231 2232
","
BOOLEAN
"

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

2233
Mapped to ""java.lang.Byte"".
Thomas Mueller's avatar
Thomas Mueller committed
2234 2235 2236 2237 2238 2239 2240 2241 2242
","
TINYINT
"

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

2243
Mapped to ""java.lang.Short"".
Thomas Mueller's avatar
Thomas Mueller committed
2244 2245 2246 2247 2248 2249 2250 2251 2252
","
SMALLINT
"

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

2253
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264
","
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.

2265
Mapped to ""java.lang.Long"".
Thomas Mueller's avatar
Thomas Mueller committed
2266 2267 2268 2269 2270
","
IDENTITY
"

"Data Types","DECIMAL Type","
2271
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2272 2273 2274 2275
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

2276
Mapped to ""java.math.BigDecimal"".
Thomas Mueller's avatar
Thomas Mueller committed
2277 2278 2279 2280 2281
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
2282
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
2283
","
Thomas Mueller's avatar
Thomas Mueller committed
2284
A floating point number. Should not be used to represent currency values, because
Thomas Mueller's avatar
Thomas Mueller committed
2285 2286
of rounding problems.

2287
Mapped to ""java.lang.Double"".
Thomas Mueller's avatar
Thomas Mueller committed
2288 2289 2290 2291 2292
","
DOUBLE
"

"Data Types","REAL Type","
2293
{ REAL | FLOAT4 }
Thomas Mueller's avatar
Thomas Mueller committed
2294
","
Thomas Mueller's avatar
Thomas Mueller committed
2295
A single precision floating point number. Should not be used to represent currency
Thomas Mueller's avatar
Thomas Mueller committed
2296 2297
values, because of rounding problems.

2298
Mapped to ""java.lang.Float"".
Thomas Mueller's avatar
Thomas Mueller committed
2299 2300 2301 2302 2303 2304 2305
","
REAL
"

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

2308
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
2309 2310 2311 2312 2313 2314 2315
","
TIME
"

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

2318
Mapped to ""java.sql.Date"", with the time set to ""00:00:00""
Thomas Mueller's avatar
Thomas Mueller committed
2319
(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
2320 2321 2322 2323 2324
","
DATE
"

"Data Types","TIMESTAMP Type","
2325
{ TIMESTAMP | DATETIME | SMALLDATETIME }
Thomas Mueller's avatar
Thomas Mueller committed
2326
","
Thomas Mueller's avatar
Thomas Mueller committed
2327
The timestamp data type. The format is yyyy-MM-dd hh:mm:ss[.nnnnnnnnn].
2328
Stored internally as a BCD-encoded date, and nano-seconds since midnight.
Thomas Mueller's avatar
Thomas Mueller committed
2329

2330
Mapped to ""java.sql.Timestamp"" (""java.util.Date"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2331 2332 2333 2334
","
TIMESTAMP
"

2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347
"Data Types","TIMESTAMP WITH TIMEZONE Type","
TIMESTAMP WITH TIMEZONE
","
VERY MUCH STILL IN TESTING.
The timestamp with timezone data type.
Stored internally as a BCD-encoded date, nano-seconds since midnight, and timezone offset in minutes.
Note that range queries on this datatype may do some weird stuff close to DST boundaries.

Mapped to ""org.h2.api.TimestampWithTimeZone""
","
TIMESTAMP WITH TIMEZONE
"

Thomas Mueller's avatar
Thomas Mueller committed
2348
"Data Types","BINARY Type","
2349
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2350
","
2351 2352 2353 2354 2355
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
2356 2357 2358 2359 2360 2361 2362 2363 2364

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

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

2371
Mapped to ""java.lang.Object"" (or any subclass).
Thomas Mueller's avatar
Thomas Mueller committed
2372 2373 2374 2375 2376
","
OTHER
"

"Data Types","VARCHAR Type","
2377 2378
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2379
","
Thomas Mueller's avatar
Thomas Mueller committed
2380
A Unicode String.
Thomas Mueller's avatar
Thomas Mueller committed
2381 2382 2383 2384 2385 2386 2387
Use two single quotes ('') to create a quote.

The maximum precision is ""Integer.MAX_VALUE"".
The precision is a size constraint; only the actual data is persisted.

The whole text is loaded into memory when using this data type.
For large text data CLOB should be used; see there for details.
Thomas Mueller's avatar
Thomas Mueller committed
2388

2389
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2390 2391 2392 2393 2394
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
2395
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2396
","
Thomas Mueller's avatar
Thomas Mueller committed
2397
Same as VARCHAR, but not case sensitive when comparing.
Thomas Mueller's avatar
Thomas Mueller committed
2398 2399 2400 2401 2402 2403 2404
Stored in mixed case.

The maximum precision is ""Integer.MAX_VALUE"".
The precision is a size constraint; only the actual data is persisted.

The whole text is loaded into memory when using this data type.
For large text data CLOB should be used; see there for details.
Thomas Mueller's avatar
Thomas Mueller committed
2405

2406
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2407 2408 2409 2410 2411
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
2412
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2413
","
Thomas Mueller's avatar
Thomas Mueller committed
2414 2415 2416
A Unicode String.
This type is supported for compatibility with other databases and older applications.
The difference to VARCHAR is that trailing spaces are ignored and not persisted.
Thomas Mueller's avatar
Thomas Mueller committed
2417

Thomas Mueller's avatar
Thomas Mueller committed
2418 2419
The maximum precision is ""Integer.MAX_VALUE"".
The precision is a size constraint; only the actual data is persisted.
Thomas Mueller's avatar
Thomas Mueller committed
2420

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

2424
Mapped to ""java.lang.String"".
Thomas Mueller's avatar
Thomas Mueller committed
2425 2426 2427 2428 2429
","
CHAR(10)
"

"Data Types","BLOB Type","
2430
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2431 2432 2433
","
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
2434
""PreparedStatement.setBinaryStream"" to store values. See also CLOB and
Thomas Mueller's avatar
Thomas Mueller committed
2435 2436
Advanced / Large Objects.

2437
Mapped to ""java.sql.Blob"" (""java.io.InputStream"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2438 2439 2440 2441 2442
","
BLOB
"

"Data Types","CLOB Type","
2443
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2444 2445 2446 2447 2448
","
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
2449
""PreparedStatement.setCharacterStream"" to store values. See also Advanced / Large Objects.
Thomas Mueller's avatar
Thomas Mueller committed
2450 2451 2452 2453 2454

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.

2455
Mapped to ""java.sql.Clob"" (""java.io.Reader"" is also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2456 2457 2458 2459 2460 2461 2462
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Thomas Mueller's avatar
Thomas Mueller committed
2463 2464 2465 2466
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
2467

Thomas Mueller's avatar
Thomas Mueller committed
2468 2469 2470 2471 2472
Please note that using an index on randomly generated data will
result on poor performance once there are millions of rows in a table.
The reason is that the cache behavior is very bad with randomly distributed data.
This is a problem for any database system.

Thomas Mueller's avatar
Thomas Mueller committed
2473
For details, see the documentation of ""java.util.UUID"".
Thomas Mueller's avatar
Thomas Mueller committed
2474 2475 2476 2477 2478 2479 2480
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
Thomas Mueller's avatar
Thomas Mueller committed
2481
An array of values.
2482
Mapped to ""java.lang.Object[]"" (arrays of any non-primitive type are also supported).
Thomas Mueller's avatar
Thomas Mueller committed
2483 2484 2485 2486


Use a value list (1, 2) or ""PreparedStatement.setObject(.., new Object[] {..})"" to store values,
and ""ResultSet.getObject(..)"" or ""ResultSet.getArray(..)"" to retrieve the values.
Thomas Mueller's avatar
Thomas Mueller committed
2487 2488 2489 2490
","
ARRAY
"

2491 2492 2493
"Data Types","GEOMETRY Type","
GEOMETRY
","
2494 2495
A spatial geometry type, based on the ""com.vividsolutions.jts"" library.
Normally represented in textual format using the WKT (well known text) format.
2496

Thomas Mueller's avatar
Thomas Mueller committed
2497
Use a quoted string containing a WKT formatted string or ""PreparedStatement.setObject()"" to store values,
2498 2499
and ""ResultSet.getObject(..)"" or ""ResultSet.getString(..)"" to retrieve the values.
","
2500
GEOMETRY
2501 2502
"

Thomas Mueller's avatar
Thomas Mueller committed
2503
"Functions (Aggregate)","AVG","
Thomas Mueller's avatar
Thomas Mueller committed
2504
AVG ( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2505
","
2506 2507
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2508
Aggregates are only allowed in select statements.
2509
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2510 2511 2512 2513
","
AVG(X)
"

2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533
"Functions (Aggregate)","BIT_AND","
BIT_AND(expression)
","
The bitwise AND of all non-null values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
BIT_AND(ID)
"

"Functions (Aggregate)","BIT_OR","
BIT_OR(expression)
","
The bitwise OR of all non-null values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
","
BIT_OR(ID)
"

Thomas Mueller's avatar
Thomas Mueller committed
2534
"Functions (Aggregate)","BOOL_AND","
2535
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2536
","
2537 2538 2539
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
2540 2541 2542 2543 2544
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2545
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2546
","
2547 2548 2549
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
2550 2551 2552 2553 2554
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2555
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2556
","
2557 2558 2559 2560
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
2561 2562 2563 2564 2565
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2566 2567
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2568
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2569
","
2570 2571 2572 2573 2574
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
2575 2576 2577 2578 2579
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2580
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2581
","
2582 2583 2584 2585
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
2586 2587 2588 2589 2590
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2591
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2592
","
2593 2594 2595 2596
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
2597 2598 2599 2600 2601
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
Thomas Mueller's avatar
Thomas Mueller committed
2602
SUM( [ DISTINCT ] { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2603
","
2604 2605 2606
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
2607
The data type of the returned value depends on the parameter data type like this:
Thomas Mueller's avatar
Thomas Mueller committed
2608
""BOOLEAN, TINYINT, SMALLINT, INT -> BIGINT, BIGINT -> DECIMAL, REAL -> DOUBLE""
Thomas Mueller's avatar
Thomas Mueller committed
2609 2610 2611 2612 2613
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2614
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2615
","
2616 2617 2618 2619 2620
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
2621 2622 2623 2624 2625
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2626
STDDEV_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2627
","
2628 2629 2630
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
2631 2632 2633 2634 2635 2636
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2637
STDDEV_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2638
","
2639 2640 2641
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
2642 2643 2644 2645 2646 2647
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
Thomas Mueller's avatar
Thomas Mueller committed
2648
VAR_POP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2649
","
2650 2651 2652 2653
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
2654 2655 2656 2657 2658
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
Thomas Mueller's avatar
Thomas Mueller committed
2659
VAR_SAMP( [ DISTINCT ] numeric )
Thomas Mueller's avatar
Thomas Mueller committed
2660
","
2661 2662 2663 2664
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
2665 2666 2667 2668 2669
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
Thomas Mueller's avatar
Thomas Mueller committed
2670
ABS ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2671
","
2672 2673
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"".
2674
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2675 2676 2677 2678 2679
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
Thomas Mueller's avatar
Thomas Mueller committed
2680
ACOS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2681
","
Thomas Mueller's avatar
Thomas Mueller committed
2682 2683
Calculate the arc cosine.
See also Java ""Math.acos"".
2684
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2685 2686 2687 2688 2689
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
Thomas Mueller's avatar
Thomas Mueller committed
2690
ASIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2691
","
Thomas Mueller's avatar
Thomas Mueller committed
2692 2693
Calculate the arc sine.
See also Java ""Math.asin"".
2694
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2695 2696 2697 2698 2699
","
ASIN(D)
"

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

"Functions (Numeric)","COS","
Thomas Mueller's avatar
Thomas Mueller committed
2710
COS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2711
","
Thomas Mueller's avatar
Thomas Mueller committed
2712 2713
Calculate the trigonometric cosine.
See also Java ""Math.cos"".
2714
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2715 2716 2717 2718
","
COS(ANGLE)
"

2719
"Functions (Numeric)","COSH","
Thomas Mueller's avatar
Thomas Mueller committed
2720
COSH(numeric)
2721 2722 2723 2724 2725 2726 2727 2728
","
Calculate the hyperbolic cosine.
See also Java ""Math.cosh"".
This method returns a double.
","
COSH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2729
"Functions (Numeric)","COT","
Thomas Mueller's avatar
Thomas Mueller committed
2730
COT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2731
","
Thomas Mueller's avatar
Thomas Mueller committed
2732
Calculate the trigonometric cotangent (""1/TAN(ANGLE)"").
2733
See also Java ""Math.*"" functions.
2734
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2735 2736 2737 2738 2739
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
Thomas Mueller's avatar
Thomas Mueller committed
2740
SIN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2741
","
Thomas Mueller's avatar
Thomas Mueller committed
2742 2743
Calculate the trigonometric sine.
See also Java ""Math.sin"".
2744
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2745 2746 2747 2748
","
SIN(ANGLE)
"

2749
"Functions (Numeric)","SINH","
Thomas Mueller's avatar
Thomas Mueller committed
2750
SINH(numeric)
2751 2752 2753 2754 2755 2756 2757 2758
","
Calculate the hyperbolic sine.
See also Java ""Math.sinh"".
This method returns a double.
","
SINH(ANGLE)
"

Thomas Mueller's avatar
Thomas Mueller committed
2759
"Functions (Numeric)","TAN","
Thomas Mueller's avatar
Thomas Mueller committed
2760
TAN(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2761
","
Thomas Mueller's avatar
Thomas Mueller committed
2762 2763
Calculate the trigonometric tangent.
See also Java ""Math.tan"".
2764
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2765 2766 2767 2768
","
TAN(ANGLE)
"

2769
"Functions (Numeric)","TANH","
Thomas Mueller's avatar
Thomas Mueller committed
2770
TANH(numeric)
2771 2772 2773 2774 2775 2776 2777 2778
","
Calculate the hyperbolic tangent.
See also Java ""Math.tanh"".
This method returns a double.
","
TANH(X)
"

Thomas Mueller's avatar
Thomas Mueller committed
2779
"Functions (Numeric)","ATAN2","
Thomas Mueller's avatar
Thomas Mueller committed
2780
ATAN2(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2781
","
Thomas Mueller's avatar
Thomas Mueller committed
2782
Calculate the angle when converting the rectangular coordinates to polar coordinates.
2783
See also Java ""Math.atan2"".
2784
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2785 2786 2787 2788 2789
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2790
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2791
","
2792 2793
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2794 2795 2796 2797 2798 2799
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2800
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2801
","
2802 2803
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2804 2805 2806 2807 2808 2809
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2810
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2811
","
2812 2813
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2814 2815 2816 2817 2818 2819
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2820
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2821
","
2822 2823
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2824 2825 2826 2827 2828 2829
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
Thomas Mueller's avatar
Thomas Mueller committed
2830
{ CEILING | CEIL } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2831
","
2832
See also Java ""Math.ceil"".
2833
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2834
","
2835
CEIL(A)
Thomas Mueller's avatar
Thomas Mueller committed
2836 2837 2838
"

"Functions (Numeric)","DEGREES","
Thomas Mueller's avatar
Thomas Mueller committed
2839
DEGREES(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2840
","
2841
See also Java ""Math.toDegrees"".
2842
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2843 2844 2845 2846 2847
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
Thomas Mueller's avatar
Thomas Mueller committed
2848
EXP(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2849
","
2850
See also Java ""Math.exp"".
2851
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2852 2853 2854 2855 2856
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
Thomas Mueller's avatar
Thomas Mueller committed
2857
FLOOR(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2858
","
2859
See also Java ""Math.floor"".
2860
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2861 2862 2863 2864 2865
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
Thomas Mueller's avatar
Thomas Mueller committed
2866
{ LOG | LN } (numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2867
","
2868
See also Java ""Math.log"".
2869
In the PostgreSQL mode, LOG(x) is base 10.
2870
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2871 2872 2873 2874 2875
","
LOG(A)
"

"Functions (Numeric)","LOG10","
Thomas Mueller's avatar
Thomas Mueller committed
2876
LOG10(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2877
","
2878
See also Java ""Math.log10"" (in Java 5).
2879
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2880 2881 2882 2883 2884
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
Thomas Mueller's avatar
Thomas Mueller committed
2885
RADIANS(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2886
","
2887
See also Java ""Math.toRadians"".
2888
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2889 2890 2891 2892 2893
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
Thomas Mueller's avatar
Thomas Mueller committed
2894
SQRT(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2895
","
2896
See also Java ""Math.sqrt"".
2897
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2898 2899 2900 2901 2902
","
SQRT(A)
"

"Functions (Numeric)","PI","
2903
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2904
","
2905
See also Java ""Math.PI"".
2906
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2907 2908 2909 2910 2911
","
PI()
"

"Functions (Numeric)","POWER","
Thomas Mueller's avatar
Thomas Mueller committed
2912
POWER(numeric, numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2913
","
2914
See also Java ""Math.pow"".
Thomas Mueller's avatar
Thomas Mueller committed
2915
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2916 2917 2918 2919 2920
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2921
{ RAND | RANDOM } ( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2922 2923 2924
","
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
2925
This method returns a double between 0 (including) and 1 (excluding).
Thomas Mueller's avatar
Thomas Mueller committed
2926 2927 2928 2929 2930
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2931
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2932 2933
","
Returns a new UUID with 122 pseudo random bits.
Thomas Mueller's avatar
Thomas Mueller committed
2934 2935 2936 2937 2938

Please note that using an index on randomly generated data will
result on poor performance once there are millions of rows in a table.
The reason is that the cache behavior is very bad with randomly distributed data.
This is a problem for any database system.
Thomas Mueller's avatar
Thomas Mueller committed
2939 2940 2941 2942 2943
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2944
ROUND(numeric [, digitsInt])
Thomas Mueller's avatar
Thomas Mueller committed
2945
","
2946
Rounds to a number of digits, or to the nearest long if the number of digits if not set.
Thomas Mueller's avatar
Thomas Mueller committed
2947
This method returns a numeric (the same type as the input).
Thomas Mueller's avatar
Thomas Mueller committed
2948 2949 2950 2951 2952
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
Thomas Mueller's avatar
Thomas Mueller committed
2953
ROUNDMAGIC(numeric)
Thomas Mueller's avatar
Thomas Mueller committed
2954
","
2955 2956 2957 2958 2959 2960
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
2961 2962 2963 2964 2965
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2966
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2967 2968
","
Generates a number of cryptographically secure random numbers.
2969
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2970 2971 2972 2973 2974
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
Thomas Mueller's avatar
Thomas Mueller committed
2975
SIGN ( { numeric } )
Thomas Mueller's avatar
Thomas Mueller committed
2976 2977 2978 2979 2980 2981 2982
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2983
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2984
","
2985
Encrypts data using a key.
2986
The supported algorithm is AES.
2987 2988
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2989 2990 2991 2992 2993
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2994
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2995
","
2996
Decrypts data using a key.
2997
The supported algorithm is AES.
2998 2999
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3000 3001 3002 3003 3004 3005
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
3006
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
3007
","
3008 3009 3010
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
3011 3012 3013 3014 3015
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
3016
{ TRUNC | TRUNCATE } ( { {numeric, digitsInt} | timestamp | date | timestampString } )
Thomas Mueller's avatar
Thomas Mueller committed
3017 3018
","
Truncates to a number of digits (to the next value closer to 0).
3019
This method returns a double.
3020
When used with a timestamp, truncates a timestamp to a date (day) value.
3021 3022
When used with a date, truncates a date to a date (day) value less time part.
When used with a timestamp as string, truncates a timestamp to a date (day) value.
Thomas Mueller's avatar
Thomas Mueller committed
3023 3024 3025 3026 3027
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
3028
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
3029
","
3030 3031 3032 3033
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
3034 3035 3036 3037 3038
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
3039
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3040 3041
","
Expands data that was compressed using the COMPRESS function.
3042
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3043 3044 3045 3046 3047
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
3048
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
3049 3050 3051 3052 3053 3054 3055
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
3056
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
3057 3058
","
Returns the ASCII value of the first character in the string.
3059
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3060 3061 3062 3063
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
3064
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3065
","
3066 3067 3068
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
3069 3070 3071 3072 3073
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
3074
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3075
","
3076 3077 3078
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
3079 3080 3081 3082 3083
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
3084
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
3085
","
3086 3087 3088 3089
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
3090 3091 3092 3093 3094
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
3095
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
3096 3097
","
Returns the character that represents the ASCII value.
3098
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3099 3100 3101 3102 3103
","
CHAR(65)
"

"Functions (String)","CONCAT","
3104
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3105 3106
","
Combines strings.
Thomas Mueller's avatar
Thomas Mueller committed
3107
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3108
and do not cause the result to become NULL.
3109
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3110 3111 3112 3113
","
CONCAT(NAME, '!')
"

3114 3115 3116 3117
"Functions (String)","CONCAT_WS","
CONCAT_WS(separatorString, string, string [,...])
","
Combines strings with separator.
Thomas Mueller's avatar
Thomas Mueller committed
3118
Unlike with the operator ""||"", NULL parameters are ignored,
Thomas Mueller's avatar
Thomas Mueller committed
3119
and do not cause the result to become NULL.
3120 3121 3122 3123 3124
This method returns a string.
","
CONCAT_WS(',', NAME, '!')
"

Thomas Mueller's avatar
Thomas Mueller committed
3125
"Functions (String)","DIFFERENCE","
3126
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
3127 3128
","
Returns the difference between the sounds of two strings.
3129
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3130 3131 3132 3133 3134
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
3135
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
3136
","
3137 3138
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
3139 3140 3141 3142 3143
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
3144
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3145
","
3146 3147 3148
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
3149 3150 3151 3152 3153
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
3154
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3155
","
3156
Returns the location of a search string in a string.
3157 3158 3159
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
3160
Please note this function is case sensitive, even if the parameters are not.
Thomas Mueller's avatar
Thomas Mueller committed
3161 3162 3163 3164 3165
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
3166
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
3167
","
3168 3169 3170
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
3171 3172 3173 3174 3175
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
3176
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3177 3178 3179 3180 3181 3182 3183
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
3184
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
3185 3186 3187 3188 3189 3190 3191
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
3192
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3193 3194 3195 3196 3197 3198 3199
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
3200
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3201 3202 3203 3204 3205 3206 3207
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
3208
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
3209
","
3210 3211 3212 3213
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
3214 3215 3216 3217 3218
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
3219
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
3220 3221 3222 3223 3224 3225 3226
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
3227
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3228
","
3229 3230 3231
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
3232 3233 3234 3235 3236
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
3237
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
3238
","
3239 3240 3241
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
3242 3243 3244 3245 3246
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
3247
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3248 3249 3250 3251 3252 3253 3254
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
3255
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
3256 3257 3258 3259 3260 3261 3262
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
3263
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
3264
","
3265 3266
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
3267 3268 3269 3270 3271
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
3272
REGEXP_REPLACE(inputString, regexString, replacementString [, flagsString])
Thomas Mueller's avatar
Thomas Mueller committed
3273
","
3274
Replaces each substring that matches a regular expression.
3275
For details, see the Java ""String.replaceAll()"" method.
3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289
If any parameter is null (except optional flagsString parameter), the result is null.

Flags values limited to 'i', 'c', 'n', 'm'. Other symbols causes exception.
Multiple symbols could be uses in one flagsString parameter (like 'im').
Later flags overrides first ones, for example 'ic' equivalent to case sensitive matching 'c'.

'i' enables case insensitive matching (Pattern.CASE_INSENSITIVE)

'c' disables case insensitive matching (Pattern.CASE_INSENSITIVE)

'n' allows the period to match the newline character (Pattern.DOTALL)

'm' enables multiline mode (Pattern.MULTILINE)

Thomas Mueller's avatar
Thomas Mueller committed
3290 3291
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
3292
REGEXP_REPLACE('Hello WWWWorld', 'w+', 'W', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3293 3294
"

3295 3296 3297 3298
"Functions (String)","REGEXP_LIKE","
REGEXP_LIKE(inputString, regexString [, flagsString])
","
Matches string to a regular expression.
3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313
For details, see the Java ""Matcher.find()"" method.
If any parameter is null (except optional flagsString parameter), the result is null.

Flags values limited to 'i', 'c', 'n', 'm'. Other symbols causes exception.
Multiple symbols could be uses in one flagsString parameter (like 'im').
Later flags overrides first ones, for example 'ic' equivalent to case sensitive matching 'c'.

'i' enables case insensitive matching (Pattern.CASE_INSENSITIVE)

'c' disables case insensitive matching (Pattern.CASE_INSENSITIVE)

'n' allows the period to match the newline character (Pattern.DOTALL)

'm' enables multiline mode (Pattern.MULTILINE)

3314 3315
","
REGEXP_LIKE('Hello    World', '[A-Z ]*', 'i')
Thomas Mueller's avatar
Thomas Mueller committed
3316 3317
"

3318

Thomas Mueller's avatar
Thomas Mueller committed
3319
"Functions (String)","REPEAT","
3320
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
3321 3322 3323 3324 3325 3326 3327
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
3328
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
3329
","
3330 3331
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.
3332
If any parameter is null, the result is null.
Thomas Mueller's avatar
Thomas Mueller committed
3333 3334 3335 3336 3337
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
3338
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
3339
","
3340 3341 3342
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
3343 3344 3345 3346 3347
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
3348
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
3349 3350 3351 3352 3353 3354 3355
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
3356
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3357
","
3358 3359 3360
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
3361 3362 3363 3364 3365
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
3366
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
3367
","
3368 3369 3370
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
3371 3372 3373 3374 3375
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
3376
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
3377 3378
","
Encodes a string to a byte array using the UTF8 encoding format.
3379
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
3380 3381 3382 3383 3384
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
3385
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
3386
","
3387
Returns a substring of a string starting at a position.
3388
If the start index is negative, then the start index is relative to the end of the string.
3389
The length is optional.
3390
Also supported is: ""SUBSTRING(string [FROM start] [FOR length])"".
Thomas Mueller's avatar
Thomas Mueller committed
3391
","
3392 3393
CALL SUBSTR('[Hello]', 2, 5);
CALL SUBSTR('Hello World', -5);
Thomas Mueller's avatar
Thomas Mueller committed
3394 3395 3396
"

"Functions (String)","UTF8TOSTRING","
3397
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
3398 3399 3400 3401 3402 3403 3404
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
3405
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3406
","
3407
Creates an XML attribute element of the form ""name=value"".
3408 3409
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3410 3411 3412 3413 3414
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
3415
XMLNODE(elementString [, attributesString [, contentString [, indentBoolean]]])
Thomas Mueller's avatar
Thomas Mueller committed
3416 3417
","
Create an XML node element.
3418 3419 3420
An empty or null attribute string means no attributes are set.
An empty or null content string means the node is empty.
The content is indented by default if it contains a newline.
3421
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3422 3423 3424 3425 3426
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
3427
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
3428
","
3429
Creates an XML comment.
3430
Two dashes (""--"") are converted to ""- -"".
3431
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3432 3433 3434 3435 3436
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
3437
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
3438
","
3439
Creates an XML CDATA element.
3440
If the value contains ""]]>"", an XML text element is created instead.
3441
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3442 3443 3444 3445 3446
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
3447
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
3448
","
Thomas Mueller's avatar
Thomas Mueller committed
3449
Returns the XML declaration.
3450
The result is always ""<?xml version=""1.0""?>"".
Thomas Mueller's avatar
Thomas Mueller committed
3451 3452 3453 3454 3455
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
3456
XMLTEXT(valueString [, escapeNewlineBoolean])
Thomas Mueller's avatar
Thomas Mueller committed
3457 3458
","
Creates an XML text element.
Thomas Mueller's avatar
Thomas Mueller committed
3459
If enabled, newline and linefeed is converted to an XML entity (&#).
3460
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3461 3462 3463 3464
","
CALL XMLTEXT('test')
"

3465
"Functions (String)","TO_CHAR","
3466
TO_CHAR(value [, formatString[, nlsParamString]])
3467 3468 3469 3470 3471 3472
","
Oracle-compatible TO_CHAR function that can format a timestamp, a number, or text.
","
CALL TO_CHAR(TIMESTAMP '2010-01-01 00:00:00', 'DD MON, YYYY')
"

3473 3474 3475 3476 3477 3478 3479 3480
"Functions (String)","TRANSLATE","
TRANSLATE(value , searchString, replacementString]])
","
Oracle-compatible TRANSLATE function that replaces a sequence of characters in a string with another set of characters.
","
CALL TRANSLATE('Hello world', 'eo', 'EO')
"

Thomas Mueller's avatar
Thomas Mueller committed
3481
"Functions (Time and Date)","CURRENT_DATE","
3482
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
3483 3484
","
Returns the current date.
3485
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3486 3487 3488 3489 3490
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
3491
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
3492 3493
","
Returns the current time.
3494
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3495 3496 3497 3498 3499
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
3500
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
3501
","
3502 3503
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
3504
This method always returns the same value within a transaction.
Thomas Mueller's avatar
Thomas Mueller committed
3505 3506 3507 3508 3509
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
3510
{ DATEADD| TIMESTAMPADD } (unitString, addIntLong, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3511
","
3512 3513
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
3514 3515
addIntLong may be a long value when manipulating milliseconds,
otherwise it's range is restricted to int.
3516
The same units as in the EXTRACT function are supported.
3517
DATEADD method returns a timestamp. TIMESTAMPADD method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3518 3519 3520 3521 3522
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
3523
{ DATEDIFF | TIMESTAMPDIFF } (unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3524
","
Thomas Mueller's avatar
Thomas Mueller committed
3525
Returns the the number of crossed unit boundaries between two timestamps.
3526 3527
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
3528 3529 3530 3531 3532 3533
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
3534
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3535 3536 3537 3538 3539 3540 3541
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
3542
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
3543 3544 3545 3546 3547 3548 3549
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
3550
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
3551 3552 3553 3554 3555 3556 3557
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
3558
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
3559 3560 3561 3562 3563 3564 3565
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
3566
EXTRACT ( { YEAR | YY | MONTH | MM | WEEK | DAY | DD | DAY_OF_YEAR
3567
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
3568
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
3569 3570
","
Returns a specific value from a timestamps.
3571
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3572 3573 3574 3575 3576
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
3577
FORMATDATETIME ( timestamp, formatString
3578
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3579
","
3580 3581 3582
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.
3583
For details of the format, see ""java.text.SimpleDateFormat"".
3584
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3585 3586 3587 3588 3589 3590
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3591
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3592 3593 3594 3595 3596 3597 3598
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3599
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3600 3601 3602 3603 3604 3605 3606
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3607
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3608 3609 3610 3611 3612 3613 3614
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3615
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3616 3617 3618 3619 3620 3621 3622
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3623
PARSEDATETIME(string, formatString
3624
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3625
","
3626 3627 3628
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.
3629
For details of the format, see ""java.text.SimpleDateFormat"".
Thomas Mueller's avatar
Thomas Mueller committed
3630 3631 3632 3633 3634 3635
","
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","
3636
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3637 3638 3639 3640 3641 3642 3643
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3644
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3645 3646 3647 3648 3649 3650 3651
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3652
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3653
","
3654 3655
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3656 3657 3658 3659 3660
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3661
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3662 3663 3664 3665 3666 3667 3668
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3669
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3670 3671
","
Returns one element of an array.
3672
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3673 3674 3675 3676 3677
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
Thomas Mueller's avatar
Thomas Mueller committed
3678
ARRAY_LENGTH(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3679 3680 3681 3682 3683 3684
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

3685 3686 3687 3688 3689 3690 3691 3692
"Functions (System)","ARRAY_CONTAINS","
ARRAY_CONTAINS(arrayExpression, value)
","
Returns a boolean true if the array contains the value.
","
CALL ARRAY_CONTAINS(('Hello', 'World'), 'Hello')
"

Thomas Mueller's avatar
Thomas Mueller committed
3693
"Functions (System)","AUTOCOMMIT","
3694
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3695 3696 3697 3698 3699 3700 3701
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3702
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3703
","
3704 3705 3706
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
3707 3708

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3709 3710 3711 3712 3713
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3714
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3715 3716
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3717
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3718 3719 3720 3721 3722
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3723
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3724
","
3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736
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
3737 3738 3739
"

"Functions (System)","COALESCE","
3740
{ COALESCE | NVL } (aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3741 3742 3743 3744 3745 3746 3747
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3748
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3749 3750 3751 3752 3753 3754 3755
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3756
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3757
","
3758 3759 3760 3761 3762
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
3763 3764 3765 3766 3767
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3768
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3769
","
3770 3771
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
3772 3773

If the column names are specified (a list of column names separated with the
3774
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3775 3776 3777 3778 3779
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
3780 3781 3782 3783 3784

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.

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

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

Thomas Mueller's avatar
Thomas Mueller committed
3789
Instead of a file, an URL may be used, for example
3790 3791
""jar:file:///c:/temp/example.zip!/org/example/nested.csv"".
To read a stream from the classpath, use the prefix ""classpath:"".
Thomas Mueller's avatar
Thomas Mueller committed
3792
To read from HTTP, use the prefix ""http:"" (as in a browser).
3793

Thomas Mueller's avatar
Thomas Mueller committed
3794 3795 3796
For performance reason, CSVREAD should not be used inside a join.
Instead, import the data first (possibly into a temporary table) and then use the table.

Thomas Mueller's avatar
Thomas Mueller committed
3797 3798 3799 3800
Admin rights are required to execute this command.
","
CALL CSVREAD('test.csv');
-- Read a file containing the columns ID, NAME with
Thomas Mueller's avatar
Thomas Mueller committed
3801 3802 3803 3804
CALL CSVREAD('test2.csv', 'ID|NAME', 'charset=UTF-8 fieldSeparator=|');
SELECT * FROM CSVREAD('data/test.csv', null, 'rowSeparator=;');
-- Read a tab-separated file
SELECT * FROM CSVREAD('data/test.tsv', null, 'rowSeparator=' || CHAR(9));
Thomas Mueller's avatar
Thomas Mueller committed
3805
SELECT ""Last Name"" FROM CSVREAD('address.csv');
3806
SELECT ""Last Name"" FROM CSVREAD('classpath:/org/acme/data/address.csv');
Thomas Mueller's avatar
Thomas Mueller committed
3807 3808 3809
"

"Functions (System)","CSVWRITE","
3810
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3811
","
3812
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3813
If only a file name is specified, it will be written to the current working directory.
3814
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3815
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
3816 3817 3818 3819 3820

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

Thomas Mueller's avatar
Thomas Mueller committed
3823 3824
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3825
","
Thomas Mueller's avatar
Thomas Mueller committed
3826 3827 3828 3829
CALL CSVWRITE('data/test.csv', 'SELECT * FROM TEST');
CALL CSVWRITE('data/test2.csv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=|');
-- Write a tab-separated file
CALL CSVWRITE('data/test.tsv', 'SELECT * FROM TEST', 'charset=UTF-8 fieldSeparator=' || CHAR(9));
Thomas Mueller's avatar
Thomas Mueller committed
3830 3831 3832
"

"Functions (System)","DATABASE","
3833
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3834 3835 3836 3837 3838 3839 3840
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3841
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3842
","
Thomas Mueller's avatar
Thomas Mueller committed
3843 3844
Returns the directory of the database files and the database name, if it is file based.
Returns NULL otherwise.
Thomas Mueller's avatar
Thomas Mueller committed
3845 3846 3847 3848
","
CALL DATABASE_PATH();
"

3849
"Functions (System)","DECODE","
Thomas Mueller's avatar
Thomas Mueller committed
3850
DECODE(value, whenValue, thenValue [,...])
3851 3852 3853 3854 3855 3856 3857 3858
","
Returns the first matching value. NULL is considered to match NULL.
If no match was found, then NULL or the last parameter (if the parameter count is even) is returned.
This function is provided for Oracle compatibility (see there for details).
","
CALL DECODE(RAND()>0.5, 0, 'Red', 1, 'Black');
"

3859
"Functions (System)","DISK_SPACE_USED","
Thomas Mueller's avatar
Thomas Mueller committed
3860
DISK_SPACE_USED(tableNameString)
3861 3862 3863 3864 3865 3866 3867 3868
","
Returns the approximate amount of space used by the table specified.
Does not currently take into account indexes or LOB's.
This function may be expensive since it has to load every page in the table.
","
CALL DISK_SPACE_USED('my_table');
"

Thomas Mueller's avatar
Thomas Mueller committed
3869
"Functions (System)","FILE_READ","
3870
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3871 3872 3873 3874
","
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
3875
default character set for this system.
3876 3877 3878 3879

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

Thomas Mueller's avatar
Thomas Mueller committed
3880
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3881 3882 3883 3884 3885
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

3886
"Functions (System)","FILE_WRITE","
3887
FILE_WRITE(blobValue, fileNameString)
3888 3889 3890 3891 3892 3893 3894 3895
","
Write the supplied parameter into a file. Return the number of bytes written.

Write access to folder, and admin rights are required to execute this command.
","
SELECT FILE_WRITE('Hello world', '/tmp/hello.txt')) LEN;
"

Thomas Mueller's avatar
Thomas Mueller committed
3896
"Functions (System)","GREATEST","
3897
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3898 3899 3900 3901 3902 3903 3904
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3905
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3906 3907
","
Returns the last inserted identity value for this session.
3908
This value changes whenever a new sequence number was generated,
3909
even within a trigger or Java function. See also SCOPE_IDENTITY.
3910
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3911 3912 3913 3914 3915
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3916
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3917 3918 3919 3920 3921 3922 3923
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3924
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3925 3926 3927 3928 3929 3930 3931
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3932
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3933 3934
","
Returns the current lock mode. See SET LOCK_MODE.
3935
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3936 3937 3938 3939 3940
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3941
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3942 3943 3944 3945 3946 3947 3948 3949
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3950
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3951
","
3952 3953 3954 3955 3956
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
3957
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3958 3959 3960 3961 3962
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3963
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3964
","
Thomas Mueller's avatar
Thomas Mueller committed
3965
Returns the free memory in KB (where 1024 bytes is a KB).
3966
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3967 3968
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3969 3970 3971 3972 3973
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3974
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3975
","
Thomas Mueller's avatar
Thomas Mueller committed
3976
Returns the used memory in KB (where 1024 bytes is a KB).
3977
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3978 3979
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3980 3981 3982 3983 3984
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3985
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3986
","
3987 3988 3989 3990
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
3991 3992 3993 3994 3995
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3996
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3997 3998 3999 4000 4001 4002
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

4003 4004 4005 4006
"Functions (System)","NVL2","
NVL2(testValue, aValue, bValue)
","
If the test value is null, then 'b' is returned. Otherwise, 'a' is returned.
4007
The data type of the returned value is the data type of 'a' if this is a text type.
4008 4009 4010 4011
","
NVL2(X, 'not null', 'null')
"

Thomas Mueller's avatar
Thomas Mueller committed
4012
"Functions (System)","READONLY","
4013
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
4014 4015 4016 4017 4018 4019 4020
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
Thomas Mueller's avatar
Thomas Mueller committed
4021
{ ROWNUM() } | { ROW_NUMBER() OVER() }
Thomas Mueller's avatar
Thomas Mueller committed
4022
","
4023
Returns the number of the current row.
4024 4025
This method returns a long.
It is supported for SELECT statements, as well as for DELETE and UPDATE.
4026 4027
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).
4028
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
4029
","
4030 4031
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
4032
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
4033 4034 4035
"

"Functions (System)","SCHEMA","
4036
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
4037 4038 4039 4040 4041 4042
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

4043 4044 4045
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
4046
Returns the last inserted identity value for this session for the current scope
Thomas Mueller's avatar
Thomas Mueller committed
4047
(ie. the current statement).
4048 4049 4050 4051 4052 4053
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
4054
"Functions (System)","SESSION_ID","
4055
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4056
","
4057 4058 4059 4060
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
4061 4062 4063 4064 4065
","
CALL SESSION_ID()
"

"Functions (System)","SET","
4066
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
4067
","
4068 4069 4070
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
4071
When used in a subquery, not all rows might be read depending on the query plan.
Thomas Mueller's avatar
Thomas Mueller committed
4072
This can be used to implement running totals / cumulative sums.
Thomas Mueller's avatar
Thomas Mueller committed
4073 4074 4075 4076 4077
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
4078
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
4079 4080 4081 4082 4083 4084 4085
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
4086
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
4087
","
4088 4089
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
4090
Otherwise a value of the following form is returned:
4091
""logFileId-position-sessionId"".
4092 4093
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
4094 4095 4096 4097
","
CALL TRANSACTION_ID()
"

4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109
"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
4110
"Functions (System)","USER","
4111
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
4112 4113 4114 4115 4116 4117
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

4118 4119 4120 4121 4122 4123 4124 4125
"Functions (System)","H2VERSION","
H2VERSION()
","
Returns the H2 version as a String.
","
H2VERSION()
"

Thomas Mueller's avatar
Thomas Mueller committed
4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140
"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
4141