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

20 21 22
LIMIT limits the number of rows returned by the query, OFFSET specified
how many rows to skip. SAMPLE_SIZE limits the number of rows read for
aggregate queries.
23

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

28
If FOR UPDATE is specified, the tables are locked for writing.
Thomas Mueller's avatar
Thomas Mueller committed
29 30
","
SELECT * FROM TEST;
31 32 33 34 35
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
36 37 38 39 40 41
SELECT * FROM (SELECT ID, COUNT(*) FROM TEST
    GROUP BY ID UNION SELECT NULL, COUNT(*) FROM TEST)
    ORDER BY 1 NULLS LAST;
"

"Commands (DML)","INSERT","
42
INSERT INTO tableName [ ( columnName [,...] ) ]
43
{ VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | select }
Thomas Mueller's avatar
Thomas Mueller committed
44 45 46 47 48 49 50
","
Inserts a new row / new rows into a table.
","
INSERT INTO TEST VALUES(1, 'Hello')
"

"Commands (DML)","UPDATE","
51
UPDATE tableName [ [ AS ] newTableAlias ] SET { columnName= { DEFAULT | expression } } [,...]
52
[ WHERE expression ]
Thomas Mueller's avatar
Thomas Mueller committed
53 54 55
","
Updates data in a table.
","
56 57
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
58 59 60
"

"Commands (DML)","DELETE","
61
DELETE FROM tableName [ WHERE expression ]
Thomas Mueller's avatar
Thomas Mueller committed
62 63 64 65 66 67 68 69 70
","
Deletes rows form a table.
","
DELETE FROM TEST WHERE ID=2
"

"Commands (DML)","BACKUP","
BACKUP TO fileNameString
","
Thomas Mueller's avatar
Thomas Mueller committed
71 72
Backs up the database files to a .zip file. Objects are not locked.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
73 74 75 76 77 78 79 80 81 82 83 84 85
","
BACKUP TO 'backup.zip'
"

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

"Commands (DML)","EXPLAIN","
86
EXPLAIN [ PLAN FOR ] { select | insert | update | delete }
Thomas Mueller's avatar
Thomas Mueller committed
87 88 89 90 91 92 93
","
Shows the execution plan for a statement.
","
EXPLAIN SELECT * FROM TEST WHERE ID=1
"

"Commands (DML)","MERGE","
94 95
MERGE INTO tableName [ ( columnName [,...] ) ]
[ KEY ( columnName [,...] ) ]
96
{ VALUES { ( { DEFAULT | expression } [,...] ) } [,...] | select }
Thomas Mueller's avatar
Thomas Mueller committed
97 98 99 100 101 102 103 104 105 106 107
","
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","
108 109
RUNSCRIPT FROM fileNameString [ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ]
[ CIPHER cipher PASSWORD string ] [ CHARSET charsetString ]
Thomas Mueller's avatar
Thomas Mueller committed
110 111 112 113 114 115 116 117
","
Runs a SQL script from a file. The script is a text file containing SQL
statements; each statement must end with ';'. This command can be used to
restore a database from a backup. The password must be in single quotes; it is
case sensitive and can contain spaces.

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

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
121 122 123 124 125
","
RUNSCRIPT FROM 'backup'
"

"Commands (DML)","SCRIPT","
126 127 128 129
SCRIPT [ SIMPLE ] [ NODATA ] [ NOPASSWORDS ] [ NOSETTINGS ]
[ DROP ] [ BLOCKSIZE blockSizeInt ]
[ TO fileNameString [ COMPRESSION { DEFLATE | LZF | ZIP | GZIP } ]
    [ CIPHER cipher PASSWORD string ] ]
Thomas Mueller's avatar
Thomas Mueller committed
130
","
131 132 133 134 135 136 137 138 139
Creates a SQL script from the database.

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

If no file name is specified, the
Thomas Mueller's avatar
Thomas Mueller committed
140 141 142 143
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.

144
If a file name is specified, then the whole
Thomas Mueller's avatar
Thomas Mueller committed
145 146 147 148 149 150 151 152 153 154 155
script (including insert statements) is written to this file, and a result set
without the insert statements is returned. When using encryption, only DEFLATE
and LZF are supported (LZF is faster but uses more space).

This command locks objects while it is running. The password must be in
single quotes; it is case sensitive and can contain spaces.
","
SCRIPT NODATA
"

"Commands (DML)","SHOW","
156 157
SHOW { SCHEMAS | TABLES [ FROM schemaName ] |
    COLUMNS FROM tableName [ FROM schemaName ] }
Thomas Mueller's avatar
Thomas Mueller committed
158 159 160 161 162 163 164 165 166
","
Lists the schemas, tables, or the columns of a table.
","
SHOW TABLES
"

"Commands (DDL)","ALTER INDEX RENAME","
ALTER INDEX indexName RENAME TO newIndexName
","
Thomas Mueller's avatar
Thomas Mueller committed
167 168
Renames an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
169 170 171 172 173
","
ALTER INDEX IDXNAME RENAME TO IDX_TEST_NAME
"

"Commands (DDL)","ALTER SEQUENCE","
174
ALTER SEQUENCE sequenceName [ RESTART WITH long ] [ INCREMENT BY long ]
Thomas Mueller's avatar
Thomas Mueller committed
175
","
Thomas Mueller's avatar
Thomas Mueller committed
176 177
Changes the next value and the increment of a sequence.
This command does not commit the current transaction; however the new value is used by other
Thomas Mueller's avatar
Thomas Mueller committed
178 179 180 181 182 183
transactions immediately, and rolling back this command has no effect.
","
ALTER SEQUENCE SEQ_ID RESTART WITH 1000
"

"Commands (DDL)","ALTER TABLE ADD","
184 185
ALTER TABLE tableName ADD name dataType [ DEFAULT expression ]
[ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] [ BEFORE columnName ]
Thomas Mueller's avatar
Thomas Mueller committed
186
","
Thomas Mueller's avatar
Thomas Mueller committed
187 188
Adds a new column to a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
189 190 191 192 193
","
ALTER TABLE TEST ADD CREATEDATE TIMESTAMP
"

"Commands (DDL)","ALTER TABLE ADD CONSTRAINT","
194
ALTER TABLE tableName ADD constraint [ CHECK | NOCHECK ]
Thomas Mueller's avatar
Thomas Mueller committed
195 196 197
","
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
198
The required indexes are automatically created if they don't exist yet.
Thomas Mueller's avatar
Thomas Mueller committed
199
It is not possible to disable checking for unique constraints.
200
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
201 202 203 204
","
ALTER TABLE TEST ADD CONSTRAINT NAME_UNIQUE UNIQUE(NAME)
"

205 206 207 208 209 210 211 212 213
"Commands (DDL)","ALTER TABLE ALTER","
ALTER TABLE tableName ALTER COLUMN columnName
{ { dataType [ DEFAULT expression ] [ [ NOT ] NULL ] [ AUTO_INCREMENT | IDENTITY ] }
    | { RENAME TO name }
    | { RESTART WITH long }
    | { SELECTIVITY int }
    | { SET DEFAULT expression }
    | { SET NULL }
    | { SET NOT NULL } }
Thomas Mueller's avatar
Thomas Mueller committed
214
","
215 216
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
217

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

220 221 222
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
223

224 225 226 227
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
228

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

231
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
232
Single column indexes on this column are dropped.
233 234 235

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

236
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
237
","
238 239 240 241 242 243 244
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
245 246 247 248 249 250
"

"Commands (DDL)","ALTER TABLE DROP COLUMN","
ALTER TABLE tableName DROP COLUMN columnName
","
Removes a column from a table.
251
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
252 253 254 255 256
","
ALTER TABLE TEST DROP COLUMN NAME
"

"Commands (DDL)","ALTER TABLE DROP CONSTRAINT","
257
ALTER TABLE tableName DROP { CONSTRAINT [ IF EXISTS ] constraintName | PRIMARY KEY }
Thomas Mueller's avatar
Thomas Mueller committed
258 259
","
Removes a constraint or a primary key from a table.
260
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
261 262 263 264 265 266
","
ALTER TABLE TEST DROP CONSTRAINT UNIQUE_NAME
"

"Commands (DDL)","ALTER TABLE SET","
ALTER TABLE tableName SET REFERENTIAL_INTEGRITY
267
    { FALSE | TRUE [ CHECK | NOCHECK ] }
Thomas Mueller's avatar
Thomas Mueller committed
268 269 270 271 272 273
","
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.
274 275

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
276 277 278 279 280 281 282
","
ALTER TABLE TEST SET REFERENTIAL_INTEGRITY FALSE
"

"Commands (DDL)","ALTER TABLE RENAME","
ALTER TABLE tableName RENAME TO newName
","
Thomas Mueller's avatar
Thomas Mueller committed
283 284
Renames a table.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
285 286 287 288 289
","
ALTER TABLE TEST RENAME TO MY_DATA
"

"Commands (DDL)","ALTER USER ADMIN","
290
ALTER USER userName ADMIN { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
291
","
Thomas Mueller's avatar
Thomas Mueller committed
292 293 294 295
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.
296
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
297 298 299 300 301 302 303
","
ALTER USER TOM ADMIN TRUE
"

"Commands (DDL)","ALTER USER RENAME","
ALTER USER userName RENAME TO newUserName
","
Thomas Mueller's avatar
Thomas Mueller committed
304 305 306 307
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
308
Admin rights are required to execute this command.
309
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
310 311 312 313 314
","
ALTER USER TOM RENAME TO THOMAS
"

"Commands (DDL)","ALTER USER SET PASSWORD","
315
ALTER USER userName SET { PASSWORD string | SALT bytes HASH bytes }
Thomas Mueller's avatar
Thomas Mueller committed
316
","
Thomas Mueller's avatar
Thomas Mueller committed
317 318 319 320 321 322
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.
323
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
324 325 326 327 328 329 330 331
","
ALTER USER SA SET PASSWORD 'rioyxlgt'
"

"Commands (DDL)","ALTER VIEW","
ALTER VIEW viewName RECOMPILE
","
Recompiles a view after the underlying tables have been changed or created.
332
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
333 334 335 336 337
","
ALTER VIEW ADDRESS_VIEW RECOMPILE
"

"Commands (DDL)","ANALYZE","
338
ANALYZE [ SAMPLE_SIZE rowCountInt ]
Thomas Mueller's avatar
Thomas Mueller committed
339 340 341 342 343 344 345
","
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.
346 347

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
348 349 350 351 352
","
ANALYZE SAMPLE_SIZE 1000
"

"Commands (DDL)","COMMENT","
353 354 355 356 357
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
358
","
Thomas Mueller's avatar
Thomas Mueller committed
359 360 361
Sets the comment of a database object. Use NULL to remove the comment.

Admin rights are required to execute this command.
362
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
363 364 365 366 367
","
COMMENT ON TABLE TEST IS 'Table used for testing'
"

"Commands (DDL)","CREATE AGGREGATE","
368
CREATE AGGREGATE [ IF NOT EXISTS ] newAggregateName FOR className
Thomas Mueller's avatar
Thomas Mueller committed
369 370 371
","
Creates a new user-defined aggregate function. The method name must be the full
qualified class name. The class must implement the interface
Thomas Mueller's avatar
Thomas Mueller committed
372 373 374
org.h2.api.AggregateFunction.

Admin rights are required to execute this command.
375
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
376 377 378 379 380
","
CREATE AGGREGATE MEDIAN FOR ""com.acme.db.Median""
"

"Commands (DDL)","CREATE ALIAS","
381
CREATE ALIAS [ IF NOT EXISTS ] newFunctionAliasName [ DETERMINISTIC ]
382
{ FOR classAndMethodName | AS sourceCodeString }
Thomas Mueller's avatar
Thomas Mueller committed
383
","
384 385 386 387 388
Creates a new function alias. Deterministic functions must always return the
same value for the same parameters. The result of such functions is cached if possible.

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

394 395 396 397
When defining a function alias with source code, the Sun javac is compiler
is used if the tools.jar is in the classpath. If not, javac is run as a separate process.
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
398 399
as dollar quoted text to avoid escaping problems. If import statements are used,
then the tag @CODE must be added before the method.
400

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

Thomas Mueller's avatar
Thomas Mueller committed
404 405 406 407
If the first parameter of the Java function is a java.sql.Connection, then a
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.
408

Thomas Mueller's avatar
Thomas Mueller committed
409
Admin rights are required to execute this command.
410
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
411 412 413 414 415
","
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');
416 417
CREATE ALIAS REVERSE AS $$ String reverse(String s) { return new StringBuilder(s).reverse().toString(); } $$;
CALL REVERSE('Test');
Thomas Mueller's avatar
Thomas Mueller committed
418 419 420
"

"Commands (DDL)","CREATE CONSTANT","
421
CREATE CONSTANT [ IF NOT EXISTS ] newConstantName VALUE expression
Thomas Mueller's avatar
Thomas Mueller committed
422
","
Thomas Mueller's avatar
Thomas Mueller committed
423 424
Creates a new constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
425 426 427 428 429
","
CREATE CONSTANT ONE VALUE 1
"

"Commands (DDL)","CREATE DOMAIN","
430 431 432
CREATE DOMAIN [ IF NOT EXISTS ] newDomainName AS dataType
[ DEFAULT expression ] [ [ NOT ] NULL ] [ SELECTIVITY selectivity ]
[ CHECK condition ]
Thomas Mueller's avatar
Thomas Mueller committed
433 434 435 436
","
Creates a new data type (domain). The check condition must evaluate to true or
to NULL (to prevent NULL, use NOT NULL). In the condition, the term VALUE refers
to the value being tested.
437 438

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
439 440 441 442 443
","
CREATE DOMAIN EMAIL AS VARCHAR(255) CHECK (POSITION('@', VALUE) > 1)
"

"Commands (DDL)","CREATE INDEX","
444 445 446
CREATE { [ UNIQUE ] [ HASH ] INDEX [ IF NOT EXISTS ] newIndexName
    | PRIMARY KEY [ HASH ] }
ON tableName ( indexColumn [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
447
","
Thomas Mueller's avatar
Thomas Mueller committed
448 449
Creates a new index.
This command commits an open transaction.
450

Thomas Mueller's avatar
Thomas Mueller committed
451
Hash indexes are meant for in-memory databases and memory tables (CREATE MEMORY TABLE).
452 453
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
454
Non-unique keys are supported.
Thomas Mueller's avatar
Thomas Mueller committed
455 456 457 458 459
","
CREATE INDEX IDXNAME ON TEST(NAME)
"

"Commands (DDL)","CREATE LINKED TABLE","
460 461 462
CREATE [ [ GLOBAL | LOCAL ] TEMPORARY ] LINKED TABLE [ IF NOT EXISTS ]
name ( driverString, urlString, userString, passwordString,
[ originalSchemaString, ] originalTableString ) [ EMIT UPDATES | READONLY ]
Thomas Mueller's avatar
Thomas Mueller committed
463 464 465 466 467 468 469 470
","
Creates a table link to an external table. The driver name may be empty if the
driver is already loaded. If the schema name is not set, only one table with
that name may exist in the target database.

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

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

To use JNDI to get the connection, the driver class must be a
javax.naming.Context (for example javax.naming.InitialContext), and the URL must
Thomas Mueller's avatar
Thomas Mueller committed
478
be the resource name (for example java:comp/env/jdbc/Test).
479

Thomas Mueller's avatar
Thomas Mueller committed
480
Admin rights are required to execute this command.
481
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
482 483 484 485 486 487 488 489 490
","
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","
491
CREATE ROLE [ IF NOT EXISTS ] newRoleName
Thomas Mueller's avatar
Thomas Mueller committed
492
","
Thomas Mueller's avatar
Thomas Mueller committed
493 494
Creates a new role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
495 496 497 498 499
","
CREATE ROLE READONLY
"

"Commands (DDL)","CREATE SCHEMA","
500
CREATE SCHEMA [ IF NOT EXISTS ] name [ AUTHORIZATION ownerUserName ]
Thomas Mueller's avatar
Thomas Mueller committed
501 502 503
","
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.
504 505

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
506 507 508 509 510
","
CREATE SCHEMA TEST_SCHEMA AUTHORIZATION SA
"

"Commands (DDL)","CREATE SEQUENCE","
511 512
CREATE SEQUENCE [ IF NOT EXISTS ] newSequenceName [ START WITH long ]
[ INCREMENT BY long ] [ CACHE long ]
Thomas Mueller's avatar
Thomas Mueller committed
513 514 515 516 517
","
Creates a new sequence. The data type of a sequence is BIGINT. Used values are
never re-used, even when the transaction is rolled back. The cache is the number
of pre-allocated numbers. If the system crashes without closing the database, at
most this many numbers are lost. The default cache size is 32.
Thomas Mueller's avatar
Thomas Mueller committed
518 519

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
520 521 522 523 524
","
CREATE SEQUENCE SEQ_ID
"

"Commands (DDL)","CREATE TABLE","
525 526
CREATE [ CACHED | MEMORY | TEMP | [ GLOBAL | LOCAL ] TEMPORARY ]
    TABLE [ IF NOT EXISTS ]
527
name { { ( { columnDefinition | constraint } [,...] ) [ AS select ] }
Thomas Mueller's avatar
Thomas Mueller committed
528 529
    | { AS select } }
[ ENGINE tableEngineName ] [ NOT PERSISTENT ]
Thomas Mueller's avatar
Thomas Mueller committed
530 531 532
","
Creates a new table.

533
Cached tables (the default) are persistent, and the number of rows is not limited by the main memory.
Thomas Mueller's avatar
Thomas Mueller committed
534

535
Memory tables are persistent, but the index data is kept in main memory,
Thomas Mueller's avatar
Thomas Mueller committed
536
that means memory tables should not get too large.
537

538 539 540
The ENGINE option is only required when custom table implementations are used.
The table engine class must implement the interface org.h2.api.TableEngine.

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

544
Temporary tables are not persistent. Temporary tables can be global (accessible by all connections)
Thomas Mueller's avatar
Thomas Mueller committed
545
or local (only accessible by the current connection). The default is for temporary tables is global.
Thomas Mueller's avatar
Thomas Mueller committed
546

547
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
548 549 550 551 552
","
CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))
"

"Commands (DDL)","CREATE TRIGGER","
553
CREATE TRIGGER [ IF NOT EXISTS ] newTriggerName { BEFORE | AFTER | INSTEAD OF }
554
{ INSERT | UPDATE | DELETE | SELECT | ROLLBACK } [,...] ON tableName [ FOR EACH ROW ]
555
[ QUEUE int ] [ NOWAIT ] CALL triggeredClassName
Thomas Mueller's avatar
Thomas Mueller committed
556 557
","
Creates a new trigger. The trigger class must be public. Nested and inner
558
classes are not supported.  The class must be available in the classpath of the
559 560
database engine (when using the server mode, it must be in the classpath of the server).

561
'BEFORE' triggers are called after data conversion is made, default values are set,
562
null and length constraint checks have been made;
563 564
but before other constraints have been checked.

565
Only row based 'AFTER' trigger can be called on rollback.
566 567
Exceptions that occur within such triggers are ignored.

568 569 570
'INSTEAD OF' triggers are implicitly row based and behave like 'BEFORE' triggers.
Only the first such trigger is called. Such triggers on views are supported.

571 572 573 574 575 576
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.

Committing or rolling back a transaction within a trigger is not allowed,
except for SELECT triggers.
577 578

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
579 580 581 582
","
CREATE TRIGGER TRIG_INS BEFORE INSERT ON TEST FOR EACH ROW CALL ""MyTrigger""
"
"Commands (DDL)","CREATE USER","
583 584
CREATE USER [ IF NOT EXISTS ] newUserName
{ PASSWORD string | SALT bytes HASH bytes } [ ADMIN ]
Thomas Mueller's avatar
Thomas Mueller committed
585
","
Thomas Mueller's avatar
Thomas Mueller committed
586 587 588
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.
589

Thomas Mueller's avatar
Thomas Mueller committed
590
Admin rights are required to execute this command.
591
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
592 593 594 595 596
","
CREATE USER GUEST PASSWORD 'abc'
"

"Commands (DDL)","CREATE VIEW","
597 598
CREATE [ FORCE ] VIEW [ IF NOT EXISTS ] newViewName
[ ( columnName [,...] ) ] AS select
Thomas Mueller's avatar
Thomas Mueller committed
599 600
","
Creates a new view. If the force option is used, then the view is created even
Thomas Mueller's avatar
Thomas Mueller committed
601
if the underlying table(s) don't exist.
602

Thomas Mueller's avatar
Thomas Mueller committed
603
Admin rights are required to execute this command.
604
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
605 606 607 608 609
","
CREATE VIEW TEST_VIEW AS SELECT * FROM TEST WHERE ID < 100
"

"Commands (DDL)","DROP AGGREGATE","
610
DROP AGGREGATE [ IF EXISTS ] aggregateName
Thomas Mueller's avatar
Thomas Mueller committed
611
","
Thomas Mueller's avatar
Thomas Mueller committed
612 613 614
Drops an existing user-defined aggregate function.

Admin rights are required to execute this command.
615
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
616 617 618 619 620
","
CREATE AGGREGATE MEDIAN
"

"Commands (DDL)","DROP ALIAS","
621
DROP ALIAS [ IF EXISTS ] existingFunctionAliasName
Thomas Mueller's avatar
Thomas Mueller committed
622
","
Thomas Mueller's avatar
Thomas Mueller committed
623 624 625
Drops an existing function alias.

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

"Commands (DDL)","DROP ALL OBJECTS","
632
DROP ALL OBJECTS [ DELETE FILES ]
Thomas Mueller's avatar
Thomas Mueller committed
633 634 635 636 637
","
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
638 639 640
back.

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
641 642 643 644 645
","
DROP ALL OBJECTS
"

"Commands (DDL)","DROP CONSTANT","
646
DROP CONSTANT [ IF EXISTS ] constantName
Thomas Mueller's avatar
Thomas Mueller committed
647
","
Thomas Mueller's avatar
Thomas Mueller committed
648 649
Drops a constant.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
650 651 652 653 654
","
DROP CONSTANT ONE
"

"Commands (DDL)","DROP DOMAIN","
655
DROP DOMAIN [ IF EXISTS ] domainName
Thomas Mueller's avatar
Thomas Mueller committed
656
","
Thomas Mueller's avatar
Thomas Mueller committed
657 658
Drops a data type (domain).
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
659 660 661 662 663
","
DROP DOMAIN EMAIL
"

"Commands (DDL)","DROP INDEX","
664
DROP INDEX [ IF EXISTS ] indexName
Thomas Mueller's avatar
Thomas Mueller committed
665
","
Thomas Mueller's avatar
Thomas Mueller committed
666 667
Drops an index.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
668 669 670 671 672
","
DROP INDEX IF EXISTS IDXNAME
"

"Commands (DDL)","DROP ROLE","
673
DROP ROLE [ IF EXISTS ] roleName
Thomas Mueller's avatar
Thomas Mueller committed
674
","
Thomas Mueller's avatar
Thomas Mueller committed
675 676
Drops a role.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
677 678 679 680 681
","
DROP ROLE READONLY
"

"Commands (DDL)","DROP SCHEMA","
682
DROP SCHEMA [ IF EXISTS ] schemaName
Thomas Mueller's avatar
Thomas Mueller committed
683
","
Thomas Mueller's avatar
Thomas Mueller committed
684 685
Drops a schema.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
686 687 688 689 690
","
DROP SCHEMA TEST_SCHEMA
"

"Commands (DDL)","DROP SEQUENCE","
691
DROP SEQUENCE [ IF EXISTS ] sequenceName
Thomas Mueller's avatar
Thomas Mueller committed
692
","
Thomas Mueller's avatar
Thomas Mueller committed
693 694
Drops a sequence.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
695 696 697 698 699
","
DROP SEQUENCE SEQ_ID
"

"Commands (DDL)","DROP TABLE","
700
DROP TABLE [ IF EXISTS ] tableName [,...]
Thomas Mueller's avatar
Thomas Mueller committed
701 702
","
Drops an existing table, or a list of existing tables.
703
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
704 705 706 707 708
","
DROP TABLE TEST
"

"Commands (DDL)","DROP TRIGGER","
709
DROP TRIGGER [ IF EXISTS ] triggerName
Thomas Mueller's avatar
Thomas Mueller committed
710
","
Thomas Mueller's avatar
Thomas Mueller committed
711 712
Drops an existing trigger.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
713 714 715 716 717
","
DROP TRIGGER TRIG_INS
"

"Commands (DDL)","DROP USER","
718
DROP USER [ IF EXISTS ] userName
Thomas Mueller's avatar
Thomas Mueller committed
719
","
Thomas Mueller's avatar
Thomas Mueller committed
720 721
Drops a user. The current user cannot be dropped.
For compatibility, only unquoted or uppercase user names are allowed.
722

Thomas Mueller's avatar
Thomas Mueller committed
723
Admin rights are required to execute this command.
724
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
725 726 727 728 729
","
DROP USER TOM
"

"Commands (DDL)","DROP VIEW","
730
DROP VIEW [ IF EXISTS ] viewName
Thomas Mueller's avatar
Thomas Mueller committed
731
","
Thomas Mueller's avatar
Thomas Mueller committed
732 733
Drops a view.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
734 735 736 737 738 739 740
","
DROP VIEW TEST_VIEW
"

"Commands (DDL)","TRUNCATE TABLE","
TRUNCATE TABLE tableName
","
Thomas Mueller's avatar
Thomas Mueller committed
741
Removes all rows from a table. Unlike DELETE FROM without where clause, this
Thomas Mueller's avatar
Thomas Mueller committed
742 743
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
Thomas Mueller's avatar
Thomas Mueller committed
744
truncated. Linked tables can't be truncated.
Thomas Mueller's avatar
Thomas Mueller committed
745 746

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
747 748 749 750 751 752 753
","
TRUNCATE TABLE TEST
"

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

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
757 758 759 760 761 762 763
","
CHECKPOINT
"

"Commands (Other)","CHECKPOINT SYNC","
CHECKPOINT SYNC
","
Thomas Mueller's avatar
Thomas Mueller committed
764
Flushes the data to disk and and forces all system buffers be written
Thomas Mueller's avatar
Thomas Mueller committed
765 766 767
to the underlying device.

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

"Commands (Other)","COMMIT","
773
COMMIT [ WORK ]
Thomas Mueller's avatar
Thomas Mueller committed
774 775 776 777 778 779 780 781 782
","
Commits a transaction.
","
COMMIT
"

"Commands (Other)","COMMIT TRANSACTION","
COMMIT TRANSACTION transactionName
","
Thomas Mueller's avatar
Thomas Mueller committed
783 784 785 786
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
787 788 789 790 791
","
COMMIT TRANSACTION XID_TEST
"

"Commands (Other)","GRANT RIGHT","
792 793
GRANT { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
794
","
Thomas Mueller's avatar
Thomas Mueller committed
795 796 797 798
Grants rights for a table to a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
799 800 801 802 803
","
GRANT SELECT ON TEST TO READONLY
"

"Commands (Other)","GRANT ROLE","
804
GRANT roleName TO { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
805
","
Thomas Mueller's avatar
Thomas Mueller committed
806 807 808 809
Grants a role to a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
810 811 812 813 814
","
GRANT READONLY TO PUBLIC
"

"Commands (Other)","HELP","
815
HELP [ anything [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
816 817 818 819 820 821 822 823 824
","
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
825 826
Prepares committing a transaction.
This command is part of the 2-phase-commit protocol.
Thomas Mueller's avatar
Thomas Mueller committed
827 828 829 830 831
","
PREPARE COMMIT XID_TEST
"

"Commands (Other)","REVOKE RIGHT","
832 833
REVOKE { SELECT | INSERT | UPDATE | DELETE | ALL } [,...] ON
tableName [,...] FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
834
","
Thomas Mueller's avatar
Thomas Mueller committed
835 836 837 838
Removes rights for a table from a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
839 840 841 842 843
","
REVOKE SELECT ON TEST FROM READONLY
"

"Commands (Other)","REVOKE ROLE","
844
REVOKE roleName FROM { PUBLIC | userName | roleName }
Thomas Mueller's avatar
Thomas Mueller committed
845
","
Thomas Mueller's avatar
Thomas Mueller committed
846 847 848 849
Removes a role from a user or role.

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
850 851 852 853 854
","
REVOKE READONLY FROM TOM
"

"Commands (Other)","ROLLBACK","
855
ROLLBACK [ TO SAVEPOINT savepointName ]
Thomas Mueller's avatar
Thomas Mueller committed
856 857 858 859 860 861 862 863 864 865
","
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
866 867 868 869
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
870 871 872 873 874 875 876
","
ROLLBACK TRANSACTION XID_TEST
"

"Commands (Other)","SAVEPOINT","
SAVEPOINT savepointName
","
Thomas Mueller's avatar
Thomas Mueller committed
877 878
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
879 880 881 882 883
","
SAVEPOINT HALF_DONE
"

"Commands (Other)","SET @","
884
SET @variableName [ = ] expression
Thomas Mueller's avatar
Thomas Mueller committed
885
","
Thomas Mueller's avatar
Thomas Mueller committed
886 887
Updates a user-defined variable.
This command does not commit a transaction, and rollback does not affect it.
Thomas Mueller's avatar
Thomas Mueller committed
888 889 890 891 892
","
SET @TOTAL=0
"

"Commands (Other)","SET ALLOW_LITERALS","
893
SET ALLOW_LITERALS { NONE | ALL | NUMBERS }
Thomas Mueller's avatar
Thomas Mueller committed
894 895 896 897 898 899 900 901 902 903
","
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
904 905 906 907 908 909
See also CREATE CONSTANT.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
This setting can be appended to the database URL: jdbc:h2:test;ALLOW_LITERALS=NONE
Thomas Mueller's avatar
Thomas Mueller committed
910 911 912 913 914
","
SET ALLOW_LITERALS NONE
"

"Commands (Other)","SET AUTOCOMMIT","
915
SET AUTOCOMMIT { TRUE | ON | FALSE | OFF }
Thomas Mueller's avatar
Thomas Mueller committed
916 917 918 919 920 921 922 923 924 925
","
Switches auto commit on or off.
This setting can be appended to the database URL: jdbc:h2:test;AUTOCOMMIT=OFF
","
SET AUTOCOMMIT OFF
"

"Commands (Other)","SET CACHE_SIZE","
SET CACHE_SIZE int
","
926 927
Sets the size of the cache in KB (each KB being 1024 bytes) for the current database.
The default value is 16384 (16 MB). The value is rounded to the next higher power of two.
Thomas Mueller's avatar
Thomas Mueller committed
928 929
Depending on the virtual machine, the actual memory required may be higher.

Thomas Mueller's avatar
Thomas Mueller committed
930
This setting is persistent and affects all connections as there is only one cache per database.
931
This setting only affects the database engine (the server in a client/server environment).
Thomas Mueller's avatar
Thomas Mueller committed
932
It has no effect for in-memory databases.
933

Thomas Mueller's avatar
Thomas Mueller committed
934 935 936 937
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
This setting can be appended to the database URL: jdbc:h2:test;CACHE_SIZE=8192
Thomas Mueller's avatar
Thomas Mueller committed
938 939 940 941 942 943 944 945 946 947 948 949
","
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
950 951 952 953
server is not responding).

Admin rights are required to execute this command.
This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
954 955 956 957 958
","
SET CLUSTER ''
"

"Commands (Other)","SET COLLATION","
959 960
SET [ DATABASE ] COLLATION
{ OFF | collationName [ STRENGTH { PRIMARY | SECONDARY | TERTIARY | IDENTICAL } ] }
Thomas Mueller's avatar
Thomas Mueller committed
961 962 963
","
Sets the collation used for comparing strings. This command can only be executed
if there are no tables defined. See java.text.Collator for details about
Thomas Mueller's avatar
Thomas Mueller committed
964 965 966 967 968
STRENGTH.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
969 970 971 972 973
","
SET COLLATION ENGLISH
"

"Commands (Other)","SET COMPRESS_LOB","
974
SET COMPRESS_LOB { NO | LZF | DEFLATE }
Thomas Mueller's avatar
Thomas Mueller committed
975 976 977
","
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
978 979 980 981

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
982 983 984 985 986 987 988 989
","
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
990 991 992 993 994
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).
This setting can be appended to the database URL: jdbc:h2:test;DATABASE_EVENT_LISTENER='sample.MyListener'
Thomas Mueller's avatar
Thomas Mueller committed
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
","
SET DATABASE_EVENT_LISTENER 'sample.MyListener'
"

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

If the application exits normally or System.exit is called, the database is
Thomas Mueller's avatar
Thomas Mueller committed
1009 1010 1011 1012 1013 1014
closed immediately, even if a delay is set.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
This setting can be appended to the database URL: jdbc:h2:test;DB_CLOSE_DELAY=-1
Thomas Mueller's avatar
Thomas Mueller committed
1015 1016 1017 1018 1019 1020 1021 1022
","
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
1023 1024 1025 1026 1027
for the new sessions. The default value for this setting is 1000 (one second).

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1028 1029 1030 1031 1032
","
SET DEFAULT_LOCK_TIMEOUT 5000
"

"Commands (Other)","SET DEFAULT_TABLE_TYPE","
1033
SET DEFAULT_TABLE_TYPE { MEMORY | CACHED }
Thomas Mueller's avatar
Thomas Mueller committed
1034 1035 1036
","
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
1037
the data is still stored in the database file. The size of memory tables is
Thomas Mueller's avatar
Thomas Mueller committed
1038
limited by the memory. The default is CACHED.
Thomas Mueller's avatar
Thomas Mueller committed
1039

Thomas Mueller's avatar
Thomas Mueller committed
1040 1041 1042
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1043 1044 1045 1046 1047
","
SET DEFAULT_TABLE_TYPE MEMORY
"

"Commands (Other)","SET EXCLUSIVE","
1048
SET EXCLUSIVE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1049 1050 1051 1052 1053
","
Switched the database to exclusive mode and back. In exclusive mode, new
connections are rejected, and operations by other connections are paused until
the exclusive mode is disabled. 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
1054 1055 1056 1057

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1058 1059 1060 1061 1062
","
SET EXCLUSIVE TRUE
"

"Commands (Other)","SET IGNORECASE","
1063
SET IGNORECASE { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1064 1065 1066 1067 1068 1069
","
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
1070 1071 1072
Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1073 1074 1075 1076 1077 1078 1079 1080
","
SET IGNORECASE TRUE
"

"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
1081
(READ_COMMITTED). This setting affects all connections.
Thomas Mueller's avatar
Thomas Mueller committed
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

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

This command does not commit a transaction, and rollback does not affect it.
This setting can be appended to the database URL: jdbc:h2:test;LOCK_TIMEOUT=10000
Thomas Mueller's avatar
Thomas Mueller committed
1111 1112 1113 1114 1115 1116 1117 1118 1119
","
SET LOCK_TIMEOUT 1000
"

"Commands (Other)","SET MAX_LENGTH_INPLACE_LOB","
SET MAX_LENGTH_INPLACE_LOB int
","
Sets the maximum size of an in-place LOB object. LOB objects larger that this
size are stored in a separate file, otherwise stored directly in the database
Thomas Mueller's avatar
Thomas Mueller committed
1120 1121 1122 1123 1124
(in-place). The default max size is 1024.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1125 1126 1127 1128 1129 1130 1131
","
SET MAX_LENGTH_INPLACE_LOB 128
"

"Commands (Other)","SET MAX_LOG_SIZE","
SET MAX_LOG_SIZE int
","
Thomas Mueller's avatar
Thomas Mueller committed
1132 1133
Sets the maximum size of the transaction log, in megabytes. If the log exceeds the
limit, a new stream is created. Old streams (that are not used for recovery) are
Thomas Mueller's avatar
Thomas Mueller committed
1134
freed automatically. The default max size is 2 MB.
Thomas Mueller's avatar
Thomas Mueller committed
1135 1136 1137 1138

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1139 1140 1141 1142 1143 1144 1145 1146
","
SET MAX_LOG_SIZE 2
"

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

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1152 1153 1154 1155 1156 1157 1158 1159 1160
","
SET MAX_MEMORY_ROWS 1000
"

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

Admin rights are required to execute this command.
This command commits an open transaction.
This setting is persistent.
Thomas Mueller's avatar
Thomas Mueller committed
1167 1168 1169 1170 1171 1172 1173 1174 1175
","
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
1176 1177 1178 1179 1180
operation. The default max size is 100000. 0 means no limit.

This setting is not persistent.
Admin rights are required to execute this command.
This setting can be appended to the database URL: jdbc:h2:test;MAX_OPERATION_MEMORY=10000
Thomas Mueller's avatar
Thomas Mueller committed
1181 1182 1183 1184 1185
","
SET MAX_OPERATION_MEMORY 0
"

"Commands (Other)","SET MODE","
1186
SET MODE { REGULAR | DB2 | DERBY | HSQLDB | MSSQLSERVER | MYSQL | ORACLE | POSTGRESQL }
Thomas Mueller's avatar
Thomas Mueller committed
1187 1188
","
Changes to another database compatibility mode. For details, see Compatibility
Thomas Mueller's avatar
Thomas Mueller committed
1189 1190 1191 1192 1193 1194
Modes in the feature section.

This setting is not persistent.
Admin rights are required to execute this command.
This command commits an open transaction.
This setting can be appended to the database URL: jdbc:h2:test;MODE=MYSQL
Thomas Mueller's avatar
Thomas Mueller committed
1195 1196 1197 1198 1199
","
SET MODE HSQLDB
"

"Commands (Other)","SET MULTI_THREADED","
1200
SET MULTI_THREADED { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1201 1202 1203
","
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
1204 1205 1206 1207 1208 1209 1210 1211
only.

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

Admin rights are required to execute this command.
This command commits an open transaction.
This setting can be appended to the database URL: jdbc:h2:test;MULTI_THREADED=1
Thomas Mueller's avatar
Thomas Mueller committed
1212 1213 1214 1215 1216
","
SET MULTI_THREADED 1
"

"Commands (Other)","SET OPTIMIZE_REUSE_RESULTS","
1217
SET OPTIMIZE_REUSE_RESULTS { 0 | 1 }
Thomas Mueller's avatar
Thomas Mueller committed
1218 1219 1220
","
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
1221 1222 1223 1224 1225
the tables was changed. This option is enabled by default.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting can be appended to the database URL: jdbc:h2:test;OPTIMIZE_REUSE_RESULTS=0
Thomas Mueller's avatar
Thomas Mueller committed
1226 1227 1228 1229 1230 1231 1232 1233 1234
","
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
1235 1236

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1237 1238 1239 1240 1241 1242 1243 1244 1245
","
SET PASSWORD 'abcstzri!.5'
"

"Commands (Other)","SET QUERY_TIMEOUT","
SET QUERY_TIMEOUT int
","
Set the query timeout of the current session to the given value. The timeout is
in milliseconds. All kinds of statements will throw an exception if they take
Thomas Mueller's avatar
Thomas Mueller committed
1246 1247 1248
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
1249 1250 1251 1252 1253
","
SET QUERY_TIMEOUT 10000
"

"Commands (Other)","SET REFERENTIAL_INTEGRITY","
1254
SET REFERENTIAL_INTEGRITY { TRUE | FALSE }
Thomas Mueller's avatar
Thomas Mueller committed
1255 1256 1257
","
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
1258 1259 1260 1261 1262
for one table.

This setting is not persistent.
This command commits an open transaction.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1263 1264 1265 1266 1267 1268 1269 1270 1271
","
SET REFERENTIAL_INTEGRITY FALSE
"

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

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1274 1275 1276 1277 1278 1279 1280 1281 1282
","
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
1283 1284 1285 1286
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
This setting can be appended to the database URL: jdbc:h2:test;SCHEMA=ABC
Thomas Mueller's avatar
Thomas Mueller committed
1287 1288 1289 1290 1291 1292 1293 1294 1295
","
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
1296 1297 1298 1299
connections is PUBLIC.

This command does not commit a transaction, and rollback does not affect it.
This setting can be appended to the database URL: jdbc:h2:test;SCHEMA_SEARCH_PATH=ABC,DEF
Thomas Mueller's avatar
Thomas Mueller committed
1300 1301 1302 1303 1304 1305 1306 1307 1308
","
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
1309 1310 1311 1312
disabled).

This command does not commit a transaction, and rollback does not affect it.
This setting can be appended to the database URL: jdbc:h2:test;THROTTLE=50
Thomas Mueller's avatar
Thomas Mueller committed
1313 1314 1315 1316 1317
","
SET THROTTLE 200
"

"Commands (Other)","SET TRACE_LEVEL","
1318
SET { TRACE_LEVEL_FILE | TRACE_LEVEL_SYSTEM_OUT } int
Thomas Mueller's avatar
Thomas Mueller committed
1319 1320 1321
","
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.
Thomas Mueller's avatar
Thomas Mueller committed
1322
To use SLF4J, append ;TRACE_LEVEL_FILE=4 to the database URL when opening the database.
Thomas Mueller's avatar
Thomas Mueller committed
1323

Thomas Mueller's avatar
Thomas Mueller committed
1324 1325 1326 1327
This setting is not persistent.
Admin rights are required to execute this command.
This command does not commit a transaction, and rollback does not affect it.
This setting can be appended to the database URL: jdbc:h2:test;TRACE_LEVEL_SYSTEM_OUT=3
Thomas Mueller's avatar
Thomas Mueller committed
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
","
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
1339 1340 1341 1342
This setting is persistent.
Admin rights are required to execute this command.
This command commits an open transaction.
This setting can be appended to the database URL: jdbc:h2:test;TRACE_MAX_FILE_SIZE=3
Thomas Mueller's avatar
Thomas Mueller committed
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
","
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
1353 1354

This command commits an open transaction.
Thomas Mueller's avatar
Thomas Mueller committed
1355 1356 1357 1358 1359 1360 1361 1362
","
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
1363 1364 1365 1366 1367
This setting is persistent. The default is 500 ms.

Admin rights are required to execute this command.
This command commits an open transaction.
This setting can be appended to the database URL: jdbc:h2:test;WRITE_DELAY=0
Thomas Mueller's avatar
Thomas Mueller committed
1368 1369 1370 1371 1372
","
SET WRITE_DELAY 2000
"

"Commands (Other)","SHUTDOWN","
1373
SHUTDOWN [ IMMEDIATELY | COMPACT ]
Thomas Mueller's avatar
Thomas Mueller committed
1374
","
1375 1376
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
1377
closed automatically when the last connection to it is closed.
Thomas Mueller's avatar
Thomas Mueller committed
1378

1379 1380
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
1381
COMPACT compacts the database (re-creating the database may further reduce the database size).
1382
IMMEDIATELY closes the database files without any cleanup.
Thomas Mueller's avatar
Thomas Mueller committed
1383 1384

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
1385
","
1386
SHUTDOWN COMPACT
Thomas Mueller's avatar
Thomas Mueller committed
1387 1388
"

1389 1390
"Other Grammar","Alias","
name
Thomas Mueller's avatar
Thomas Mueller committed
1391
","
1392
An alias is a name that is only valid in the context of the statement.
Thomas Mueller's avatar
Thomas Mueller committed
1393
","
1394
A
Thomas Mueller's avatar
Thomas Mueller committed
1395 1396
"

1397 1398
"Other Grammar","And Condition","
condition [ { AND condition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1399
","
1400
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1401
","
1402
ID=1 AND NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1403 1404
"

1405 1406
"Other Grammar","Array","
( expression [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
1407
","
1408
An array of values.
Thomas Mueller's avatar
Thomas Mueller committed
1409
","
1410
(1, 2)
Thomas Mueller's avatar
Thomas Mueller committed
1411 1412
"

1413 1414
"Other Grammar","Boolean","
TRUE | FALSE
1415
","
1416
A boolean value.
1417
","
1418
TRUE
1419 1420
"

1421 1422
"Other Grammar","Bytes","
X'hex'
Thomas Mueller's avatar
Thomas Mueller committed
1423
","
1424
A binary value. The hex value is not case sensitive.
Thomas Mueller's avatar
Thomas Mueller committed
1425
","
1426
X'01FF'
Thomas Mueller's avatar
Thomas Mueller committed
1427 1428
"

1429 1430 1431
"Other Grammar","Case","
CASE expression { WHEN expression THEN expression } [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1432
","
1433 1434
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
1435
","
1436
CASE CNT WHEN 0 THEN 'No' WHEN 1 THEN 'One' ELSE 'Some' END
Thomas Mueller's avatar
Thomas Mueller committed
1437 1438
"

1439 1440 1441
"Other Grammar","Case When","
CASE { WHEN expression THEN expression} [...]
[ ELSE expression ] END
Thomas Mueller's avatar
Thomas Mueller committed
1442
","
1443 1444
Returns the first expression where the condition is true. If no else part is
specified, return NULL.
Thomas Mueller's avatar
Thomas Mueller committed
1445
","
1446 1447 1448 1449 1450 1451
CASE WHEN CNT<10 THEN 'Low' ELSE 'High' END
"

"Other Grammar","Cipher","
{ AES | XTEA }
","
Thomas Mueller's avatar
Thomas Mueller committed
1452
Two algorithms are supported, AES (AES-128) and XTEA (using 32 rounds). The AES
1453 1454 1455
algorithm is about half as fast as XTEA.
","
AES
Thomas Mueller's avatar
Thomas Mueller committed
1456 1457
"

1458 1459 1460 1461 1462 1463
"Other Grammar","Column Definition","
columnName dataType { DEFAULT expression | AS computedColumnExpression } [ [ NOT ] NULL ]
[ { AUTO_INCREMENT | IDENTITY } [ ( startInt [, incrementInt ] ) ] ]
[ SELECTIVITY selectivity ] [ PRIMARY KEY [ HASH ] | UNIQUE ]
","
Default expressions are used if no explicit value was used when adding a row.
Thomas Mueller's avatar
Thomas Mueller committed
1464
The computed column expression is evaluated and assigned whenever the row changes.
1465 1466 1467 1468 1469

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
1470 1471 1472
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);
1473 1474
"

1475 1476
"Other Grammar","Comments","
-- anythingUntilEndOfLine | // anythingUntilEndOfLine | /* anythingUntilEndComment */
Thomas Mueller's avatar
Thomas Mueller committed
1477
","
1478 1479 1480
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
1481
","
1482
// This is a comment
Thomas Mueller's avatar
Thomas Mueller committed
1483 1484
"

1485 1486
"Other Grammar","Compare","
<> | <= | >= | = | < | > | !=
Thomas Mueller's avatar
Thomas Mueller committed
1487
","
1488
Comparison operator. The operator != is the same as <>.
Thomas Mueller's avatar
Thomas Mueller committed
1489
","
1490
<>
Thomas Mueller's avatar
Thomas Mueller committed
1491 1492 1493
"

"Other Grammar","Condition","
1494
operand [ conditionRightHandSide ] | NOT condition | EXISTS ( select )
Thomas Mueller's avatar
Thomas Mueller committed
1495 1496 1497 1498 1499 1500 1501
","
Boolean value or condition.
","
ID<>2
"

"Other Grammar","Condition Right Hand Side","
1502 1503 1504 1505 1506 1507
compare { { { ALL | ANY | SOME } ( select ) } | operand }
    | IS [ NOT ] NULL
    | BETWEEN operand AND operand
    | IN ( { select | expression [,...] } )
    | [ NOT ] LIKE operand [ ESCAPE string ]
    | [ NOT ] REGEXP operand
Thomas Mueller's avatar
Thomas Mueller committed
1508
","
Thomas Mueller's avatar
Thomas Mueller committed
1509
The right hand side of a condition.
1510

Thomas Mueller's avatar
Thomas Mueller committed
1511 1512
When comparing with LIKE, the wildcards characters are _ (any one character)
and % (any characters). The database uses an index when comparing with LIKE
1513
except if the operand starts with a wildcard. To search for the characters % and
Thomas Mueller's avatar
Thomas Mueller committed
1514
_, the characters need to be escaped. The default escape character is \ (backslash).
1515
To select no escape character, use ESCAPE '' (empty string).
1516 1517 1518
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.
1519

Thomas Mueller's avatar
Thomas Mueller committed
1520
When comparing with REGEXP, regular expression matching is used.
1521
See Java Matcher.find for details.
Thomas Mueller's avatar
Thomas Mueller committed
1522 1523 1524 1525
","
LIKE 'Jo%'
"

1526 1527 1528 1529 1530
"Other Grammar","Constraint","
[ constraintNameDefinition ] {
    CHECK expression | UNIQUE ( columnName [,...] )
    | referentialConstraint }
    | PRIMARY KEY [ HASH ] ( columnName [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
1531
","
1532 1533
Defines a constraint. The check condition must evaluate to true or to NULL (to
prevent NULL, use NOT NULL).
Thomas Mueller's avatar
Thomas Mueller committed
1534
","
1535
PRIMARY KEY(ID, NAME)
Thomas Mueller's avatar
Thomas Mueller committed
1536 1537
"

1538 1539
"Other Grammar","Constraint Name Definition","
CONSTRAINT [ IF NOT EXISTS ] newConstraintName
Thomas Mueller's avatar
Thomas Mueller committed
1540
","
1541
Defines a constraint name.
Thomas Mueller's avatar
Thomas Mueller committed
1542
","
1543
CONSTRAINT CONST_ID
Thomas Mueller's avatar
Thomas Mueller committed
1544 1545
"

1546 1547
"Other Grammar","Csv Options","
charsetString [, fieldSepString [, fieldDelimString [, escString [, nullString]]]]]
Thomas Mueller's avatar
Thomas Mueller committed
1548
","
1549
Optional parameters for CSVREAD and CSVWRITE.
Thomas Mueller's avatar
Thomas Mueller committed
1550
","
1551
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'UTF-8', '|');
Thomas Mueller's avatar
Thomas Mueller committed
1552 1553
"

1554 1555 1556 1557 1558
"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
1559
","
1560
A data type definition.
Thomas Mueller's avatar
Thomas Mueller committed
1561
","
1562
INT
Thomas Mueller's avatar
Thomas Mueller committed
1563 1564
"

1565 1566
"Other Grammar","Date","
DATE 'yyyy-MM-dd'
Thomas Mueller's avatar
Thomas Mueller committed
1567
","
1568 1569 1570
A date literal. The limitations are the same as for the Java data type
java.sql.Date, but for compatibility with other databases the suggested minimum
and maximum years are 0001 and 9999.
Thomas Mueller's avatar
Thomas Mueller committed
1571
","
1572
DATE '2004-12-31'
Thomas Mueller's avatar
Thomas Mueller committed
1573 1574
"

1575 1576
"Other Grammar","Decimal","
[ + | - ] number [ . number ]
1577
","
1578
Number with fixed precision and scale.
1579
","
1580
-1600.05
1581 1582
"

1583 1584
"Other Grammar","Digit","
0-9
Thomas Mueller's avatar
Thomas Mueller committed
1585
","
1586
A digit.
Thomas Mueller's avatar
Thomas Mueller committed
1587
","
1588
0
Thomas Mueller's avatar
Thomas Mueller committed
1589 1590
"

1591 1592
"Other Grammar","Dollar Quoted String","
$$anythingExceptTwoDollarSigns$$
Thomas Mueller's avatar
Thomas Mueller committed
1593
","
1594 1595 1596
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
1597
","
1598
$$John's car$$
Thomas Mueller's avatar
Thomas Mueller committed
1599 1600
"

1601 1602
"Other Grammar","Double","
[ + | - ] { { number [ . number ] } | { . number } } [ E [ + | - ] expNumber [...] ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1603
","
1604
The limitations are the same as for the Java data type Double.
Thomas Mueller's avatar
Thomas Mueller committed
1605
","
1606
-1.4e-10
Thomas Mueller's avatar
Thomas Mueller committed
1607 1608
"

1609 1610
"Other Grammar","Expression","
andCondition [ { OR andCondition } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1611
","
1612
Value or condition.
Thomas Mueller's avatar
Thomas Mueller committed
1613
","
1614
ID=1 OR NAME='Hi'
Thomas Mueller's avatar
Thomas Mueller committed
1615 1616
"

1617 1618
"Other Grammar","Factor","
term [ { { * | / } term } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1619
","
1620
A value or a numeric factor.
Thomas Mueller's avatar
Thomas Mueller committed
1621
","
1622
ID * 10
Thomas Mueller's avatar
Thomas Mueller committed
1623 1624
"

1625 1626
"Other Grammar","Hex","
{ { digit | a-f | A-F } { digit | a-f | A-F } } [...]
Thomas Mueller's avatar
Thomas Mueller committed
1627
","
1628 1629
The hexadecimal representation of a number or of bytes. Two characters are one
byte.
Thomas Mueller's avatar
Thomas Mueller committed
1630
","
1631
cafe
Thomas Mueller's avatar
Thomas Mueller committed
1632 1633
"

1634 1635
"Other Grammar","Hex Number","
[ + | - ] 0x hex
Thomas Mueller's avatar
Thomas Mueller committed
1636
","
1637
A number written in hexadecimal notation.
Thomas Mueller's avatar
Thomas Mueller committed
1638
","
1639
0xff
Thomas Mueller's avatar
Thomas Mueller committed
1640 1641
"

1642 1643
"Other Grammar","Index Column","
columnName [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1644
","
1645 1646 1647
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
1648
","
1649
NAME
Thomas Mueller's avatar
Thomas Mueller committed
1650 1651 1652
"

"Other Grammar","Int","
1653
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1654 1655 1656 1657 1658 1659 1660
","
The maximum integer number is 2147483647, the minimum is -2147483648.
","
10
"

"Other Grammar","Long","
1661
[ + | - ] number
Thomas Mueller's avatar
Thomas Mueller committed
1662 1663 1664 1665 1666 1667
","
Long numbers are between -9223372036854775808 and 9223372036854775807.
","
100000
"

1668 1669
"Other Grammar","Name","
{ { A-Z|_  } [ { A-Z|_|0-9 } [...] ] } | quotedName
Thomas Mueller's avatar
Thomas Mueller committed
1670
","
1671
Names are not case sensitive. There is no maximum name length.
Thomas Mueller's avatar
Thomas Mueller committed
1672
","
1673
TEST
Thomas Mueller's avatar
Thomas Mueller committed
1674 1675
"

1676 1677
"Other Grammar","Null","
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1678
","
1679
NULL is a value without data type and means 'unknown value'.
Thomas Mueller's avatar
Thomas Mueller committed
1680
","
1681
NULL
Thomas Mueller's avatar
Thomas Mueller committed
1682 1683
"

1684 1685 1686 1687 1688 1689 1690 1691
"Other Grammar","Number","
digit [...]
","
The maximum length of the number depends on the data type used.
","
100
"

1692 1693
"Other Grammar","Operand","
summand [ { || summand } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1694
","
1695
A value or a concatenation of values.
Thomas Mueller's avatar
Thomas Mueller committed
1696
","
1697
'Hi' || ' Eva'
Thomas Mueller's avatar
Thomas Mueller committed
1698 1699
"

1700 1701
"Other Grammar","Order","
{ int | expression } [ ASC | DESC ] [ NULLS { FIRST | LAST } ]
Thomas Mueller's avatar
Thomas Mueller committed
1702
","
1703 1704 1705
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
1706
","
1707
NAME DESC NULLS LAST
Thomas Mueller's avatar
Thomas Mueller committed
1708 1709
"

1710 1711
"Other Grammar","Quoted Name","
""anythingExceptDoubleQuote""
Thomas Mueller's avatar
Thomas Mueller committed
1712
","
1713 1714 1715
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
1716
","
1717
""FirstName""
Thomas Mueller's avatar
Thomas Mueller committed
1718 1719
"

1720 1721 1722 1723 1724
"Other Grammar","Referential Constraint","
FOREIGN KEY ( columnName [,...] )
REFERENCES [ refTableName ] [ ( refColumnName [,...] ) ]
[ ON DELETE { CASCADE | RESTRICT | NO ACTION | SET { DEFAULT | NULL } } ]
[ ON UPDATE { CASCADE | SET { DEFAULT | NULL } } ]
Thomas Mueller's avatar
Thomas Mueller committed
1725
","
1726 1727 1728 1729 1730
Defines a referential constraint. If the table name is not specified, then the
same table is referenced. As this database does not support deferred checking,
RESTRICT and NO ACTION will both throw an exception if the constraint is
violated. If the referenced columns are not specified, then the primary key
columns are used. The required indexes are automatically created if required.
Thomas Mueller's avatar
Thomas Mueller committed
1731
","
1732
FOREIGN KEY(ID) REFERENCES TEST(ID)
Thomas Mueller's avatar
Thomas Mueller committed
1733 1734
"

1735 1736
"Other Grammar","Select Expression","
* | expression [ [ AS ] columnAlias ] | tableAlias.*
Thomas Mueller's avatar
Thomas Mueller committed
1737
","
1738
An expression in a SELECT statement.
Thomas Mueller's avatar
Thomas Mueller committed
1739
","
1740
ID AS VALUE
Thomas Mueller's avatar
Thomas Mueller committed
1741 1742
"

1743 1744
"Other Grammar","String","
'anythingExceptSingleQuote'
Thomas Mueller's avatar
Thomas Mueller committed
1745
","
1746 1747
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
1748
","
1749
'John''s car'
Thomas Mueller's avatar
Thomas Mueller committed
1750 1751
"

1752 1753
"Other Grammar","Summand","
factor [ { { + | - } factor } [...] ]
Thomas Mueller's avatar
Thomas Mueller committed
1754
","
1755
A value or a numeric sum.
Thomas Mueller's avatar
Thomas Mueller committed
1756
","
1757
ID + 20
Thomas Mueller's avatar
Thomas Mueller committed
1758 1759
"

1760 1761 1762 1763
"Other Grammar","Table Expression","
{ [ schemaName. ] tableName | ( select ) } [ [ AS ] newTableAlias ]
[ { { LEFT | RIGHT } [ OUTER ] | [ INNER ] | CROSS | NATURAL }
    JOIN tableExpression [ ON expression ] ]
Thomas Mueller's avatar
Thomas Mueller committed
1764
","
1765 1766 1767
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
1768
","
1769
TEST AS T LEFT JOIN TEST AS T1 ON T.ID = T1.ID
Thomas Mueller's avatar
Thomas Mueller committed
1770 1771
"

1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
"Other Grammar","Term","
value
    | columnName
    | ?[ int ]
    | NEXT VALUE FOR sequenceName
    | function
    | { - | + } term
    | ( expression )
    | select
    | case
    | caseWhen
    | tableAlias.columnName
Thomas Mueller's avatar
Thomas Mueller committed
1784
","
1785
A value. Parameters can be indexed, for example ?1 meaning the first parameter.
Thomas Mueller's avatar
Thomas Mueller committed
1786
","
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
'Hello'
"

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

"Other Grammar","Timestamp","
TIMESTAMP 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]'
","
A timestamp literal. The limitations are the same as for the Java data type
java.sql.Timestamp, but for compatibility with other databases the suggested
minimum and maximum years are 0001 and 9999.
","
TIMESTAMP '2005-12-31 23:59:59'
"

"Other Grammar","Value","
string | dollarQuotedString | hexNumber | int | long | decimal | double
    | date | time | timestamp | boolean | bytes | array | null
","
A value of any data type, or null.
","
10
Thomas Mueller's avatar
Thomas Mueller committed
1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879
"

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

Mapped to java.lang.Integer.
","
INT
"

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

Mapped to java.lang.Boolean.
","
BOOLEAN
"

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

Mapped to java.lang.Byte.
","
TINYINT
"

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

Mapped to java.lang.Short.
","
SMALLINT
"

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

Mapped to java.lang.Long.
","
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.

Mapped to java.lang.Long.
","
IDENTITY
"

"Data Types","DECIMAL Type","
1880
{ DECIMAL | NUMBER | DEC | NUMERIC } ( precisionInt [ , scaleInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
","
Data type with fixed precision and scale. This data type is recommended for
storing currency values.

Mapped to java.math.BigDecimal.
","
DECIMAL(20, 2)
"

"Data Types","DOUBLE Type","
1891
{ DOUBLE [ PRECISION ] | FLOAT | FLOAT4 | FLOAT8 }
Thomas Mueller's avatar
Thomas Mueller committed
1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916
","
Floating point number. Should not be used to represent currency values, because
of rounding problems.

Mapped to java.lang.Double.
","
DOUBLE
"

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

Mapped to java.lang.Float.
","
REAL
"

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

Thomas Mueller's avatar
Thomas Mueller committed
1917
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
1918 1919 1920 1921 1922 1923 1924 1925 1926
","
TIME
"

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

1927
Mapped to java.sql.Date, with the time set to 00:00:00
Thomas Mueller's avatar
Thomas Mueller committed
1928
(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
1929 1930 1931 1932 1933
","
DATE
"

"Data Types","TIMESTAMP Type","
1934
{ TIMESTAMP | DATETIME | SMALLDATETIME }
Thomas Mueller's avatar
Thomas Mueller committed
1935 1936 1937 1938 1939 1940 1941 1942 1943
","
The format is yyyy-MM-dd hh:mm:ss[.nnnnnnnnn].

Mapped to java.sql.Timestamp (java.util.Date is also supported).
","
TIMESTAMP
"

"Data Types","BINARY Type","
1944
{ BINARY | VARBINARY | LONGVARBINARY | RAW | BYTEA } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
1945
","
1946 1947 1948 1949 1950
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
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971

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

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

Mapped to java.lang.Object (or any subclass).
","
OTHER
"

"Data Types","VARCHAR Type","
1972 1973
{ VARCHAR | LONGVARCHAR | VARCHAR2 | NVARCHAR
    | NVARCHAR2 | VARCHAR_CASESENSITIVE}  [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
1974
","
Thomas Mueller's avatar
Thomas Mueller committed
1975
Unicode String. Use two single quotes ('') to create a quote. The maximum precision
1976 1977
is Integer.MAX_VALUE. The precision is a size constraint; only the actual data is
persisted. The whole text is kept in memory when using this data type. For large text data CLOB
Thomas Mueller's avatar
Thomas Mueller committed
1978 1979 1980 1981 1982 1983 1984 1985
should be used; see there for details.

Mapped to java.lang.String.
","
VARCHAR(255)
"

"Data Types","VARCHAR_IGNORECASE Type","
1986
VARCHAR_IGNORECASE [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
1987 1988
","
Same as VARCHAR, but not case sensitive when comparing. Stored in mixed case.
1989 1990 1991
The maximum precision is Integer.MAX_VALUE characters, but the whole text is kept in
memory when using this data type. For large text data CLOB should be used;
see there for details.
Thomas Mueller's avatar
Thomas Mueller committed
1992 1993 1994 1995 1996 1997 1998

Mapped to java.lang.String.
","
VARCHAR_IGNORECASE
"

"Data Types","CHAR Type","
1999
{ CHAR | CHARACTER | NCHAR } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2000 2001 2002 2003
","
This type is supported for compatibility with other databases and older
applications. The difference to VARCHAR is that trailing spaces are ignored and
not persisted. Unicode String. Use two single quotes ('') to create a quote.
Thomas Mueller's avatar
Thomas Mueller committed
2004
The maximum precision is Integer.MAX_VALUE. The precision is a size constraint;
2005 2006
only the actual data is persisted. The whole text is kept in memory when using
this data type. For large text data CLOB should be used; see there for details.
Thomas Mueller's avatar
Thomas Mueller committed
2007 2008 2009 2010 2011 2012 2013

Mapped to java.lang.String.
","
CHAR(10)
"

"Data Types","BLOB Type","
2014
{ BLOB | TINYBLOB | MEDIUMBLOB | LONGBLOB | IMAGE | OID } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
","
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
PreparedStatement.setBinaryStream to store values. See also CLOB and
Advanced / Large Objects.

Mapped to java.sql.Blob (java.io.InputStream is also supported).
","
BLOB
"

"Data Types","CLOB Type","
2027
{ CLOB | TINYTEXT | TEXT | MEDIUMTEXT | LONGTEXT | NTEXT | NCLOB } [ ( precisionInt ) ]
Thomas Mueller's avatar
Thomas Mueller committed
2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
","
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
PreparedStatement.setCharacterStream to store values. See also Advanced / Large Objects.

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.

Mapped to java.sql.Clob (java.io.Reader is also supported).
","
CLOB
"

"Data Types","UUID Type","
UUID
","
Universally unique identifier. This is a 128 bit value. Use
PreparedStatement.setBytes or setString to store values.

Mapped to java.util.UUID.
","
UUID
"

"Data Types","ARRAY Type","
ARRAY
","
An array of values. Use a value list (1, 2) or PreparedStatement.setObject(..,
2059
new Object[] {..}) to store values.
Thomas Mueller's avatar
Thomas Mueller committed
2060 2061 2062 2063 2064 2065 2066

Mapped to java.lang.Object[] (arrays of any non-primitive type are also supported).
","
ARRAY
"

"Functions (Aggregate)","AVG","
2067
AVG ( [ DISTINCT ] { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2068
","
2069 2070
The average (mean) value.
If no rows are selected, the result is NULL.
Thomas Mueller's avatar
Thomas Mueller committed
2071
Aggregates are only allowed in select statements.
2072
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2073 2074 2075 2076 2077
","
AVG(X)
"

"Functions (Aggregate)","BOOL_AND","
2078
BOOL_AND(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2079
","
2080 2081 2082
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
2083 2084 2085 2086 2087
","
BOOL_AND(ID>10)
"

"Functions (Aggregate)","BOOL_OR","
2088
BOOL_OR(boolean)
Thomas Mueller's avatar
Thomas Mueller committed
2089
","
2090 2091 2092
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
2093 2094 2095 2096 2097
","
BOOL_OR(NAME LIKE 'W%')
"

"Functions (Aggregate)","COUNT","
2098
COUNT( { * | { [ DISTINCT ] expression } } )
Thomas Mueller's avatar
Thomas Mueller committed
2099
","
2100 2101 2102 2103
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
2104 2105 2106 2107 2108
","
COUNT(*)
"

"Functions (Aggregate)","GROUP_CONCAT","
2109 2110
GROUP_CONCAT ( [ DISTINCT ] string
[ ORDER BY { expression [ ASC | DESC ] } [,...] ]
2111
[ SEPARATOR expression ] )
Thomas Mueller's avatar
Thomas Mueller committed
2112
","
2113 2114 2115 2116 2117
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
2118 2119 2120 2121 2122
","
GROUP_CONCAT(NAME ORDER BY ID SEPARATOR ', ')
"

"Functions (Aggregate)","MAX","
2123
MAX(value)
Thomas Mueller's avatar
Thomas Mueller committed
2124
","
2125 2126 2127 2128
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
2129 2130 2131 2132 2133
","
MAX(NAME)
"

"Functions (Aggregate)","MIN","
2134
MIN(value)
Thomas Mueller's avatar
Thomas Mueller committed
2135
","
2136 2137 2138 2139
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
2140 2141 2142 2143 2144
","
MIN(NAME)
"

"Functions (Aggregate)","SUM","
2145
SUM( [ DISTINCT ] { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2146
","
2147 2148 2149 2150
The sum of all values.
If no rows are selected, the result is NULL.
Aggregates are only allowed in select statements.
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2151 2152 2153 2154 2155
","
SUM(X)
"

"Functions (Aggregate)","SELECTIVITY","
2156
SELECTIVITY(value)
Thomas Mueller's avatar
Thomas Mueller committed
2157
","
2158 2159 2160 2161 2162
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
2163 2164 2165 2166 2167
","
SELECT SELECTIVITY(FIRSTNAME), SELECTIVITY(NAME) FROM TEST WHERE ROWNUM()<20000
"

"Functions (Aggregate)","STDDEV_POP","
2168
STDDEV_POP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2169
","
2170 2171 2172
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
2173 2174 2175 2176 2177 2178
Aggregates are only allowed in select statements.
","
STDDEV_POP(X)
"

"Functions (Aggregate)","STDDEV_SAMP","
2179
STDDEV_SAMP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2180
","
2181 2182 2183
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
2184 2185 2186 2187 2188 2189
Aggregates are only allowed in select statements.
","
STDDEV(X)
"

"Functions (Aggregate)","VAR_POP","
2190
VAR_POP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2191
","
2192 2193 2194 2195
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
2196 2197 2198 2199 2200
","
VAR_POP(X)
"

"Functions (Aggregate)","VAR_SAMP","
2201
VAR_SAMP( [ DISTINCT ] double )
Thomas Mueller's avatar
Thomas Mueller committed
2202
","
2203 2204 2205 2206
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
2207 2208 2209 2210 2211
","
VAR_SAMP(X)
"

"Functions (Numeric)","ABS","
2212
ABS ( { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2213
","
2214 2215 2216
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.
The returned value is of the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
2217 2218 2219 2220 2221
","
ABS(ID)
"

"Functions (Numeric)","ACOS","
2222
ACOS(double)
Thomas Mueller's avatar
Thomas Mueller committed
2223 2224
","
See also Java Math.* functions.
2225
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2226 2227 2228 2229 2230
","
ACOS(D)
"

"Functions (Numeric)","ASIN","
2231
ASIN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2232 2233
","
See also Java Math.* functions.
2234
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2235 2236 2237 2238 2239
","
ASIN(D)
"

"Functions (Numeric)","ATAN","
2240
ATAN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2241 2242
","
See also Java Math.* functions.
2243
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2244 2245 2246 2247 2248
","
ATAN(D)
"

"Functions (Numeric)","COS","
2249
COS(double)
Thomas Mueller's avatar
Thomas Mueller committed
2250 2251
","
See also Java Math.* functions.
2252
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2253 2254 2255 2256 2257
","
COS(ANGLE)
"

"Functions (Numeric)","COT","
2258
COT(double)
Thomas Mueller's avatar
Thomas Mueller committed
2259 2260
","
See also Java Math.* functions.
2261
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2262 2263 2264 2265 2266
","
COT(ANGLE)
"

"Functions (Numeric)","SIN","
2267
SIN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2268 2269
","
See also Java Math.* functions.
2270
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2271 2272 2273 2274 2275
","
SIN(ANGLE)
"

"Functions (Numeric)","TAN","
2276
TAN(double)
Thomas Mueller's avatar
Thomas Mueller committed
2277 2278
","
See also Java Math.* functions.
2279
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2280 2281 2282 2283 2284
","
TAN(ANGLE)
"

"Functions (Numeric)","ATAN2","
2285
ATAN2(double, double)
Thomas Mueller's avatar
Thomas Mueller committed
2286 2287
","
See also Java Math.atan2.
2288
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2289 2290 2291 2292 2293
","
ATAN2(X, Y)
"

"Functions (Numeric)","BITAND","
2294
BITAND(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2295
","
2296 2297
The bitwise AND operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2298 2299 2300 2301 2302 2303
See also Java operator &.
","
BITAND(A, B)
"

"Functions (Numeric)","BITOR","
2304
BITOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2305
","
2306 2307
The bitwise OR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2308 2309 2310 2311 2312 2313
See also Java operator |.
","
BITOR(A, B)
"

"Functions (Numeric)","BITXOR","
2314
BITXOR(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2315
","
2316 2317
The bitwise XOR operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2318 2319 2320 2321 2322 2323
See also Java operator ^.
","
BITXOR(A, B)
"

"Functions (Numeric)","MOD","
2324
MOD(long, long)
Thomas Mueller's avatar
Thomas Mueller committed
2325
","
2326 2327
The modulo operation.
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
2328 2329 2330 2331 2332 2333
See also Java operator %.
","
MOD(A, B)
"

"Functions (Numeric)","CEILING","
2334
CEILING(double)
Thomas Mueller's avatar
Thomas Mueller committed
2335 2336
","
See also Java Math.ceil.
2337
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2338 2339 2340 2341 2342
","
LOG(A)
"

"Functions (Numeric)","DEGREES","
2343
DEGREES(double)
Thomas Mueller's avatar
Thomas Mueller committed
2344 2345
","
See also Java Math.toDegrees.
2346
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2347 2348 2349 2350 2351
","
DEGREES(A)
"

"Functions (Numeric)","EXP","
2352
EXP(double)
Thomas Mueller's avatar
Thomas Mueller committed
2353 2354
","
See also Java Math.exp.
2355
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2356 2357 2358 2359 2360
","
EXP(A)
"

"Functions (Numeric)","FLOOR","
2361
FLOOR(double)
Thomas Mueller's avatar
Thomas Mueller committed
2362 2363
","
See also Java Math.floor.
2364
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2365 2366 2367 2368 2369
","
FLOOR(A)
"

"Functions (Numeric)","LOG","
2370
LOG(double)
Thomas Mueller's avatar
Thomas Mueller committed
2371 2372
","
See also Java Math.log.
2373
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2374 2375 2376 2377 2378
","
LOG(A)
"

"Functions (Numeric)","LOG10","
2379
LOG10(double)
Thomas Mueller's avatar
Thomas Mueller committed
2380 2381
","
See also Java Math.log10 (in Java 5).
2382
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2383 2384 2385 2386 2387
","
LOG10(A)
"

"Functions (Numeric)","RADIANS","
2388
RADIANS(double)
Thomas Mueller's avatar
Thomas Mueller committed
2389 2390
","
See also Java Math.toRadians.
2391
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2392 2393 2394 2395 2396
","
RADIANS(A)
"

"Functions (Numeric)","SQRT","
2397
SQRT(double)
Thomas Mueller's avatar
Thomas Mueller committed
2398 2399
","
See also Java Math.sqrt.
2400
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2401 2402 2403 2404 2405
","
SQRT(A)
"

"Functions (Numeric)","PI","
2406
PI()
Thomas Mueller's avatar
Thomas Mueller committed
2407 2408
","
See also Java Math.PI.
2409
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2410 2411 2412 2413 2414
","
PI()
"

"Functions (Numeric)","POWER","
2415
POWER(double, double)
Thomas Mueller's avatar
Thomas Mueller committed
2416 2417
","
See also Java Math.pow.
2418
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2419 2420 2421 2422 2423
","
POWER(A, B)
"

"Functions (Numeric)","RAND","
2424
RAND( [ int ] )
Thomas Mueller's avatar
Thomas Mueller committed
2425 2426 2427
","
Calling the function without parameter returns the next a pseudo random number.
Calling it with an parameter seeds the session's random number generator.
2428
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2429 2430 2431 2432 2433
","
RAND()
"

"Functions (Numeric)","RANDOM_UUID","
2434
RANDOM_UUID()
Thomas Mueller's avatar
Thomas Mueller committed
2435 2436 2437 2438 2439 2440 2441
","
Returns a new UUID with 122 pseudo random bits.
","
RANDOM_UUID()
"

"Functions (Numeric)","ROUND","
2442
ROUND(double, digitsInt)
Thomas Mueller's avatar
Thomas Mueller committed
2443 2444
","
Rounds to a number of digits.
2445
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2446 2447 2448 2449 2450
","
ROUND(VALUE, 2)
"

"Functions (Numeric)","ROUNDMAGIC","
2451
ROUNDMAGIC(double)
Thomas Mueller's avatar
Thomas Mueller committed
2452
","
2453 2454 2455 2456 2457 2458
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
2459 2460 2461 2462 2463
","
ROUNDMAGIC(VALUE/3*3)
"

"Functions (Numeric)","SECURE_RAND","
2464
SECURE_RAND(int)
Thomas Mueller's avatar
Thomas Mueller committed
2465 2466
","
Generates a number of cryptographically secure random numbers.
2467
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2468 2469 2470 2471 2472
","
CALL SECURE_RAND(16)
"

"Functions (Numeric)","SIGN","
2473
SIGN ( { int | long | decimal | double } )
Thomas Mueller's avatar
Thomas Mueller committed
2474 2475 2476 2477 2478 2479 2480
","
Returns -1 if the value is smaller 0, 0 if zero, and otherwise 1.
","
SIGN(VALUE)
"

"Functions (Numeric)","ENCRYPT","
2481
ENCRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2482
","
2483 2484 2485 2486
Encrypts data using a key.
Supported algorithms are XTEA and AES.
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2487 2488 2489 2490 2491
","
CALL ENCRYPT('AES', '00', STRINGTOUTF8('Test'))
"

"Functions (Numeric)","DECRYPT","
2492
DECRYPT(algorithmString, keyBytes, dataBytes)
Thomas Mueller's avatar
Thomas Mueller committed
2493
","
2494 2495 2496 2497
Decrypts data using a key.
Supported algorithms are XTEA and AES.
The block size is 16 bytes.
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2498 2499 2500 2501 2502 2503
","
CALL TRIM(CHAR(0) FROM UTF8TOSTRING(
    DECRYPT('AES', '00', '3fabb4de8f1ee2e97d7793bab2db1116')))
"

"Functions (Numeric)","HASH","
2504
HASH(algorithmString, dataBytes, iterationInt)
Thomas Mueller's avatar
Thomas Mueller committed
2505
","
2506 2507 2508
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
2509 2510 2511 2512 2513
","
CALL HASH('SHA256', STRINGTOUTF8('Password'), 1000)
"

"Functions (Numeric)","TRUNCATE","
2514
TRUNCATE(double, digitsInt)
Thomas Mueller's avatar
Thomas Mueller committed
2515 2516
","
Truncates to a number of digits (to the next value closer to 0).
2517
This method returns a double.
Thomas Mueller's avatar
Thomas Mueller committed
2518 2519 2520 2521 2522
","
TRUNCATE(VALUE, 2)
"

"Functions (Numeric)","COMPRESS","
2523
COMPRESS(dataBytes [, algorithmString])
Thomas Mueller's avatar
Thomas Mueller committed
2524
","
2525 2526 2527 2528
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
2529 2530 2531 2532 2533
","
COMPRESS(STRINGTOUTF8('Test'))
"

"Functions (Numeric)","EXPAND","
2534
EXPAND(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2535 2536
","
Expands data that was compressed using the COMPRESS function.
2537
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2538 2539 2540 2541 2542
","
UTF8TOSTRING(EXPAND(COMPRESS(STRINGTOUTF8('Test'))))
"

"Functions (Numeric)","ZERO","
2543
ZERO()
Thomas Mueller's avatar
Thomas Mueller committed
2544 2545 2546 2547 2548 2549 2550
","
Returns the value 0. This function can be used even if numeric literals are disabled.
","
ZERO()
"

"Functions (String)","ASCII","
2551
ASCII(string)
Thomas Mueller's avatar
Thomas Mueller committed
2552 2553
","
Returns the ASCII value of the first character in the string.
2554
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2555 2556 2557 2558
","
ASCII('Hi')
"
"Functions (String)","BIT_LENGTH","
2559
BIT_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2560
","
2561 2562 2563
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
2564 2565 2566 2567 2568
","
BIT_LENGTH(NAME)
"

"Functions (String)","LENGTH","
2569
{ LENGTH | CHAR_LENGTH | CHARACTER_LENGTH } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2570
","
2571 2572 2573
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
2574 2575 2576 2577 2578
","
LENGTH(NAME)
"

"Functions (String)","OCTET_LENGTH","
2579
OCTET_LENGTH(string)
Thomas Mueller's avatar
Thomas Mueller committed
2580
","
2581 2582 2583 2584
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
2585 2586 2587 2588 2589
","
OCTET_LENGTH(NAME)
"

"Functions (String)","CHAR","
2590
{ CHAR | CHR } ( int )
Thomas Mueller's avatar
Thomas Mueller committed
2591 2592
","
Returns the character that represents the ASCII value.
2593
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2594 2595 2596 2597 2598
","
CHAR(65)
"

"Functions (String)","CONCAT","
2599
CONCAT(string, string [,...])
Thomas Mueller's avatar
Thomas Mueller committed
2600 2601
","
Combines strings.
2602
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2603 2604 2605 2606 2607
","
CONCAT(NAME, '!')
"

"Functions (String)","DIFFERENCE","
2608
DIFFERENCE(string, string)
Thomas Mueller's avatar
Thomas Mueller committed
2609 2610
","
Returns the difference between the sounds of two strings.
2611
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2612 2613 2614 2615 2616
","
DIFFERENCE(T1.NAME, T2.NAME)
"

"Functions (String)","HEXTORAW","
2617
HEXTORAW(string)
Thomas Mueller's avatar
Thomas Mueller committed
2618
","
2619 2620
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
2621 2622 2623 2624 2625
","
HEXTORAW(DATA)
"

"Functions (String)","RAWTOHEX","
2626
RAWTOHEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2627
","
2628 2629 2630
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
2631 2632 2633 2634 2635
","
RAWTOHEX(DATA)
"

"Functions (String)","INSTR","
2636
INSTR(string, searchString, [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2637
","
2638 2639 2640 2641
Returns the location of a search string in a string (s).
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
2642 2643 2644 2645 2646
","
INSTR(EMAIL,'@')
"

"Functions (String)","INSERT Function","
2647
INSERT(originalString, startInt, lengthInt, addString)
Thomas Mueller's avatar
Thomas Mueller committed
2648
","
2649 2650 2651
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
2652 2653 2654 2655 2656
","
INSERT(NAME, 1, 1, ' ')
"

"Functions (String)","LOWER","
2657
{ LOWER | LCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2658 2659 2660 2661 2662 2663 2664
","
Converts a string to lowercase.
","
LOWER(NAME)
"

"Functions (String)","UPPER","
2665
{ UPPER | UCASE } ( string )
Thomas Mueller's avatar
Thomas Mueller committed
2666 2667 2668 2669 2670 2671 2672
","
Converts a string to uppercase.
","
UPPER(NAME)
"

"Functions (String)","LEFT","
2673
LEFT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2674 2675 2676 2677 2678 2679 2680
","
Returns the leftmost number of characters.
","
LEFT(NAME, 3)
"

"Functions (String)","RIGHT","
2681
RIGHT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2682 2683 2684 2685 2686 2687 2688
","
Returns the rightmost number of characters.
","
RIGHT(NAME, 3)
"

"Functions (String)","LOCATE","
2689
LOCATE(searchString, string [, startInt])
Thomas Mueller's avatar
Thomas Mueller committed
2690
","
2691 2692 2693 2694
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
2695 2696 2697 2698 2699
","
LOCATE('.', NAME)
"

"Functions (String)","POSITION","
2700
POSITION(searchString, string)
Thomas Mueller's avatar
Thomas Mueller committed
2701 2702 2703 2704 2705 2706 2707
","
Returns the location of a search string in a string. See also LOCATE.
","
POSITION('.', NAME)
"

"Functions (String)","LPAD","
2708
LPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2709
","
2710 2711 2712
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
2713 2714 2715 2716 2717
","
LPAD(AMOUNT, 10, '*')
"

"Functions (String)","RPAD","
2718
RPAD(string, int[, paddingString])
Thomas Mueller's avatar
Thomas Mueller committed
2719
","
2720 2721 2722
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
2723 2724 2725 2726 2727
","
RPAD(TEXT, 10, '-')
"

"Functions (String)","LTRIM","
2728
LTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2729 2730 2731 2732 2733 2734 2735
","
Removes all leading spaces from a string.
","
LTRIM(NAME)
"

"Functions (String)","RTRIM","
2736
RTRIM(string)
Thomas Mueller's avatar
Thomas Mueller committed
2737 2738 2739 2740 2741 2742 2743
","
Removes all trailing spaces from a string.
","
RTRIM(NAME)
"

"Functions (String)","TRIM","
2744
TRIM ( [ { LEADING | TRAILING | BOTH } [ string ] FROM ] string )
Thomas Mueller's avatar
Thomas Mueller committed
2745
","
2746 2747
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
2748 2749 2750 2751 2752
","
TRIM(BOTH '_' FROM NAME)
"

"Functions (String)","REGEXP_REPLACE","
2753
REGEXP_REPLACE(inputString, regexString, replacementString)
Thomas Mueller's avatar
Thomas Mueller committed
2754
","
2755 2756
Replaces each substring that matches a regular expression.
For details, see the Java String.replaceAll() method.
Thomas Mueller's avatar
Thomas Mueller committed
2757 2758 2759 2760 2761
","
REGEXP_REPLACE('Hello    World', ' +', ' ')
"

"Functions (String)","REPEAT","
2762
REPEAT(string, int)
Thomas Mueller's avatar
Thomas Mueller committed
2763 2764 2765 2766 2767 2768 2769
","
Returns a string repeated some number of times.
","
REPEAT(NAME || ' ', 10)
"

"Functions (String)","REPLACE","
2770
REPLACE(string, searchString [, replacementString])
Thomas Mueller's avatar
Thomas Mueller committed
2771
","
2772 2773
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.
Thomas Mueller's avatar
Thomas Mueller committed
2774 2775 2776 2777 2778
","
REPLACE(NAME, ' ')
"

"Functions (String)","SOUNDEX","
2779
SOUNDEX(string)
Thomas Mueller's avatar
Thomas Mueller committed
2780
","
2781 2782 2783
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
2784 2785 2786 2787 2788
","
SOUNDEX(NAME)
"

"Functions (String)","SPACE","
2789
SPACE(int)
Thomas Mueller's avatar
Thomas Mueller committed
2790 2791 2792 2793 2794 2795 2796
","
Returns a string consisting of a number of spaces.
","
SPACE(80)
"

"Functions (String)","STRINGDECODE","
2797
STRINGDECODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
2798
","
2799 2800 2801
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
2802 2803 2804 2805 2806
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGENCODE","
2807
STRINGENCODE(string)
Thomas Mueller's avatar
Thomas Mueller committed
2808
","
2809 2810 2811
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
2812 2813 2814 2815 2816
","
CALL STRINGENCODE(STRINGDECODE('Lines 1\nLine 2'))
"

"Functions (String)","STRINGTOUTF8","
2817
STRINGTOUTF8(string)
Thomas Mueller's avatar
Thomas Mueller committed
2818 2819
","
Encodes a string to a byte array using the UTF8 encoding format.
2820
This method returns bytes.
Thomas Mueller's avatar
Thomas Mueller committed
2821 2822 2823 2824 2825
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","SUBSTRING","
2826
{ SUBSTRING | SUBSTR } ( string, startInt [, lengthInt ] )
Thomas Mueller's avatar
Thomas Mueller committed
2827
","
2828 2829
Returns a substring of a string starting at a position.
The length is optional.
Thomas Mueller's avatar
Thomas Mueller committed
2830 2831 2832 2833 2834 2835
Also supported is: SUBSTRING(string FROM start [FOR length]).
","
SUBSTR(NAME, 1)
"

"Functions (String)","UTF8TOSTRING","
2836
UTF8TOSTRING(bytes)
Thomas Mueller's avatar
Thomas Mueller committed
2837 2838 2839 2840 2841 2842 2843
","
Decodes a byte array in the UTF8 format to a string.
","
CALL UTF8TOSTRING(STRINGTOUTF8('This is a test'))
"

"Functions (String)","XMLATTR","
2844
XMLATTR(nameString, valueString)
Thomas Mueller's avatar
Thomas Mueller committed
2845
","
2846 2847 2848
Creates an XML attribute element of the form name=""value"".
The value is encoded as XML text.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2849 2850 2851 2852 2853
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'))
"

"Functions (String)","XMLNODE","
2854
XMLNODE(elementString [, attributesString [, contentString]])
Thomas Mueller's avatar
Thomas Mueller committed
2855 2856
","
Create an XML node element.
2857
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2858 2859 2860 2861 2862
","
CALL XMLNODE('a', XMLATTR('href', 'http://h2database.com'), 'H2')
"

"Functions (String)","XMLCOMMENT","
2863
XMLCOMMENT(commentString)
Thomas Mueller's avatar
Thomas Mueller committed
2864
","
2865 2866 2867
Creates an XML comment.
Two dashes (--) are converted to - -.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2868 2869 2870 2871 2872
","
CALL XMLCOMMENT('Test')
"

"Functions (String)","XMLCDATA","
2873
XMLCDATA(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
2874
","
2875 2876 2877
Creates an XML CDATA element.
If the value contains ']]>', an XML text element is created instead.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2878 2879 2880 2881 2882
","
CALL XMLCDATA('data')
"

"Functions (String)","XMLSTARTDOC","
2883
XMLSTARTDOC()
Thomas Mueller's avatar
Thomas Mueller committed
2884 2885 2886 2887 2888 2889 2890
","
The string '<?xml version=""1.0""?>' is returned.
","
CALL XMLSTARTDOC()
"

"Functions (String)","XMLTEXT","
2891
XMLTEXT(valueString)
Thomas Mueller's avatar
Thomas Mueller committed
2892 2893
","
Creates an XML text element.
2894
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2895 2896 2897 2898 2899
","
CALL XMLTEXT('test')
"

"Functions (Time and Date)","CURRENT_DATE","
2900
{ CURRENT_DATE [ () ] | CURDATE() | SYSDATE | TODAY }
Thomas Mueller's avatar
Thomas Mueller committed
2901 2902 2903 2904 2905 2906 2907
","
Returns the current date.
","
CURRENT_DATE()
"

"Functions (Time and Date)","CURRENT_TIME","
2908
{ CURRENT_TIME [ () ] | CURTIME() }
Thomas Mueller's avatar
Thomas Mueller committed
2909 2910 2911 2912 2913 2914 2915
","
Returns the current time.
","
CURRENT_TIME()
"

"Functions (Time and Date)","CURRENT_TIMESTAMP","
2916
{ CURRENT_TIMESTAMP [ ( [ int ] ) ] | NOW( [ int ] ) }
Thomas Mueller's avatar
Thomas Mueller committed
2917
","
2918 2919
Returns the current timestamp.
The precision parameter for nanoseconds precision is optional.
Thomas Mueller's avatar
Thomas Mueller committed
2920 2921 2922 2923 2924
","
CURRENT_TIMESTAMP()
"

"Functions (Time and Date)","DATEADD","
2925
DATEADD(unitString, addInt, timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
2926
","
2927 2928 2929 2930
Adds units to a timestamp. The string indicates the unit.
Use negative values to subtract units.
The same units as in the EXTRACT function are supported.
This method returns a timestamp.
Thomas Mueller's avatar
Thomas Mueller committed
2931 2932 2933 2934 2935
","
DATEADD('MONTH', 1, DATE '2001-01-31')
"

"Functions (Time and Date)","DATEDIFF","
2936
DATEDIFF(unitString, aTimestamp, bTimestamp)
Thomas Mueller's avatar
Thomas Mueller committed
2937
","
2938 2939 2940
Returns the difference between two timestamps.
This method returns a long.
The string indicates the unit.
Thomas Mueller's avatar
Thomas Mueller committed
2941 2942 2943 2944 2945 2946
The same units as in the EXTRACT function are supported.
","
DATEDIFF('YEAR', T1.CREATED, T2.CREATED)
"

"Functions (Time and Date)","DAYNAME","
2947
DAYNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
2948 2949 2950 2951 2952 2953 2954
","
Returns the name of the day (in English).
","
DAYNAME(CREATED)
"

"Functions (Time and Date)","DAY_OF_MONTH","
2955
DAY_OF_MONTH(date)
Thomas Mueller's avatar
Thomas Mueller committed
2956 2957 2958 2959 2960 2961 2962
","
Returns the day of the month (1-31).
","
DAY_OF_MONTH(CREATED)
"

"Functions (Time and Date)","DAY_OF_WEEK","
2963
DAY_OF_WEEK(date)
Thomas Mueller's avatar
Thomas Mueller committed
2964 2965 2966 2967 2968 2969 2970
","
Returns the day of the week (1 means Sunday).
","
DAY_OF_WEEK(CREATED)
"

"Functions (Time and Date)","DAY_OF_YEAR","
2971
DAY_OF_YEAR(date)
Thomas Mueller's avatar
Thomas Mueller committed
2972 2973 2974 2975 2976 2977 2978
","
Returns the day of the year (1-366).
","
DAY_OF_YEAR(CREATED)
"

"Functions (Time and Date)","EXTRACT","
2979 2980
EXTRACT ( { YEAR | YY | MONTH | MM | DAY | DD | DAY_OF_YEAR
    | DOY | HOUR | HH | MINUTE | MI | SECOND | SS | MILLISECOND | MS }
2981
    FROM timestamp )
Thomas Mueller's avatar
Thomas Mueller committed
2982 2983
","
Returns a specific value from a timestamps.
2984
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
2985 2986 2987 2988 2989
","
EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
"

"Functions (Time and Date)","FORMATDATETIME","
2990
FORMATDATETIME ( timestamp, formatString
2991
[ , localeString [ , timeZoneString ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
2992
","
2993 2994 2995 2996 2997
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.
For details of the format, see java.text.SimpleDateFormat.
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
2998 2999 3000 3001 3002 3003
","
CALL FORMATDATETIME(TIMESTAMP '2001-02-03 04:05:06',
    'EEE, d MMM yyyy HH:mm:ss z', 'en', 'GMT')
"

"Functions (Time and Date)","HOUR","
3004
HOUR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3005 3006 3007 3008 3009 3010 3011
","
Returns the hour (0-23) from a timestamp.
","
HOUR(CREATED)
"

"Functions (Time and Date)","MINUTE","
3012
MINUTE(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3013 3014 3015 3016 3017 3018 3019
","
Returns the minute (0-59) from a timestamp.
","
MINUTE(CREATED)
"

"Functions (Time and Date)","MONTH","
3020
MONTH(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3021 3022 3023 3024 3025 3026 3027
","
Returns the month (1-12) from a timestamp.
","
MONTH(CREATED)
"

"Functions (Time and Date)","MONTHNAME","
3028
MONTHNAME(date)
Thomas Mueller's avatar
Thomas Mueller committed
3029 3030 3031 3032 3033 3034 3035
","
Returns the name of the month (in English).
","
MONTHNAME(CREATED)
"

"Functions (Time and Date)","PARSEDATETIME","
3036
PARSEDATETIME(string, formatString
3037
[, localeString [, timeZoneString]])
Thomas Mueller's avatar
Thomas Mueller committed
3038
","
3039 3040 3041 3042
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.
For details of the format, see java.text.SimpleDateFormat.
Thomas Mueller's avatar
Thomas Mueller committed
3043 3044 3045 3046 3047 3048
","
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","
3049
QUARTER(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3050 3051 3052 3053 3054 3055 3056
","
Returns the quarter (1-4) from a timestamp.
","
QUARTER(CREATED)
"

"Functions (Time and Date)","SECOND","
3057
SECOND(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3058 3059 3060 3061 3062 3063 3064
","
Returns the second (0-59) from a timestamp.
","
SECOND(CREATED)
"

"Functions (Time and Date)","WEEK","
3065
WEEK(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3066
","
3067 3068
Returns the week (1-53) from a timestamp.
This method uses the current system locale.
Thomas Mueller's avatar
Thomas Mueller committed
3069 3070 3071 3072 3073
","
WEEK(CREATED)
"

"Functions (Time and Date)","YEAR","
3074
YEAR(timestamp)
Thomas Mueller's avatar
Thomas Mueller committed
3075 3076 3077 3078 3079 3080 3081
","
Returns the year from a timestamp.
","
YEAR(CREATED)
"

"Functions (System)","ARRAY_GET","
3082
ARRAY_GET(arrayExpression, indexExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3083 3084
","
Returns one element of an array.
3085
This method returns a string.
Thomas Mueller's avatar
Thomas Mueller committed
3086 3087 3088 3089 3090
","
CALL ARRAY_GET(('Hello', 'World'), 2)
"

"Functions (System)","ARRAY_LENGTH","
3091
ARRAY_GET(arrayExpression)
Thomas Mueller's avatar
Thomas Mueller committed
3092 3093 3094 3095 3096 3097 3098
","
Returns the length of an array.
","
CALL ARRAY_LENGTH(('Hello', 'World'))
"

"Functions (System)","AUTOCOMMIT","
3099
AUTOCOMMIT()
Thomas Mueller's avatar
Thomas Mueller committed
3100 3101 3102 3103 3104 3105 3106
","
Returns true if auto commit is switched on for this session.
","
AUTOCOMMIT()
"

"Functions (System)","CANCEL_SESSION","
3107
CANCEL_SESSION(sessionInt)
Thomas Mueller's avatar
Thomas Mueller committed
3108
","
3109 3110 3111
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
3112 3113

Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3114 3115 3116 3117 3118
","
CANCEL_SESSION(3)
"

"Functions (System)","CASEWHEN Function","
3119
CASEWHEN(boolean, aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3120 3121
","
Returns 'a' if the boolean expression is true, otherwise 'b'.
3122
Returns the same data type as the parameter.
Thomas Mueller's avatar
Thomas Mueller committed
3123 3124 3125 3126 3127
","
CASEWHEN(ID=1, 'A', 'B')
"

"Functions (System)","CAST","
3128
CAST(value AS dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3129 3130 3131 3132 3133 3134 3135 3136
","
Converts a value to another data type. When converting a text to a number, the default Java conversion
rules are used (prefixes 0x or # for hexadecimal numbers, prefix 0 for octal numbers).
","
CAST(NAME AS INT)
"

"Functions (System)","COALESCE","
3137
COALESCE(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3138 3139 3140 3141 3142 3143 3144
","
Returns the first value that is not null.
","
COALESCE(A, B, C)
"

"Functions (System)","CONVERT","
3145
CONVERT(value, dataType)
Thomas Mueller's avatar
Thomas Mueller committed
3146 3147 3148 3149 3150 3151 3152
","
Converts a value to another data type.
","
CONVERT(NAME, INT)
"

"Functions (System)","CURRVAL","
3153
CURRVAL( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3154
","
3155 3156 3157 3158 3159
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
3160 3161 3162 3163 3164
","
CURRVAL('TEST_SEQ')
"

"Functions (System)","CSVREAD","
3165
CSVREAD(fileNameString [, columnsString [, csvOptions ] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3166
","
3167 3168
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
3169 3170

If the column names are specified (a list of column names separated with the
3171
fieldSeparator), those are used, otherwise (or if they are set to NULL) the first line of
3172 3173 3174 3175 3176
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
3177 3178 3179 3180 3181 3182 3183 3184

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.

This function can be used like a table: SELECT * FROM CSVREAD(...).
Instead of a file, an URL may be used, for example
jar:file:///c:/temp/example.zip!/org/example/nested.zip.
3185

Thomas Mueller's avatar
Thomas Mueller committed
3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197
Admin rights are required to execute this command.
","
CALL CSVREAD('test.csv');
-- Read a file containing the columns ID, NAME with
-- UTF-8 encoding and the pipe (|) as field separator
CALL CSVREAD('test2.csv', 'ID|NAME', 'UTF-8', '|');
-- Read a semicolon-separated file
SELECT * FROM CSVREAD('data/test.csv', NULL, NULL, ';');
SELECT ""Last Name"" FROM CSVREAD('address.csv');
"

"Functions (System)","CSVWRITE","
3198
CSVWRITE ( fileNameString, queryString [, csvOptions [, lineSepString] ] )
Thomas Mueller's avatar
Thomas Mueller committed
3199
","
3200
Writes a CSV (comma separated values). The file is overwritten if it exists.
Thomas Mueller's avatar
Thomas Mueller committed
3201
If only a file name is specified, it will be written to the current working directory.
3202
For each parameter, NULL means the default value should be used.
Thomas Mueller's avatar
Thomas Mueller committed
3203
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
3204 3205 3206 3207 3208 3209 3210

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
system ('line.separator' system property).

Thomas Mueller's avatar
Thomas Mueller committed
3211 3212
The returned value is the number or rows written.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3213 3214 3215 3216 3217 3218 3219
","
CALL CSVWRITE('test.csv', 'SELECT * FROM TEST');
-- Write a file with UTF-8 encoding and the pipe (|) as field separator
CALL CSVWRITE('test2.csv', 'SELECT * FROM TEST', 'UTF-8', '|');
"

"Functions (System)","DATABASE","
3220
DATABASE()
Thomas Mueller's avatar
Thomas Mueller committed
3221 3222 3223 3224 3225 3226 3227
","
Returns the name of the database.
","
CALL DATABASE();
"

"Functions (System)","DATABASE_PATH","
3228
DATABASE_PATH()
Thomas Mueller's avatar
Thomas Mueller committed
3229 3230 3231 3232 3233 3234 3235 3236
","
Returns the directory of the database files and the database name, if it is file
based. Returns NULL otherwise.
","
CALL DATABASE_PATH();
"

"Functions (System)","FILE_READ","
3237
FILE_READ(fileNameString [,encodingString])
Thomas Mueller's avatar
Thomas Mueller committed
3238 3239 3240 3241
","
Returns the contents of a file. If only one parameter is supplied, the data are
returned as a BLOB. If two parameters are used, the data is returned as a CLOB
(text). The second parameter is the character set to use, NULL meaning the
Thomas Mueller's avatar
Thomas Mueller committed
3242 3243
default character set for this system. File names and URLs are supported.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3244 3245 3246 3247 3248 3249
","
SELECT LENGTH(FILE_READ('~/.h2.server.properties')) LEN;
SELECT FILE_READ('http://localhost:8182/stylesheet.css', NULL) CSS;
"

"Functions (System)","GREATEST","
3250
GREATEST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3251 3252 3253 3254 3255 3256 3257
","
Returns the largest value that is not NULL, or NULL if all values are NULL.
","
CALL GREATEST(1, 2, 3);
"

"Functions (System)","IDENTITY","
3258
IDENTITY()
Thomas Mueller's avatar
Thomas Mueller committed
3259 3260
","
Returns the last inserted identity value for this session.
3261 3262
This value changes whenever a new sequence number was generated,
even within a trigger or Java function. See also SCOPE_IDENTITY().
3263
This method returns a long.
Thomas Mueller's avatar
Thomas Mueller committed
3264 3265 3266 3267 3268
","
CALL IDENTITY();
"

"Functions (System)","IFNULL","
3269
IFNULL(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3270 3271 3272 3273 3274 3275 3276
","
Returns the value of 'a' if it is not null, otherwise 'b'.
","
CALL IFNULL(NULL, '');
"

"Functions (System)","LEAST","
3277
LEAST(aValue, bValue [,...])
Thomas Mueller's avatar
Thomas Mueller committed
3278 3279 3280 3281 3282 3283 3284
","
Returns the smallest value that is not NULL, or NULL if all values are NULL.
","
CALL LEAST(1, 2, 3);
"

"Functions (System)","LOCK_MODE","
3285
LOCK_MODE()
Thomas Mueller's avatar
Thomas Mueller committed
3286 3287
","
Returns the current lock mode. See SET LOCK_MODE.
3288
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3289 3290 3291 3292 3293
","
CALL LOCK_MODE();
"

"Functions (System)","LOCK_TIMEOUT","
3294
LOCK_TIMEOUT()
Thomas Mueller's avatar
Thomas Mueller committed
3295 3296 3297 3298 3299 3300 3301 3302
","
Returns the lock timeout of the current session (in milliseconds).
","
LOCK_TIMEOUT()
"

"Functions (System)","LINK_SCHEMA","
LINK_SCHEMA(targetSchemaString, driverString, urlString,
3303
userString, passwordString, sourceSchemaString)
Thomas Mueller's avatar
Thomas Mueller committed
3304
","
3305 3306 3307 3308 3309
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
3310
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3311 3312 3313 3314 3315
","
CALL LINK_SCHEMA('TEST2', '', 'jdbc:h2:test2', 'sa', 'sa', 'PUBLIC');
"

"Functions (System)","MEMORY_FREE","
3316
MEMORY_FREE()
Thomas Mueller's avatar
Thomas Mueller committed
3317
","
Thomas Mueller's avatar
Thomas Mueller committed
3318
Returns the free memory in KB (where 1024 bytes is a KB).
3319
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3320 3321
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3322 3323 3324 3325 3326
","
MEMORY_FREE()
"

"Functions (System)","MEMORY_USED","
3327
MEMORY_USED()
Thomas Mueller's avatar
Thomas Mueller committed
3328
","
Thomas Mueller's avatar
Thomas Mueller committed
3329
Returns the used memory in KB (where 1024 bytes is a KB).
3330
This method returns an int.
Thomas Mueller's avatar
Thomas Mueller committed
3331 3332
The garbage is run before returning the value.
Admin rights are required to execute this command.
Thomas Mueller's avatar
Thomas Mueller committed
3333 3334 3335 3336 3337
","
MEMORY_USED()
"

"Functions (System)","NEXTVAL","
3338
NEXTVAL ( [ schemaName, ] sequenceString )
Thomas Mueller's avatar
Thomas Mueller committed
3339
","
3340 3341 3342 3343
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
3344 3345 3346 3347 3348
","
NEXTVAL('TEST_SEQ')
"

"Functions (System)","NULLIF","
3349
NULLIF(aValue, bValue)
Thomas Mueller's avatar
Thomas Mueller committed
3350 3351 3352 3353 3354 3355 3356
","
Returns NULL if 'a' is equals to 'b', otherwise 'a'.
","
NULLIF(A, B)
"

"Functions (System)","READONLY","
3357
READONLY()
Thomas Mueller's avatar
Thomas Mueller committed
3358 3359 3360 3361 3362 3363 3364
","
Returns true if the database is read-only.
","
READONLY()
"

"Functions (System)","ROWNUM","
3365
ROWNUM()
Thomas Mueller's avatar
Thomas Mueller committed
3366
","
3367 3368 3369 3370
Returns the number of the current row.
This method returns an int.
This function is supported for SELECT statements, as well as for DELETE and UPDATE.
The first row has the row number 1, and is calculated before ordering and grouping the result set.
3371
To get the row number after ordering and grouping, use a subquery.
Thomas Mueller's avatar
Thomas Mueller committed
3372
","
3373 3374
SELECT ROWNUM(), * FROM TEST;
SELECT ROWNUM(), * FROM (SELECT * FROM TEST ORDER BY NAME);
Thomas Mueller's avatar
Thomas Mueller committed
3375
SELECT ID FROM (SELECT T.*, ROWNUM AS R FROM TEST T) WHERE R BETWEEN 2 AND 3;
Thomas Mueller's avatar
Thomas Mueller committed
3376 3377 3378
"

"Functions (System)","SCHEMA","
3379
SCHEMA()
Thomas Mueller's avatar
Thomas Mueller committed
3380 3381 3382 3383 3384 3385
","
Returns the name of the default  schema for this session.
","
CALL SCHEMA()
"

3386 3387 3388 3389 3390 3391 3392 3393 3394 3395
"Functions (System)","SCOPE_IDENTITY","
SCOPE_IDENTITY()
","
Returns the last inserted identity value for this session for the current scope.
Changes within triggers and Java functions are ignored. See also IDENTITY().
This method returns a long.
","
CALL SCOPE_IDENTITY();
"

Thomas Mueller's avatar
Thomas Mueller committed
3396
"Functions (System)","SESSION_ID","
3397
SESSION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3398
","
3399 3400 3401 3402
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
3403 3404 3405 3406 3407
","
CALL SESSION_ID()
"

"Functions (System)","SET","
3408
SET(@variableName, value)
Thomas Mueller's avatar
Thomas Mueller committed
3409
","
3410 3411 3412
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
3413 3414 3415 3416 3417
","
SELECT X, SET(@I, IFNULL(@I, 0)+X) RUNNING_TOTAL FROM SYSTEM_RANGE(1, 10)
"

"Functions (System)","TABLE","
3418
{ TABLE | TABLE_DISTINCT } ( { name dataType = expression } [,...] )
Thomas Mueller's avatar
Thomas Mueller committed
3419 3420 3421 3422 3423 3424 3425
","
Returns the result set. TABLE_DISTINCT removes duplicate rows.
","
SELECT * FROM TABLE(ID INT=(1, 2), NAME VARCHAR=('Hello', 'World'))
"

"Functions (System)","TRANSACTION_ID","
3426
TRANSACTION_ID()
Thomas Mueller's avatar
Thomas Mueller committed
3427
","
3428 3429
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
3430
Otherwise a value of the following form is returned:
3431 3432 3433
logFileId-position-sessionId.
This method returns a string.
The value is unique across database restarts (values are not re-used).
Thomas Mueller's avatar
Thomas Mueller committed
3434 3435 3436 3437 3438
","
CALL TRANSACTION_ID()
"

"Functions (System)","USER","
3439
{ USER | CURRENT_USER } ()
Thomas Mueller's avatar
Thomas Mueller committed
3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460
","
Returns the name of the current user of this session.
","
CURRENT_USER()
"

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

"
"System Tables","Range Table","
SYSTEM_RANGE(start, end)
","
Contains all values from start to end (this is a dynamic table).
","
SYSTEM_RANGE(0, 100)
"