5.15.2. camel-sql-kafka-connector ソース設定
コネクターの説明: Spring JDBC を使用して SQL クエリーを実行します。
camel-sql-kafka-connector をソースとして使用する場合、以下の Maven 依存関係を使用してコネクターをサポートするようにしてください。
Kafka コネクションでこのソースコネクターを使用するには、以下の connector.class を設定する必要があります。
connector.class=org.apache.camel.kafkaconnector.sql.CamelSqlSourceConnector
connector.class=org.apache.camel.kafkaconnector.sql.CamelSqlSourceConnector
camel-sql ソースコネクターは、以下に示す 47 のオプションをサポートしています。
名前 | 説明 | デフォルト | 必要性 | 優先順位 |
---|---|---|---|---|
camel.source.path.query | 実行する SQL クエリーを設定します。file: または classpath: を接頭辞として使用してクエリーを外部化し、ファイルの場所を指定できます。 | null | true | HIGH |
camel.source.endpoint.allowNamedParameters | クエリーで名前付きパラメーターの使用を許可するかどうか。 | true | false | MEDIUM |
camel.source.endpoint.dataSource | エンドポイントレベルでデータベースと通信するために使用する DataSource を設定します。 | null | false | MEDIUM |
camel.source.endpoint.dataSourceRef | データベースとの通信に使用するために、レジストリーから参照する DataSource への参照を設定します。 | null | false | 低度の影響 |
camel.source.endpoint.outputClass | outputType=SelectOne の場合、変換として使用する完全なパッケージとクラス名を指定します。 | null | false | MEDIUM |
camel.source.endpoint.outputHeader | メッセージ本文ではなく、ヘッダーにクエリー結果を格納します。デフォルトでは、outputHeader == null で、クエリー結果はメッセージ本文に格納され、メッセージ本文の既存のコンテンツは破棄されます。outputHeader が設定されている場合、値はクエリー結果を格納するヘッダーの名前として使用され、元のメッセージ本文は保持されます。 | null | false | MEDIUM |
camel.source.endpoint.outputType | 以下の方法で、コンシューマーまたはプロデューサの出力を Map のリストとして SelectList、または単一の Java オブジェクトとして SelectOne にします。a) クエリーが単一の列を持っている場合、その JDBC 列オブジェクトが返されます。(SELECT COUNT( ) FROM PROJECT のような場合、Long オブジェクトを返します。) b) クエリーが複数の列を持つ場合、その結果の Map を返します。c) 出力クラスが設定されている場合、列名に一致するすべてのセッターを呼び出して、クエリーの結果を Java Bean オブジェクトに変換します。クラスには、インスタンスを作成するためのデフォルトのコンストラクターがあると想定されます。d) クエリーの結果が複数の行になった場合、一意でない結果の例外が出力されます。StreamList は、Iterator を使用してクエリーの結果をストリーミングします。これは、ストリーミング方式で ResultSet を処理するために、ストリーミングモードでスプリッタ EIP とともに使用できます。One of: [SelectOne] [SelectList] [StreamList] | "SelectList" | false | MEDIUM |
camel.source.endpoint.separator | パラメーター値がメッセージ本文 (本文が文字列型の場合) から取得されるときに使用するセパレーターで、# プレースホルダーに挿入されます。名前付きパラメーターを使用する場合は、代わりに Map タイプが使用されることに注意してください。デフォルト値は、コンマです。 | "," | false | MEDIUM |
camel.source.endpoint.breakBatchOnConsumeFail | onConsume が失敗した場合にバッチを中断するかどうかを設定します。 | false | false | MEDIUM |
camel.source.endpoint.bridgeErrorHandler | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、コンシューマーは org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | false | MEDIUM |
camel.source.endpoint.expectedUpdateCount | onConsume を使用するときに検証する予想更新カウントを設定します。 | -1 | false | MEDIUM |
camel.source.endpoint.maxMessagesPerPoll | ポーリングするメッセージの最大数を設定します | null | false | MEDIUM |
camel.source.endpoint.onConsume | 各行を処理した後、エクスチェンジが正常に処理された場合、たとえば行を処理済みとしてマークするために、このクエリーを実行できます。クエリーにはパラメーターを含めることができます。 | null | false | MEDIUM |
camel.source.endpoint.onConsumeBatchComplete | バッチ全体を処理した後、このクエリーを実行して行などを一括更新できます。クエリーにパラメーターを含めることはできません。 | null | false | MEDIUM |
camel.source.endpoint.onConsumeFailed | 各行を処理した後、エクスチェンジが失敗した場合、たとえば、行を失敗としてマークするために、このクエリーを実行できます。クエリーにはパラメーターを含めることができます。 | null | false | MEDIUM |
camel.source.endpoint.routeEmptyResultSet | 空の結果セットを次のホップに送信できるようにするかどうかを設定します。デフォルトは false です。したがって、空の結果セットは除外されます。 | false | false | MEDIUM |
camel.source.endpoint.sendEmptyMessageWhenIdle | ポーリングコンシューマーがファイルをポーリングしなかった場合、このオプションを有効にして、代わりに空のメッセージ (ボディーなし) を送信できます。 | false | false | MEDIUM |
camel.source.endpoint.transacted | トランザクションを有効または無効にします。有効にした場合、エクスチェンジの処理が失敗した場合、コンシューマーはそれ以上のエクスチェンジの処理を中断して、ロールバックイーガーを引き起こします。 | false | false | MEDIUM |
camel.source.endpoint.useIterator | 結果セットをルートに配信する方法を設定します。リストまたは個々のオブジェクトとして配信を示します。デフォルトは真です。 | true | false | MEDIUM |
camel.source.endpoint.exceptionHandler | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、コンシューマーは例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | null | false | MEDIUM |
camel.source.endpoint.exchangePattern | コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。[InOnly]、[InOut]、[InOptionalOut] のいずれか。 | null | false | MEDIUM |
camel.source.endpoint.pollStrategy | プラグ可能な org.apache.camel.PollingConsumerPollingStrategy を使用すると、エクスチェンジが作成され、Camel でルーティングされる前に、通常はポーリング操作中に発生するエラー処理を制御するカスタム実装が提供できます。 | null | false | MEDIUM |
camel.source.endpoint.processingStrategy | コンシューマーが行/バッチを処理したときに、カスタム org.apache.camel.component.sql.SqlProcessingStrategy を使用してクエリーを実行するプラグインを許可します。 | null | false | MEDIUM |
camel.source.endpoint.alwaysPopulateStatement | 有効にすると、org.apache.camel.component.sql.SqlPrepareStatementStrategy の populateStatement メソッドが常に呼び出されます。また、準備する必要のあるパラメーターがない場合も同様です。これが false の場合、populateStatement は、1 つ以上の予期されるパラメーターが設定される場合にのみ呼び出されます。たとえば、これにより、パラメーターのない SQL クエリーのメッセージ本文/ヘッダーの読み取りが回避されます。 | false | false | MEDIUM |
camel.source.endpoint.parametersCount | 0 より大きい値を設定すると、Camel は JDBC メタデータ API を介してクエリーを実行する代わりに、このパラメーターのカウント値を使用して置き換えます。これは、JDBC ベンダーが正しいパラメーター数を返すことができず、ユーザーが代わりにオーバーライドできる場合に役立ちます。 | null | false | MEDIUM |
camel.source.endpoint.placeholder | SQL クエリーで置換される文字を指定します。これは単純な String.replaceAll() 操作であり、SQL 解析が含まれていないことに注意してください (引用符で囲まれた文字列も変更されます)。 | "#" | false | MEDIUM |
camel.source.endpoint.prepareStatementStrategy | プラグインでカスタム org.apache.camel.component.sql.SqlPrepareStatementStrategy を使用して、クエリーと準備済みステートメントの準備を制御できるようにします。 | null | false | MEDIUM |
camel.source.endpoint.templateOptions | マップからのキー/値を使用して Spring JdbcTemplate を設定します | null | false | MEDIUM |
camel.source.endpoint.usePlaceholder | SQL クエリーでプレースホルダーを使用し、すべてのプレースホルダー文字を符号に置き換えるかどうかを設定します。 | true | false | MEDIUM |
camel.source.endpoint.backoffErrorThreshold | backoffMultipler が開始する前に発生する必要がある後続のエラーポーリング (エラーによって失敗した) の数。 | null | false | MEDIUM |
camel.source.endpoint.backoffIdleThreshold | backoffMultipler が開始する前に発生する必要がある後続のアイドルポーリングの数。 | null | false | MEDIUM |
camel.source.endpoint.backoffMultiplier | 後続のアイドル状態/エラーが連続して発生した場合に、スケジュールされたポーリングコンシューマーのバックオフを許可します。乗数は、実際に次の試行が行われる前にスキップされるポーリングの数です。このオプションが使用されている場合は、backoffIdleThreshold や backoffErrorThreshold も設定する必要があります。 | null | false | MEDIUM |
camel.source.endpoint.delay | 次のポーリングまでの時間 (ミリ秒単位)。 | 500L | false | MEDIUM |
camel.source.endpoint.greedy | greedy が有効で、以前の実行が 1 つ以上のメッセージをポーリングした場合、ScheduledPollConsumer は即座に再度実行されます。 | false | false | MEDIUM |
camel.source.endpoint.initialDelay | 最初のポーリングが開始されるまでの時間 (ミリ秒単位)。 | 1000L | false | MEDIUM |
camel.source.endpoint.repeatCount | 実行の最大数を指定します。そのため、これを 1 に設定するとスケジューラーは 1 度だけ実行されます。これを 5 に設定した場合、5 回だけ実行されます。0 または負の値を設定すると、無制限に実行されます。 | 0L | false | MEDIUM |
camel.source.endpoint.runLoggingLevel | コンシューマーはポーリング時に開始/完了のログ行を記録します。このオプションを使用すると、ログレベルを設定できます。[TRACE]、[DEBUG]、[INFO]、[WARN]、[ERROR]、[OFF] のいずれか。 | "TRACE" | false | MEDIUM |
camel.source.endpoint.scheduledExecutorService | コンシューマーに使用するカスタム/共有スレッドプールを設定できます。デフォルトでは、各コンシューマーに独自の単一スレッドのスレッドプールがあります。 | null | false | MEDIUM |
camel.source.endpoint.scheduler | camel-spring または camel-quartz コンポーネントから cron スケジューラーを使用します。スケジューラーにビルドされた値 spring または quartz を使用。 | "none" | false | MEDIUM |
camel.source.endpoint.schedulerProperties | カスタムスケジューラーまたは Quartz や Spring ベースのスケジューラーを使用する場合に、追加のプロパティーを設定します。 | null | false | MEDIUM |
camel.source.endpoint.startScheduler | スケジューラーを自動起動するかどうか。 | true | false | MEDIUM |
camel.source.endpoint.timeUnit | initialDelay および delay オプションの時間単位。[NANOSECONDS]、[MICROSECONDS]、[MILLISECONDS]、[SECONDS]、[MINUTES]、[HOURS]、[DAYS] のいずれか。 | "MILLISECONDS" | false | MEDIUM |
camel.source.endpoint.useFixedDelay | 固定遅延または固定レートを使用するかどうかを制御します。詳細は、JDK の ScheduledExecutorService を参照してください。 | true | false | MEDIUM |
camel.component.sql.dataSource | データベースとの通信に使用する DataSource を設定します。 | null | false | MEDIUM |
camel.component.sql.bridgeErrorHandler | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、コンシューマーは org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | false | MEDIUM |
camel.component.sql.autowiredEnabled | 自動ワイヤリングが有効になっているかどうか。これは、コンポーネントで設定される一致するタイプのインスタンスが 1 つあるかどうかを検出するためにレジストリーを検索することで、自動ワイアリングオプションに使用されます (オプションは自動ワイアとマーク付けされる必要があります)。これは、JDBC データソース、JMS 接続ファクトリー、AWS クライアントなどの自動設定に使用できます。 | true | false | MEDIUM |
camel.component.sql.usePlaceholder | SQL クエリーでプレースホルダーを使用し、すべてのプレースホルダー文字を符号に置き換えるかどうかを設定します。このオプションのデフォルトは true です | true | false | MEDIUM |
camel-sql ソースコネクターには、すぐに使用できるコンバーターはありません。
camel-sql ソースコネクターには、すぐに使える変換はありません。
camel-sql ソースコネクターには、すぐに使用できる集計ストラテジーはありません。