第93章 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 の場合、メッセージボディーから
名前付きパラメーターを解決できない場合、例外が発生します。
93.1. オプション
ElSQL コンポーネントは、以下に示す 5 つのオプションをサポートします。
| Name | 説明 | デフォルト | Type |
|---|---|---|---|
| databaseVendor (common) | ベンダー固有の com.opengamma.elsql.ElSqlConfig を使用する。 | ElSqlDatabaseVendor | |
| dataSource (common) | データベースとの通信に使用する DataSource を設定します。 | DataSource | |
| elSqlConfig (advanced) | 特定の設定済みの ElSqlConfig を使用します。代わりに databaseVendor オプションを使用することが推奨されます。 | ElSqlConfig | |
| resourceUri (common) | 使用する elsql SQL ステートメントが含まれるリソースファイル。コンマで区切られた複数のリソースを指定できます。デフォルトでは、リソースはクラスパスに読み込まれます。前に file: 接頭辞をファイルシステムから読み込むことができます。このオプションをコンポーネントに設定し、エンドポイントで設定する必要がないことに注意してください。 | 文字列 | |
| resolveProperty Placeholders (advanced) | 起動時にコンポーネント自体がプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
ElSQL エンドポイントは、URI 構文を使用して設定します。
elsql:elsqlName:resourceUri
以下の path パラメーターおよびクエリーパラメーターを使用します。
93.1.1. パスパラメーター（2 パラメーター）:
| Name | 説明 | デフォルト | Type |
|---|---|---|---|
| elsqlName | 必須: 使用する elsql の名前（elsql ファイルの NAMED）。 | 文字列 | |
| resourceUri | 使用する elsql SQL ステートメントが含まれるリソースファイル。コンマで区切られた複数のリソースを指定できます。デフォルトでは、リソースはクラスパスに読み込まれます。前に file: 接頭辞をファイルシステムから読み込むことができます。このオプションをコンポーネントに設定し、エンドポイントで設定する必要がないことに注意してください。 | 文字列 |
93.1.2. クエリーパラメーター（47 パラメーター）:
| Name | 説明 | デフォルト | Type |
|---|---|---|---|
| allowNamedParameters (common) | クエリーで名前付きパラメーターを使用できるかどうか。 | true | boolean |
| databaseVendor (common) | ベンダー固有の com.opengamma.elsql.ElSqlConfig を使用する。 | ElSqlDatabaseVendor | |
| dataSource (common) | データベースとの通信に使用する DataSource を設定します。 | DataSource | |
| dataSourceRef (common) | 非推奨。データベースとの通信に使用する DataSource への参照をレジストリーから参照するように設定します。 | 文字列 | |
| outputClass (common) | outputType=SelectOne の変換として使用する完全なパッケージおよびクラス名を指定します。 | 文字列 | |
| outputHeader (common) | クエリー結果をメッセージのボディーの代わりにヘッダーに保存します。デフォルトでは、outputHeader == null とクエリー結果はメッセージボディーに保存され、メッセージボディー内の既存のコンテンツは破棄されます。outputHeader が設定されている場合、値はクエリー結果を保存するヘッダーの名前として使用され、元のメッセージボディーは保持されます。 | 文字列 | |
| outputType (common) | コンシューマーまたはプロデューサーの出力を Map の List として選択するか、以下のように SelectOne を単一の Java オブジェクトとして選択します。クエリーに単一の列のみが含まれる場合、JDBC Column オブジェクトが返されます（SELECT COUNT（）FROM PROJECT は Long object.b を返します）、クエリーに複数の列がある場合、outputClass が設定されている場合は、その result.c の Map を返します。 次に、列名に一致するすべてのセッターを呼び出してクエリー結果を Java Bean オブジェクトに変換します。これは、クラスにインスタンスを作成するためのデフォルトのコンストラクターを想定します。クエリーが複数の行で作成された場合は、一意でない結果 exception.StreamList がイタレーターを使用してクエリーの結果をストリーミングします。これはストリーミングモードで Splitter EIP と共に使用して、ストリーミング方式で ResultSet を処理することができます。 | SelectList | SqlOutputType |
| セパレーター （共通） | パラメーター値がメッセージボディー（本文が String タイプである場合）から取得されるときに使用する区切り文字はプレースホルダーに挿入されます。名前付きパラメーターを使用する場合は、代わりに Map タイプが使用されます。デフォルト値は comma です。 | , | char |
| breakBatchOnConsumeFail (consumer) | 消費に失敗した場合にバッチを壊すかどうかを設定します。 | false | boolean |
| bridgeErrorHandler (consumer) | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、コンシューマーは org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
| expectedUpdateCount (consumer) | onConsume の使用時に、予想される更新数を検証するように設定します。 | -1 | int |
| maxMessagesPerPoll (consumer) | ポーリングするメッセージの最大数を設定します。 | int | |
| onConsume (consumer) | 各行の処理後、Exchange が正常に処理されたときにこのクエリーを実行できます。たとえば、行を処理済みとしてマークします。クエリーにはパラメーターを指定できます。 | 文字列 | |
| onConsumeBatchComplete (consumer) | バッチ全体を処理したら、このクエリーを実行して行を一括更新することができます。クエリーにパラメーターを含めることはできません。 | 文字列 | |
| onConsumeFailed (consumer) | 各行の処理後、エクスチェンジが失敗した場合、行の失敗をマークするなど、このクエリーを実行できます。クエリーにはパラメーターを指定できます。 | 文字列 | |
| routeEmptyResultSet (consumer) | 空の結果セットを次のホップに送信できるようにするかどうかを設定します。デフォルトは false です。そのため、空の結果セットが除外されます。 | false | boolean |
| sendEmptyMessageWhenIdle (consumer) | ポーリングコンシューマーがファイルをポーリングしなかった場合、このオプションを有効にして、代わりに空のメッセージ (ボディーなし) を送信できます。 | false | boolean |
| トランザクション （コンシューマー） | トランザクションを有効または無効にします。有効にすると、エクスチェンジの処理に失敗した場合、コンシューマーは追加のエクスチェンジを処理してロールバック Eager を生じさせます。 | false | boolean |
| useIterator (consumer) | resultset をルートに配信する方法を設定します。配信をリストまたは個別オブジェクトのいずれかとして指定します。デフォルトは true です。 | 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 （プロデューサー） | バッチモードを有効または無効にします。 | 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 の場合、1 つ以上の想定パラメーターが設定されている場合にのみ populateStatement が呼び出されます。たとえば、パラメーターを指定せずに SQL クエリーのメッセージボディー/ヘッダーを読み取ることが回避されます。 | false | boolean |
| parametersCount (producer) | ゼロより大きい場合、Camel は JDBC メタデータ API 経由でクエリーを実行する代わりに、このパラメーター値を使用して置き換えるパラメーターの数を使用します。これは、JDBC ベンダーが正しいパラメーター数を返しないとユーザーが上書きできる場合に便利です。 | int | |
| elSqlConfig (advanced) | 特定の設定済みの ElSqlConfig を使用します。代わりに databaseVendor オプションを使用することが推奨されます。 | ElSqlConfig | |
| placeholder (advanced) | SQL クエリーで置き換える文字を指定します。これは単純な String.replaceAll（）操作であり、SQL 解析が行われないことに注意してください（引用符付きの文字列も変更されます）。 | # | 文字列 |
| prepareStatementStrategy (advanced) | プラグインがカスタムの org.apache.camel.component.sql.SqlPrepareStatementStrategy を使用して、クエリーおよび準備済みステートメントの準備を制御できます。 | SqlPrepareStatement Strategy | |
| 同期 （詳細） | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるようにするかを設定します（サポートされている場合）。 | false | boolean |
| templateOptions (advanced) | マップのキー/値で Spring JdbcTemplate を設定します。 | マップ | |
| usePlaceholder (advanced) | プレースホルダーを使用するかどうかを設定し、すべてのプレースホルダー文字を SQL クエリーの署名に置き換えるかどうかを設定します。 | true | boolean |
| backoffErrorThreshold (scheduler) | backoffMultipler が開始する前に発生する必要がある後続のエラーポーリング (エラーによって失敗した) の数。 | int | |
| backoffIdleThreshold (scheduler) | backoffMultipler が開始する前に発生する必要がある後続のアイドルポーリングの数。 | int | |
| backoffMultiplier (scheduler) | 後続のアイドル状態/エラーが連続して発生した場合に、スケジュールされたポーリングコンシューマーのバックオフを許可します。乗数は、実際に次の試行が行われる前にスキップされるポーリングの数です。このオプションが使用されている場合は、backoffIdleThreshold や backoffErrorThreshold も設定する必要があります。 | int | |
| 遅延 （スケジューラー） | 次のポーリングまでの時間 (ミリ秒単位)。また、60 秒（60 秒）、5m30s（5 分と 30 秒）、および 1h（1 時間）などの単位を使用して時間の値を指定することもできます。 | 500 | Long |
| greedy (scheduler) | greedy が有効で、以前の実行が 1 つ以上のメッセージをポーリングした場合、ScheduledPollConsumer は即座に再度実行されます。 | false | boolean |
| initialDelay (scheduler) | 最初のポーリングが開始されるまでの時間 (ミリ秒単位)。また、60 秒（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 ベースのスケジューラーを使用する場合に追加のプロパティーを設定します。 | マップ | |
| startScheduler (scheduler) | スケジューラーを自動起動するかどうか。 | true | boolean |
| timeUnit (scheduler) | initialDelay および delay オプションの時間単位。 | ミリ秒 | TimeUnit |
| useFixedDelay (scheduler) | 固定遅延または固定レートを使用するかどうかを制御します。詳細は、JDK の ScheduledExecutorService を参照してください。 | true | boolean |
