Skip to content

Instantly share code, notes, and snippets.

@maeste

maeste/ExampleDS

Created December 15, 2011 21:00
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save maeste/1482849 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save maeste/1482849 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
datasource=*
[standalone@localhost:9999 /] /subsystem=datasources/data-source=*:read-resource-description
{
"address" => [
("subsystem" => "datasources"),
("data-source" => "*")
],
"outcome" => "success",
"result" => {
"description" => "A JDBC data-source configuration",
"head-comment-allowed" => true,
"tail-comment-allowed" => true,
"attributes" => {
"connection-url" => {
"description" => "The JDBC driver connection URL",
"type" => STRING,
"required" => true,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"driver-class" => {
"description" => "The fully qualifed name of the JDBC driver class",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"datasource-class" => {
"description" => "The fully qualifed name of the JDBC datasource class",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"jndi-name" => {
"description" => "Specifies the JNDI name for the datasource",
"type" => STRING,
"required" => true,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"driver-name" => {
"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 jar, the name is the name of deployment unit",
"type" => STRING,
"required" => true,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"new-connection-sql" => {
"description" => "Specifies an SQL statement to execute whenever a connection is added to the connection pool",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"url-delimiter" => {
"description" => "Specifies the delimeter for URLs in connection-url for HA datasources",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"url-selector-strategy-class-name" => {
"description" => "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"use-java-context" => {
"description" => "Setting this to false will bind the datasource into global JNDI",
"type" => BOOLEAN,
"required" => false,
"default" => "true",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"jta" => {
"description" => "Enable JTA integration",
"type" => BOOLEAN,
"required" => false,
"default" => "true",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"max-pool-size" => {
"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",
"type" => INT,
"required" => false,
"default" => "20",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"min-pool-size" => {
"description" => "The min-pool-size element specifies the minimum number of connections for a pool",
"type" => INT,
"required" => false,
"default" => "0",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"pool-prefill" => {
"description" => "Should the pool be prefilled. Changing this value requires a server restart",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"pool-use-strict-min" => {
"description" => "Specifies if the min-pool-size should be considered strictly",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"user-name" => {
"description" => "Specify the user name used when creating a new connection",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"password" => {
"description" => "Specifies the password used when creating a new connection",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"security-domain" => {
"description" => "Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"reauth-plugin-class-name" => {
"description" => "The fully qualified class name of the reauthentication plugin implementation",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"reauth-plugin-properties" => {
"description" => "The properties for the reauthentication plugin",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"flush-strategy" => {
"description" => "Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool",
"type" => STRING,
"required" => false,
"default" => "\"FailingConnectionOnly\"",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"prepared-statements-cache-size" => {
"description" => "The number of prepared statements per connection in an LRU cache",
"type" => LONG,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"share-prepared-statements" => {
"description" => "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"track-statements" => {
"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",
"type" => STRING,
"required" => false,
"default" => "\"NOWARN\"",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"allocation-retry" => {
"description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception",
"type" => INT,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"allocation-retry-wait-millis" => {
"description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection",
"type" => LONG,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"blocking-timeout-wait-millis" => {
"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",
"type" => LONG,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"idle-timeout-minutes" => {
"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 requires a server restart.",
"type" => LONG,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"query-timeout" => {
"description" => "Any configured query timeout in seconds. If not provided no timeout will be set",
"type" => LONG,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"use-try-lock" => {
"description" => "Any configured timeout for internal locks on the resource adapter objects in seconds",
"type" => LONG,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"set-tx-query-timeout" => {
"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",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"transaction-isolation" => {
"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",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"check-valid-connection-sql" => {
"description" => "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,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"exception-sorter-class-name" => {
"description" => "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"exception-sorter-properties" => {
"description" => "The exception sorter properties",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"stale-connection-checker-class-name" => {
"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",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"stale-connection-checker-properties" => {
"description" => "The stale connection checker properties",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"valid-connection-checker-class-name" => {
"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",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"valid-connection-checker-properties" => {
"description" => "The valid connection checker properties",
"type" => STRING,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"background-validation-millis" => {
"description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart",
"type" => LONG,
"required" => false,
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"background-validation" => {
"description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"use-fast-fail" => {
"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)",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"validate-on-match" => {
"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",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"spy" => {
"description" => "Enable spying of SQL statements",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"use-ccm" => {
"description" => "Enable the use of a cached connection manager",
"type" => BOOLEAN,
"required" => false,
"default" => "true",
"access-type" => "read-write",
"storage" => "configuration",
"restart-required" => "no-services"
},
"enabled" => {
"description" => "Specifies if the datasource should be enabled",
"type" => BOOLEAN,
"access-type" => "read-only",
"storage" => "configuration"
}
},
"children" => {"connection-properties" => {"description" => "The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method"}}
}
}
]
}
Raw
ExampleDS
[standalone@localhost:9999 /] /subsystem=datasources/data-source=ExampleDS:read-resource-description
{
"outcome" => "success",
"result" => {
"description" => "A JDBC data-source configuration",
"head-comment-allowed" => true,
"tail-comment-allowed" => true,
"attributes" => {
"connection-url" => {
"description" => "The JDBC driver connection URL",
"type" => STRING,
"required" => true,
"access-type" => "read-only",
"storage" => "configuration"
},
"driver-class" => {
"description" => "The fully qualifed name of the JDBC driver class",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"datasource-class" => {
"description" => "The fully qualifed name of the JDBC datasource class",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"jndi-name" => {
"description" => "Specifies the JNDI name for the datasource",
"type" => STRING,
"required" => true,
"access-type" => "read-only",
"storage" => "configuration"
},
"driver-name" => {
"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 jar, the name is the name of deployment unit",
"type" => STRING,
"required" => true,
"access-type" => "read-only",
"storage" => "configuration"
},
"new-connection-sql" => {
"description" => "Specifies an SQL statement to execute whenever a connection is added to the connection pool",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"url-delimiter" => {
"description" => "Specifies the delimeter for URLs in connection-url for HA datasources",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"url-selector-strategy-class-name" => {
"description" => "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"use-java-context" => {
"description" => "Setting this to false will bind the datasource into global JNDI",
"type" => BOOLEAN,
"required" => false,
"default" => "true",
"access-type" => "read-only",
"storage" => "configuration"
},
"jta" => {
"description" => "Enable JTA integration",
"type" => BOOLEAN,
"required" => false,
"default" => "true",
"access-type" => "read-only",
"storage" => "configuration"
},
"max-pool-size" => {
"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",
"type" => INT,
"required" => false,
"default" => "20",
"access-type" => "read-only",
"storage" => "configuration"
},
"min-pool-size" => {
"description" => "The min-pool-size element specifies the minimum number of connections for a pool",
"type" => INT,
"required" => false,
"default" => "0",
"access-type" => "read-only",
"storage" => "configuration"
},
"pool-prefill" => {
"description" => "Should the pool be prefilled. Changing this value requires a server restart",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"pool-use-strict-min" => {
"description" => "Specifies if the min-pool-size should be considered strictly",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"user-name" => {
"description" => "Specify the user name used when creating a new connection",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"password" => {
"description" => "Specifies the password used when creating a new connection",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"security-domain" => {
"description" => "Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"reauth-plugin-class-name" => {
"description" => "The fully qualified class name of the reauthentication plugin implementation",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"reauth-plugin-properties" => {
"description" => "The properties for the reauthentication plugin",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"flush-strategy" => {
"description" => "Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool",
"type" => STRING,
"required" => false,
"default" => "\"FailingConnectionOnly\"",
"access-type" => "read-only",
"storage" => "configuration"
},
"prepared-statements-cache-size" => {
"description" => "The number of prepared statements per connection in an LRU cache",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"share-prepared-statements" => {
"description" => "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"track-statements" => {
"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",
"type" => STRING,
"required" => false,
"default" => "\"NOWARN\"",
"access-type" => "read-only",
"storage" => "configuration"
},
"allocation-retry" => {
"description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception",
"type" => INT,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"allocation-retry-wait-millis" => {
"description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"blocking-timeout-wait-millis" => {
"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",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"idle-timeout-minutes" => {
"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 requires a server restart.",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"query-timeout" => {
"description" => "Any configured query timeout in seconds. If not provided no timeout will be set",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"use-try-lock" => {
"description" => "Any configured timeout for internal locks on the resource adapter objects in seconds",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"set-tx-query-timeout" => {
"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",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"transaction-isolation" => {
"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",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"check-valid-connection-sql" => {
"description" => "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,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"exception-sorter-class-name" => {
"description" => "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"exception-sorter-properties" => {
"description" => "The exception sorter properties",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"stale-connection-checker-class-name" => {
"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",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"stale-connection-checker-properties" => {
"description" => "The stale connection checker properties",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"valid-connection-checker-class-name" => {
"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",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"valid-connection-checker-properties" => {
"description" => "The valid connection checker properties",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"background-validation-millis" => {
"description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"background-validation" => {
"description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"use-fast-fail" => {
"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)",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"validate-on-match" => {
"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",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"spy" => {
"description" => "Enable spying of SQL statements",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"use-ccm" => {
"description" => "Enable the use of a cached connection manager",
"type" => BOOLEAN,
"required" => false,
"default" => "true",
"access-type" => "read-only",
"storage" => "configuration"
},
"enabled" => {
"description" => "Specifies if the datasource should be enabled",
"type" => BOOLEAN,
"access-type" => "read-only",
"storage" => "configuration"
},
"statistics" => {
"description" => "Runtime statistics provided by the resource adapter.",
"access-type" => "read-only",
"storage" => "configuration"
}
},
"children" => {"connection-properties" => {"description" => "The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method"}}
}
}
Raw
gistfile1.txt
[standalone@localhost:9999 /] /subsystem=datasources/data-source=ExampleDS:read-resource-description
{
"outcome" => "success",
"result" => {
"description" => "A JDBC data-source configuration",
"head-comment-allowed" => true,
"tail-comment-allowed" => true,
"attributes" => {
"connection-url" => {
"description" => "The JDBC driver connection URL",
"type" => STRING,
"required" => true,
"access-type" => "read-only",
"storage" => "configuration"
},
"driver-class" => {
"description" => "The fully qualifed name of the JDBC driver class",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"datasource-class" => {
"description" => "The fully qualifed name of the JDBC datasource class",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"jndi-name" => {
"description" => "Specifies the JNDI name for the datasource",
"type" => STRING,
"required" => true,
"access-type" => "read-only",
"storage" => "configuration"
},
"driver-name" => {
"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 jar, the name is the name of deployment unit",
"type" => STRING,
"required" => true,
"access-type" => "read-only",
"storage" => "configuration"
},
"new-connection-sql" => {
"description" => "Specifies an SQL statement to execute whenever a connection is added to the connection pool",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"url-delimiter" => {
"description" => "Specifies the delimeter for URLs in connection-url for HA datasources",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"url-selector-strategy-class-name" => {
"description" => "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"use-java-context" => {
"description" => "Setting this to false will bind the datasource into global JNDI",
"type" => BOOLEAN,
"required" => false,
"default" => "true",
"access-type" => "read-only",
"storage" => "configuration"
},
"jta" => {
"description" => "Enable JTA integration",
"type" => BOOLEAN,
"required" => false,
"default" => "true",
"access-type" => "read-only",
"storage" => "configuration"
},
"max-pool-size" => {
"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",
"type" => INT,
"required" => false,
"default" => "20",
"access-type" => "read-only",
"storage" => "configuration"
},
"min-pool-size" => {
"description" => "The min-pool-size element specifies the minimum number of connections for a pool",
"type" => INT,
"required" => false,
"default" => "0",
"access-type" => "read-only",
"storage" => "configuration"
},
"pool-prefill" => {
"description" => "Should the pool be prefilled. Changing this value requires a server restart",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"pool-use-strict-min" => {
"description" => "Specifies if the min-pool-size should be considered strictly",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"user-name" => {
"description" => "Specify the user name used when creating a new connection",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"password" => {
"description" => "Specifies the password used when creating a new connection",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"security-domain" => {
"description" => "Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"reauth-plugin-class-name" => {
"description" => "The fully qualified class name of the reauthentication plugin implementation",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"reauth-plugin-properties" => {
"description" => "The properties for the reauthentication plugin",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"flush-strategy" => {
"description" => "Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool",
"type" => STRING,
"required" => false,
"default" => "\"FailingConnectionOnly\"",
"access-type" => "read-only",
"storage" => "configuration"
},
"prepared-statements-cache-size" => {
"description" => "The number of prepared statements per connection in an LRU cache",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"share-prepared-statements" => {
"description" => "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"track-statements" => {
"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",
"type" => STRING,
"required" => false,
"default" => "\"NOWARN\"",
"access-type" => "read-only",
"storage" => "configuration"
},
"allocation-retry" => {
"description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception",
"type" => INT,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"allocation-retry-wait-millis" => {
"description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"blocking-timeout-wait-millis" => {
"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",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"idle-timeout-minutes" => {
"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 requires a server restart.",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"query-timeout" => {
"description" => "Any configured query timeout in seconds. If not provided no timeout will be set",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"use-try-lock" => {
"description" => "Any configured timeout for internal locks on the resource adapter objects in seconds",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"set-tx-query-timeout" => {
"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",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"transaction-isolation" => {
"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",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"check-valid-connection-sql" => {
"description" => "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,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"exception-sorter-class-name" => {
"description" => "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"exception-sorter-properties" => {
"description" => "The exception sorter properties",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"stale-connection-checker-class-name" => {
"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",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"stale-connection-checker-properties" => {
"description" => "The stale connection checker properties",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"valid-connection-checker-class-name" => {
"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",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"valid-connection-checker-properties" => {
"description" => "The valid connection checker properties",
"type" => STRING,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"background-validation-millis" => {
"description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart",
"type" => LONG,
"required" => false,
"access-type" => "read-only",
"storage" => "configuration"
},
"background-validation" => {
"description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"use-fast-fail" => {
"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)",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"validate-on-match" => {
"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",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"spy" => {
"description" => "Enable spying of SQL statements",
"type" => BOOLEAN,
"required" => false,
"default" => "false",
"access-type" => "read-only",
"storage" => "configuration"
},
"use-ccm" => {
"description" => "Enable the use of a cached connection manager",
"type" => BOOLEAN,
"required" => false,
"default" => "true",
"access-type" => "read-only",
"storage" => "configuration"
},
"enabled" => {
"description" => "Specifies if the datasource should be enabled",
"type" => BOOLEAN,
"access-type" => "read-only",
"storage" => "configuration"
},
"statistics" => {
"description" => "Runtime statistics provided by the resource adapter.",
"access-type" => "read-only",
"storage" => "configuration"
}
},
"children" => {"connection-properties" => {"description" => "The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method"}}
}
}
Raw
write-attribute
[standalone@localhost:9999 /] /subsystem=datasources/data-source=ExampleDS:write-attribute(name=use-ccm,value=false)
{
"outcome" => "failed",
"failure-description" => "JBAS014639: Attribute use-ccm is not writable",
"rolled-back" => true
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment