JBoss EAP 6.1 Model Reference

  1. JBoss EAP 6.1
  2. subsystem=datasources
  3. data-source

A JDBC data-source configuration

Children (1)

  • connection-properties The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method

Attributes (46)

  • allocation-retry The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • allocation-retry-wait-millis The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • allow-multiple-users Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • background-validation An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • background-validation-millis The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Min 1
    Max 2,147,483,647
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • blocking-timeout-wait-millis The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • check-valid-connection-sql Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • connection-url The JDBC driver connection URL
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • datasource-class The fully qualified name of the JDBC datasource class
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • driver-class The fully qualified name of the JDBC driver class
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • driver-name Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • enabled Specifies if the datasource should be enabled
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • exception-sorter-class-name An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • exception-sorter-properties The exception sorter properties
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • flush-strategy Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool
    • Attribute Value
    Default Value FailingConnectionOnly
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values UNKNOWN
    FailingConnectionOnly
    IdleConnections
    EntirePool
  • idle-timeout-minutes The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MINUTES
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • jndi-name Specifies the JNDI name for the datasource
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • jta Enable JTA integration
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • max-pool-size The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool
    • Attribute Value
    Default Value 20
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • min-pool-size The min-pool-size element specifies the minimum number of connections for a pool
    • Attribute Value
    Default Value 0
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • new-connection-sql Specifies an SQL statement to execute whenever a connection is added to the connection pool
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • password Specifies the password used when creating a new connection
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • pool-prefill Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • pool-use-strict-min Specifies if the min-pool-size should be considered strictly
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • prepared-statements-cache-size The number of prepared statements per connection in an LRU cache
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • query-timeout Any configured query timeout in seconds. If not provided no timeout will be set
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • reauth-plugin-class-name The fully qualified class name of the reauthentication plugin implementation
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • reauth-plugin-properties The properties for the reauthentication plugin
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • security-domain Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • set-tx-query-timeout Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • share-prepared-statements Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • spy Enable spying of SQL statements
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • stale-connection-checker-class-name An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • stale-connection-checker-properties The stale connection checker properties
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • track-statements Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed
    • Attribute Value
    Default Value NOWARN
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • transaction-isolation Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • url-delimiter Specifies the delimiter for URLs in connection-url for HA datasources
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • url-selector-strategy-class-name A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • use-ccm Enable the use of a cached connection manager
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • use-fast-fail Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • use-java-context Setting this to false will bind the datasource into global JNDI
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • use-try-lock Any configured timeout for internal locks on the resource adapter objects in seconds
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • user-name Specify the user name used when creating a new connection
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • valid-connection-checker-class-name An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • valid-connection-checker-properties The valid connection checker properties
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • validate-on-match The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services

Operations (4)

  • add Add a new data-source
    Request Parameter Type Required Expressions Allowed Default value Description
    share-prepared-statements BOOLEAN false true false Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement
    driver-class STRING false true The fully qualified name of the JDBC driver class
    prepared-statements-cache-size LONG false true The number of prepared statements per connection in an LRU cache
    spy BOOLEAN false true false Enable spying of SQL statements
    password STRING false true Specifies the password used when creating a new connection
    max-pool-size INT false true 20 The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool
    set-tx-query-timeout BOOLEAN false true false Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction
    jndi-name STRING true true Specifies the JNDI name for the datasource
    url-delimiter STRING false true Specifies the delimiter for URLs in connection-url for HA datasources
    enabled BOOLEAN false false false Specifies if the datasource should be enabled
    blocking-timeout-wait-millis LONG false true The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time
    pool-use-strict-min BOOLEAN false true false Specifies if the min-pool-size should be considered strictly
    validate-on-match BOOLEAN false true false The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation
    transaction-isolation STRING false true Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE
    jta BOOLEAN false true true Enable JTA integration
    valid-connection-checker-class-name STRING false true An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element
    allocation-retry-wait-millis LONG false true The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection
    exception-sorter-properties OBJECT false true The exception sorter properties
    background-validation-millis LONG false true The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise
    track-statements STRING false true NOWARN Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed
    use-fast-fail BOOLEAN false true false Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)
    flush-strategy STRING false true FailingConnectionOnly Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool
    stale-connection-checker-class-name STRING false true An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
    exception-sorter-class-name STRING false true An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error
    background-validation BOOLEAN false true false An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
    check-valid-connection-sql STRING false true Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool
    reauth-plugin-class-name STRING false true The fully qualified class name of the reauthentication plugin implementation
    allow-multiple-users BOOLEAN false false false Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that
    url-selector-strategy-class-name STRING false true A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy
    user-name STRING false true Specify the user name used when creating a new connection
    use-ccm BOOLEAN false true true Enable the use of a cached connection manager
    reauth-plugin-properties OBJECT false true The properties for the reauthentication plugin
    driver-name STRING true true Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit
    stale-connection-checker-properties OBJECT false true The stale connection checker properties
    datasource-class STRING false true The fully qualified name of the JDBC datasource class
    idle-timeout-minutes LONG false true The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
    query-timeout LONG false true Any configured query timeout in seconds. If not provided no timeout will be set
    use-java-context BOOLEAN false true true Setting this to false will bind the datasource into global JNDI
    valid-connection-checker-properties OBJECT false true The valid connection checker properties
    min-pool-size INT false true 0 The min-pool-size element specifies the minimum number of connections for a pool
    allocation-retry INT false true The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception
    security-domain STRING false true Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool
    new-connection-sql STRING false true Specifies an SQL statement to execute whenever a connection is added to the connection pool
    connection-url STRING true true The JDBC driver connection URL
    use-try-lock LONG false true Any configured timeout for internal locks on the resource adapter objects in seconds
    pool-prefill BOOLEAN false true false Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
  • disable Disable the data-source
  • enable Enable the data-source
    Request Parameter Type Required Expressions Allowed Default value Description
    persistent BOOLEAN true false true if true enable attribute is persisted
  • remove Remove the data-source