Interface Attribute
public interface Attribute
List of all connection (JDBC) attributes by the system.
This class exists for two reasons
- To act as the internal documentation for the attributes.
- To remove the need to declare a java static field for the attributes 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
FieldsModifier and TypeFieldDescriptionstatic final String
If dataEncryption is true, use this attribute to pass in the secret key.static final String
User should use this prefix for the client attributes traceLevel and traceDirectory when they are sending those attributes as JVM properties.static final String
retrieveMessageText.static final String
securityMechanism sets the mechanism for transmitting the user name and password from the client.static final String
traceFileAppend.static final String
traceDirectory sets the client side trace directory.static final String
traceFile sets the client side trace file.static final String
traceLevel.static final String
Set the collation sequence of the database, currently on IDENTITY will be supported (strings will sort according to binary comparison).static final String
The attribute that is used to request a database create.static final String
This attribute is used to request to create a database from backup.static final String
Attribute for encrypting a database.static final String
Attribute for encrypting a database.static final String
Attribute for encrypting a database.static final String
Attribute for encrypting a database.static final String
Attribute name to encrypt the database on disk.static final String
The attribute that is used for the database name, from the JDBC notion of jdbc:: static final String
The protocol for Derby Network Clientstatic final String
The attribute that is used to set the connection's DRDA ID.static final String
The protocol for the IBM Universal JDBC Driverstatic final String
Put the log on a different device.static final String
The attribute that is used to set the user password.static final String
Not an attribute but the root for the JDBC URL that Derby supports.static final String
Attribute name to start failover for a given database..static final String
Attribute name to stop replication slave mode for a database.static final String
If startMaster is true, this attribute is used to specify the host name the master should connect to.static final String
If startMaster is true, this attribute is used to specify the port the master should connect to.static final String
Attribute name to start replication master mode for a database.static final String
Attribute name to start replication slave mode for a database.static final String
Attribute name to stop replication master mode for a database.static final String
Attribute name to stop replication slave mode for a database.static final String
This attribute is used to request a database restore from backup.static final String
The attribute that is used to request a roll-forward recovery of the database.static final String
The attribute that is used to request a shutdown.static final String
The SQLJ protocol for getting the default connection for server side jdbcstatic final String
The attribute that is used to set client SSL mode.static final String
Set the territory for the database.static final String
The attribute that is used to allow upgrade.static final String
The attribute that is used to set the user name.
-
Field Details
-
PROTOCOL
Not an attribute but the root for the JDBC URL that Derby supports.- See Also:
-
SQLJ_NESTED
The SQLJ protocol for getting the default connection for server side jdbc- See Also:
-
DNC_PROTOCOL
The protocol for Derby Network Client- See Also:
-
JCC_PROTOCOL
The protocol for the IBM Universal JDBC Driver- See Also:
-
CLIENT_JVM_PROPERTY_PREFIX
User should use this prefix for the client attributes traceLevel and traceDirectory when they are sending those attributes as JVM properties. These 2 attributes can be sent through jdbc url directly (supported way) or as JVM properties with the following prefix (undocumented way). DERBY-1275- See Also:
-
DATA_ENCRYPTION
Attribute name to encrypt the database on disk. If set to true, all user data is stored encrypted on disk.- See Also:
-
BOOT_PASSWORD
If dataEncryption is true, use this attribute to pass in the secret key. The secret key must be at least 8 characters long. This key must not be stored persistently in cleartext anywhere.- See Also:
-
REPLICATION_START_MASTER
Attribute name to start replication master mode for a database. If used, REPLICATION_SLAVE_HOST is a required attribute.- See Also:
-
REPLICATION_STOP_MASTER
Attribute name to stop replication master mode for a database.- See Also:
-
REPLICATION_START_SLAVE
Attribute name to start replication slave mode for a database.- See Also:
-
REPLICATION_STOP_SLAVE
Attribute name to stop replication slave mode for a database.- See Also:
-
REPLICATION_INTERNAL_SHUTDOWN_SLAVE
Attribute name to stop replication slave mode for a database. Internal use only- See Also:
-
REPLICATION_SLAVE_HOST
If startMaster is true, this attribute is used to specify the host name the master should connect to. This is a required attribute.- See Also:
-
REPLICATION_FAILOVER
Attribute name to start failover for a given database..- See Also:
-
REPLICATION_SLAVE_PORT
If startMaster is true, this attribute is used to specify the port the master should connect to. This is an optional attribute.- See Also:
-
DBNAME_ATTR
The attribute that is used for the database name, from the JDBC notion of jdbc:: - See Also:
-
SHUTDOWN_ATTR
The attribute that is used to request a shutdown.- See Also:
-
CREATE_ATTR
The attribute that is used to request a database create.- See Also:
-
USERNAME_ATTR
The attribute that is used to set the user name.- See Also:
-
PASSWORD_ATTR
The attribute that is used to set the user password.- See Also:
-
DRDAID_ATTR
The attribute that is used to set the connection's DRDA ID.- See Also:
-
UPGRADE_ATTR
The attribute that is used to allow upgrade.- See Also:
-
LOG_DEVICE
Put the log on a different device.- See Also:
-
TERRITORY
Set the territory for the database.- See Also:
-
COLLATE
Set the collation sequence of the database, currently on IDENTITY will be supported (strings will sort according to binary comparison).- See Also:
-
CRYPTO_PROVIDER
Attribute for encrypting a database. Specifies the cryptographic services provider.- See Also:
-
CRYPTO_ALGORITHM
Attribute for encrypting a database. Specifies the cryptographic algorithm.- See Also:
-
CRYPTO_KEY_LENGTH
Attribute for encrypting a database. Specifies the key length in bytes for the specified cryptographic algorithm.- See Also:
-
CRYPTO_EXTERNAL_KEY
Attribute for encrypting a database. Specifies the actual key. When this is specified all the supplied crypto information is stored external to the database, ie by the application.- See Also:
-
CREATE_FROM
This attribute is used to request to create a database from backup. This will throw error if a database with same already exists at the location where we tring to create.- See Also:
-
RESTORE_FROM
This attribute is used to request a database restore from backup. It must be used only when the active database is corrupted, because it will cleanup the existing database and replace it from the backup.- See Also:
-
ROLL_FORWARD_RECOVERY_FROM
The attribute that is used to request a roll-forward recovery of the database.- See Also:
-
CLIENT_SECURITY_MECHANISM
securityMechanism sets the mechanism for transmitting the user name and password from the client. Client driver attribute.- See Also:
-
CLIENT_TRACE_FILE
traceFile sets the client side trace file. Client driver attribute.- See Also:
-
CLIENT_TRACE_DIRECTORY
traceDirectory sets the client side trace directory. Client driver attribute.- See Also:
-
CLIENT_TRACE_APPEND
traceFileAppend. Client driver attribute.- See Also:
-
CLIENT_TRACE_LEVEL
traceLevel. Client driver attribute.- See Also:
-
CLIENT_RETIEVE_MESSAGE_TEXT
retrieveMessageText. Client driver attribute.- See Also:
-
SSL_ATTR
The attribute that is used to set client SSL mode.- See Also:
-