第 96 章 ElSQL Component
从 Camel 版本 2.16 开始提供
elsql: 组件是现有 SQL 组件的扩展,使用 ElSql 定义 SQL 查询。
此组件在后台使用 spring-jdbc
进行实际的 SQL 处理。
此组件可用作 事务客户端。
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: 如果 简单 表达式,来自消息正文。
- 如果来自消息标头的 'java.util.Map'3.
如果无法解析指定参数,则抛出异常。
96.1. 选项
ElSQL 组件支持 5 个选项,如下所列。
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
databaseVendor (common) | 使用特定于供应商的 com.opengamma.elsql.ElSqlConfig | ElSqlDatabaseVendor | |
DataSource (common) | 设置 DataSource 用于与数据库通信。 | DataSource | |
elSqlConfig (advanced) | 使用特定的配置的 ElSqlConfig。最好使用 databaseVendor 选项。 | ElSqlConfig | |
resourceUri (common) | 包含要使用的 elsql SQL 语句的资源文件。您可以指定用逗号分开的多个资源。默认情况下,资源在 classpath 上载入,您可以使用 file: 前缀来从文件系统中加载。请注意,您可以在组件上设置这个选项,然后您不必在端点上配置这个选项。 | 字符串 | |
resolveProperty Placeholders (advanced) | 组件是否应在启动时解析属性占位符。只有 String 类型的属性可以使用属性占位符。 | true | 布尔值 |
ElSQL 端点使用 URI 语法进行配置:
elsql:elsqlName:resourceUri
使用以下路径和查询参数:
96.1.1. 路径参数(2 参数):
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
elsqlName | 必需 要使用的 elsql 的名称(elsql 文件中的 NAMED) | 字符串 | |
resourceUri | 包含要使用的 elsql SQL 语句的资源文件。您可以指定用逗号分开的多个资源。默认情况下,资源在 classpath 上载入,您可以使用 file: 前缀来从文件系统中加载。请注意,您可以在组件上设置这个选项,然后您不必在端点上配置这个选项。 | 字符串 |
96.1.2. 查询参数(47 参数):
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
allowNamedParameters (common) | 是否允许在查询中使用命名参数。 | true | 布尔值 |
databaseVendor (common) | 使用特定于供应商的 com.opengamma.elsql.ElSqlConfig | ElSqlDatabaseVendor | |
DataSource (common) | 设置 DataSource 用于与数据库通信。 | DataSource | |
dataSourceRef (common) | 弃用 将引用设置为从 registry 中查询的 DataSource,以用于与数据库通信。 | 字符串 | |
outputClass (common) | 指定在 outputType=SelectOne 时使用的完整软件包和类名称。 | 字符串 | |
outputHeader (common) | 将查询结果存储在标头中而不是消息正文。默认情况下,outputHeader == null,查询结果存储在消息正文中,消息正文中的任何现有内容都会被丢弃。如果设置了 outputHeader,则值将用作标头名称来存储查询结果,并保留原始消息正文。 | 字符串 | |
outputType (common) | 将使用者或制作者的输出设置为 SelectList 作为 Map 列表,或者选择One 作为单个 Java 对象:a)如果查询只有一个列,则返回 JDBC Column 对象。(如 SELECT COUNT ()FROM PROJECT 将会返回 Long object.b)如果查询具有多个列,则它将返回该结果的映射。然后,它将调用与列名称匹配的所有集合将查询结果转换为 Java bean 对象。It 将假定您的类具有默认的构造器来创建实例 with.d)。如果查询导致多个行,它会抛出一个非唯一结果异常。StreamList 会处理使用 Iterator 的查询结果的结果。这可与流模式的 Splitter EIP 一起使用,以流传输方式处理 ResultSet。 | SelectList | SqlOutputType |
分隔符 (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) | 处理每行后,可以执行此查询,如果 Exchange 成功处理,例如将行标记为已处理。查询可以有参数。 | 字符串 | |
onConsumeBatchComplete (consumer) | 处理整个批处理后,可以执行此查询以批量更新行等。查询不能有参数。 | 字符串 | |
onConsumeFailed (consumer) | 处理每行后,可以执行此查询,如果 Exchange 失败,例如将行标记为失败。查询可以有参数。 | 字符串 | |
routeEmptyResultSet (consumer) | 设置是否允许空 resultset 发送到下一跃点。默认为false。因此,空结果集将被过滤掉。 | false | 布尔值 |
sendEmptyMessageWhenIdle (consumer) | 如果轮询使用者没有轮询任何文件,您可以启用此选项来发送空消息(无正文)。 | false | 布尔值 |
transacted (consumer) | 启用或禁用事务。如果启用,如果处理交换失败,则消费者破坏了任何进一步交换的处理,从而导致回滚。 | false | 布尔值 |
useIterator (consumer) | 设置如何将 resultset 传送到 route。将交付表示为列表或单个对象。默认为 true。 | true | 布尔值 |
ExceptionHandler ( consumer) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。 | ExceptionHandler | |
exchangePattern (consumer) | 在消费者创建交换时设置交换模式。 | ExchangePattern | |
pollStrategy (consumer) | 可插拔 org.apache.camel.PollingConsumerPollingStrategy 允许您提供自定义实施来控制在轮询操作期间通常会发生错误处理,然后再创建交换并在 Camel 中路由。 | PollingConsumerPoll Strategy | |
processingStrategy (consumer) | 当消费者处理 rows/batch 时,允许插件使用自定义 org.apache.camel.component.sql.SqlProcessingStrategy 执行查询。 | 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 查询的消息正文/标题。 | false | 布尔值 |
elSqlConfig (advanced) | 使用特定的配置的 ElSqlConfig。最好使用 databaseVendor 选项。 | ElSqlConfig | |
parametersCount (advanced) | 如果设置大于零,则 Camel 将使用此计数的参数值替换,而不是通过 JDBC 元数据 API 查询。如果 JDBC 供应商无法返回正确的参数数,则这非常有用,用户可能会改为覆盖。 | int | |
占位符 (高级) | 指定在 SQL 查询中替换到的字符。请注意,它只是一个简单的 String.replaceAll ()操作,且不会涉及 SQL 解析(加引号的字符串也会改变)。 | # | 字符串 |
prepareStatementStrategy (advanced) | 允许插件使用自定义 org.apache.camel.component.sql.SqlPrepareStatementStrategy 来控制查询和准备语句的准备。 | SqlPrepareStatement 策略 | |
同步 (高级) | 设置是否应严格使用同步处理,还是允许 Camel 使用异步处理(如果支持)。 | false | 布尔值 |
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) | 下一次轮询前的时间(毫秒)。您还可以使用单位来指定时间值,如 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 | 布尔值 |