Top Description Fields
org.apache.derby.shared.common.reference

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

Modifier and TypeField and Description
public static final String
ALPHA_BETA_ALLOW_UPGRADE

Allow database upgrade during alpha/beta time.

public static final String
AUTHENTICATION_BUILTIN_ALGORITHM

Property that specifies the name of the hash algorithm to use with the configurable hash authentication scheme.

public static final String
AUTHENTICATION_BUILTIN_ALGORITHM_DEFAULT

Default value for derby.authentication.builtin.algorithm when creating a new database.

public static final 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.

public static final String
AUTHENTICATION_BUILTIN_ITERATIONS

Property that specifies the number of times to apply the hash function in the configurable hash authentication scheme.

public static final int
AUTHENTICATION_BUILTIN_ITERATIONS_DEFAULT

Default value for derby.authentication.builtin.iterations.

public static final String
AUTHENTICATION_BUILTIN_SALT_LENGTH

Property that specifies the number of bytes with random salt to use when hashing credentials using the configurable hash authentication scheme.

public static final int
AUTHENTICATION_BUILTIN_SALT_LENGTH_DEFAULT

The default value for derby.authentication.builtin.saltLength.

public static final String
public static final long
public static final String
public static final double
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
BOOT_ALL

derby.system.bootAll Automatically boot any services at start up time.

public static final String
BOOT_DB_CLASSPATH

internal use only, passes the database classpathinto the class manager Undocumented.

public static final String
CHECKPOINT_INTERVAL

Property name for specifying checkpoint interval Undocumented.

public static final String
public static final String
public static final String
CREATE_WITH_NO_LOG

Creation of an access factory should be done with no logging.

public static final String
DATABASE_CLASSPATH

derby.database.classpath Consists of a series of two part jar names.

public static final String
public static final String
DATABASE_PROPERTIES_ONLY

derby.database.propertiesOnly

public static final String
DEADLOCK_MONITOR

Turn on lock monitor to help debug deadlocks.

public static final String
DEADLOCK_TIMEOUT

Configuration parameter for deadlock timeouts, set in seconds.

public static final int
DEADLOCK_TIMEOUT_DEFAULT

Default value for deadlock timesouts (20 seconds)

public static final String
DEADLOCK_TRACE

Turn on deadlock trace to help debug deadlocks.

public static final String
DEFAULT_CONNECTION_MODE_PROPERTY

Default connection level authorization, set to one of NO_ACCESS, READ_ONLY_ACCESS or FULL_ACCESS.

public static final int
public static final int
DEFAULT_LOCKS_ESCALATION_THRESHOLD

The default value for LOCKS_ESCALATION_THRESHOLD

public static final String
public static final int
DEFAULT_XA_TRANSACTION_TIMEOUT

The default value for XA transaction timeout if the corresponding property is not found in system properties.

public static final 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.

public static final 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.

public static final String
public static final String
DERBY_INSTALL_URL

This property is private to Derby.

public static final String
DERBY_SECURITY_HOST

This property is private to Derby.

public static final String
DERBY_SECURITY_PORT

This property is private to Derby.

public static final String
public static final String
DRDA_PROP_KEEPALIVE

derby.drda.keepAlive client socket setKeepAlive value

public static final String
DRDA_PROP_LOGCONNECTIONS

derby.drda.logConnections

Indicates whether to log connections and disconnections.

public static final String
public static final String
public static final String
DRDA_PROP_PORTNUMBER

derby.drda.portNumber The port number used by the network server.

public static final 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.

public static final 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

public static final String
DRDA_PROP_STREAMOUTBUFFERSIZE

derby.drda.streamOutBufferSize size of buffer used when stream out for client.

public static final String
public static final String
DRDA_PROP_TRACE

derby.drda.trace

public static final String
DRDA_PROP_TRACEALL

derby.drda.traceAll

Turns tracing on for all sessions.

public static final String
DRDA_PROP_TRACEDIRECTORY

derby.drda.traceDirectory The directory used for network server tracing files.

public static final 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.

public static final 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.

public static final String
ERRORLOG_FIELD_PROPERTY

derby.stream.error.field= className.fieldName returning an OutputStream or Writer object

public static final String
ERRORLOG_FILE_PROPERTY

derby.stream.error.file=absolute or relative error log filename Takes precendence over derby.stream.error.method.

public static final String
ERRORLOG_METHOD_PROPERTY

derby.stream.error.method= $className.$methodName returning an OutputStream or Writer object Takes precendence over derby.stream.error.field

public static final String
ERRORLOG_ROLLINGFILE_COUNT_PROPERTY

derby.stream.error.rollingfile.count=the rolling file count

The default count is 10

public static final String
ERRORLOG_ROLLINGFILE_LIMIT_PROPERTY

derby.stream.error.rollingfile.limit=the rolling file size limit

The default limit is 1024000

public static final String
ERRORLOG_ROLLINGFILE_PATTERN_PROPERTY

derby.stream.error.rollingfile.pattern=the pattern A pattern consists of a string that includes the following special components that will be replaced at runtime:

  • "/" the local pathname separator
  • "%t" the system temporary directory
  • "%h" the value of the "user.home" system property
  • "%d" the value of the "derby.system.home" system property
  • "%g" the generation number to distinguish rotated logs
  • "%u" a unique number to resolve conflicts
  • "%%" translates to a single percent sign "%"
public static final String
ERRORLOG_STYLE_PROPERTY

derby.stream.error.style=The error stream error style.

public static final String
EXT_DIAG_SEVERITY_LEVEL

derby.stream.error.ExtendedDiagSeverityLevel=integerValue Indicates the minimum level of severity for errors that are reported thread dump information and diagnosis information depends on jvm vender.

public static final 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.

public static final 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.

public static final String
public static final String
FULL_ACCESS_USERS_PROPERTY

List of users with full access connection level authorization.

public static final String
public static final String
public static final String
public static final int
IDX_PAGE_SIZE_BUMP_THRESHOLD

The bump threshold for pages size for index.

public static final 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.

public static final String
LANG_PERMISSIONS_CACHE_SIZE

The size of the permissions cache used by the data dictionary.

public static final int
public static final String
LANG_SEQGEN_CACHE_SIZE

The size of the sequence generator cache used by the data dictionary.

public static final int
public static final String
LANG_SEQUENCE_PREALLOCATOR

Name of the implementation of SequencePreallocator which is used to tune how many values Derby pre-allocates for identity columns and sequences.

public static final String
LANG_SPS_CACHE_SIZE

The size of the stored prepared statment descriptor cache used by the data dictionary.

public static final int
public static final String
LANG_TD_CACHE_SIZE

The size of the table descriptor cache used by the data dictionary.

public static final int
public static final 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.

public static final String
LOCKS_ESCALATION_THRESHOLD

derby.locks.escalationThreshold The number of row locks on a table after which we escalate to table locking.

public static final String
public static final String
LOCKWAIT_TIMEOUT

Configuration parameter for lock wait timeouts, set in seconds.

public static final String
LOG_ARCHIVE_MODE

derby.storage.logArchiveMode used to identify whether the log is being archived for the database or not.

public static final String
LOG_BOOT_TRACE

derby.stream.error.logBootTrace defaults to false.

public static final String
LOG_BUFFER_SIZE

Property name for specifying log Buffer Size Undocumented.

public static final 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.

public static final 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.

public static final String
LOG_SEVERITY_LEVEL

derby.stream.error.logSeverityLevel=integerValue Indicates the minimum level of severity for errors that are reported to the error stream.

public static final String
LOG_SWITCH_INTERVAL

Property name for specifying log switch interval Undocumented.

public static final long
public static final int
public static final int
MIN_LOCKS_ESCALATION_THRESHOLD

The minimum value for LOCKS_ESCALATION_THRESHOLD

public static final String
MODULE_ENV_CLASSES_PREFIX

Declare a set of classes that the class for a module or sub sub protocol requires.

public static final String
MODULE_ENV_JDK_PREFIX

Declare a minimum JDK level the class for a module or sub sub protocol supports.

public static final String
MODULE_PREFIX

derby.module.modulename

Defines a new module.

public static final String
public static final String
NO_AUTO_BOOT

derby.database.noAutoBoot Don't automatically boot this service at start up time.

public static final String
PAGE_SIZE_DEFAULT_LONG

The default page size to use for tables that contain a long column.

public static final String
PAGE_SIZE_PARAMETER

The page size to create a table or index with.

public static final String
PROP_XA_TRANSACTION_TIMEOUT

The property name used to get the default value for XA transaction timeout in seconds.

public static final String
PROPERTIES_CONGLOM_ID

derby.storage.propertiesId Stores the id of the conglomerate that holds the per-database properties.

public static final String
PROPERTIES_FILE

Name of the file that contains system wide properties.

public static final String
PROPERTY_RUNTIME_PREFIX

By convention properties that must not be stored any persistent form of service properties start with this prefix.

public static final String
public static final String
READ_ONLY_ACCESS_USERS_PROPERTY

List of users with read-only connection level authorization.

public static final String
REPLICATION_LOG_BUFFER_SIZE

Property name for specifying the size of the replication log buffers

public static final String
REPLICATION_MAX_SHIPPING_INTERVAL

Property name for specifying the maximum log shipping interval

public static final String
REPLICATION_MIN_SHIPPING_INTERVAL

Property name for specifying the minimum log shipping interval

public static final String
REPLICATION_VERBOSE

Property name for specifying whether or not replication messages are written to the log

public static final String
public static final String
ROW_LOCKING

Derby supports Row Level Locking (rll), but you can use this property to disable rll.

public static final String
public static final String
public static final String
public static final String
public static final 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.

public static final String
public static final int
public static final String
STORAGE_AUTO_INDEX_STATS

Tells if automatic index statistics update is enabled (default is true).

public static final String
STORAGE_AUTO_INDEX_STATS_DEBUG_ABSDIFF_THRESHOLD

Specifies the lower threshold for the absolute difference between the row estimate for the table and the row estimate for the index before creating statistics for the associated indexes.

public static final int
public static final String
STORAGE_AUTO_INDEX_STATS_DEBUG_CREATE_THRESHOLD

Specifies the lower threshold for the number of rows in a table before creating statistics for the associated indexes.

public static final int
public static final String
STORAGE_AUTO_INDEX_STATS_DEBUG_KEEP_DISPOSABLE_STATS

Specifies whether to revert to 10.8 behavior and keep disposable stats.

public static final String
STORAGE_AUTO_INDEX_STATS_DEBUG_LNDIFF_THRESHOLD

Specifies the lower threshold for the logarithmical (natural logarithm e) difference between the row estimate for the table and the row estimate for the index before creating statistics for the associated indexes.

public static final double
public static final String
STORAGE_AUTO_INDEX_STATS_DEBUG_QUEUE_SIZE

Specifies the size of the work unit queue in the index statistics update daemon.

public static final int
public static final String
STORAGE_AUTO_INDEX_STATS_LOGGING

Tells if activities related to automatic index statistics update should be written to the Derby system log file (derby.log).

public static final String
STORAGE_AUTO_INDEX_STATS_TRACING

Tells if more detailed activities related to automatic index statistics update should be traced.

public static final 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.

public static final 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.

public static final String
STORAGE_LOG_NOT_SYNCED

db2j.storage.logNotSynced

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

public static final String
STORAGE_TEMP_DIRECTORY

derby.storage.tempDirectory

Sets the temp directory for a database.

public static final String
STORAGE_USE_DEFAULT_FILE_PERMISSIONS

derby.storage.useDefaultFilePermissions = {false,true}

When set to true, the store system will not limit file permissions of files created by Derby to owner, but rely on the current OS default.

public static final 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 org.apache.derby.io.StorageFactory StorageFactory or org.apache.derby.io.WritableStorageFactory WritableStorageFactory interface.

public static final String
SYSTEM_HOME_PROPERTY

derby.system.home Property name for the home directory.

public 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

public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final int
WAIT_TIMEOUT_DEFAULT

Default value for wait timeouts (60 seconds)