Management API Reference for data-source

A JDBC data-source configuration

Children (1)

connection-properties

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.data-source	true	/subsystem=datasources/xa-data-source=*

Attributes (65)

allocation-retry - The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	LONG
Unit	MILLISECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

authentication-context - The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "security-domain", "user-name" ], "capability-reference" : "org.wildfly.security.authentication-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "authentication-client-ref" : {"type" : "core"}, "data-source-security" : {"type" : "datasources"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-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.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

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

Type	LONG
Unit	MILLISECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "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", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

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

Type	LONG
Unit	MILLISECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "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", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

capacity-decrementer-class - Class defining the policy for decrementing connections in the pool

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class defining the policy for decrementing connections in the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

capacity-decrementer-properties - Properties to be injected in class defining the policy for decrementing connections in the pool

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Properties to be injected in class defining the policy for decrementing connections in the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

capacity-incrementer-class - Class defining the policy for incrementing connections in the pool

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class defining the policy for incrementing connections in the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

capacity-incrementer-properties - Properties to be injected in class defining the policy for incrementing connections in the pool

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Properties to be injected in class defining the policy for incrementing connections in the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

connectable - Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

connection-listener-property - Properties to be injected in class specidied in connection-listener-class

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Properties to be injected in class specidied in connection-listener-class", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

connection-url - The JDBC driver connection URL

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The JDBC driver connection URL", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

credential-reference - Credential (from Credential Store) to authenticate on data source

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Credential (from Credential Store) to authenticate on data source", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["password"], "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "data-source-security" : {"type" : "datasources"} }}, "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.credential-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

datasource-class - The fully qualified name of the JDBC datasource class

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The fully qualified name of the JDBC datasource class", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

driver-class - The fully qualified name of the JDBC driver class

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The fully qualified name of the JDBC driver class", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

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.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "Elytron is enabled by default and this field is ignored." }, "access-constraints" : {"sensitive" : {"data-source-security" : {"type" : "datasources"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

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.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "deprecated" : { "since" : "3.0.0", "reason" : "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

enlistment-trace - Defines if WildFly/IronJacamar should record enlistment traces

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if WildFly/IronJacamar should record enlistment traces", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

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

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

exception-sorter-module - The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ExceptionSorter available

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ExceptionSorter available", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

exception-sorter-properties - The exception sorter properties

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The exception sorter properties", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["exception-sorter-class-name"], "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

flush-strategy - Specifies how the pool should be flush in case of an error.

Type	STRING
Default Value	FailingConnectionOnly
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	FailingConnectionOnly InvalidIdleConnections AllGracefully Gracefully AllIdleConnections IdleConnections AllConnections EntirePool AllInvalidIdleConnections
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies how the pool should be flush in case of an error.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "FailingConnectionOnly", "allowed" : [ "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

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.

Type	LONG
Unit	MINUTES
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	0
Max	2147483647
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MINUTES", "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

initial-pool-size - The initial-pool-size element indicates the initial number of connections a pool should hold.

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The initial-pool-size element indicates the initial number of connections a pool should hold.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

jndi-name - Specifies the JNDI name for the datasource

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the JNDI name for the datasource", "expressions-allowed" : true, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

jta - Enable Jakarta Transactions integration

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable Jakarta Transactions integration", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	INT
Default Value	20
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 20, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

mcp - Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool

Type	STRING
Default Value	org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

min-pool-size - The min-pool-size element specifies the minimum number of connections for a pool

Type	INT
Default Value	0
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The min-pool-size element specifies the minimum number of connections for a pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

new-connection-sql - Specifies an SQL statement to execute whenever a connection is added to the connection pool

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies an SQL statement to execute whenever a connection is added to the connection pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

password - Specifies the password used when creating a new connection

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the password used when creating a new connection", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["credential-reference"], "requires" : ["user-name"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "data-source-security" : {"type" : "datasources"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

pool-fair - Defines if pool use should be fair

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if pool use should be fair", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

pool-prefill - Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

pool-use-strict-min - Specifies if the min-pool-size should be considered strictly

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the min-pool-size should be considered strictly", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

prepared-statements-cache-size - The number of prepared statements per connection in an LRU cache

Type	LONG
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of prepared statements per connection in an LRU cache", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

query-timeout - Any configured query timeout in seconds. If not provided no timeout will be set

Type	LONG
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Any configured query timeout in seconds. If not provided no timeout will be set", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "SECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

reauth-plugin-class-name - The fully qualified class name of the reauthentication plugin implementation

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The fully qualified class name of the reauthentication plugin implementation", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

reauth-plugin-properties - The properties for the reauthentication plugin

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The properties for the reauthentication plugin", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["reauth-plugin-class-name"], "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the PicketBox security domain which defines the PicketBox javax.security.auth.Subject that are used to distinguish connections in the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : [ "user-name", "authentication-context" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security" }, "access-constraints" : {"sensitive" : { "security-domain-ref" : {"type" : "core"}, "data-source-security" : {"type" : "datasources"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

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

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

- Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

spy - Enable spying of SQL statements

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable spying of SQL statements", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

stale-connection-checker-module - The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.StaleConnectionChecker available

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.StaleConnectionChecker available", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

stale-connection-checker-properties - The stale connection checker properties

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The stale connection checker properties", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["stale-connection-checker-class-name"], "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

statistics-enabled - Define whether runtime statistics are enabled or not.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Define whether runtime statistics are enabled or not.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	STRING
Default Value	nowarn
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	true false nowarn
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "nowarn", "allowed" : [ "true", "false", "nowarn" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

tracking - Defines if IronJacamar should track connection handles across transaction boundaries

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if IronJacamar should track connection handles across transaction boundaries", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	TRANSACTION_NONE TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED TRANSACTION_SERIALIZABLE TRANSACTION_REPEATABLE_READ
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "TRANSACTION_NONE", "TRANSACTION_READ_COMMITTED", "TRANSACTION_READ_UNCOMMITTED", "TRANSACTION_REPEATABLE_READ", "TRANSACTION_SERIALIZABLE" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

url-delimiter - Specifies the delimiter for URLs in connection-url for HA datasources

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the delimiter for URLs in connection-url for HA datasources", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

url-selector-strategy-class-name - A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

use-ccm - Enable the use of a cached connection manager

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable the use of a cached connection manager", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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)

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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)", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

use-java-context - Setting this to false will bind the datasource into global JNDI

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Setting this to false will bind the datasource into global JNDI", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

use-try-lock - Any configured timeout for internal locks on the resource adapter objects in seconds

Type	LONG
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Any configured timeout for internal locks on the resource adapter objects in seconds", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

user-name - Specify the user name used when creating a new connection

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specify the user name used when creating a new connection", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : [ "security-domain", "authentication-context" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "data-source-security" : {"type" : "datasources"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

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

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

valid-connection-checker-module - The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ValidConnectionChecker available

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ValidConnectionChecker available", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

valid-connection-checker-properties - The valid connection checker properties

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The valid connection checker properties", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["valid-connection-checker-class-name"], "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (10)

add - Add a new data-source

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
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
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
allow-multiple-users	BOOLEAN	false	true	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
authentication-context	STRING	false	false		The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
background-validation	BOOLEAN	false	true		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.
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
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
capacity-decrementer-class	STRING	false	true		Class defining the policy for decrementing connections in the pool
capacity-decrementer-properties	OBJECT	false	true		Properties to be injected in class defining the policy for decrementing connections in the pool
capacity-incrementer-class	STRING	false	true		Class defining the policy for incrementing connections in the pool
capacity-incrementer-properties	OBJECT	false	true		Properties to be injected in class defining the policy for incrementing connections in the pool
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
connectable	BOOLEAN	false	true	false	Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.
connection-listener-class	STRING	false	true		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.
connection-listener-property	OBJECT	false	true		Properties to be injected in class specidied in connection-listener-class
connection-url	STRING	false	true		The JDBC driver connection URL
credential-reference	OBJECT	false	false		Credential (from Credential Store) to authenticate on data source
datasource-class	STRING	false	true		The fully qualified name of the JDBC datasource class
driver-class	STRING	false	true		The fully qualified name of the JDBC driver class
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 a jar, the name is the name of the deployment unit
elytron-enabled	BOOLEAN	false	true	false	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).
enabled	BOOLEAN	false	true	true	Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.
enlistment-trace	BOOLEAN	false	true	false	Defines if WildFly/IronJacamar should record enlistment traces
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
exception-sorter-module	STRING	false	true		The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ExceptionSorter available
exception-sorter-properties	OBJECT	false	true		The exception sorter properties
flush-strategy	STRING	false	true	FailingConnectionOnly	Specifies how the pool should be flush in case of an error.
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.
initial-pool-size	INT	false	true		The initial-pool-size element indicates the initial number of connections a pool should hold.
jndi-name	STRING	true	true		Specifies the JNDI name for the datasource
jta	BOOLEAN	false	true	true	Enable Jakarta Transactions integration
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
mcp	STRING	false	true	org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool	Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool
min-pool-size	INT	false	true	0	The min-pool-size element specifies the minimum number of connections for a pool
new-connection-sql	STRING	false	true		Specifies an SQL statement to execute whenever a connection is added to the connection pool
password	STRING	false	true		Specifies the password used when creating a new connection
pool-fair	BOOLEAN	false	true	true	Defines if pool use should be fair
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.
pool-use-strict-min	BOOLEAN	false	true	false	Specifies if the min-pool-size should be considered strictly
prepared-statements-cache-size	LONG	false	true		The number of prepared statements per connection in an LRU cache
query-timeout	LONG	false	true		Any configured query timeout in seconds. If not provided no timeout will be set
reauth-plugin-class-name	STRING	false	true		The fully qualified class name of the reauthentication plugin implementation
reauth-plugin-properties	OBJECT	false	true		The properties for the reauthentication plugin
security-domain	STRING	false	true		Specifies the PicketBox security domain which defines the PicketBox javax.security.auth.Subject that are used to distinguish connections in the 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
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
spy	BOOLEAN	false	true	false	Enable spying of SQL statements
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
stale-connection-checker-module	STRING	false	true		The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.StaleConnectionChecker available
stale-connection-checker-properties	OBJECT	false	true		The stale connection checker properties
statistics-enabled	BOOLEAN	false	true	false	Define whether runtime statistics are enabled or not.
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
tracking	BOOLEAN	false	true	false	Defines if IronJacamar should track connection handles across transaction boundaries
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. Different values are used to set customLevel using TransactionIsolation#customLevel
url-delimiter	STRING	false	true		Specifies the delimiter for URLs in connection-url for HA datasources
url-selector-strategy-class-name	STRING	false	true		A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy
use-ccm	BOOLEAN	false	true	true	Enable the use of a cached connection manager
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)
use-java-context	BOOLEAN	false	true	true	Setting this to false will bind the datasource into global JNDI
use-try-lock	LONG	false	true		Any configured timeout for internal locks on the resource adapter objects in seconds
user-name	STRING	false	true		Specify the user name used when creating a new connection
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
valid-connection-checker-module	STRING	false	true		The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ValidConnectionChecker available
valid-connection-checker-properties	OBJECT	false	true		The valid connection checker properties
validate-on-match	BOOLEAN	false	true		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

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new data-source",
    "request-properties" : {
        "allocation-retry" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "allocation-retry-wait-millis" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "allow-multiple-users" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "authentication-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : [
                "security-domain",
                "user-name"
            ],
            "capability-reference" : "org.wildfly.security.authentication-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "background-validation" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "background-validation-millis" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "MILLISECONDS",
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "blocking-timeout-wait-millis" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "capacity-decrementer-class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Class defining the policy for decrementing connections in the pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "capacity-decrementer-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Properties to be injected in class defining the policy for decrementing connections in the pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "capacity-incrementer-class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Class defining the policy for incrementing connections in the pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "capacity-incrementer-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Properties to be injected in class defining the policy for incrementing connections in the pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "check-valid-connection-sql" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "connectable" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "connection-listener-class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "connection-listener-property" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Properties to be injected in class specidied in connection-listener-class",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "connection-url" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The JDBC driver connection URL",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "credential-reference" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Credential (from Credential Store) to authenticate on data source",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["password"],
            "stability" : "default",
            "value-type" : {
                "store" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the credential store holding the alias to credential",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "capability-reference" : "org.wildfly.security.credential-store",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "alias" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The alias which denotes stored secret or credential in the store",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "requires" : ["store"],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of credential this reference is denoting",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "clear-text" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "datasource-class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The fully qualified name of the JDBC datasource class",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "driver-class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The fully qualified name of the JDBC driver class",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "driver-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "elytron-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default",
            "deprecated" : {
                "since" : "6.1.0",
                "reason" : "Elytron is enabled by default and this field is ignored."
            }
        },
        "enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default",
            "deprecated" : {
                "since" : "3.0.0",
                "reason" : "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions."
            }
        },
        "enlistment-trace" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Defines if WildFly/IronJacamar should record enlistment traces",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "exception-sorter-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "exception-sorter-module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ExceptionSorter available",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "exception-sorter-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The exception sorter properties",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "requires" : ["exception-sorter-class-name"],
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "flush-strategy" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies how the pool should be flush in case of an error.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "FailingConnectionOnly",
            "allowed" : [
                "FailingConnectionOnly",
                "InvalidIdleConnections",
                "IdleConnections",
                "Gracefully",
                "EntirePool",
                "AllInvalidIdleConnections",
                "AllIdleConnections",
                "AllGracefully",
                "AllConnections"
            ],
            "stability" : "default"
        },
        "idle-timeout-minutes" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "MINUTES",
            "min" : 0,
            "max" : 2147483647,
            "stability" : "default"
        },
        "initial-pool-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The initial-pool-size element indicates the initial number of connections a pool should hold.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "jndi-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the JNDI name for the datasource",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "stability" : "default"
        },
        "jta" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enable Jakarta Transactions integration",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "max-pool-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 20,
            "stability" : "default"
        },
        "mcp" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "min-pool-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The min-pool-size element specifies the minimum number of connections for a pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "stability" : "default"
        },
        "new-connection-sql" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies an SQL statement to execute whenever a connection is added to the connection pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "password" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the password used when creating a new connection",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["credential-reference"],
            "requires" : ["user-name"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "pool-fair" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Defines if pool use should be fair",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "pool-prefill" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "pool-use-strict-min" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Specifies if the min-pool-size should be considered strictly",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "prepared-statements-cache-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The number of prepared statements per connection in an LRU cache",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "query-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Any configured query timeout in seconds. If not provided no timeout will be set",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "SECONDS",
            "stability" : "default"
        },
        "reauth-plugin-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The fully qualified class name of the reauthentication plugin implementation",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "reauth-plugin-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The properties for the reauthentication plugin",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "requires" : ["reauth-plugin-class-name"],
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "security-domain" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the PicketBox security domain which defines the PicketBox javax.security.auth.Subject that are used to distinguish connections in the pool",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : [
                "user-name",
                "authentication-context"
            ],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "6.1.0",
                "reason" : "PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security"
            }
        },
        "set-tx-query-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "share-prepared-statements" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "spy" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enable spying of SQL statements",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "stale-connection-checker-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "stale-connection-checker-module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.StaleConnectionChecker available",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "stale-connection-checker-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The stale connection checker properties",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "requires" : ["stale-connection-checker-class-name"],
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Define whether runtime statistics are enabled or not.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "track-statements" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "nowarn",
            "allowed" : [
                "true",
                "false",
                "nowarn"
            ],
            "stability" : "default"
        },
        "tracking" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Defines if IronJacamar should track connection handles across transaction boundaries",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "transaction-isolation" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "allowed" : [
                "TRANSACTION_NONE",
                "TRANSACTION_READ_COMMITTED",
                "TRANSACTION_READ_UNCOMMITTED",
                "TRANSACTION_REPEATABLE_READ",
                "TRANSACTION_SERIALIZABLE"
            ],
            "stability" : "default"
        },
        "url-delimiter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the delimiter for URLs in connection-url for HA datasources",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "url-selector-strategy-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "use-ccm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enable the use of a cached connection manager",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "use-fast-fail" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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)",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "use-java-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Setting this to false will bind the datasource into global JNDI",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "use-try-lock" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Any configured timeout for internal locks on the resource adapter objects in seconds",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "user-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specify the user name used when creating a new connection",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : [
                "security-domain",
                "authentication-context"
            ],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "valid-connection-checker-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "valid-connection-checker-module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the module which makes the implementation of org.jboss.jca.adapters.jdbc.ValidConnectionChecker available",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "valid-connection-checker-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The valid connection checker properties",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "requires" : ["valid-connection-checker-class-name"],
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "validate-on-match" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

disable - Disable the data-source. Note this operation will not be supported runtime in next versions.

Deprecated Since 3.0.0

Disable the data-source. Note this operation will not be supported runtime in next versions.

Raw DMR model


{
    "operation-name" : "disable",
    "description" : "Disable the data-source. Note this operation will not be supported runtime in next versions.",
    "request-properties" : {},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "3.0.0",
        "reason" : "Disable the data-source. Note this operation will not be supported runtime in next versions."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

dump-queued-threads-in-pool - Dump queued threads in the pool

Raw DMR model


{
    "operation-name" : "dump-queued-threads-in-pool",
    "description" : "Dump queued threads in the pool",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

enable - Enable the data-source. Note this operation will not be supported runtime in next versions.

Deprecated Since 3.0.0

Enable the data-source. Note this operation will not be supported runtime in next versions.

Raw DMR model


{
    "operation-name" : "enable",
    "description" : "Enable the data-source. Note this operation will not be supported runtime in next versions.",
    "request-properties" : {},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "3.0.0",
        "reason" : "Enable the data-source. Note this operation will not be supported runtime in next versions."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

flush-all-connection-in-pool - Flushes all connections in the pool

Raw DMR model


{
    "operation-name" : "flush-all-connection-in-pool",
    "description" : "Flushes all connections in the pool",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

flush-gracefully-connection-in-pool - Flushes all connections gracefully in the pool

Raw DMR model


{
    "operation-name" : "flush-gracefully-connection-in-pool",
    "description" : "Flushes all connections gracefully in the pool",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

flush-idle-connection-in-pool - Flushes all idle connections in the pool

Raw DMR model


{
    "operation-name" : "flush-idle-connection-in-pool",
    "description" : "Flushes all idle connections in the pool",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

flush-invalid-connection-in-pool - Flushes all invalid connections in the pool

Raw DMR model


{
    "operation-name" : "flush-invalid-connection-in-pool",
    "description" : "Flushes all invalid connections in the pool",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

remove - Remove the data-source

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the data-source",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

test-connection-in-pool - Test if a connection can be obtained

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
user-name	STRING	false	true		User name to authenticate connection
password	STRING	false	true		Password to authenticate connection

Raw DMR model


{
    "operation-name" : "test-connection-in-pool",
    "description" : "Test if a connection can be obtained",
    "request-properties" : {
        "user-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "User name to authenticate connection",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : [
                "security-domain",
                "authentication-context"
            ],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "password" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Password to authenticate connection",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["credential-reference"],
            "requires" : ["user-name"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.datasources.data-source

        
<feature spec="subsystem.datasources.data-source">
  <param name="data-source" value="{resource name}"/>
  <param name="allocation-retry" value="{value}"/>
  <param name="allocation-retry-wait-millis" value="{value}"/>
  <param name="allow-multiple-users" value="{value}"/>
  <param name="authentication-context" value="{value}"/>
  <param name="background-validation" value="{value}"/>
  <param name="background-validation-millis" value="{value}"/>
  <param name="blocking-timeout-wait-millis" value="{value}"/>
  <param name="capacity-decrementer-class" value="{value}"/>
  <param name="capacity-decrementer-properties" value="{value}"/>
  <param name="capacity-incrementer-class" value="{value}"/>
  <param name="capacity-incrementer-properties" value="{value}"/>
  <param name="check-valid-connection-sql" value="{value}"/>
  <param name="connectable" value="{value}"/>
  <param name="connection-listener-class" value="{value}"/>
  <param name="connection-listener-property" value="{value}"/>
  <param name="connection-url" value="{value}"/>
  <param name="credential-reference" value="{value}"/>
  <param name="datasource-class" value="{value}"/>
  <param name="driver-class" value="{value}"/>
  <param name="driver-name" value="{value}"/>
  <param name="elytron-enabled" value="{value}"/>
  <param name="enabled" value="{value}"/>
  <param name="enlistment-trace" value="{value}"/>
  <param name="exception-sorter-class-name" value="{value}"/>
  <param name="exception-sorter-module" value="{value}"/>
  <param name="exception-sorter-properties" value="{value}"/>
  <param name="flush-strategy" value="{value}"/>
  <param name="idle-timeout-minutes" value="{value}"/>
  <param name="initial-pool-size" value="{value}"/>
  <param name="jndi-name" value="{value}"/>
  <param name="jta" value="{value}"/>
  <param name="max-pool-size" value="{value}"/>
  <param name="mcp" value="{value}"/>
  <param name="min-pool-size" value="{value}"/>
  <param name="new-connection-sql" value="{value}"/>
  <param name="password" value="{value}"/>
  <param name="pool-fair" value="{value}"/>
  <param name="pool-prefill" value="{value}"/>
  <param name="pool-use-strict-min" value="{value}"/>
  <param name="prepared-statements-cache-size" value="{value}"/>
  <param name="query-timeout" value="{value}"/>
  <param name="reauth-plugin-class-name" value="{value}"/>
  <param name="reauth-plugin-properties" value="{value}"/>
  <param name="security-domain" value="{value}"/>
  <param name="set-tx-query-timeout" value="{value}"/>
  <param name="share-prepared-statements" value="{value}"/>
  <param name="spy" value="{value}"/>
  <param name="stale-connection-checker-class-name" value="{value}"/>
  <param name="stale-connection-checker-module" value="{value}"/>
  <param name="stale-connection-checker-properties" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
  <param name="track-statements" value="{value}"/>
  <param name="tracking" value="{value}"/>
  <param name="transaction-isolation" value="{value}"/>
  <param name="url-delimiter" value="{value}"/>
  <param name="url-selector-strategy-class-name" value="{value}"/>
  <param name="use-ccm" value="{value}"/>
  <param name="use-fast-fail" value="{value}"/>
  <param name="use-java-context" value="{value}"/>
  <param name="use-try-lock" value="{value}"/>
  <param name="user-name" value="{value}"/>
  <param name="valid-connection-checker-class-name" value="{value}"/>
  <param name="valid-connection-checker-module" value="{value}"/>
  <param name="valid-connection-checker-properties" value="{value}"/>
  <param name="validate-on-match" value="{value}"/>
<feature/>