An RDBMS Extension represents a Datasource to access the RDBMS. RDBMS Extension stores the login details and the parameters required for configuring a connection pool.
The RDBMS Extension component inherits from the Extension
A description of each property follows.
Basic Properties: | Advanced Properties: |
---|---|
↓ enabled | ↓ connection-pool-provider |
↓ jdbc-driver-class | ↓ connection-reuse-count |
↓ jdbc-url | ↓ inactive-connection-timeout |
↓ rdbms-password | ↓ initial-connection-pool-size |
↓ rdbms-username | ↓ java-class |
↓ target-database | ↓ login-timeout |
↓ maximum-connection-pool-size | |
↓ minimum-connection-pool-size |
Description | Indicates whether the Extension is enabled. |
---|---|
Default Value | None |
Allowed Values | true false |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | Specifies the fully-qualified name of the Java class that provides the JDBC driver implementation for the RDBMS vendor. |
---|---|
Default Value | None |
Allowed Values | A String |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | JDBC URL for connecting to the database. |
---|---|
Default Value | None |
Allowed Values | A String |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | The password with which connections have to be obtained. This attribute is used to specify the rdbms password which is used to obtain connections. |
---|---|
Default Value | |
Allowed Values | Unknown |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | The user name with which connections have to be obtained. |
---|---|
Default Value | None |
Allowed Values | A String |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | Specify the Target Database in the backend. |
---|---|
Default Value | No Database specific customizations will be done |
Allowed Values | db2 - DB2 is a family of relational database management system (RDBMS) products from IBM db2mainframe - DB2 mainframe is a consolidated Database from IBM derby - Derby is a relational database management system, can be embedded in Java programs and used for online transaction processing mysql - mysql is a open source relational database management system from Oracle mysql4 - mysql4 is a open source relational database management system from Oracle oracle - Oracle Relational database and it can be any version oracle10g - Oracle 10g is a version of the Oracle Database and the g stands for Grid oracle11 - Oracle 11 is a version of the Oracle Database and the theme for this release is Consolidate Compress Control oracle8i - Oracle 8i is a Oracle Database and i stands for Internet oracle9i - Oracle 9i is a version of the Oracle Database and the i stands for Internet ready postgresql - Postgres is an open source object-relational database management system (ORDBMS) with an emphasis on extensibility and standards compliance sqlserver - Microsoft SQL Server is a relational database management system developed by Microsoft Inc. timesten - TimesTen is an in-memory, relational database management system with persistence and recoverability |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | No |
Read-only | No |
Description | The connection pool implementation to use for this extension. By default we use Universal Connection Pool (UCP). NOTE: In case Simple_Pool is used then the RDBMS Extension cannot be shared across multiple RDBMS WorkflowElements. |
---|---|
Default Value | universal-connection-pool |
Allowed Values | simple-pool - universal-connection-pool - |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | Sets the maximum connection reuse count property. This property specifies the maximum number of times any connection can be reused after which the pool removes and closes a connection. The value must be greater than 0 for this feature to be enabled. For example, if the specified value is 100, then when a connection is reused or borrowed 100 times from the pool, it is closed and removed from the pool. Connections are closed gracefully after they are returned to the pool and the property value has been exceeded. Default is 0, which means this feature is not enabled. |
---|---|
Default Value | 0 |
Allowed Values | An integer value. Lower value is 0. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | Sets the inactive connection timeout. This timeout determines how long an available connection remains in the connection pool before it is removed from the pool. The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0. Setting the value to 0 disables inactive connection timeout processing. |
---|---|
Default Value | 0 |
Allowed Values | An integer value. Lower value is 0. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | The initial number of connections setup by the ConnectionPool. This is the number of connections that will be created and placed in the pool when the pool is started. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 0. |
---|---|
Default Value | 0 |
Allowed Values | An integer value. Lower value is 0. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | Specifies the fully-qualified name of the Java class that provides the RDBMS Extension implementation. |
---|---|
Default Value | com.oracle.dps.server.workflowelement.rdbms.RDBMSExtension |
Allowed Values | A java class that implements or extends the class(es) : org.opends.server.api.Extension |
Multi-valued | No |
Required | Yes |
Admin Action Required | The RDBMS Extension must be disabled and re-enabled for changes to this setting to take effect |
Advanced Property | Yes |
Read-only | No |
Description | Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. |
---|---|
Default Value | 0 |
Allowed Values | An integer value. Lower value is 0. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | The maximum number of connections that can be setup by the connection pool. The maximum number of connections includes the number of connections that are in use as well as the number of available connections. The range of valid values is 1 to Integer.MAX_VALUE. Defaults to 20. |
---|---|
Default Value | 20 |
Allowed Values | An integer value. Lower value is 0. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |
Description | Sets the minimum number of connections set up by the connection pool. If the number of available connections + the number of connections in use is less than the minimum then the connection is returned to the pool. Otherwise, the connection is closed. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 10. |
---|---|
Default Value | 10 |
Allowed Values | An integer value. Lower value is 0. |
Multi-valued | No |
Required | No |
Admin Action Required | None |
Advanced Property | Yes |
Read-only | No |