第95章 ElSQL コンポーネント
Camel バージョン 2.16 以降で利用可能
elsql: コンポーネントは、ElSql を使用して SQL クエリーを定義する既存の SQL コンポーネント の拡張です。
このコンポーネントは、実際の SQL 処理のために舞台裏で spring-jdbc を使用します。
このコンポーネントは、Transactional Client として使用できます。
Maven ユーザーは、このコンポーネントの pom.xml に以下の依存関係を追加する必要があります。
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-elsql</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>SQL コンポーネントは、次のエンドポイント URI 表記を使用します。
sql:elSqlName:resourceUri[?options]
URI には、?option=value&option=value&… の形式でクエリーオプションを追加できます。
SQL クエリーへのパラメーターは、elsql マッピングファイル内の名前付きパラメーターであり、指定された優先順位で Camel メッセージから対応するキーにマップされます。
- Camel 2.16.1: Simple 式の場合はメッセージボディーから。
- `java.util.Map` の場合はメッセージ本文から 3.メッセージヘッダーから
名前付きパラメーターを解決できない場合は、例外が出力されます。
95.1. オプション
ElSQL コンポーネントは、以下に示す 5 個のオプションをサポートしています。
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| databaseVendor (Common) | ベンダー固有の com.opengamma.elsql.ElSqlConfig を使用する場合 | ElSqlDatabaseVendor | |
| dataSource (Common) | データベースとの通信に使用する DataSource を設定します。 | DataSource | |
| elSqlConfig (advanced) | 特定の設定済み ElSqlConfig を使用する場合。代わりに、databaseVendor オプションを使用することをお勧めします。 | ElSqlConfig | |
| resourceUri (common) | 使用する elsql SQL ステートメントを含むリソースファイル。複数のリソースをコンマで区切って指定できます。リソースはデフォルトでクラスパスにロードされます。file: を前に付けて、ファイルシステムからロードできます。このオプションはコンポーネントで設定でき、エンドポイントでこれを設定する必要がないことに注意してください。 | String | |
| resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
ElSQL エンドポイントは、URI 構文を使用して設定されます。
elsql:elsqlName:resourceUri
パスおよびクエリーパラメーターを使用します。
95.1.1. パスパラメーター (2 個のパラメーター):
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| elsqlName | 必須 使用する elsql の名前 (elsql ファイルでは NAMED です) | String | |
| resourceUri | 使用する elsql SQL ステートメントを含むリソースファイル。複数のリソースをコンマで区切って指定できます。リソースはデフォルトでクラスパスにロードされます。file: を前に付けて、ファイルシステムからロードできます。このオプションはコンポーネントで設定でき、エンドポイントでこれを設定する必要がないことに注意してください。 | String |
95.1.2. クエリーパラメーター(47 個のパラメーター):
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| allowNamedParameters (common) | クエリーで名前付きパラメーターの使用を許可するかどうか。 | true | boolean |
| databaseVendor (Common) | ベンダー固有の com.opengamma.elsql.ElSqlConfig を使用する場合 | ElSqlDatabaseVendor | |
| dataSource (Common) | データベースとの通信に使用する DataSource を設定します。 | DataSource | |
| dataSourceRef (common) | 非推奨 データベースとの通信に使用するために、レジストリーから参照する DataSource への参照を設定します。 | String | |
| outputClass (common) | outputType=SelectOne の場合、変換として使用する完全なパッケージとクラス名を指定します。 | String | |
| outputHeader (common) | メッセージ本文ではなく、ヘッダーにクエリー結果を格納します。デフォルトでは、outputHeader == null で、クエリー結果はメッセージ本文に格納され、メッセージ本文の既存のコンテンツは破棄されます。outputHeader が設定されている場合、値はクエリー結果を格納するヘッダーの名前として使用され、元のメッセージ本文は保持されます。 | String | |
| outputType (common) | 以下の方法で、コンシューマーまたはプロデューサーの出力を SelectList にマップのリストとして、または SelectOne を単一の Java オブジェクトとして作成します。a) クエリーに単一の列しかない場合、その JDBC 列オブジェクトが返されます。(SELECT COUNT() FROM PROJECT などは Long オブジェクトを返します。b) クエリーに複数の列がある場合、その結果のマップを返します。c) outputClass が設定されている場合、クエリーを変換します。列名に一致するすべてのセッターを呼び出すことにより、Java Bean オブジェクトになります。クラスには、インスタンスを作成するためのデフォルトのコンストラクターがあると想定されます。d) クエリーの結果が複数の行になった場合、一意でない結果が出力されます。exception.StreamList は、Iterator を使用してクエリーの結果をストリーミングします。これは、ストリーミング方式で ResultSet を処理するために、ストリーミングモードでスプリッタ EIP とともに使用できます。 | SelectList | SqlOutputType |
| separator (common) | パラメーター値がメッセージ本文から取得されるときに使用するセパレーター (ボディーが文字列型の場合)、プレースホルダーに挿入されます。名前付きパラメーターを使用する場合は、代わりに Map 型が使用されることに注意してください。デフォルト値は、コンマです。 | , | char |
| breakBatchOnConsumeFail (consumer) | onConsume が失敗した場合にバッチを中断するかどうかを設定します。 | false | boolean |
| bridgeErrorHandler (consumer) | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、コンシューマーは org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
| expectedUpdateCount (consumer) | onConsume を使用するときに検証する予想更新カウントを設定します。 | -1 | int |
| maxMessagesPerPoll (consumer) | ポーリングするメッセージの最大数を設定します | int | |
| onConsume (consumer) | 各行を処理した後、エクスチェンジが正常に処理された場合、たとえば行を処理済みとしてマークするために、このクエリーを実行できます。クエリーにはパラメーターを含めることができます。 | String | |
| onConsumeBatchComplete (consumer) | バッチ全体を処理した後、このクエリーを実行して行などを一括更新できます。クエリーにパラメーターを含めることはできません。 | String | |
| onConsumeFailed (consumer) | 各行を処理した後、エクスチェンジが失敗した場合、たとえば、行を失敗としてマークするために、このクエリーを実行できます。クエリーにはパラメーターを含めることができます。 | String | |
| routeEmptyResultSet (consumer) | 空の結果セットを次のホップに送信できるようにするかどうかを設定します。デフォルトは false です。したがって、空の結果セットは除外されます。 | false | boolean |
| sendEmptyMessageWhenIdle (consumer) | ポーリングコンシューマーがファイルをポーリングしなかった場合、このオプションを有効にして、代わりに空のメッセージ (ボディーなし) を送信できます。 | false | boolean |
| transacted (consumer) | トランザクションを有効または無効にします。有効にすると、交換の処理が失敗した場合に、コンシューマーはそれ以上の交換の処理を中断して、先行してロールバックを実行させます。 | false | boolean |
| useIterator (consumer) | 結果セットをルートに配信する方法を設定します。リストまたは個々のオブジェクトとして配信を示します。デフォルトは真です。 | true | boolean |
| exceptionHandler (consumer) | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、コンシューマーは例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
| exchangePattern (consumer) | コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。 | ExchangePattern | |
| pollStrategy (consumer) | プラグ可能な org.apache.camel.PollingConsumerPollingStrategy を使用すると、エクスチェンジが作成され、Camel でルーティングされる前に、通常はポーリング操作中に発生するエラー処理を制御するカスタム実装が提供できます。 | PollingConsumerPoll Strategy | |
| processingStrategy (consumer) | コンシューマーが行/バッチを処理したときに、カスタム org.apache.camel.component.sql.SqlProcessingStrategy を使用してクエリーを実行するプラグインを許可します。 | SqlProcessingStrategy | |
| batch (producer) | バッチモードを有効または無効にします | false | boolean |
| noop (producer) | 設定されている場合、SQL クエリーの結果を無視し、既存の IN メッセージを OUT メッセージとして使用して処理を続行します。 | false | boolean |
| useMessageBodyForSql (producer) | メッセージ本文を SQL として使用し、次にパラメーターのヘッダーを使用するかどうか。このオプションを有効にすると、URI の SQL は使用されません。 | false | boolean |
| alwaysPopulateStatement (producer) | 有効にすると、org.apache.camel.component.sql.SqlPrepareStatementStrategy の populateStatement メソッドが常に呼び出されます。また、準備する必要のあるパラメーターがない場合も同様です。これが false の場合、populateStatement は、1 つ以上の予期されるパラメーターが設定される場合にのみ呼び出されます。たとえば、これにより、パラメーターのない SQL クエリーのメッセージ本文/ヘッダーの読み取りが回避されます。 | false | boolean |
| parametersCount (プロデューサー) | 0 より大きい値を設定すると、Camel は JDBC メタデータ API を介してクエリーを実行する代わりに、このパラメーターのカウント値を使用して置き換えます。これは、JDBC ベンダーが正しいパラメーター数を返すことができず、ユーザーが代わりにオーバーライドできる場合に役立ちます。 | int | |
| elSqlConfig (advanced) | 特定の設定済み ElSqlConfig を使用する場合。代わりに、databaseVendor オプションを使用することをお勧めします。 | ElSqlConfig | |
| placeholder (advanced) | SQL クエリーで置換される文字を指定します。これは単純な String.replaceAll() 操作であり、SQL 解析が含まれていないことに注意してください (引用符で囲まれた文字列も変更されます)。 | # | String |
| prepareStatementStrategy (advanced) | プラグインでカスタム org.apache.camel.component.sql.SqlPrepareStatementStrategy を使用して、クエリーと準備済みステートメントの準備を制御できるようにします。 | SqlPrepareStatement Strategy | |
| synchronous (advanced) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | false | boolean |
| templateOptions (advanced) | マップからのキー/値を使用して Spring JdbcTemplate を設定します | Map | |
| usePlaceholder (advanced) | SQL クエリーでプレースホルダーを使用し、すべてのプレースホルダー文字を符号に置き換えるかどうかを設定します。 | true | boolean |
| backoffErrorThreshold (scheduler) | backoffMultipler が開始する前に発生する必要がある後続のエラーポーリング (エラーによって失敗した) の数。 | int | |
| backoffIdleThreshold (scheduler) | backoffMultipler が開始する前に発生する必要がある後続のアイドルポーリングの数。 | int | |
| backoffMultiplier (scheduler) | 後続のアイドル状態/エラーが連続して発生した場合に、スケジュールされたポーリングコンシューマーのバックオフを許可します。乗数は、実際に次の試行が行われる前にスキップされるポーリングの数です。このオプションが使用されている場合は、backoffIdleThreshold や backoffErrorThreshold も設定する必要があります。 | int | |
| delay (scheduler) | 次のポーリングまでの時間 (ミリ秒単位)。60s (60 秒)、5m30s (5 分 30 秒)、1h (1 時間) などの単位を使用して時間値を指定することもできます。 | 500 | long |
| greedy (scheduler) | greedy が有効で、以前の実行が 1 つ以上のメッセージをポーリングした場合、ScheduledPollConsumer は即座に再度実行されます。 | false | boolean |
| initialDelay (scheduler) | 最初のポーリングが開始されるまでの時間 (ミリ秒単位)。60s (60 秒)、5m30s (5 分 30 秒)、1h (1 時間) などの単位を使用して時間値を指定することもできます。 | 1000 | long |
| runLoggingLevel (scheduler) | コンシューマーはポーリング時に開始/完了のログ行を記録します。このオプションを使用すると、ログレベルを設定できます。 | TRACE | LoggingLevel |
| scheduledExecutorService (scheduler) | コンシューマーに使用するカスタム/共有スレッドプールを設定できます。デフォルトでは、各コンシューマーに独自の単一スレッドのスレッドプールがあります。 | ScheduledExecutor Service | |
| scheduler (scheduler) | camel-spring または camel-quartz2 コンポーネントから cron スケジューラーを使用します。 | none | ScheduledPollConsumer Scheduler |
| schedulerProperties (scheduler) | カスタムスケジューラーまたは Quartz2 や Spring ベースのスケジューラーを使用する場合に、追加のプロパティーを設定します。 | Map | |
| startScheduler (scheduler) | スケジューラーを自動起動するかどうか。 | true | boolean |
| timeUnit (scheduler) | initialDelay および delay オプションの時間単位。 | MILLISECONDS | TimeUnit |
| useFixedDelay (scheduler) | 固定遅延または固定レートを使用するかどうかを制御します。詳細は、JDK の ScheduledExecutorService を参照してください。 | true | boolean |
