org.apache.derby.iapi.reference
Interface Property


public interface Property

List of all properties understood by the system. It also has some other static fields.

This class exists for two reasons

  1. To act as the internal documentation for the properties.
  2. To remove the need to declare a java static field for the property name in the protocol/implementation class. This reduces the footprint as the string is final and thus can be included simply as a String constant pool entry.

This class should not be shipped with the product.

This class has no methods, all it contains are String's which by are public, static and final since they are declared in an interface.


Field Summary
static java.lang.String ALPHA_BETA_ALLOW_UPGRADE
          Allow database upgrade during alpha/beta time.
static java.lang.String AUTHENTICATION_BUILTIN_ALGORITHM
          Property that specifies the name of the hash algorithm to use with the configurable hash authentication scheme.
static java.lang.String AUTHENTICATION_BUILTIN_ALGORITHM_DEFAULT
          Default value for derby.authentication.builtin.algorithm when creating a new database.
static java.lang.String AUTHENTICATION_BUILTIN_ALGORITHM_FALLBACK
          Alternative default value for derby.authentication.builtin.algorithm if AUTHENTICATION_BUILTIN_ALGORITHM_DEFAULT is not available at database creation time.
static java.lang.String AUTHENTICATION_PROVIDER_BUILTIN
           
static java.lang.String AUTHENTICATION_PROVIDER_LDAP
           
static java.lang.String AUTHENTICATION_PROVIDER_PARAMETER
           
static java.lang.String AUTHENTICATION_SERVER_PARAMETER
           
static java.lang.String BOOT_ALL
          derby.system.bootAll
Automatically boot any services at start up time.
static java.lang.String BOOT_DB_CLASSPATH
          internal use only, passes the database classpathinto the class manager
static java.lang.String CHECKPOINT_INTERVAL
          Property name for specifying checkpoint interval
static java.lang.String COLLATION
           
static java.lang.String COLLATION_NONE
           
static java.lang.String CREATE_WITH_NO_LOG
          Creation of an access factory should be done with no logging.
static java.lang.String DATABASE_CLASSPATH
          derby.database.classpath
Consists of a series of two part jar names.
static java.lang.String DATABASE_MODULE
           
static java.lang.String DATABASE_PROPERTIES_ONLY
          derby.database.propertiesOnly
static java.lang.String DEADLOCK_MONITOR
          Turn on lock monitor to help debug deadlocks.
static java.lang.String DEADLOCK_TIMEOUT
          Configuration parameter for deadlock timeouts, set in seconds.
static int DEADLOCK_TIMEOUT_DEFAULT
          Default value for deadlock timesouts (20 seconds)
static java.lang.String DEADLOCK_TRACE
          Turn on deadlock trace to help debug deadlocks.
static java.lang.String DEFAULT_CONNECTION_MODE_PROPERTY
          Default connection level authorization, set to one of NO_ACCESS, READ_ONLY_ACCESS or FULL_ACCESS.
static int DEFAULT_LANGUAGE_STALE_PLAN_CHECK_INTERVAL
          Default value for above
static int DEFAULT_LOCKS_ESCALATION_THRESHOLD
          The default value for LOCKS_ESCALATION_THRESHOLD
static java.lang.String DEFAULT_USER_NAME
           
static int DEFAULT_XA_TRANSACTION_TIMEOUT
          The default value for XA transaction timeout if the corresponding property is not found in system properties.
static java.lang.String DELETE_ON_CREATE
          derby.
static java.lang.String DELETE_ROOT_ON_ERROR
          db2j.deleteRootOnError
If we a new root is created while doing restore from backup, it should be deleted if a error occur before we could complete restore successfully.
static java.lang.String DERBY_INSTALL_URL
          Ths property is private to Derby.
static java.lang.String DERBY_SECURITY_HOST
          Ths property is private to Derby.
static java.lang.String DRDA_PROP_HOSTNAME
           
static java.lang.String DRDA_PROP_KEEPALIVE
          derby.drda.keepAlive
client socket setKeepAlive value
static java.lang.String DRDA_PROP_LOGCONNECTIONS
          derby.drda.logConnections
Indicates whether to log connections and disconnections.
static java.lang.String DRDA_PROP_MAXTHREADS
           
static java.lang.String DRDA_PROP_MINTHREADS
           
static java.lang.String DRDA_PROP_PORTNUMBER
          derby.drda.portNumber
The port number used by the network server.
static java.lang.String DRDA_PROP_SECURITYMECHANISM
          derby.drda.securityMechanism
This property can be set to one of the following values USER_ONLY_SECURITY CLEAR_TEXT_PASSWORD_SECURITY ENCRYPTED_USER_AND_PASSWORD_SECURITY STRONG_PASSWORD_SUBSTITUTE_SECURITY
if derby.drda.securityMechanism is set to a valid mechanism, then the Network Server accepts only connections which use that security mechanism.
static java.lang.String DRDA_PROP_SSL_MODE
          derby.drda.sslMode
This property may be set to one of the following three values off: No Wire encryption basic: Encryption, but no SSL client authentication peerAuthentication: Encryption and with SSL client authentication
static java.lang.String DRDA_PROP_STREAMOUTBUFFERSIZE
          derby.drda.streamOutBufferSize size of buffer used when stream out for client.
static java.lang.String DRDA_PROP_TIMESLICE
           
static java.lang.String DRDA_PROP_TRACE
           
static java.lang.String DRDA_PROP_TRACEALL
          derby.drda.traceAll
Turns tracing on for all sessions.
static java.lang.String DRDA_PROP_TRACEDIRECTORY
          derby.drda.traceDirectory
The directory used for network server tracing files.
static java.lang.String DURABILITY_PROPERTY
          derby.system.durability Currently the only valid supported case insensitive value is 'test' Note, if this property is set to any other value other than 'test', this property setting is ignored In the future, this property can be used to set different modes - for example a form of relaxed durability where database can recover to a consistent state, or to enable some kind of in-memory mode.
static java.lang.String DURABILITY_TESTMODE_NO_SYNC
          This is a value supported for derby.system.durability When derby.system.durability=test, the storage system does not force syncs and the system may not recover.
static java.lang.String ERRORLOG_FIELD_PROPERTY
          derby.stream.error.field= .
static java.lang.String ERRORLOG_FILE_PROPERTY
          derby.stream.error.file=absolute or relative error log filename Takes precendence over derby.stream.error.method.
static java.lang.String ERRORLOG_METHOD_PROPERTY
          derby.stream.error.method= .
static java.lang.String FILESYNC_TRANSACTION_LOG
          derby.storage.fileSyncTransactionLog When set, the store system will use sync() call on the log at commit instead of doing a write sync on all writes to the log; even if the write sync mode (rws) is supported in the JVM.
static java.lang.String FORCE_DATABASE_LOCK
          derby.database.forceDatabaseLock
Derby attempts to prevent two instances of Derby from booting the same database with the use of a file called db.lck inside the database directory.
static java.lang.String FULL_ACCESS
           
static java.lang.String FULL_ACCESS_USERS_PROPERTY
          List of users with full access connection level authorization.
static java.lang.String HTTP_DB_FILE_LENGTH
           
static java.lang.String HTTP_DB_FILE_NAME
           
static java.lang.String HTTP_DB_FILE_OFFSET
           
static int IDX_PAGE_SIZE_BUMP_THRESHOLD
          The bump threshold for pages size for index.
static java.lang.String IN_RESTORE_FROM_BACKUP
          db2j.inRestore
This Property is used to indicate that we are in restore mode if if the system is doing a restore from backup.
static java.lang.String LANG_PERMISSIONS_CACHE_SIZE
          The size of the permissions cache used by the data dictionary.
static int LANG_PERMISSIONS_CACHE_SIZE_DEFAULT
           
static java.lang.String LANG_SEQGEN_CACHE_SIZE
          The size of the sequence generator cache used by the data dictionary.
static int LANG_SEQGEN_CACHE_SIZE_DEFAULT
           
static java.lang.String LANG_SPS_CACHE_SIZE
          The size of the stored prepared statment descriptor cache used by the data dictionary.
static int LANG_SPS_CACHE_SIZE_DEFAULT
           
static java.lang.String LANG_TD_CACHE_SIZE
          The size of the table descriptor cache used by the data dictionary.
static int LANG_TD_CACHE_SIZE_DEFAULT
           
static java.lang.String LANGUAGE_STALE_PLAN_CHECK_INTERVAL
          derby.language.stalePlanCheckInterval This property tells the number of times a prepared statement should be executed before checking whether its plan is stale.
static java.lang.String LOCKS_ESCALATION_THRESHOLD
          derby.locks.escalationThreshold
The number of row locks on a table after which we escalate to table locking.
static java.lang.String LOCKS_INTRO
           
static java.lang.String LOCKWAIT_TIMEOUT
          Configuration parameter for lock wait timeouts, set in seconds.
static java.lang.String LOG_ARCHIVAL_DIRECTORY
          Property name for specifying log archival location
static java.lang.String LOG_ARCHIVE_MODE
          derby.storage.logArchiveMode
used to identify whether the log is being archived for the database or not.
static java.lang.String LOG_BOOT_TRACE
          derby.stream.error.logBootTrace
defaults to false.
static java.lang.String LOG_BUFFER_SIZE
          Property name for specifying log Buffer Size
static java.lang.String LOG_DEVICE_AT_BACKUP
          derby.storage.logDeviceWhenBackedUp
This property indicates the logDevice location(path) when the backup was taken, used to restore the log to the same location while restoring from backup.
static java.lang.String LOG_FILE_APPEND
          derby.infolog.append={true,false}
If the info stream goes to a file and the file already exist, it can either delete the existing file or append to it.
static java.lang.String LOG_SEVERITY_LEVEL
          derby.stream.error.logSeverityLevel=integerValue
Indicates the minimum level of severity for errors that are reported to the error stream.
static java.lang.String LOG_SWITCH_INTERVAL
          Property name for specifying log switch interval
static int MIN_LANGUAGE_STALE_PLAN_CHECK_INTERVAL
          Minimum value for above
static int MIN_LOCKS_ESCALATION_THRESHOLD
          The minimum value for LOCKS_ESCALATION_THRESHOLD
static java.lang.String MODULE_ENV_CLASSES_PREFIX
          Declare a set of classes that the class for a module or sub sub protocol requires.
static java.lang.String MODULE_ENV_JDK_PREFIX
          Declare a minimum JDK level the class for a module or sub sub protocol supports.
static java.lang.String MODULE_PREFIX
          derby.module.modulename Defines a new module.
static java.lang.String NO_ACCESS
           
static java.lang.String NO_AUTO_BOOT
          derby.database.noAutoBoot
Don't automatically boot this service at start up time.
static java.lang.String PAGE_SIZE_DEFAULT_LONG
          The default page size to use for tables that contain a long column.
static java.lang.String PAGE_SIZE_PARAMETER
          The page size to create a table or index with.
static java.lang.String PROP_XA_TRANSACTION_TIMEOUT
          The property name used to get the default value for XA transaction timeout in seconds.
static java.lang.String PROPERTIES_CONGLOM_ID
          derby.storage.propertiesId
Stores the id of the conglomerate that holds the per-database properties.
static java.lang.String PROPERTIES_FILE
          Name of the file that contains system wide properties.
static java.lang.String PROPERTY_RUNTIME_PREFIX
          By convention properties that must not be stored any persistent form of service properties start with this prefix.
static java.lang.String READ_ONLY_ACCESS
           
static java.lang.String READ_ONLY_ACCESS_USERS_PROPERTY
          List of users with read-only connection level authorization.
static java.lang.String REPLICATION_LOG_BUFFER_SIZE
          Property name for specifying the size of the replication log buffers
static java.lang.String REPLICATION_MAX_SHIPPING_INTERVAL
          Property name for specifying the maximum log shipping interval
static java.lang.String REPLICATION_MIN_SHIPPING_INTERVAL
          Property name for specifying the minimum log shipping interval
static java.lang.String REPLICATION_VERBOSE
          Property name for specifying whether or not replication messages are written to the log
static java.lang.String REQUIRE_AUTHENTICATION_PARAMETER
           
static java.lang.String ROW_LOCKING
          Derby supports Row Level Locking (rll), but you can use this property to disable rll.
static java.lang.String SERVICE_LOCALE
           
static java.lang.String SERVICE_PROTOCOL
           
static java.lang.String SQL_AUTHORIZATION_PROPERTY
           
static java.lang.String START_DRDA
          derby.drda.startNetworkServer
If true then we will attempt to start a DRDA network server when Derby boots, turning the current JVM into a server.
static java.lang.String STATEMENT_CACHE_SIZE
           
static int STATEMENT_CACHE_SIZE_DEFAULT
           
static java.lang.String STORAGE_DATA_NOT_SYNCED_AT_ALLOCATION
          db2j.storage.dataNotSyncedAtAllocation When set, the store system will not force a sync() call on the containers when pages are allocated.
static java.lang.String STORAGE_DATA_NOT_SYNCED_AT_CHECKPOINT
          db2j.storage.dataNotSyncedAtCheckPoint When set, the store system will not force a sync() call on the containers during a checkpoint.
static java.lang.String STORAGE_LOG_NOT_SYNCED
          db2j.storage.logNotSynced When set, the store system will not force a sync() call on the log at commit.
static java.lang.String STORAGE_TEMP_DIRECTORY
          derby.storage.tempDirectory
Sets the temp directory for a database.
static java.lang.String SUB_SUB_PROTOCOL_PREFIX
          derby.subSubProtocol.xxx A new subsubprotocol can be defined by specifying the class that handles storage for the subsubprotocol by implementing the StorageFactory or WritableStorageFactory interface.
static java.lang.String SYSTEM_HOME_PROPERTY
          derby.system.home
Property name for the home directory.
static int TBL_PAGE_SIZE_BUMP_THRESHOLD
          The bump threshold for pages sizes for create tables If the approximate column sizes of a table is greater than this threshold, the page size for the tbl is bumped to PAGE_SIZE_DEFAULT_LONG provided the page size is not already specified as a property
static java.lang.String TERRITORY_BASED_COLLATION
           
static java.lang.String TERRITORY_BASED_IDENTICAL_COLLATION
           
static java.lang.String TERRITORY_BASED_PRIMARY_COLLATION
           
static java.lang.String TERRITORY_BASED_SECONDARY_COLLATION
           
static java.lang.String TERRITORY_BASED_TERTIARY_COLLATION
           
static java.lang.String UCS_BASIC_COLLATION
           
static java.lang.String USER_PROPERTY_PREFIX
           
static int WAIT_TIMEOUT_DEFAULT
          Default value for wait timeouts (60 seconds)
 

Field Detail

PROPERTIES_FILE

static final java.lang.String PROPERTIES_FILE
Name of the file that contains system wide properties. Has to be located in ${derby.system.home} if set, otherwise ${user.dir}

See Also:
Constant Field Values

PROPERTY_RUNTIME_PREFIX

static final java.lang.String PROPERTY_RUNTIME_PREFIX
By convention properties that must not be stored any persistent form of service properties start with this prefix.

See Also:
Constant Field Values

LOG_SEVERITY_LEVEL

static final java.lang.String LOG_SEVERITY_LEVEL
derby.stream.error.logSeverityLevel=integerValue
Indicates the minimum level of severity for errors that are reported to the error stream. Default to 0 in a "sane" server, and SESSION_SEVERITY in the insane (and product) server.

See Also:
ExceptionSeverity.SESSION_SEVERITY, Constant Field Values

LOG_BOOT_TRACE

static final java.lang.String LOG_BOOT_TRACE
derby.stream.error.logBootTrace
defaults to false. If set to true logs a stack trace to the error stream on successful boot or shutdown. This can be useful when trying to debug dual boot scenarios especially with multiple class loaders.

See Also:
Constant Field Values

ERRORLOG_FILE_PROPERTY

static final java.lang.String ERRORLOG_FILE_PROPERTY
derby.stream.error.file=absolute or relative error log filename Takes precendence over derby.stream.error.method. Takes precendence over derby.stream.error.field

See Also:
Constant Field Values

ERRORLOG_METHOD_PROPERTY

static final java.lang.String ERRORLOG_METHOD_PROPERTY
derby.stream.error.method= . returning an OutputStream or Writer object Takes precendence over derby.stream.error.field

See Also:
Constant Field Values

ERRORLOG_FIELD_PROPERTY

static final java.lang.String ERRORLOG_FIELD_PROPERTY
derby.stream.error.field= . returning an OutputStream or Writer object>

See Also:
Constant Field Values

LOG_FILE_APPEND

static final java.lang.String LOG_FILE_APPEND
derby.infolog.append={true,false}
If the info stream goes to a file and the file already exist, it can either delete the existing file or append to it. User can specifiy whether info log file should append or not by setting derby.infolog.append={true/false} The default behavior is that the exiting file will be deleted when a new info stream is started.

See Also:
Constant Field Values

SYSTEM_HOME_PROPERTY

static final java.lang.String SYSTEM_HOME_PROPERTY
derby.system.home
Property name for the home directory. Any relative path in the system should be accessed though this property

See Also:
Constant Field Values

BOOT_ALL

static final java.lang.String BOOT_ALL
derby.system.bootAll
Automatically boot any services at start up time. When set to true this services will be booted at startup, otherwise services will be booted on demand.

See Also:
Constant Field Values

NO_AUTO_BOOT

static final java.lang.String NO_AUTO_BOOT
derby.database.noAutoBoot
Don't automatically boot this service at start up time. When set to true this service will only be booted on demand, otherwise the service will be booted at startup time if possible.

See Also:
Constant Field Values

DELETE_ON_CREATE

static final java.lang.String DELETE_ON_CREATE
derby.__deleteOnCreate
Before creating this service delete any remenants (e.g. the directory) of a previous service at the same location.

INTERNAL USE ONLY

See Also:
Constant Field Values

FORCE_DATABASE_LOCK

static final java.lang.String FORCE_DATABASE_LOCK
derby.database.forceDatabaseLock
Derby attempts to prevent two instances of Derby from booting the same database with the use of a file called db.lck inside the database directory. On some platforms, Derby can successfully prevent a second instance of Derby from booting the database, and thus prevents corruption. If this is the case, you will see an SQLException like the following: ERROR XJ040: Failed to start database 'toursDB', see the next exception for details. ERROR XSDB6: Another instance of Derby may have already booted the database C:\databases\toursDB. The error is also written to the information log. On other platforms, Derby issues a warning message if an instance of Derby attempts to boot a database that may already have a running instance of Derby attached to it. However, it does not prevent the second instance from booting, and thus potentially corrupting, the database. If a warning message has been issued, corruption may already have occurred. The warning message looks like this: WARNING: Derby (instance 80000000-00d2-3265-de92-000a0a0a0200) is attempting to boot the database /export/home/sky/wombat even though Derby (instance 80000000-00d2-3265-8abf-000a0a0a0200) may still be active. Only one instance of Derby should boot a database at a time. Severe and non-recoverable corruption can result and may have already occurred. The warning is also written to the information log. This warning is primarily a Technical Support aid to determine the cause of corruption. However, if you see this warning, your best choice is to close the connection and exit the JVM. This minimizes the risk of a corruption. Close all instances of Derby, then restart one instance of Derby and shut down the database properly so that the db.lck file can be removed. The warning message continues to appear until a proper shutdown of the Derby system can delete the db.lck file. If the "derby.database.forceDatabaseLock" property is set to true then this default behavior is altered on systems where Derby cannot prevent this dual booting. If the to true, then if the platform does not provide the ability for Derby to guarantee no double boot, and if Derby finds a db.lck file when it boots, it will throw an exception (TODO - mikem - add what exception), leave the db.lck file in place and not boot the system. At this point the system will not boot until the db.lck file is removed by hand. Note that this situation can arise even when 2 VM's are not accessing the same Derby system. Also note that if the db.lck file is removed by hand while a VM is still accessing a derby.database, then there is no way for Derby to prevent a second VM from starting up and possibly corrupting the database. In this situation no warning message will be logged to the error log. To disable the default behavior of the db.lck file set property as follows: derby.database.forceDatabaseLock=true

See Also:
Constant Field Values

LOCKS_INTRO

static final java.lang.String LOCKS_INTRO
See Also:
Constant Field Values

LOCKS_ESCALATION_THRESHOLD

static final java.lang.String LOCKS_ESCALATION_THRESHOLD
derby.locks.escalationThreshold
The number of row locks on a table after which we escalate to table locking. Also used by the optimizer to decide when to start with table locking. The String value must be convertible to an int.

See Also:
Constant Field Values

DEFAULT_LOCKS_ESCALATION_THRESHOLD

static final int DEFAULT_LOCKS_ESCALATION_THRESHOLD
The default value for LOCKS_ESCALATION_THRESHOLD

See Also:
Constant Field Values

MIN_LOCKS_ESCALATION_THRESHOLD

static final int MIN_LOCKS_ESCALATION_THRESHOLD
The minimum value for LOCKS_ESCALATION_THRESHOLD

See Also:
Constant Field Values

DEADLOCK_TIMEOUT

static final java.lang.String DEADLOCK_TIMEOUT
Configuration parameter for deadlock timeouts, set in seconds.

See Also:
Constant Field Values

DEADLOCK_TIMEOUT_DEFAULT

static final int DEADLOCK_TIMEOUT_DEFAULT
Default value for deadlock timesouts (20 seconds)

See Also:
Constant Field Values

WAIT_TIMEOUT_DEFAULT

static final int WAIT_TIMEOUT_DEFAULT
Default value for wait timeouts (60 seconds)

See Also:
Constant Field Values

DEADLOCK_MONITOR

static final java.lang.String DEADLOCK_MONITOR
Turn on lock monitor to help debug deadlocks. Default value is OFF. With this property turned on, all deadlocks will cause a tracing to be output to the db2j.LOG file.
This property takes effect dynamically.

See Also:
Constant Field Values

DEADLOCK_TRACE

static final java.lang.String DEADLOCK_TRACE
Turn on deadlock trace to help debug deadlocks. Effect 1: This property only takes effect if DEADLOCK_MONITOR is turned ON for deadlock trace. With this property turned on, each lock object involved in a deadlock will output its stack trace to db2j.LOG. Effect 2: When a timeout occurs, a lockTable dump will also be output to db2j.LOG. This acts independent of DEADLOCK_MONITOR.
This property takes effect dynamically.

See Also:
Constant Field Values

LOCKWAIT_TIMEOUT

static final java.lang.String LOCKWAIT_TIMEOUT
Configuration parameter for lock wait timeouts, set in seconds.

See Also:
Constant Field Values

DATABASE_CLASSPATH

static final java.lang.String DATABASE_CLASSPATH
derby.database.classpath
Consists of a series of two part jar names.

See Also:
Constant Field Values

BOOT_DB_CLASSPATH

static final java.lang.String BOOT_DB_CLASSPATH
internal use only, passes the database classpathinto the class manager

See Also:
Constant Field Values

DATABASE_PROPERTIES_ONLY

static final java.lang.String DATABASE_PROPERTIES_ONLY
derby.database.propertiesOnly

See Also:
Constant Field Values

DERBY_INSTALL_URL

static final java.lang.String DERBY_INSTALL_URL
Ths property is private to Derby. This property is forcibly set by the Network Server to override any values which the user may have set. This property is only used to parameterize the Basic security policy used by the Network Server. This property is the location of the derby jars.

See Also:
Constant Field Values

DERBY_SECURITY_HOST

static final java.lang.String DERBY_SECURITY_HOST
Ths property is private to Derby. This property is forcibly set by the Network Server to override any values which the user may have set. This property is only used to parameterize the Basic security policy used by the Network Server. This property is the hostname which the server uses.

See Also:
Constant Field Values

CREATE_WITH_NO_LOG

static final java.lang.String CREATE_WITH_NO_LOG
Creation of an access factory should be done with no logging. This is a run-time property that should not make it to disk in the service.properties file.

See Also:
Constant Field Values

PAGE_SIZE_PARAMETER

static final java.lang.String PAGE_SIZE_PARAMETER
The page size to create a table or index with. Must be a multiple of 2k, usual choices are: 2k, 4k, 8k, 16k, 32k, 64k. The default if property is not set is 4k.

See Also:
Constant Field Values

PAGE_SIZE_DEFAULT_LONG

static final java.lang.String PAGE_SIZE_DEFAULT_LONG
The default page size to use for tables that contain a long column.

See Also:
Constant Field Values

TBL_PAGE_SIZE_BUMP_THRESHOLD

static final int TBL_PAGE_SIZE_BUMP_THRESHOLD
The bump threshold for pages sizes for create tables If the approximate column sizes of a table is greater than this threshold, the page size for the tbl is bumped to PAGE_SIZE_DEFAULT_LONG provided the page size is not already specified as a property

See Also:
Constant Field Values

IDX_PAGE_SIZE_BUMP_THRESHOLD

static final int IDX_PAGE_SIZE_BUMP_THRESHOLD
The bump threshold for pages size for index. If the approximate key columns of an index is greater than this threshold, the page size for the index is bumped to PAGE_SIZE_DEFAULT_LONG provided the page size is not already specified as a property

See Also:
Constant Field Values

ROW_LOCKING

static final java.lang.String ROW_LOCKING
Derby supports Row Level Locking (rll), but you can use this property to disable rll. Applications which use rll will use more system resources, so if an application knows that it does not need rll then it can use this system property to force all locking in the system to lock at the table level. This property can be set to the boolean values "true" or "false". Setting the property to true is the same as not setting the property at all, and will result in rll being enabled. Setting the property to false disables rll.

See Also:
Constant Field Values

PROPERTIES_CONGLOM_ID

static final java.lang.String PROPERTIES_CONGLOM_ID
derby.storage.propertiesId
Stores the id of the conglomerate that holds the per-database properties. Is stored in the service.properties file.

INTERNAL USE ONLY

See Also:
Constant Field Values

STORAGE_TEMP_DIRECTORY

static final java.lang.String STORAGE_TEMP_DIRECTORY
derby.storage.tempDirectory
Sets the temp directory for a database.

See Also:
Constant Field Values

DURABILITY_PROPERTY

static final java.lang.String DURABILITY_PROPERTY
derby.system.durability

Currently the only valid supported case insensitive value is 'test' Note, if this property is set to any other value other than 'test', this property setting is ignored In the future, this property can be used to set different modes - for example a form of relaxed durability where database can recover to a consistent state, or to enable some kind of in-memory mode.
When set to 'test', the store system will not force sync calls in the following cases - for the log file at each commit - for the log file before data page is forced to disk - for page allocation when file is grown - for data writes during checkpoint That means - a commit no longer guarantees that the transaction's modification will survive a system crash or JVM termination - the database may not recover successfully upon restart - a near full disk at runtime may cause unexpected errors - database can be in an inconsistent state

This setting is provided for performance reasons and should ideally only be used when the system can withstand the above consequences.
One sample use would be to use this mode (derby.system.durability=test) when using Derby as a test database, where high performance is required and the data is not very important
Valid supported values are test
Example derby.system.durability=test One can set this as a command line option to the JVM when starting the application or in the derby.properties file. It is a system level property.
This property is static; if you change it while Derby is running, the change does not take effect until you reboot.

See Also:
Constant Field Values

DURABILITY_TESTMODE_NO_SYNC

static final java.lang.String DURABILITY_TESTMODE_NO_SYNC
This is a value supported for derby.system.durability When derby.system.durability=test, the storage system does not force syncs and the system may not recover. It is also possible that the database might be in an inconsistent state

See Also:
DURABILITY_PROPERTY, Constant Field Values

FILESYNC_TRANSACTION_LOG

static final java.lang.String FILESYNC_TRANSACTION_LOG
derby.storage.fileSyncTransactionLog

When set, the store system will use sync() call on the log at commit instead of doing a write sync on all writes to the log; even if the write sync mode (rws) is supported in the JVM.

See Also:
Constant Field Values

LOG_ARCHIVE_MODE

static final java.lang.String LOG_ARCHIVE_MODE
derby.storage.logArchiveMode
used to identify whether the log is being archived for the database or not. It Is stored in the service.properties file. This property can be set to the boolean values "true" or "false". Setting the property to true means log is being archived, which could be used for roll-forward recovery. Setting the property to false disables log archive mode.

INTERNAL USE ONLY

See Also:
Constant Field Values

LOG_DEVICE_AT_BACKUP

static final java.lang.String LOG_DEVICE_AT_BACKUP
derby.storage.logDeviceWhenBackedUp
This property indicates the logDevice location(path) when the backup was taken, used to restore the log to the same location while restoring from backup.

INTERNAL USE ONLY

See Also:
Constant Field Values

MODULE_PREFIX

static final java.lang.String MODULE_PREFIX
derby.module.modulename

Defines a new module. Modulename is a name used when loading the definition of a module, it provides the linkage to other properties used to define the module, derby.env.jdk.modulename and derby.env.classes.modulename. The value is a Java class name that implements functionality required by the other parts of a Derby system or database. The class can optionally implement these classes to control its use and startup.

See Also:
Constant Field Values

SUB_SUB_PROTOCOL_PREFIX

static final java.lang.String SUB_SUB_PROTOCOL_PREFIX
derby.subSubProtocol.xxx

A new subsubprotocol can be defined by specifying the class that handles storage for the subsubprotocol by implementing the StorageFactory or WritableStorageFactory interface. This is done using a property named db2j.subsubprotocol.xxx where xxx is the subsubprotocol name. Subsubprotocol names are case sensitive and must be at least 3 characters in length.

For instance:
derby.subSubProtocol.mem=com.mycompany.MemStore
defines the "mem" subsubprotocol with class com.mycompany.MemStore as its StorageFactory implementation. A database implemented using this subsubprotocol can be opened with the URL "jdbc:derby:mem:myDatabase".

Subsubprotocols "directory", "classpath", "jar", "http", and "https" are built in and may not be overridden.

See Also:
Constant Field Values

MODULE_ENV_JDK_PREFIX

static final java.lang.String MODULE_ENV_JDK_PREFIX
Declare a minimum JDK level the class for a module or sub sub protocol supports. Set to an integer value from the JVMInfo class to represent a JDK. If the JDK is running at a lower level than the class requires then the class will not be loaded and will not be used. If there are multiple modules classes implementing the same functionality and supported by the JVM, then the one with the highest JDK requirements will be selected. This functionality is not present for sub sub protocol classes yet. See org.apache.derby.iapi.services.info.JVMInfo.JDK_ID

See Also:
Constant Field Values

MODULE_ENV_CLASSES_PREFIX

static final java.lang.String MODULE_ENV_CLASSES_PREFIX
Declare a set of classes that the class for a module or sub sub protocol requires. Value is a comma separated list of classes. If the classes listed are not loadable by the virtual machine then the module class will not be loaded and will not be used.

See Also:
Constant Field Values

LANG_TD_CACHE_SIZE

static final java.lang.String LANG_TD_CACHE_SIZE
The size of the table descriptor cache used by the data dictionary. Database. Static.

Undocumented.

See Also:
Constant Field Values

LANG_TD_CACHE_SIZE_DEFAULT

static final int LANG_TD_CACHE_SIZE_DEFAULT
See Also:
Constant Field Values

LANG_PERMISSIONS_CACHE_SIZE

static final java.lang.String LANG_PERMISSIONS_CACHE_SIZE
The size of the permissions cache used by the data dictionary. Database. Static.

Undocumented.

See Also:
Constant Field Values

LANG_PERMISSIONS_CACHE_SIZE_DEFAULT

static final int LANG_PERMISSIONS_CACHE_SIZE_DEFAULT
See Also:
Constant Field Values

LANG_SPS_CACHE_SIZE

static final java.lang.String LANG_SPS_CACHE_SIZE
The size of the stored prepared statment descriptor cache used by the data dictionary. Database. Static.

Externally visible.

See Also:
Constant Field Values

LANG_SPS_CACHE_SIZE_DEFAULT

static final int LANG_SPS_CACHE_SIZE_DEFAULT
See Also:
Constant Field Values

LANG_SEQGEN_CACHE_SIZE

static final java.lang.String LANG_SEQGEN_CACHE_SIZE
The size of the sequence generator cache used by the data dictionary. Database. Static.

Externally visible.

See Also:
Constant Field Values

LANG_SEQGEN_CACHE_SIZE_DEFAULT

static final int LANG_SEQGEN_CACHE_SIZE_DEFAULT
See Also:
Constant Field Values

LANGUAGE_STALE_PLAN_CHECK_INTERVAL

static final java.lang.String LANGUAGE_STALE_PLAN_CHECK_INTERVAL
derby.language.stalePlanCheckInterval

This property tells the number of times a prepared statement should be executed before checking whether its plan is stale. Database. Dynamic.

Externally visible.

See Also:
Constant Field Values

DEFAULT_LANGUAGE_STALE_PLAN_CHECK_INTERVAL

static final int DEFAULT_LANGUAGE_STALE_PLAN_CHECK_INTERVAL
Default value for above

See Also:
Constant Field Values

MIN_LANGUAGE_STALE_PLAN_CHECK_INTERVAL

static final int MIN_LANGUAGE_STALE_PLAN_CHECK_INTERVAL
Minimum value for above

See Also:
Constant Field Values

STATEMENT_CACHE_SIZE

static final java.lang.String STATEMENT_CACHE_SIZE
See Also:
Constant Field Values

STATEMENT_CACHE_SIZE_DEFAULT

static final int STATEMENT_CACHE_SIZE_DEFAULT
See Also:
Constant Field Values

PROP_XA_TRANSACTION_TIMEOUT

static final java.lang.String PROP_XA_TRANSACTION_TIMEOUT
The property name used to get the default value for XA transaction timeout in seconds. Zero means no timout.

See Also:
Constant Field Values

DEFAULT_XA_TRANSACTION_TIMEOUT

static final int DEFAULT_XA_TRANSACTION_TIMEOUT
The default value for XA transaction timeout if the corresponding property is not found in system properties. Zero means no timeout.

See Also:
Constant Field Values

DEFAULT_USER_NAME

static final java.lang.String DEFAULT_USER_NAME
See Also:
Constant Field Values

DATABASE_MODULE

static final java.lang.String DATABASE_MODULE
See Also:
Constant Field Values

SQL_AUTHORIZATION_PROPERTY

static final java.lang.String SQL_AUTHORIZATION_PROPERTY
See Also:
Constant Field Values

DEFAULT_CONNECTION_MODE_PROPERTY

static final java.lang.String DEFAULT_CONNECTION_MODE_PROPERTY
Default connection level authorization, set to one of NO_ACCESS, READ_ONLY_ACCESS or FULL_ACCESS. Defaults to FULL_ACCESS if not set.

See Also:
Constant Field Values

NO_ACCESS

static final java.lang.String NO_ACCESS
See Also:
Constant Field Values

READ_ONLY_ACCESS

static final java.lang.String READ_ONLY_ACCESS
See Also:
Constant Field Values

FULL_ACCESS

static final java.lang.String FULL_ACCESS
See Also:
Constant Field Values

READ_ONLY_ACCESS_USERS_PROPERTY

static final java.lang.String READ_ONLY_ACCESS_USERS_PROPERTY
List of users with read-only connection level authorization.

See Also:
Constant Field Values

FULL_ACCESS_USERS_PROPERTY

static final java.lang.String FULL_ACCESS_USERS_PROPERTY
List of users with full access connection level authorization.

See Also:
Constant Field Values

REQUIRE_AUTHENTICATION_PARAMETER

static final java.lang.String REQUIRE_AUTHENTICATION_PARAMETER
See Also:
Constant Field Values

AUTHENTICATION_PROVIDER_PARAMETER

static final java.lang.String AUTHENTICATION_PROVIDER_PARAMETER
See Also:
Constant Field Values

USER_PROPERTY_PREFIX

static final java.lang.String USER_PROPERTY_PREFIX
See Also:
Constant Field Values

AUTHENTICATION_PROVIDER_BUILTIN

static final java.lang.String AUTHENTICATION_PROVIDER_BUILTIN
See Also:
Constant Field Values

AUTHENTICATION_PROVIDER_LDAP

static final java.lang.String AUTHENTICATION_PROVIDER_LDAP
See Also:
Constant Field Values

AUTHENTICATION_SERVER_PARAMETER

static final java.lang.String AUTHENTICATION_SERVER_PARAMETER
See Also:
Constant Field Values

AUTHENTICATION_BUILTIN_ALGORITHM

static final java.lang.String AUTHENTICATION_BUILTIN_ALGORITHM
Property that specifies the name of the hash algorithm to use with the configurable hash authentication scheme.

See Also:
Constant Field Values

AUTHENTICATION_BUILTIN_ALGORITHM_DEFAULT

static final java.lang.String AUTHENTICATION_BUILTIN_ALGORITHM_DEFAULT
Default value for derby.authentication.builtin.algorithm when creating a new database.

See Also:
Constant Field Values

AUTHENTICATION_BUILTIN_ALGORITHM_FALLBACK

static final java.lang.String AUTHENTICATION_BUILTIN_ALGORITHM_FALLBACK
Alternative default value for derby.authentication.builtin.algorithm if AUTHENTICATION_BUILTIN_ALGORITHM_DEFAULT is not available at database creation time.

See Also:
Constant Field Values

LOG_SWITCH_INTERVAL

static final java.lang.String LOG_SWITCH_INTERVAL
Property name for specifying log switch interval

See Also:
Constant Field Values

CHECKPOINT_INTERVAL

static final java.lang.String CHECKPOINT_INTERVAL
Property name for specifying checkpoint interval

See Also:
Constant Field Values

LOG_ARCHIVAL_DIRECTORY

static final java.lang.String LOG_ARCHIVAL_DIRECTORY
Property name for specifying log archival location

See Also:
Constant Field Values

LOG_BUFFER_SIZE

static final java.lang.String LOG_BUFFER_SIZE
Property name for specifying log Buffer Size

See Also:
Constant Field Values

REPLICATION_LOG_BUFFER_SIZE

static final java.lang.String REPLICATION_LOG_BUFFER_SIZE
Property name for specifying the size of the replication log buffers

See Also:
Constant Field Values

REPLICATION_MIN_SHIPPING_INTERVAL

static final java.lang.String REPLICATION_MIN_SHIPPING_INTERVAL
Property name for specifying the minimum log shipping interval

See Also:
Constant Field Values

REPLICATION_MAX_SHIPPING_INTERVAL

static final java.lang.String REPLICATION_MAX_SHIPPING_INTERVAL
Property name for specifying the maximum log shipping interval

See Also:
Constant Field Values

REPLICATION_VERBOSE

static final java.lang.String REPLICATION_VERBOSE
Property name for specifying whether or not replication messages are written to the log

See Also:
Constant Field Values

ALPHA_BETA_ALLOW_UPGRADE

static final java.lang.String ALPHA_BETA_ALLOW_UPGRADE
Allow database upgrade during alpha/beta time. Only intended to be used to allow Derby developers to test their upgrade code. Only supported as a system/application (derby.properties) property.

See Also:
Constant Field Values

IN_RESTORE_FROM_BACKUP

static final java.lang.String IN_RESTORE_FROM_BACKUP
db2j.inRestore
This Property is used to indicate that we are in restore mode if if the system is doing a restore from backup. Used internally to set flags to indicate that service is not booted.

INTERNAL USE ONLY

See Also:
Constant Field Values

DELETE_ROOT_ON_ERROR

static final java.lang.String DELETE_ROOT_ON_ERROR
db2j.deleteRootOnError
If we a new root is created while doing restore from backup, it should be deleted if a error occur before we could complete restore successfully.

INTERNAL USE ONLY

See Also:
Constant Field Values

HTTP_DB_FILE_OFFSET

static final java.lang.String HTTP_DB_FILE_OFFSET
See Also:
Constant Field Values

HTTP_DB_FILE_LENGTH

static final java.lang.String HTTP_DB_FILE_LENGTH
See Also:
Constant Field Values

HTTP_DB_FILE_NAME

static final java.lang.String HTTP_DB_FILE_NAME
See Also:
Constant Field Values

START_DRDA

static final java.lang.String START_DRDA
derby.drda.startNetworkServer
If true then we will attempt to start a DRDA network server when Derby boots, turning the current JVM into a server.
Default: false

See Also:
Constant Field Values

DRDA_PROP_LOGCONNECTIONS

static final java.lang.String DRDA_PROP_LOGCONNECTIONS
derby.drda.logConnections
Indicates whether to log connections and disconnections.
Default: false

See Also:
Constant Field Values

DRDA_PROP_TRACEALL

static final java.lang.String DRDA_PROP_TRACEALL
derby.drda.traceAll
Turns tracing on for all sessions.
Default: false

See Also:
Constant Field Values

DRDA_PROP_TRACE

static final java.lang.String DRDA_PROP_TRACE
See Also:
Constant Field Values

DRDA_PROP_TRACEDIRECTORY

static final java.lang.String DRDA_PROP_TRACEDIRECTORY
derby.drda.traceDirectory
The directory used for network server tracing files.
Default: if the derby.system.home property has been set, it is the default. Otherwise, the default is the current directory.

See Also:
Constant Field Values

DRDA_PROP_MINTHREADS

static final java.lang.String DRDA_PROP_MINTHREADS
See Also:
Constant Field Values

DRDA_PROP_MAXTHREADS

static final java.lang.String DRDA_PROP_MAXTHREADS
See Also:
Constant Field Values

DRDA_PROP_TIMESLICE

static final java.lang.String DRDA_PROP_TIMESLICE
See Also:
Constant Field Values

DRDA_PROP_SSL_MODE

static final java.lang.String DRDA_PROP_SSL_MODE
derby.drda.sslMode
This property may be set to one of the following three values off: No Wire encryption basic: Encryption, but no SSL client authentication peerAuthentication: Encryption and with SSL client authentication

See Also:
Constant Field Values

DRDA_PROP_SECURITYMECHANISM

static final java.lang.String DRDA_PROP_SECURITYMECHANISM
derby.drda.securityMechanism
This property can be set to one of the following values USER_ONLY_SECURITY CLEAR_TEXT_PASSWORD_SECURITY ENCRYPTED_USER_AND_PASSWORD_SECURITY STRONG_PASSWORD_SUBSTITUTE_SECURITY
if derby.drda.securityMechanism is set to a valid mechanism, then the Network Server accepts only connections which use that security mechanism. No other types of connections are accepted.
if the derby.drda.securityMechanism is not set at all, then the Network Server accepts any connection which uses a valid security mechanism.
E.g derby.drda.securityMechanism=USER_ONLY_SECURITY This property is static. Server must be restarted for the property to take effect. Default value for this property is as though it is not set - in which case the server will allow clients with supported security mechanisms to connect

See Also:
Constant Field Values

DRDA_PROP_PORTNUMBER

static final java.lang.String DRDA_PROP_PORTNUMBER
derby.drda.portNumber
The port number used by the network server.

See Also:
Constant Field Values

DRDA_PROP_HOSTNAME

static final java.lang.String DRDA_PROP_HOSTNAME
See Also:
Constant Field Values

DRDA_PROP_KEEPALIVE

static final java.lang.String DRDA_PROP_KEEPALIVE
derby.drda.keepAlive
client socket setKeepAlive value

See Also:
Constant Field Values

DRDA_PROP_STREAMOUTBUFFERSIZE

static final java.lang.String DRDA_PROP_STREAMOUTBUFFERSIZE
derby.drda.streamOutBufferSize size of buffer used when stream out for client.

See Also:
Constant Field Values

SERVICE_PROTOCOL

static final java.lang.String SERVICE_PROTOCOL
See Also:
Constant Field Values

SERVICE_LOCALE

static final java.lang.String SERVICE_LOCALE
See Also:
Constant Field Values

COLLATION

static final java.lang.String COLLATION
See Also:
Constant Field Values

UCS_BASIC_COLLATION

static final java.lang.String UCS_BASIC_COLLATION
See Also:
Constant Field Values

TERRITORY_BASED_COLLATION

static final java.lang.String TERRITORY_BASED_COLLATION
See Also:
Constant Field Values

TERRITORY_BASED_PRIMARY_COLLATION

static final java.lang.String TERRITORY_BASED_PRIMARY_COLLATION
See Also:
Constant Field Values

TERRITORY_BASED_SECONDARY_COLLATION

static final java.lang.String TERRITORY_BASED_SECONDARY_COLLATION
See Also:
Constant Field Values

TERRITORY_BASED_TERTIARY_COLLATION

static final java.lang.String TERRITORY_BASED_TERTIARY_COLLATION
See Also:
Constant Field Values

TERRITORY_BASED_IDENTICAL_COLLATION

static final java.lang.String TERRITORY_BASED_IDENTICAL_COLLATION
See Also:
Constant Field Values

COLLATION_NONE

static final java.lang.String COLLATION_NONE
See Also:
Constant Field Values

STORAGE_DATA_NOT_SYNCED_AT_CHECKPOINT

static final java.lang.String STORAGE_DATA_NOT_SYNCED_AT_CHECKPOINT
db2j.storage.dataNotSyncedAtCheckPoint

When set, the store system will not force a sync() call on the containers during a checkpoint.

An internal debug system only flag. The recovery system will not work properly if this flag is enabled, it is provided to do performance debugging to see whether the system is I/O bound based on checkpoint synchronous I/O.

See Also:
Constant Field Values

STORAGE_DATA_NOT_SYNCED_AT_ALLOCATION

static final java.lang.String STORAGE_DATA_NOT_SYNCED_AT_ALLOCATION
db2j.storage.dataNotSyncedAtAllocation

When set, the store system will not force a sync() call on the containers when pages are allocated.

An internal debug system only flag. The recovery system will not work properly if this flag is enabled, it is provided to do performance debugging to see whether the system is I/O bound based on page allocation synchronous I/O.

See Also:
Constant Field Values

STORAGE_LOG_NOT_SYNCED

static final java.lang.String STORAGE_LOG_NOT_SYNCED
db2j.storage.logNotSynced

When set, the store system will not force a sync() call on the log at commit.

An internal debug system only flag. The recovery system will not work properly if this flag is enabled, it is provided to do performance debugging to see whether the system is I/O bound based on log file synchronous I/O.

See Also:
Constant Field Values

Built on Thu 2011-03-10 11:54:14+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.