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