326.2. 选项
SQL 组件支持 3 个选项,如下所列。
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
dataSource (common) | 设置 DataSource 用于与数据库通信。 | DataSource | |
usePlaceholder (advanced) | 设置是否使用占位符,并将所有占位符字符替换为 SQL 查询中的符号。这个选项默认为 true | true | 布尔值 |
resolveProperty Placeholders (advanced) | 启动时组件是否应解析自身上的属性占位符。只有属于 String 类型的属性才能使用属性占位符。 | true | 布尔值 |
SQL 端点使用 URI 语法进行配置:
sql:query
使用以下路径和查询参数:
326.2.1. 路径参数(1 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
query | 必需 设置要执行的 SQL 查询。您可以使用 file: 或 classpath: 作为前缀来外部化查询,并指定文件的位置。 | 字符串 |
326.2.2. 查询参数(45 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
allowNamedParameters (common) | 是否在查询中使用命名参数。 | true | 布尔值 |
dataSource (common) | 设置 DataSource 用于与数据库通信。 | DataSource | |
dataSourceRef (common) | 弃用 设置对从 registry 中查找的 DataSource 的引用,以用于与数据库通信。 | 字符串 | |
outputClass (common) | 指定在 outputType=SelectOne 或 SelectList 时用作转换的完整软件包和类名称。 | 字符串 | |
outputHeader (common) | 将查询结果存储在标头中,而不是消息正文。默认情况下,outputHeader == null,查询结果存储在消息正文中,消息正文中的任何现有内容都会被丢弃。如果设置了 outputHeader,则该值将用作标头的名称,以存储查询结果,并保留原始消息正文。 | 字符串 | |
outputType (common) | 将消费者或制作者的输出设置为 SelectList 作为 Map 列表,或选择以以下方式使用单个 Java 对象:a)如果查询只有一个列,则返回 JDBC Column 对象。(如 SELECT COUNT ()FROM PROJECT)将返回 Long 对象。如果查询有多个列,则它将返回该结果的 Map。c)如果设置了 outputClass,则输出为: 然后,它将通过调用与列名称匹配的所有 setters 将查询结果转换为 Java bean 对象。它将假设您的类具有默认的构造器来创建实例。d)如果查询导致多个行,它会抛出一个非唯一结果异常。 | SelectList | SqlOutputType |
separator (common) | 从消息正文获取参数值时使用的分隔符(如果正文是 String 类型),以在 # 占位符插入。注意如果您使用命名参数,则改为使用 Map 类型。默认值为 comma。 | , | char |
breakBatchOnConsumeFail (consumer) | 如果 onConsume 失败,则设置是否中断批处理。 | false | 布尔值 |
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
expectedUpdateCount (consumer) | 在使用 onConsume 时,设置要验证的预期更新数。 | -1 | int |
maxMessagesPerPoll (consumer) | 设置要轮询的最大消息数 | int | |
onConsume (consumer) | 在处理完每行后,可以执行此查询,如果交换成功处理,例如将行标记为已处理。查询可以具有参数。 | 字符串 | |
onConsumeBatchComplete (consumer) | 处理整个批处理后,可以执行此查询来批量更新行等。查询不能有参数。 | 字符串 | |
onConsumeFailed (consumer) | 在处理完每行后,可以执行此查询,如果 Exchange 失败,例如,将行标记为失败。查询可以具有参数。 | 字符串 | |
routeEmptyResultSet (consumer) | 设置是否应该允许将空结果集发送到下一个跃点。默认为false。因此,空结果集会被过滤掉。 | false | 布尔值 |
sendEmptyMessageWhenIdle (consumer) | 如果轮询使用者没有轮询任何文件,您可以启用此选项来发送空消息(无正文)。 | false | 布尔值 |
transacted (consumer) | 启用或禁用事务。如果启用,如果处理交换失败,则消费者中断处理任何进一步的交换,从而导致回滚 eager | false | 布尔值 |
useIterator (consumer) | 设置结果集应如何传送到路由。将 delivery 表示作为列表或单个对象。默认为 true。 | true | 布尔值 |
exceptionHandler (consumer) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。 | ExceptionHandler | |
exchangePattern (consumer) | 在消费者创建交换时设置交换模式。 | ExchangePattern | |
pollStrategy (consumer) | 可插拔 org.apache.camel.PollingConsumerPollingStrategy 允许您提供自定义实施来控制在轮询操作期间通常会发生错误处理,然后再创建交换并在 Camel 中路由。 | PollingConsumerPoll Strategy | |
processingStrategy (consumer) | 允许插件使用自定义 org.apache.camel.component.sql.SqlProcessingStrategy 在消费者处理 rows/batch 时执行查询。 | SqlProcessingStrategy | |
batch (producer) | 启用或禁用批处理模式 | false | 布尔值 |
noop (producer) | 如果设置,将忽略 SQL 查询的结果,并使用现有的 IN 消息作为处理持续的 OUT 消息 | false | 布尔值 |
useMessageBodyForSql (producer) | 是否使用消息正文作为 SQL,然后对参数进行标头。如果启用了这个选项,则不会使用 uri 中的 SQL。 | false | 布尔值 |
alwaysPopulateStatement (advanced) | 如果启用,则来自 org.apache.camel.component.sql.SqlPrepareStatementStrategy 的 populateStatement 方法总是被调用,如果没有预期的参数可以被准备。当这是 false 时,只有在要设置 1 个或更多预期参数时才会调用 populateStatement;例如,这样可避免读取没有参数的 SQL 查询的消息正文/headers。 | false | 布尔值 |
parametersCount (advanced) | 如果设置大于零,则 Camel 将使用此 count 值来替换,而不是通过 JDBC 元数据 API 进行查询。如果 JDBC 供应商无法返回正确的参数数,则这很有用,然后用户可能会覆盖。 | int | |
占位符 (advanced) | 指定将在 SQL 查询中替换的字符。请注意,它是简单的 String.replaceAll ()操作,且不会涉及 SQL 解析(加引号的字符串也会更改)。 | # | 字符串 |
prepareStatementStrategy (advanced) | 允许插件使用自定义 org.apache.camel.component.sql.SqlPrepareStatementStrategy 来控制查询和 prepared 语句的准备。 | SqlPrepareStatement Strategy | |
同步 (advanced) | 设置是否应严格使用同步处理,或者 Camel 允许使用异步处理(如果受支持)。 | false | 布尔值 |
templateOptions (advanced) | 使用 Map 中的键/值配置 Spring JdbcTemplate | Map | |
usePlaceholder (advanced) | 设置是否使用占位符,并将所有占位符字符替换为 SQL 查询中的符号。这个选项默认为 true | true | 布尔值 |
backoffErrorThreshold (scheduler) | 在 backoffMultipler 应该 kick-in 之前发生的后续错误轮询(因为某些错误)的数量。 | int | |
backoffIdleThreshold (scheduler) | 在 backoffMultipler 应该 kick-in 之前应该发生的后续空闲轮询数量。 | int | |
backoffMultiplier (scheduler) | 如果一行中有很多后续空闲/errors,则让调度的轮询消费者避退。然后,倍数是在下一次实际尝试再次发生前跳过的轮询数量。当使用这个选项时,还必须配置 backoffIdleThreshold 和/或 backoffErrorThreshold。 | int | |
delay (scheduler) | 下一次轮询前的时间(毫秒)。您还可以使用单位来指定时间值,如 60s (60 秒)、5m30s (5 分钟和 30 秒)和 1h (1 小时)。 | 500 | long |
greedy (scheduler) | 如果启用了 greedy,如果上一个运行轮询 1 或更多消息,则 ScheduledPollConsumer 将立即运行。 | false | 布尔值 |
initialDelay (scheduler) | 第一次轮询开始前的毫秒。您还可以使用单位来指定时间值,如 60s (60 秒)、5m30s (5 分钟和 30 秒)和 1h (1 小时)。 | 1000 | long |
runLoggingLevel (scheduler) | 消费者在轮询时记录 start/complete log 行。这个选项允许您为其配置日志级别。 | TRACE | LoggingLevel |
scheduledExecutorService (scheduler) | 允许配置用于消费者的自定义/共享线程池。默认情况下,每个使用者都有自己的单线程线程池。 | ScheduledExecutor Service | |
scheduler (scheduler) | 使用 camel-spring 或 camel-quartz2 组件的 cron 调度程序 | none | ScheduledPollConsumer Scheduler |
schedulerProperties (scheduler) | 在使用自定义调度程序或任何基于 Spring 的调度程序时配置附加属性。 | Map | |
startScheduler (scheduler) | 调度程序是否应自动启动。 | true | 布尔值 |
timeUnit (scheduler) | initialDelay 和 delay 选项的时间单位。 | MILLISECONDS | TimeUnit |
useFixedDelay (scheduler) | 控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。 | true | 布尔值 |