JDBCStoreMBean

Overview

Defines an instance of the persistent store that stores its persistent records in a JDBC-accessible database. It may be used by JMS and by other subsystems.

Related MBeans

This section describes attributes that provide access to other MBeans.

DataSource

The JDBC data source used by this JDBC store to access its backing table.

The specified data source must use a non-XA JDBC driver since connection pools for XA JDBC drivers are not supported.

Targets

The server instances or migratable targets defined in the current domain that are candidates for hosting the file store.

In a clustered environment, a recommended best practice is to target a custom file store to the same migratable target as the migratable JMS service, so that a member server will not be a single point of failure. A file store can also be configured to automatically migrate from an unhealthy server instance to a healthy server instance with the help of the server health monitoring services.

Attributes

This section describes the following attributes:

CachingDisabled

Private property that disables caching in proxies.

CreateTableDDLFile

Specifies the DDL (Data Definition Language) file to use for creating the JDBC store's backing table.

• This field is ignored when the JDBC store's backing table, WLStore, already exists.

• If a DDL file is not specified and the JDBC store detects that a backing table doesn't already exist, the JDBC store automatically creates the table by executing a preconfigured DDL file that is specific to the database vendor. These preconfigured files are located in the weblogic\store\io\jdbc\ddl directory of the MIDDLEWARE_HOME\modules\com.bea.core.store.jdbc_x.x.x.x.jar file.

• If a DDL file is specified and the JDBC store detects that a backing table doesn't already exist, then the JDBC store searches for the DDL file in the file path first, and then if the file is not found, it searches for it in the CLASSPATH. Once found, the SQL within the DDL file is executed to create the JDBC store's database table. If the DDL file is not found and the backing table doesn't already exist, the JDBC store will fail to boot.

DeletesPerBatchMaximum

The maximum number of table rows that are deleted per database call.

• When possible, a JDBC store uses JDBC 3.0 batching to batch concurrent client requests.

• Both the maximum batch size for concurrent inserts and for concurrent writes are configurable.

• To disable JDBC 3.0 batching, set the maximum batch size to 1.

• The maximum batch size has no effect on the maximum number of concurrent client requests.

For more information, see:

• getInsertsPerBatchMaximum
• getDeletesPerStatementMaximum

DeletesPerStatementMaximum

The maximum number of table rows that are deleted per database call.

• Applies only when a JDBC store does not use JDBC 3.0 batching to batch concurrent client requests.

• The maximum deletes per statement has no effect on the maximum number of concurrent client requests.

• For some databases, the JDBC store may choose a lower value than the one configured.

For more information, see:

• getDeletesPerBatchMaximum
• getInsertsPerBatchMaximum

DeploymentOrder

A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

InsertsPerBatchMaximum

The maximum number of table rows that are inserted per database call.

• When possible, a JDBC store uses JDBC 3.0 batching to batch concurrent client requests.

• Both the maximum batch size for concurrent inserts and for concurrent writes are configurable.

• To disable JDBC 3.0 batching, set the maximum batch size to 1.

• The maximum batch size has no effect on the maximum number of concurrent client requests.

For more information, see:

• getDeletesPerBatchMaximum
• getDeletesPerStatementMaximum

LogicalName

The name used by subsystems to refer to different stores on different servers using the same name.

For example, an EJB that uses the timer service may refer to its store using the logical name, and this name may be valid on multiple servers in the same cluster, even if each server has a store with a different physical name.

Multiple stores in the same domain or the same cluster may share the same logical name. However, a given logical name may not be assigned to more than one store on the same server.

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:
Name=user-specified-name

Notes

Optional information that you can include to describe this configuration.

WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

Parent

Return the immediate parent for this MBean

PrefixName

The prefix for the JDBC store's database table (WLStore), in the following format: [[[catalog.]schema.]prefix].

Each period symbol in the [[catalog.]schema.]prefix format is significant, where schema generally corresponds to username in many databases. When no prefix is specified, the JDBC store table name is simply WLStore and the database implicitly determines the schema according to the JDBC connection's user. As a best practice, you should always configure a prefix for the JDBC WLStore table name.

For specific guidelines about using JDBC store prefixes, refer to the "Using the WebLogic Store" section of Designing and Configuring WebLogic Server Environments".

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

ThreeStepThreshold

Specifies the threshold, in bytes, when the JDBC store uses 3 steps (insert, select, populate) instead of 1 step (insert) to populate an Oracle Blob data type.

Applies only to Oracle databases where a Blob data type is used instead of the default Long Raw data type for record data.

The default value is 200000.

For more information, see:

• Enabling Oracle BLOB Record Columns

Type

Returns the type of the MBean.

WorkerCount

The number of JDBC store worker threads to process the workerload.

• A value of 1 indicates a single thread is used (the default).

• A value greater than 1 indicates that multiple threads are used.

• For Oracle databases, Oracle recommends users rebuild the primary key index into a reverse index for the JDBC Store table when the worker count is greater than 1.

• For non-Oracle databases, refer to the database provider's documentation for help with indexing.

For more information, see:

• Enabling I/O Multithreading for JDBC Stores

WorkerPreferredBatchSize

Specifies the batch size when the Worker Count attribute is configured to a value greater than 1.

Used to configure the workload the JDBC store incrementally puts on each worker thread. The workload consists of IO requests which are grouped and pushed to each JDBC worker thread for processing. If the IO request is very large (for example 1M), then tune this attribute to a smaller value.

For more information, see:

• Enabling I/O Multithreading for JDBC Stores

XAResourceName

Overrides the name of the XAResource that this store registers with JTA.

You should not normally set this attribute. Its purpose is to allow the name of the XAResource to be overridden when a store has been upgraded from an older release and the store contained prepared transactions. The generated name should be used in all other cases.

Operations

This section describes the following operations:

addTarget

Targets a server instance to a store.

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

removeTarget

Untargets a server instance from a store.

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

unSet

Restore the given property to its default value.