Top Description Fields Constructors Methods
org.h2.engine

public Class Constants

extends Object
Class Inheritance
Imports
java.sql.ResultSet

Constants are fixed values that are used in the whole database code.

Field Summary

Modifier and TypeField and Description
public static final int
ALLOW_LITERALS_ALL

Constant meaning both numbers and text is allowed in SQL statements.

public static final int
ALLOW_LITERALS_NONE

Constant meaning no literals are allowed in SQL statements.

public static final int
ALLOW_LITERALS_NUMBERS

Constant meaning only numbers are allowed in SQL statements (but no texts).

public static final boolean
BLOB_SEARCH

Whether searching in Blob values should be supported.

public static final String
BUILD_DATE

The build date is updated for each public release.

public static final int
BUILD_ID

Sequential version number.

public static final boolean
BUILD_SNAPSHOT

Whether this is a snapshot version.

public static final String
BUILD_VENDOR_AND_VERSION

If H2 is compiled to be included in a product, this should be set to a unique vendor id (to distinguish from official releases).

public static final int
CACHE_MIN_RECORDS

The minimum number of entries to keep in the cache.

public static final String
CACHE_TYPE_DEFAULT

The default cache type.

public static final String
CLUSTERING_DISABLED

The value of the cluster setting if clustering is disabled.

public static final String
CLUSTERING_ENABLED

The value of the cluster setting if clustering is enabled (the actual value is checked later).

public static final String
CONN_URL_COLUMNLIST

The database URL used when calling a function if only the column list should be returned.

public static final String
CONN_URL_INTERNAL

The database URL used when calling a function if the data should be returned.

public static final int
COST_ROW_OFFSET

The cost is calculated on rowcount + this offset, to avoid using the wrong or no index if the table contains no rows _currently_ (when preparing the statement)

public static final int
DEADLOCK_CHECK

The number of milliseconds after which to check for a deadlock if locking is not successful.

public static final int
DEFAULT_HTTP_PORT

The default port number of the HTTP server (for the H2 Console).

public static final int
DEFAULT_LOCK_MODE

The default value for the LOCK_MODE setting.

public static final int
DEFAULT_MAX_LENGTH_INPLACE_LOB

The default maximum length of an LOB that is stored with the record itself, and not in a separate place.

public static final int
DEFAULT_MAX_OPERATION_MEMORY

The default for the setting MAX_OPERATION_MEMORY.

public static final int
DEFAULT_PAGE_SIZE

The default page size to use for new databases.

public static final int
DEFAULT_RESULT_SET_CONCURRENCY

The default result set concurrency for statements created with Connection.createStatement() or prepareStatement(String sql).

public static final int
DEFAULT_TCP_PORT

The default port of the TCP server.

public static final int
DEFAULT_WRITE_DELAY

The default delay in milliseconds before the transaction log is written.

public static final int
ENCRYPTION_KEY_HASH_ITERATIONS

The password is hashed this many times to slow down dictionary attacks.

public static final int
FILE_BLOCK_SIZE

The block of a file.

public static final String
FULL_VERSION

The complete version number of this database, consisting of the major version, the minor version, the build id, and the build date.

public static final int
INFORMATION_SCHEMA_ID

The identity of INFORMATION_SCHEMA.

public static final int
INITIAL_LOCK_TIMEOUT

For testing, the lock timeout is smaller than for interactive use cases.

public static final int
IO_BUFFER_SIZE

The block size for I/O operations.

public static final int
IO_BUFFER_SIZE_COMPRESS

The block size used to compress data in the LZFOutputStream.

public static final int
LOCK_MODE_OFF

The lock mode that means no locking is used at all.

public static final int
LOCK_MODE_READ_COMMITTED

The lock mode that means read locks are acquired, but they are released immediately after the statement is executed.

public static final int
LOCK_MODE_TABLE

The lock mode that means table level locking is used for reads and writes.

public static final int
LOCK_MODE_TABLE_GC

The lock mode that means table level locking is used for reads and writes.

public static final int
LOCK_SLEEP

The number of milliseconds to wait between checking the .lock.db file still exists once a database is locked.

public static final int
MAIN_SCHEMA_ID

The identity of PUBLIC schema.

public static final int
MAX_ARRAY_CARDINALITY

The maximum allowed cardinality of array.

public static final int
MAX_COLUMNS

The maximum number of columns in a table, select statement or row value.

public static final int
MAX_IDENTIFIER_LENGTH

The maximum allowed length of identifiers.

public static final int
MAX_NUMERIC_PRECISION

The maximum allowed precision of numeric data types.

public static final int
MAX_PARAMETER_INDEX

The highest possible parameter index.

public static final int
MAX_STRING_LENGTH

The maximum allowed length for character string, binary string, and other data types based on them; excluding LOB data types.

public static final int
MEMORY_ARRAY

The memory needed by an array.

public static final int
MEMORY_OBJECT

The memory needed by a regular object with at least one field.

public static final int
MEMORY_POINTER

The memory needed by a pointer.

public static final int
MEMORY_ROW

The memory needed by a Row.

public static final int
MIN_WEB_ADMIN_PASSWORD_LENGTH

The minimum number of characters in web admin password.

public static final int
PG_CATALOG_SCHEMA_ID

The identity of pg_catalog schema.

public static final String
PG_VERSION

Announced version for PgServer.

public static final String
PREFIX_INDEX

The name prefix used for indexes that are not explicitly named.

public static final String
PREFIX_JOIN

The name prefix used for synthetic nested join tables.

public static final String
PREFIX_PRIMARY_KEY

The name prefix used for primary key constraints that are not explicitly named.

public static final String
PREFIX_QUERY_ALIAS

The name prefix used for query aliases that are not explicitly named.

public static final String
PUBLIC_ROLE_NAME

Every user belongs to this role.

public static final int
QUERY_STATISTICS_MAX_ENTRIES

The maximum number of entries in query statistics.

public static final int
SALT_LEN

The number of bytes in random salt that is used to hash passwords.

public static final String
SCHEMA_MAIN

The name of the default schema.

public static final String
SCHEMA_PG_CATALOG

The name of the pg_catalog schema.

public static final int
SELECTIVITY_DEFAULT

The default selectivity (used if the selectivity is not calculated).

public static final int
SELECTIVITY_DISTINCT_COUNT

The number of distinct values to keep in memory when running ANALYZE.

public static final String
SERVER_PROPERTIES_DIR

The default directory name of the server properties file for the H2 Console.

public static final String
SERVER_PROPERTIES_NAME

The name of the server properties file for the H2 Console.

public static final long
SLOW_QUERY_LIMIT_MS

Queries that take longer than this number of milliseconds are written to the trace file with the level info.

public static final String
START_URL

The database URL prefix of this database.

public static final String
SUFFIX_LOCK_FILE

The file name suffix of file lock files that are used to make sure a database is open by only one process at any time.

public static final String
SUFFIX_MV_FILE

The file name suffix of a MVStore file.

public static final String
SUFFIX_MV_STORE_NEW_FILE

The file name suffix of a new MVStore file, used when compacting a store.

public static final String
SUFFIX_MV_STORE_TEMP_FILE

The file name suffix of a temporary MVStore file, used when compacting a store.

public static final String
SUFFIX_OLD_DATABASE_FILE

The file name suffix of a H2 version 1.1 database file.

public static final String
SUFFIX_TEMP_FILE

The file name suffix of temporary files.

public static final String
SUFFIX_TRACE_FILE

The file name suffix of trace files.

public static final int
TCP_PROTOCOL_VERSION_17

The TCP protocol version number 17.

public static final int
TCP_PROTOCOL_VERSION_18

The TCP protocol version number 18.

public static final int
TCP_PROTOCOL_VERSION_19

The TCP protocol version number 19.

public static final int
TCP_PROTOCOL_VERSION_20

The TCP protocol version number 20.

public static final int
TCP_PROTOCOL_VERSION_21

The TCP protocol version number 21.

public static final int
TCP_PROTOCOL_VERSION_MAX_SUPPORTED

Maximum supported version of TCP protocol.

public static final int
TCP_PROTOCOL_VERSION_MIN_SUPPORTED

Minimum supported version of TCP protocol.

public static final int
THROTTLE_DELAY

How often we check to see if we need to apply a throttling delay if SET THROTTLE has been used.

public static final int
TRANSACTION_SNAPSHOT

SNAPSHOT isolation level of transaction.

public static final String
URL_FORMAT

The database URL format in simplified Backus-Naur form.

public static final String
USER_PACKAGE

The package name of user defined classes.

public static final String
VERSION

The version of this product, consisting of major version, minor version, and build id.

public static final int
VERSION_MAJOR

The major version of this database.

public static final int
VERSION_MINOR

The minor version of this database.

public static final int
VIEW_COST_CACHE_MAX_AGE

The maximum time in milliseconds to keep the cost of a view.

public static final int
VIEW_INDEX_CACHE_SIZE

The name of the index cache that is used for temporary view (subqueries used as tables).

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ALLOW_LITERALS_ALLback to summary
public static final int ALLOW_LITERALS_ALL

Constant meaning both numbers and text is allowed in SQL statements.

ALLOW_LITERALS_NONEback to summary
public static final int ALLOW_LITERALS_NONE

Constant meaning no literals are allowed in SQL statements.

ALLOW_LITERALS_NUMBERSback to summary
public static final int ALLOW_LITERALS_NUMBERS

Constant meaning only numbers are allowed in SQL statements (but no texts).

BUILD_DATEback to summary
public static final String BUILD_DATE

The build date is updated for each public release.

BUILD_IDback to summary
public static final int BUILD_ID

Sequential version number. Even numbers are used for official releases, odd numbers are used for development builds.

BUILD_SNAPSHOTback to summary
public static final boolean BUILD_SNAPSHOT

Whether this is a snapshot version.

BUILD_VENDOR_AND_VERSIONback to summary
public static final String BUILD_VENDOR_AND_VERSION

If H2 is compiled to be included in a product, this should be set to a unique vendor id (to distinguish from official releases). Additionally, a version number should be set to distinguish releases. Example: ACME_SVN1651_BUILD3

CACHE_MIN_RECORDSback to summary
public static final int CACHE_MIN_RECORDS

The minimum number of entries to keep in the cache.

CACHE_TYPE_DEFAULTback to summary
public static final String CACHE_TYPE_DEFAULT

The default cache type.

CLUSTERING_DISABLEDback to summary
public static final String CLUSTERING_DISABLED

The value of the cluster setting if clustering is disabled.

CLUSTERING_ENABLEDback to summary
public static final String CLUSTERING_ENABLED

The value of the cluster setting if clustering is enabled (the actual value is checked later).

CONN_URL_COLUMNLISTback to summary
public static final String CONN_URL_COLUMNLIST

The database URL used when calling a function if only the column list should be returned.

CONN_URL_INTERNALback to summary
public static final String CONN_URL_INTERNAL

The database URL used when calling a function if the data should be returned.

COST_ROW_OFFSETback to summary
public static final int COST_ROW_OFFSET

The cost is calculated on rowcount + this offset, to avoid using the wrong or no index if the table contains no rows _currently_ (when preparing the statement)

DEADLOCK_CHECKback to summary
public static final int DEADLOCK_CHECK

The number of milliseconds after which to check for a deadlock if locking is not successful.

DEFAULT_HTTP_PORTback to summary
public static final int DEFAULT_HTTP_PORT

The default port number of the HTTP server (for the H2 Console). This value is also in the documentation and in the Server javadoc.

DEFAULT_LOCK_MODEback to summary
public static final int DEFAULT_LOCK_MODE

The default value for the LOCK_MODE setting.

DEFAULT_MAX_LENGTH_INPLACE_LOBback to summary
public static final int DEFAULT_MAX_LENGTH_INPLACE_LOB

The default maximum length of an LOB that is stored with the record itself, and not in a separate place.

DEFAULT_MAX_OPERATION_MEMORYback to summary
public static final int DEFAULT_MAX_OPERATION_MEMORY

The default for the setting MAX_OPERATION_MEMORY.

DEFAULT_PAGE_SIZEback to summary
public static final int DEFAULT_PAGE_SIZE

The default page size to use for new databases.

DEFAULT_RESULT_SET_CONCURRENCYback to summary
public static final int DEFAULT_RESULT_SET_CONCURRENCY

The default result set concurrency for statements created with Connection.createStatement() or prepareStatement(String sql).

DEFAULT_TCP_PORTback to summary
public static final int DEFAULT_TCP_PORT

The default port of the TCP server. This port is also used in the documentation and in the Server javadoc.

DEFAULT_WRITE_DELAYback to summary
public static final int DEFAULT_WRITE_DELAY

The default delay in milliseconds before the transaction log is written.

ENCRYPTION_KEY_HASH_ITERATIONSback to summary
public static final int ENCRYPTION_KEY_HASH_ITERATIONS

The password is hashed this many times to slow down dictionary attacks.

FILE_BLOCK_SIZEback to summary
public static final int FILE_BLOCK_SIZE

The block of a file. It is also the encryption block size.

FULL_VERSIONback to summary
public static final String FULL_VERSION

The complete version number of this database, consisting of the major version, the minor version, the build id, and the build date.

INFORMATION_SCHEMA_IDback to summary
public static final int INFORMATION_SCHEMA_ID

The identity of INFORMATION_SCHEMA.

INITIAL_LOCK_TIMEOUTback to summary
public static final int INITIAL_LOCK_TIMEOUT

For testing, the lock timeout is smaller than for interactive use cases. This value could be increased to about 5 or 10 seconds.

IO_BUFFER_SIZEback to summary
public static final int IO_BUFFER_SIZE

The block size for I/O operations.

IO_BUFFER_SIZE_COMPRESSback to summary
public static final int IO_BUFFER_SIZE_COMPRESS

The block size used to compress data in the LZFOutputStream.

LOCK_MODE_OFFback to summary
public static final int LOCK_MODE_OFF

The lock mode that means no locking is used at all.

LOCK_MODE_READ_COMMITTEDback to summary
public static final int LOCK_MODE_READ_COMMITTED

The lock mode that means read locks are acquired, but they are released immediately after the statement is executed.

LOCK_MODE_TABLEback to summary
public static final int LOCK_MODE_TABLE

The lock mode that means table level locking is used for reads and writes.

LOCK_MODE_TABLE_GCback to summary
public static final int LOCK_MODE_TABLE_GC

The lock mode that means table level locking is used for reads and writes. If a table is locked, System.gc is called to close forgotten connections.

LOCK_SLEEPback to summary
public static final int LOCK_SLEEP

The number of milliseconds to wait between checking the .lock.db file still exists once a database is locked.

MAIN_SCHEMA_IDback to summary
public static final int MAIN_SCHEMA_ID

The identity of PUBLIC schema.

MAX_ARRAY_CARDINALITYback to summary
public static final int MAX_ARRAY_CARDINALITY

The maximum allowed cardinality of array.

MAX_COLUMNSback to summary
public static final int MAX_COLUMNS

The maximum number of columns in a table, select statement or row value.

MAX_IDENTIFIER_LENGTHback to summary
public static final int MAX_IDENTIFIER_LENGTH

The maximum allowed length of identifiers.

MAX_NUMERIC_PRECISIONback to summary
public static final int MAX_NUMERIC_PRECISION

The maximum allowed precision of numeric data types.

MAX_PARAMETER_INDEXback to summary
public static final int MAX_PARAMETER_INDEX

The highest possible parameter index.

MAX_STRING_LENGTHback to summary
public static final int MAX_STRING_LENGTH

The maximum allowed length for character string, binary string, and other data types based on them; excluding LOB data types.

This needs to be less than (2^31-8)/2 to avoid running into the limit on encoding data fields when storing rows.

MEMORY_ARRAYback to summary
public static final int MEMORY_ARRAY

The memory needed by an array.

MEMORY_OBJECTback to summary
public static final int MEMORY_OBJECT

The memory needed by a regular object with at least one field.

MEMORY_POINTERback to summary
public static final int MEMORY_POINTER

The memory needed by a pointer.

MEMORY_ROWback to summary
public static final int MEMORY_ROW

The memory needed by a Row.

MIN_WEB_ADMIN_PASSWORD_LENGTHback to summary
public static final int MIN_WEB_ADMIN_PASSWORD_LENGTH

The minimum number of characters in web admin password.

PG_CATALOG_SCHEMA_IDback to summary
public static final int PG_CATALOG_SCHEMA_ID

The identity of pg_catalog schema.

PG_VERSIONback to summary
public static final String PG_VERSION

Announced version for PgServer.

PREFIX_INDEXback to summary
public static final String PREFIX_INDEX

The name prefix used for indexes that are not explicitly named.

PREFIX_JOINback to summary
public static final String PREFIX_JOIN

The name prefix used for synthetic nested join tables.

PREFIX_PRIMARY_KEYback to summary
public static final String PREFIX_PRIMARY_KEY

The name prefix used for primary key constraints that are not explicitly named.

PREFIX_QUERY_ALIASback to summary
public static final String PREFIX_QUERY_ALIAS

The name prefix used for query aliases that are not explicitly named.

PUBLIC_ROLE_NAMEback to summary
public static final String PUBLIC_ROLE_NAME

Every user belongs to this role.

QUERY_STATISTICS_MAX_ENTRIESback to summary
public static final int QUERY_STATISTICS_MAX_ENTRIES

The maximum number of entries in query statistics.

SALT_LENback to summary
public static final int SALT_LEN

The number of bytes in random salt that is used to hash passwords.

SCHEMA_MAINback to summary
public static final String SCHEMA_MAIN

The name of the default schema.

SCHEMA_PG_CATALOGback to summary
public static final String SCHEMA_PG_CATALOG

The name of the pg_catalog schema.

SELECTIVITY_DEFAULTback to summary
public static final int SELECTIVITY_DEFAULT

The default selectivity (used if the selectivity is not calculated).

SELECTIVITY_DISTINCT_COUNTback to summary
public static final int SELECTIVITY_DISTINCT_COUNT

The number of distinct values to keep in memory when running ANALYZE.

SERVER_PROPERTIES_DIRback to summary
public static final String SERVER_PROPERTIES_DIR

The default directory name of the server properties file for the H2 Console.

SERVER_PROPERTIES_NAMEback to summary
public static final String SERVER_PROPERTIES_NAME

The name of the server properties file for the H2 Console.

SLOW_QUERY_LIMIT_MSback to summary
public static final long SLOW_QUERY_LIMIT_MS

Queries that take longer than this number of milliseconds are written to the trace file with the level info.

START_URLback to summary
public static final String START_URL

The database URL prefix of this database.

SUFFIX_LOCK_FILEback to summary
public static final String SUFFIX_LOCK_FILE

The file name suffix of file lock files that are used to make sure a database is open by only one process at any time.

SUFFIX_MV_FILEback to summary
public static final String SUFFIX_MV_FILE

The file name suffix of a MVStore file.

SUFFIX_MV_STORE_NEW_FILEback to summary
public static final String SUFFIX_MV_STORE_NEW_FILE

The file name suffix of a new MVStore file, used when compacting a store.

SUFFIX_MV_STORE_TEMP_FILEback to summary
public static final String SUFFIX_MV_STORE_TEMP_FILE

The file name suffix of a temporary MVStore file, used when compacting a store.

SUFFIX_OLD_DATABASE_FILEback to summary
public static final String SUFFIX_OLD_DATABASE_FILE

The file name suffix of a H2 version 1.1 database file.

SUFFIX_TEMP_FILEback to summary
public static final String SUFFIX_TEMP_FILE

The file name suffix of temporary files.

SUFFIX_TRACE_FILEback to summary
public static final String SUFFIX_TRACE_FILE

The file name suffix of trace files.

TCP_PROTOCOL_VERSION_17back to summary
public static final int TCP_PROTOCOL_VERSION_17

The TCP protocol version number 17.

Since
1.4.197 (2018-03-18)
TCP_PROTOCOL_VERSION_18back to summary
public static final int TCP_PROTOCOL_VERSION_18

The TCP protocol version number 18.

Since
1.4.198 (2019-02-22)
TCP_PROTOCOL_VERSION_19back to summary
public static final int TCP_PROTOCOL_VERSION_19

The TCP protocol version number 19.

Since
1.4.200 (2019-10-14)
TCP_PROTOCOL_VERSION_20back to summary
public static final int TCP_PROTOCOL_VERSION_20

The TCP protocol version number 20.

Since
2.0.202 (2021-11-25)
TCP_PROTOCOL_VERSION_21back to summary
public static final int TCP_PROTOCOL_VERSION_21

The TCP protocol version number 21.

Since
2.3.230 (TODO)
TCP_PROTOCOL_VERSION_MAX_SUPPORTEDback to summary
public static final int TCP_PROTOCOL_VERSION_MAX_SUPPORTED

Maximum supported version of TCP protocol.

TCP_PROTOCOL_VERSION_MIN_SUPPORTEDback to summary
public static final int TCP_PROTOCOL_VERSION_MIN_SUPPORTED

Minimum supported version of TCP protocol.

THROTTLE_DELAYback to summary
public static final int THROTTLE_DELAY

How often we check to see if we need to apply a throttling delay if SET THROTTLE has been used.

TRANSACTION_SNAPSHOTback to summary
public static final int TRANSACTION_SNAPSHOT

SNAPSHOT isolation level of transaction.

URL_FORMATback to summary
public static final String URL_FORMAT

The database URL format in simplified Backus-Naur form.

USER_PACKAGEback to summary
public static final String USER_PACKAGE

The package name of user defined classes.

VERSIONback to summary
public static final String VERSION

The version of this product, consisting of major version, minor version, and build id.

VERSION_MAJORback to summary
public static final int VERSION_MAJOR

The major version of this database.

VERSION_MINORback to summary
public static final int VERSION_MINOR

The minor version of this database.

VIEW_COST_CACHE_MAX_AGEback to summary
public static final int VIEW_COST_CACHE_MAX_AGE

The maximum time in milliseconds to keep the cost of a view. 10000 means 10 seconds.

VIEW_INDEX_CACHE_SIZEback to summary
public static final int VIEW_INDEX_CACHE_SIZE

The name of the index cache that is used for temporary view (subqueries used as tables).

Constructor Detail

Constantsback to summary
private Constants()