xa-data-source add --help

xa-data-source-help.out

[standalone@localhost:9990 /] xa-data-source add --help

DESCRIPTION:

  Add a new XA data-source (unlike the add operation, this command accepts
  xa-datasource-properties).


REQUIRED ARGUMENTS:

 --name                 - Required argument in commands which identifies
                          the instance to execute the command against.

 --driver-name          - (STRING) 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

 --jndi-name            - (STRING) Specifies the JNDI name for the
                          datasource



OPTIONAL ARGUMENTS:

 --allocation-retry     - (INT) 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) 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) 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

 --background-validation  - (BOOLEAN) 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) 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) 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) Class defining the policy for
                                 decrementing connections in the pool

 --capacity-decrementer-properties  - (OBJECT) Properties to inject in
                                      class defining the policy for
                        decrementing connections in the pool

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

 --capacity-incrementer-properties  - (OBJECT) Properties to inject in
                                      class defining the policy for
                        incrementing connections in the pool

 --check-valid-connection-sql  - (STRING) 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) Enable the use of CMR for this
                          datasource. This feature means that a local
                        resource can reliably participate in an XA
                        transaction.

 --connection-listener-class  - (STRING) Speciefies class name extending
                                org.jboss.jca.adapters.jdbc.spi.listener.Co
                        nnectionListener 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) Properties to be injected in
                                   class specified in
                        connection-listener-class

 --enabled              - (BOOLEAN) Specifies if the datasource should be
                          enabled. Note this attribute will not be
                        supported runtime in next versions.

 --enlistment-trace     - (BOOLEAN) Defines if WildFly/IronJacamar should
                          record enlistment traces

 --exception-sorter-class-name  - (STRING) An
                                  org.jboss.jca.adapters.jdbc.ExceptionSort
                        er that provides an isExceptionFatal(SQLException)
                        method to validate if an exception should broadcast
                        an error

 --exception-sorter-properties  - (OBJECT) The exception sorter properties

 --flush-strategy       - (STRING) Specifies how the pool should be flush
                          in case of an error. Valid values are:
                        FailingConnectionOnly (default), IdleConnections
                        and EntirePool

 --idle-timeout-minutes  - (LONG) 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) The initial-pool-size element indicates the
                          initial number of connections a pool should hold.

 --interleaving         - (BOOLEAN) An element to enable interleaving for
                          XA connections

 --max-pool-size        - (INT) 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) Defines the ManagedConnectionPool
                          implementation, f.ex.
                        org.jboss.jca.core.connectionmanager.pool.mcp.Semap
                        horeArrayListManagedConnectionPool

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

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

 --no-recovery          - (BOOLEAN) Specifies if the connection pool should
                          be excluded from recovery

 --no-tx-separate-pool  - (BOOLEAN) Oracle does not like XA connections
                          getting used both inside and outside a JTA
                        transaction. To workaround the problem you can
                        create separate sub-pools for the different
                        contexts

 --pad-xid              - (BOOLEAN) Should the Xid be padded

 --password             - (STRING) Specifies the password used when
                          creating a new connection

 --pool-fair            - (BOOLEAN) Defines if pool should use be fair

 --pool-prefill         - (BOOLEAN) 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) Specifies if the min-pool-size should
                          be considered strictly

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

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

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

 --reauth-plugin-properties  - (OBJECT) The properties for the
                               reauthentication plugin

 --recovery-password    - (STRING) The password used for recovery

 --recovery-plugin-class-name  - (STRING) The fully qualified class name of
                                 the recovery plugin implementation

 --recovery-plugin-properties  - (OBJECT) The properties for the recovery
                                 plugin

 --recovery-security-domain  - (STRING) The security domain used for
                               recovery

 --recovery-username    - (STRING) The user name used for recovery

 --same-rm-override     - (BOOLEAN) The is-same-rm-override element allows
                          one to unconditionally set whether the
                        javax.transaction.xa.XAResource.isSameRM(XAResource
                        ) returns true or false

 --security-domain      - (STRING) Specifies the security domain which
                          defines the javax.security.auth.Subject that are
                        used to distinguish connections in the pool

 --set-tx-query-timeout  - (BOOLEAN) 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) Whether to share prepared
                                statements, i.e. whether asking for same
                        statement twice without closing uses the same
                        underlying prepared statement

 --spy                  - (BOOLEAN) Enable spying of SQL statements

 --stale-connection-checker-class-name  - (STRING) An
                                          org.jboss.jca.adapters.jdbc.Stale
                        ConnectionChecker that provides an
                        isStaleConnection(SQLException) method which if it
                        returns true will wrap the exception in an
                        org.jboss.jca.adapters.jdbc.StaleConnectionExceptio
                        n

 --stale-connection-checker-properties  - (OBJECT) The stale connection
                                          checker properties

 --statistics-enabled   - (BOOLEAN) define if runtime statistics is enabled
                          or not

 --track-statements     - (STRING) 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) Defines if IronJacamar should track
                          connection handles across transaction boundaries

 --transaction-isolation  - (STRING) 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

 --url-delimiter        - (STRING) Specifies the delimiter for URLs in
                          connection-url for HA datasources

 --url-property         - (STRING) Specifies the property for the URL
                          property in the xa-datasource-property values

 --url-selector-strategy-class-name  - (STRING) A class that implements
                                       org.jboss.jca.adapters.jdbc.URLSelec
                        torStrategy

 --use-ccm              - (BOOLEAN) Enable the use of a cached connection
                          manager

 --use-fast-fail        - (BOOLEAN) 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) Setting this to false will bind the
                          datasource into global JNDI

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

 --user-name            - (STRING) Specify the user name used when creating
                          a new connection

 --valid-connection-checker-class-name  - (STRING) An
                                          org.jboss.jca.adapters.jdbc.Valid
                        ConnectionChecker 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-properties  - (OBJECT) The valid connection
                                          checker properties

 --validate-on-match    - (BOOLEAN) 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

 --wrap-xa-resource     - (BOOLEAN) Should the XAResource instances be
                          wrapped in an org.jboss.tm.XAResourceWrapper
                        instance

 --xa-datasource-class  - (STRING) The fully qualified name of the
                          javax.sql.XADataSource implementation

 --xa-resource-timeout  - (INT) The value is passed to
                          XAResource.setTransactionTimeout(), in seconds.
                        Default is zero

 --xa-datasource-properties  - (LIST) A comma-separated list of XA
                               datasource properties in key=value pair
                        format.