A.20. データソースの属性

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/jboss_as_logging_5_0.xsd のスキーマ定義ファイルで確認してください。

表A.44 データソースの属性

属性データソースタイプ説明

allocation-retry

非 XA、XA

例外が発生する前に接続の割り当てを試行する回数。デフォルトは 0 で、初回の割り当て失敗で例外が発生します。

allocation-retry-wait-millis

非 XA、XA

接続の割り当てを再試行する間隔 (ミリ秒単位)。デフォルトは 5000 ミリ秒です。

allow-multiple-users

非 XA、XA

複数のユーザーが getConnection(user, password) メソッドを使いデータソースへアクセスするかどうか、およびこの挙動が内部プールタイプによるものであるかどうか。

authentication-context

非 XA、XA

プールの接続を区別するために使用される javax.security.auth.Subject を定義する Elytron 認証コンテキスト。

background-validation

非 XA、XA

接続がバックグラウンドスレッドで検証されるべきか、または使用前に検証されるか。通常バックグラウンド検証は validate-on-match とともに使用されません。使用されると冗長チェックが行われます。バックグラウンド検証では、検証時とクライアントへ渡す時の間で接続が不良になる可能性があるため、アプリケーションはこの可能性に対応する必要があります。

background-validation-millis

非 XA、XA

バックグラウンド検証を実行する頻度 (ミリ秒単位)。

blocking-timeout-wait-millis

非 XA、XA

例外が発生する前に接続を待機している間にブロックする最大時間 (ミリ秒単位)。この時間を超過すると、例外が発生します。 これは、接続のロックを待っている間のみブロックし、新規接続の作成に長時間要している場合は例外は発生しません。

capacity-decrementer-class

非 XA、XA

プールの接続をデクリメントするポリシーを定義するクラス。

capacity-decrementer-properties

非 XA、XA

プールの接続をデクリメントするポリシーを定義するクラスにインジェクトされるプロパティー。

capacity-incrementer-class

非 XA、XA

プールの接続をインクリメントするポリシーを定義するクラス。

capacity-incrementer-properties

非 XA、XA

プールの接続をインクリメントするポリシーを定義するクラスにインジェクトされるプロパティー。

check-valid-connection-sql

非 XA、XA

プール接続の妥当性を確認する SQL ステートメント。これは、プールから管理接続を取得するときに呼び出される場合があります。

connectable

非 XA、XA

CMR の使用を有効にします。 これは、ローカルリソースが信頼して XA トランザクションに参加できることを意味します。

connection-listener-class

非 XA、XA

org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener を拡張するクラス名を指定します。このクラスは、接続がアプリケーションまたはプールに返される前にアクションを実行するために接続のアクティベーションおよびパッシベーションをリッスンします。「コアモジュールとしての JDBC ドライバーのインストール」のとおりに、2 つのリソース JAR を使用して 1 つのモジュールで指定されたクラスを JDBC ドライバーとバンドルするか、「グローバルモジュールの定義」のとおりに、指定されたクラスを個別のグローバルモジュールでバンドルする必要があります。

connection-listener-property

非 XA、XA

connection-listener-class で指定されたクラスにインジェクトされるプロパティー。インジェクトされるプロパティーは JavaBeans の慣例に対応します。たとえば、foo という名前のプロパティーを指定する場合、接続リスナークラスには String を引数として許可するメソッド setFoo が必要です。

connection-properties

非 XA のみ

Driver.connect(url, props) メソッドに渡す任意の文字列名と値のペアである接続プロパティー。

connection-url

非 XA のみ

JDBC ドライバーの接続 URL。

credential-reference

非 XA、XA

データソース上で認証される、認証情報ストアからの認証情報。

datasource-class

非 XA のみ

JDBC データソースクラスの完全修飾名。

driver-class

非 XA のみ

JDBC ドライバークラスの完全修飾名。

driver-name

非 XA、XA

データソースが使用する JDBC ドライバーを定義します。インストールされたドライバーに一致するシンボリック名になります。ドライバーが JAR としてデプロイされた場合、名前はデプロイメントの名前になります。

elytron-enabled

非 XA、XA

接続の認証の処理に Elytron セキュリティーを有効にします。指定されたコンテキストがない場合、使用される Elytron の authentication-context が現在のコンテキストになります。詳細は authentication-context を参照してください。

enabled

非 XA、XA

データソースを有効にするかどうか。

enlistment-trace

非 XA、XA

エンリストメントトレースを記録するかどうか。デフォルトは false です。

exception-sorter-class-name

非 XA、XA

例外がエラーをブロードキャストする場合に検証するメソッドを提供する org.jboss.jca.adapters.jdbc.ExceptionSorter のインスタンス。

exception-sorter-properties

非 XA、XA

例外ソータープロパティー。

flush-strategy

非 XA、XA

エラーの場合にプールをフラッシュする方法を指定します。有効な値は以下のとおりです。

FailingConnectionOnly
問題のある接続のみが削除されます。これはデフォルト設定です。
InvalidIdleConnections
同じ認証情報を共有し ValidatingManagedConnectionFactory.getInvalidConnections(…​) メソッドによって無効として返される、問題のある接続とアイドル状態の接続が削除されます。
IdleConnections
同じ認証情報を共有する問題のある接続とアイドル状態の接続が削除されます。
Gracefully
同じ認証情報を共有する問題のある接続とアイドル状態の接続が削除されます。同じ認証情報を共有するアクティブな接続は、プールに戻された時点で破棄されます。
EntirePool
同じ認証情報を共有する問題のある接続、アイドル状態の接続、およびアクティブな接続が削除されます。この設定は本番環境のシステムには推奨されません。
AllInvalidIdleConnections
ValidatingManagedConnectionFactory.getInvalidConnections(…​) メソッドによって無効として返される、問題のある接続とアイドル状態の接続が削除されます。
AllIdleConnections
問題のある接続と、アイドル状態の接続すべてが削除されます。
AllGracefully
問題のある接続と、アイドル状態の接続すべてが削除されます。アクティブな接続は、プールに戻された時点で破棄されます。
AllConnections
問題のある接続、アイドル状態の接続すべて、およびアクティブな接続すべてが削除されます。この設定は本番環境のシステムには推奨されません。

idle-timeout-minutes

非 XA、XA

接続が閉じられるまでのアイドル最大時間 (分単位) を指定します。指定がない場合、デフォルトは 30 分になります。実際の最大時間は、IdleRemover スキャン時間 (プールの最小 idle-timeout-minutes の半分) にも左右されます。

initial-pool-size

非 XA、XA

プールが保持する最初の接続数。

interleaving

XA のみ

XA 接続のインターリービングを有効にするかどうか。

jndi-name

非 XA、XA

データソースの一意の JNDI 名。

jta

非 XA のみ

JTA の統合を有効にします。

max-pool-size

非 XA、XA

プールが保持可能な最大接続数。

mcp

非 XA、XA

ManagedConnectionPool 実装。例: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool

min-pool-size

非 XA、XA

プールが保持可能な最小接続数。

new-connection-sql

非 XA、XA

接続が接続プールに追加されたときに実行する SQL ステートメント。

no-recovery

XA のみ

リカバリーから接続プールが除外されるかどうか。

no-tx-separate-pool

XA のみ

各コンテキストに対して個別のサブプールを作成するかどうか。これは、JTA トランザクションの内部と外部の両方で XA 接続を使用できない一部の Oracle データソースで必要になることがあります。このオプションを使用すると、実際のプールがつ作成されるため、合計プールサイズが max-pool-size の倍になります。

pad-xid

XA のみ

Xid のパディングを行うかどうかを指定します。

password

非 XA、XA

新しい接続の作成時に使用するパスワード。

pool-fair

非 XA、XA

プールが fair であるかを定義します。この設定は、JCA の接続プールを管理するために使用される Semaphore クラスの一部で、リースする接続の順番が必要でない一部のユースケースでパフォーマンスが向上されます。

pool-prefill

非 XA、XA

プールをプレフィルするかどうか。

pool-use-strict-min

非 XA、XA

min-pool-size を厳格に考慮するかどうか。

prepared-statements-cache-size

非 XA、XA

LRU (Least Recently Used) キャッシュにある接続毎の準備済みステートメントの数。

query-timeout

非 XA、XA

クエリーのタイムアウト (秒単位)。デフォルトではタイムアウトはありません。

reauth-plugin-class-name

非 XA、XA

物理接続の再認証する再認証プラグイン実装の完全修飾クラス名。

reauth-plugin-properties

非 XA、XA

再認証プラグインのプロパティー。

recovery-authentication-context

XA のみ

プールの接続を区別するために使用される javax.security.auth.Subject を定義する Elytron 認証コンテキスト。

recovery-credential-reference

XA のみ

データソース上で認証される、認証情報ストアからの認証情報。

recovery-elytron-enabled

XA のみ

リカバリーに対する接続の認証の処理に Elytron セキュリティーを有効にします。指定された authentication-context がない場合、使用される Elytron の authentication-context が現在のコンテキストになります。詳細は authentication-context を参照してください。

recovery-password

XA のみ

リカバリーのリソースへの接続に使用するパスワード。

recovery-plugin-class-name

XA のみ

リカバリープラグイン実装の完全修飾クラス名。

recovery-plugin-properties

XA のみ

リカバリープラグインのプロパティー。

recovery-security-domain

XA のみ

リカバリーでリソースに接続するために使用するセキュリティードメイン。

recovery-username

XA のみ

リカバリーでリソースに接続するために使用するユーザー名。

same-rm-override

XA のみ

javax.transaction.xa.XAResource.isSameRM(XAResource) クラスが true または false を返すかどうか。

security-domain

非 XA、XA

認証処理を行う JAAS security-manager の名前。この名前は、JAAS ログイン設定の application-policy/name 属性に相関します。

set-tx-query-timeout

非 XA、XA

トランザクションがタイムアウトするまでの残り時間を基にクエリーのタイムアウトを設定するかどうかを指定します。トランザクションが存在しない場合は設定済みのクエリーのタイムアウトが使用されます。

share-prepared-statements

非 XA、XA

アプリケーションに提供されたラッパーがアプリケーションコードによって閉じられたときに、JBoss EAP が基盤の物理ステートメントを閉じたり終了せずに、キャッシュするかどうか。デフォルトは false です。

spy

非 XA、XA

JDBC レイヤーでスパイ機能を有効にします。この機能は、データソースへの JDBC トラフィックをすべてログに記録します。ロギングカテゴリーの jboss.jdbc.spylogging サブシステムのログレベルである DEBUG に設定する必要があることに注意してください。

stale-connection-checker-class-name

非 XA、XA

isStaleConnection(SQLException) メソッドを提供する org.jboss.jca.adapters.jdbc.StaleConnectionChecker のインスタンス。このメソッドが true を返す場合、例外は org.jboss.jca.adapters.jdbc.StaleConnectionException でラップされます。

stale-connection-checker-properties

非 XA、XA

陳腐接続チェッカーのプロパティー。

statistics-enabled

非 XA、XA

ランタイム統計が有効になっているかどうか。デフォルトは false です。

track-statements

非 XA、XA

接続がプールへ返され、ステートメントが準備済みステートメントキャッシュへ返された時に、閉じられていないステートメントをチェックするかどうか。false の場合、ステートメントは追跡されません。有効な値は次のとおりです。

  • true: ステートメントと結果セットが追跡され、ステートメントが閉じられていない場合は警告が出力されます。
  • false: ステートメントと結果セットのいずれも追跡されません。
  • nowarn: ステートメントは追跡されますが、警告は出力されません (デフォルト)。

tracking

非 XA、XA

トランザクション境界にまたがる接続ハンドルを追跡するかどうか。

transaction-isolation

非 XA、XA

java.sql.Connection トランザクション分離レベル。有効な値は次のとおりです。

  • TRANSACTION_READ_UNCOMMITTED
  • TRANSACTION_READ_COMMITTED
  • TRANSACTION_REPEATABLE_READ
  • TRANSACTION_SERIALIZABLE
  • TRANSACTION_NONE

url-delimiter

非 XA、XA

高可用性 (HA) データソースの connection-url にある URL の区切り文字。

url-property

XA のみ

xa-datasource-property 値の URL プロパティーのプロパティー。

url-selector-strategy-class-name

非 XA、XA

org.jboss.jca.adapters.jdbc.URLSelectorStrategy を実装するクラス。

use-ccm

非 XA、XA

キャッシュ接続マネージャーを有効にします。

use-fast-fail

非 XA、XA

true の場合、接続が無効であれば最初に接続を割り当てしようとした時点で失敗します。false の場合、プールが枯渇するまで再試行します。

use-java-context

非 XA、XA

データソースをグローバル JNDI にバインドするかどうか。

use-try-lock

非 XA、XA

内部ロックのタイムアウト値。ロックが使用できない場合に即座に失敗するのではなく、タイムアウトする前に設定された秒数間ロックの取得を試みます。tryLock() の代わりに lock() を使用します。

user-name

非 XA、XA

新しい接続の作成時に使用するユーザー名。

valid-connection-checker-class-name

非 XA、XA

SQLException.isValidConnection(Connection e) メソッドを提供して接続を検証する org.jboss.jca.adaptors.jdbc.ValidConnectionChecker の実装。接続が破棄されると例外が発生します。存在する場合、check-valid-connection-sql 属性が上書きされます。

valid-connection-checker-properties

非 XA、XA

有効な接続チェッカープロパティー。

validate-on-match

非 XA、XA

接続ファクトリーが管理された接続への一致を試みたときに接続の検証が実行されるかどうか。これは、使用前にクライアントの接続を検証する必要がある場合に使用する必要があります。通常、Validate-on-match は background-validation と使用しません。 使用すると冗長チェックが行われます。

wrap-xa-resource

XA のみ

org.jboss.tm.XAResourceWrapper インスタンスで XAResource をラップするかどうか。

xa-datasource-class

XA のみ

javax.sql.XADataSource 実装クラスの完全修飾名。

xa-datasource-properties

XA のみ

XA データソースプロパティーの文字列名と値のペア。

xa-resource-timeout

XA のみ

ゼロ以外の値は XAResource.setTransactionTimeout メソッドに渡されます。

表A.45 JDBC ドライバー属性

属性データソースタイプ説明

datasource-class-info

非 XA、XA

jdbc-driverdatasource-class および xa-datasource-class に使用できるプロパティー。datasource-class および xa-datasource-class 属性は、javax.sql.DataSource または javax.sql.XADataSource クラスを実装する完全修飾クラス名を定義します。定義されたクラスはさまざまなプロパティーのセッターを持つことができます。datasource-class-info 属性は、クラスに設定できるこれらのプロパティーをリストします。