WildFly 34 Model Reference

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 (65)

  • 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 runtime
    Access Type read-only
    Stability default
  • 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
    Unit MILLISECONDS
    Storage runtime
    Access Type read-only
    Stability default
  • 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 true
    Storage runtime
    Access Type read-only
    Stability default
  • authentication-context The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type read-only
    Stability default
  • 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
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • capacity-decrementer-class Class defining the policy for decrementing connections in the pool
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • capacity-decrementer-properties Properties to be injected in class defining the policy for decrementing connections in the pool
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • capacity-incrementer-class Class defining the policy for incrementing connections in the pool
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • capacity-incrementer-properties Properties to be injected in class defining the policy for incrementing connections in the pool
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • connectable Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • connection-listener-class Speciefies class name extending org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • connection-listener-property Properties to be injected in class specidied in connection-listener-class
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • connection-url The JDBC driver connection URL
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • credential-reference Credential (from Credential Store) to authenticate on data source
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type read-only
    Stability default
  • datasource-class The fully qualified name of the JDBC datasource class
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • driver-class The fully qualified name of the JDBC driver class
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 a jar, the name is the name of the deployment unit
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • elytron-enabled Enables Elytron security for handling authentication of connections. The Elytron authentication-context to be used will be current context if no context is specified (see authentication-context).
    • Deprecated Since 6.1.0
    Elytron is enabled by default and this field is ignored.
    Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • enabled Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.
    • Deprecated Since 3.0.0
    Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.
    Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • enlistment-trace Defines if WildFly/IronJacamar should record enlistment traces
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • exception-sorter-module The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ExceptionSorter available
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • exception-sorter-properties The exception sorter properties
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • flush-strategy Specifies how the pool should be flush in case of an error.
    • Attribute Value
    Default Value FailingConnectionOnly
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Allowed Values FailingConnectionOnly
    InvalidIdleConnections
    IdleConnections
    Gracefully
    EntirePool
    AllInvalidIdleConnections
    AllIdleConnections
    AllGracefully
    AllConnections
    Stability default
  • 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
    Min 0
    Max 2,147,483,647
    Unit MINUTES
    Storage runtime
    Access Type read-only
    Stability default
  • initial-pool-size The initial-pool-size element indicates the initial number of connections a pool should hold.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • jndi-name Specifies the JNDI name for the datasource
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • jta Enable Jakarta Transactions integration
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • mcp Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool
    • Attribute Value
    Default Value org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • password Specifies the password used when creating a new connection
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • pool-fair Defines if pool use should be fair
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • 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
    Unit SECONDS
    Storage runtime
    Access Type read-only
    Stability default
  • reauth-plugin-class-name The fully qualified class name of the reauthentication plugin implementation
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • reauth-plugin-properties The properties for the reauthentication plugin
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • security-domain Specifies the PicketBox security domain which defines the PicketBox javax.security.auth.Subject that are used to distinguish connections in the pool
    • Deprecated Since 6.1.0
    PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • spy Enable spying of SQL statements
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • stale-connection-checker-module The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.StaleConnectionChecker available
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • stale-connection-checker-properties The stale connection checker properties
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • statistics-enabled Define whether runtime statistics are enabled or not.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Allowed Values true
    false
    nowarn
    Stability default
  • tracking Defines if IronJacamar should track connection handles across transaction boundaries
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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. Different values are used to set customLevel using TransactionIsolation#customLevel
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Allowed Values TRANSACTION_NONE
    TRANSACTION_READ_COMMITTED
    TRANSACTION_READ_UNCOMMITTED
    TRANSACTION_REPEATABLE_READ
    TRANSACTION_SERIALIZABLE
    Stability default
  • url-delimiter Specifies the delimiter for URLs in connection-url for HA datasources
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • use-ccm Enable the use of a cached connection manager
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • user-name Specify the user name used when creating a new connection
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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 runtime
    Access Type read-only
    Stability default
  • valid-connection-checker-module The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ValidConnectionChecker available
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • valid-connection-checker-properties The valid connection checker properties
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default
  • 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
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage runtime
    Access Type read-only
    Stability default

Operations (6)