Database Store (databaseStore)

Specifies a relational database as a persistent store for server features.

NameTypeDefaultDescription

authDataRef

A reference to top level authData element (string).

Authentication data for task scheduling, queries, and execution.

createTables

boolean

true

When set to true, database tables are created.

dataSourceRef

A reference to top level dataSource element (string).

DefaultDataSource

Data source that connects to the persistent store.

id

string

A unique configuration ID.

keyGenerationStrategy

  • AUTO

  • IDENTITY

  • SEQUENCE

  • TABLE

AUTO

The preferred strategy for generating unique primary keys. If the selected strategy is not supported for the database, a different strategy might be used.
AUTO
Automatically select the strategy to generate unique primary keys.
IDENTITY
Use a database identity column to generate unique primary keys.
SEQUENCE
Use a database sequence to generate unique primary keys.
TABLE
Use a database table to generate unique primary keys.

schema

string

Schema name with read and write access to the database tables.

tablePrefix

string

WLP

Name prefix for tables, sequences, and other database artifacts.

databaseStore > authData

Authentication data for task scheduling, queries, and execution.

NameTypeDefaultDescription

krb5Principal

string

The name of the Kerberos principal name or Kerberos service name to be used.

krb5TicketCache

Path to a file

The file location where Kerberos credentials for the Kerberos principal name or service name will be stored. Also known as the Kerberos credential cache (ccache)

password

Reversably encoded password (string)

Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

user

string

Name of the user to use when connecting to the EIS.

databaseStore > dataSource

Data source that connects to the persistent store.

NameTypeDefaultDescription

connectionManagerRef

A reference to top level connectionManager element (string).

Connection manager for a data source. If updated while the server is running, existing connections are destroyed.

connectionSharing

  • MatchCurrentState

  • MatchOriginalRequest

MatchOriginalRequest

Specifies how connections are matched for sharing.
MatchCurrentState
When sharing connections, match based on the current state of the connection. If updated while the server is running, the update is applied with each first connection handle in a transaction.
MatchOriginalRequest
When sharing connections, match based on the original connection request.

containerAuthDataRef

A reference to top level authData element (string).

Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. If updated while the server is running, the change is applied with new connection requests; in-use connections are not impacted.

isolationLevel

  • TRANSACTION_NONE

  • TRANSACTION_READ_COMMITTED

  • TRANSACTION_READ_UNCOMMITTED

  • TRANSACTION_REPEATABLE_READ

  • TRANSACTION_SERIALIZABLE

  • TRANSACTION_SNAPSHOT

Default transaction isolation level. If unspecified and the database is identified as DB2, Derby, Informix, Microsoft SQL Server or Sybase, TRANSACTION_REPEATABLE_READ is used. If unspecified for other databases, TRANSACTION_READ_COMMITTED is used. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.
TRANSACTION_NONE
Indicates that the JDBC driver does not support transactions.
TRANSACTION_READ_COMMITTED
Dirty reads are prevented; non-repeatable reads and phantom reads can occur.
TRANSACTION_READ_UNCOMMITTED
Dirty reads, non-repeatable reads and phantom reads can occur.
TRANSACTION_REPEATABLE_READ
Dirty reads and non-repeatable reads are prevented; phantom reads can occur.
TRANSACTION_SERIALIZABLE
Dirty reads, non-repeatable reads and phantom reads are prevented.
TRANSACTION_SNAPSHOT
Snapshot isolation for Microsoft SQL Server JDBC Driver and DataDirect Connect for JDBC driver.

jaasLoginContextEntryRef

A reference to top level jaasLoginContextEntry element (string).

JAAS login context entry for authentication. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.

jdbcDriverRef

A reference to top level jdbcDriver element (string).

JDBC driver for a data source. If updated while the server is running, existing connections are destroyed.

jndiName

string

JNDI name for a data source. If updated while the server is running, existing connections are destroyed.

statementCacheSize

int
Min: 0

10

Maximum number of cached statements per connection. If updated while the server is running, the statement cache is resized upon next use. To set this option, complete the following prerequisites: Review either the application code or an SQL trace that you gather from the database or database driver for all unique prepared statements. Ensure that the cache size is larger than the number of statements.

transactional

boolean

true

Enable participation in transactions that are managed by the application server. If updated while the server is running, existing connections are destroyed.

type

  • java.sql.Driver

  • javax.sql.ConnectionPoolDataSource

  • javax.sql.DataSource

  • javax.sql.XADataSource

Type of data source. If updated while the server is running, existing connections are destroyed.

Advanced Properties

beginTranForResultSetScrollingAPIs

boolean

true

Attempt transaction enlistment when result set scrolling interfaces are used.

beginTranForVendorAPIs

boolean

true

Attempt transaction enlistment when vendor interfaces are used.

commitOrRollbackOnCleanup

  • commit

  • rollback

Determines how to clean up connections that might be in a database unit of work (AutoCommit=false) when the connection is closed or returned to the pool.
commit
Clean up the connection by committing.
rollback
Clean up the connection by rolling back.

enableConnectionCasting

boolean

false

Indicates that connections obtained from the data source should be castable to interface classes that the JDBC vendor connection implementation implements. Enabling this option incurs additional overhead on each getConnection operation. If vendor JDBC interfaces are needed less frequently, it might be more efficient to leave this option disabled and use Connection.unwrap(interface) only where it is needed. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.

onConnect

string

SQL command to execute once on each new connection that is established to the database. The SQL statement applies only to newly created connections, not to existing connections that are reused from the connection pool. If updated while the server is running, existing connections are destroyed.

queryTimeout

A period of time with second precision

Default query timeout for SQL statements. In a JTA transaction, syncQueryTimeoutWithTransactionTimeout can override this default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

recoveryAuthDataRef

A reference to top level authData element (string).

Authentication data for transaction recovery.

supplementalJDBCTrace

boolean

Supplements the JDBC driver trace that is logged when JDBC driver trace is enabled in bootstrap.properties. JDBC driver trace specifications include: com.ibm.ws.database.logwriter, com.ibm.ws.db2.logwriter, com.ibm.ws.derby.logwriter, com.ibm.ws.informix.logwriter, com.ibm.ws.oracle.logwriter, com.ibm.ws.sqlserver.logwriter, com.ibm.ws.sybase.logwriter. If updated while the server is running, existing connections are destroyed.

syncQueryTimeoutWithTransactionTimeout

boolean

false

Use the time remaining (if any) in a JTA transaction as the default query timeout for SQL statements.

validationTimeout

A period of time with second precision

When specified, pooled connections are validated before being reused from the connection pool. The validation timeout is also used when the connection manager validates connections in response to a stale connection for PurgePolicy=ValidateAllConnections. The full amount of the validation timeout applies to each connection that is validated, which is done via the Connection.isValid(timeout) JDBC API operation. A value of 0 means that connections are validated without applying any timeout. Validation timeout requires a JDBC driver that complies with the JDBC 4.0 specification or higher. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

Expand
databaseStore > dataSource > connectionManager

Connection manager for a data source. If updated while the server is running, existing connections are destroyed.

Expand
databaseStore > dataSource > containerAuthData

Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER. If updated while the server is running, the change is applied with new connection requests; in-use connections are not impacted.

Expand
databaseStore > dataSource > identifyException

Identify a specific SQL error code or SQL state on a SQLException. This enables the server to take appropriate action based on the error condition. For example, closing a stale connection instead of returning it to the connection pool.

Expand
databaseStore > dataSource > jaasLoginContextEntry

JAAS login context entry for authentication. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.

Expand
databaseStore > dataSource > jdbcDriver

JDBC driver for a data source. If updated while the server is running, existing connections are destroyed.

Expand
databaseStore > dataSource > jdbcDriver > library

Expand
databaseStore > dataSource > jdbcDriver > library > file

Expand
databaseStore > dataSource > jdbcDriver > library > fileset

Expand
databaseStore > dataSource > jdbcDriver > library > folder

Expand
databaseStore > dataSource > properties

List of JDBC vendor properties for the data source. For example, databaseName="dbname" serverName="localhost" portNumber="50000". Use this generic properties list when no vendor-specific properties list type is available for your JDBC driver. Do not specify multiple properties elements under a data source. Instead, place all property name-value pairs on a single properties or properties.{JDBC_VENDOR_TYPE} element.

Expand
databaseStore > dataSource > properties.datadirect.sqlserver

Data source properties for the DataDirect Connect for JDBC driver for Microsoft SQL Server.

Expand
databaseStore > dataSource > properties.db2.i.native

Data source properties for the IBM DB2 for i Native JDBC driver.

Expand
databaseStore > dataSource > properties.db2.i.toolbox

Data source properties for the IBM DB2 for i Toolbox JDBC driver.

Expand
databaseStore > dataSource > properties.db2.jcc

Data source properties for the IBM Data Server Driver for JDBC and SQLJ for DB2.

Expand
databaseStore > dataSource > properties.derby.client

Data source properties for Derby Network Client JDBC driver.

Expand
databaseStore > dataSource > properties.derby.embedded

Data source properties for Derby Embedded JDBC driver.

Expand
databaseStore > dataSource > properties.informix

Data source properties for the Informix JDBC driver.

Expand
databaseStore > dataSource > properties.informix.jcc

Data source properties for the IBM Data Server Driver for JDBC and SQLJ for Informix.

Expand
databaseStore > dataSource > properties.microsoft.sqlserver

Data source properties for Microsoft SQL Server JDBC Driver.

Expand
databaseStore > dataSource > properties.oracle

Data source properties for Oracle JDBC driver.

Expand
databaseStore > dataSource > properties.oracle.ucp

Data source properties for Oracle Universal Connection Pooling.

Expand
databaseStore > dataSource > properties.postgresql

Data source properties for PostgreSQL JDBC driver.

Expand
databaseStore > dataSource > properties.sybase

Data source properties for Sybase JDBC driver.

Expand
databaseStore > dataSource > recoveryAuthData

Authentication data for transaction recovery.