第 95 章 ElSQL Component
作为 Camel 版本 2.16 可用
elsql: 组件是对使用 ElSql 定义 SQL 查询的现有 SQL 组件的扩展。
此组件使用 spring-jdbc
在 scenes 后面进行实际处理。
此组件可用作 交易客户端。
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,则来自消息正文。
如果无法解析命名参数,则会抛出异常。
95.1. 选项
ElSQL 组件支持 5 选项,它们如下所列。
名称 | 描述 | 默认 | 类型 |
---|---|---|---|
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 | 布尔值 |
ElSQL 端点使用 URI 语法配置:
elsql:elsqlName:resourceUri
使用以下路径和查询参数:
95.1.1. 路径名(2 参数):
名称 | 描述 | 默认 | 类型 |
---|---|---|---|
elsqlName | 要使用的 elsql 名称( elsql 文件中是 NAMED) | 字符串 | |
resourceUri | 包含要使用的 elsql SQL 语句的资源文件。您可以用逗号分隔多个资源。默认情况下,这些资源会在类路径上加载,前缀为 file: 从文件系统加载。请注意,您可以在组件上设置这个选项,因此您不必在端点上配置此选项。 | 字符串 |
95.1.2. 查询参数(47 参数):
名称 | 描述 | 默认 | 类型 |
---|---|---|---|
allowNamedParameters (common) | 是否允许使用查询中的指定参数。 | true | 布尔值 |
databaseVendor (common) | 使用特定于供应商的 com.opengamma.elsql.ElSqlConfig | ElSqlDatabaseVendor | |
dataSource (common) | 设置用于与数据库通信的 DataSource。 | DataSource | |
dataSourceRef (common) | 弃用了 设置对 DataSource 的引用以从 registry 中查询,以用于与数据库通信。 | 字符串 | |
outputClass (common) | 指定在 outputType=SelectOne 时用作转换的完整软件包和类名称。 | 字符串 | |
outputHeader (common) | 将查询结果存储在标题中,而不是消息正文。默认情况下,输出Header == null,并且查询结果存储在消息正文中,消息正文中的所有现有内容将被丢弃。如果设置了输出Header,则值用作存储查询结果的标头名称,并保留原始消息正文。 | 字符串 | |
outputType (common) | 使消费者或制作者的输出选择列表为 Map,或者以以下方式选择为单个 Java 对象:a)如果查询仅含有单一列,则返回 JDBC Column 对象。(如 SELECT COUNT ()FROM PROJECT)将返回 Long 对象.b)如果查询有多个列,则返回 JDBC Column 对象。(如 SELECT COUNT ()FROM PROJECT)将返回 Long 对象。 然后,它会返回该 result.c 的映射。如果设置了 outputClass,它将通过将查询结果转换为 Java bean 对象,方法是调用与列名称匹配的所有 setter。It 将假定您的类具有默认构造器来创建具有默认构造器的实例。如果查询会产生多个一行,它将引发一个非唯一结果结果。It 将假定您的类具有默认构造器来创建实例。这可以与 Splitter EIP 在流化模式中一起使用,以流处理 ResultSet。 | SelectList | SqlOutputType |
separator (common) | 从消息正文中提取参数值时使用的分隔符(如果正文为 String 类型),将插入 # placeholders.Notice (如果使用命名参数),则会使用 Map 类型。默认值为 comma | , | char |
breakBatchOnConsumeFail (consumer) | 如果Consume 失败,则设置是否中断批处理。 | false | 布尔值 |
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由 Error Handler,这意味着使用者试图获取传入消息或类似信息时出现任何异常,现在将作为一个消息进行处理,并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.Exception 处理程序处理异常,该处理程序将记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
expectedUpdateCount (consumer) | 设置预期的更新数,以便在使用 onConsume 时进行验证。 | -1 | int |
maxMessagesPerPoll (consumer) | 设置要轮询的最大消息数 | int | |
onConsume (consumer) | 在处理每一行后,可以执行此查询,如果交换被成功处理,例如,将行标记为已处理。查询可以具有 参数。 | 字符串 | |
onConsumeBatchComplete (consumer) | 在处理整个批处理后,可以执行此查询以批量更新行等。查询不能有参数。 | 字符串 | |
onConsumeFailed (consumer) | 处理每行后,可以执行此查询,如果 Exchange 失败,例如要将行标记为失败。查询可以具有 参数。 | 字符串 | |
routeEmptyResultSet (consumer) | 设置是否应该允许将空 resultset 发送到下一个跃点。默认为false。因此,空 resultset 将会被过滤掉。 | false | 布尔值 |
sendEmptyMessageWhenIdle (consumer) | 如果轮询使用者没有轮询任何文件,您可以启用这个选项来发送空消息(无正文)。 | false | 布尔值 |
翻译( 消费者) | 启用或禁用事务。如果启用,如果处理交换失败,则消费者破坏处理任何进一步的交换会导致回滚。 | false | 布尔值 |
useIterator (consumer) | 设置应该如何传送给路由。表示作为列表或单个对象进行交付。默认为 true。 | true | 布尔值 |
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 在使用者处理行/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 | 布尔值 |
elSqlConfig (advanced) | 使用特定配置的 ElSqlConfig。相反,最好使用 databaseVendor 选项。 | ElSqlConfig | |
parametersCount (advanced) | 如果设置大于零,则 Camel 将使用此计数值参数来替换,而不是通过 JDBC 元数据 API 进行查询。这在 JDBC 供应商无法返回正确的参数计数时很有用,然后用户可能会覆盖。 | int | |
placeholder (advanced) | 指定在 SQL 查询中将替换为 的字符。请注意,它是 simple String.replaceAll ()操作,不涉及 SQL 解析(引号的字符串也会更改)。 | # | 字符串 |
prepareStatementStrategy (advanced) | 允许插件使用自定义 org.apache.camel.component.sql.SqlPrepareStatementStrategy 来控制对查询准备和准备的语句。 | SqlPrepareStatement Strategy | |
同步 (高级) | 设置同步处理是否应当严格使用,还是允许 Camel 使用异步处理(如果受支持)。 | false | 布尔值 |
templateOptions (advanced) | 使用 Map 中的键/值配置 Spring JdbcTemplate | map | |
usePlaceholder (advanced) | 设置是否在 SQL 查询中使用占位符和替换所有占位符字符。 | true | 布尔值 |
backoffErrorThreshold (scheduler) | 后续错误轮询(因某些错误导致的失败)的数量,在 backoffMultipler 应该启动前发生。 | int | |
backoffIdleThreshold (scheduler) | 后续闲置轮询的数量,在 backoffMultipler 应该启动之前发生。 | int | |
backoffMultiplier (scheduler) | 如果行中有多个后续闲置/errors,让调度的轮询消费者重新关闭。然后,倍数是下一次实际尝试发生前跳过的轮询数量。当使用这个选项时,还必须配置 backoffIdleThreshold 和/or backoffErrorThreshold。 | int | |
延迟 (scheduler) | 下次轮询前的毫秒。您还可以使用单位(60 秒)、5m30s (5 分钟和 30 秒)和 1h (1 小时)指定时间值。 | 500 | long |
greedy (scheduler) | 如果启用了 greedy,则 ScheduledPollConsumer 将立即再次运行,如果上一运行轮询了 1 或更多消息。 | false | 布尔值 |
initialDelay (scheduler) | 第一次轮询启动前的毫秒。您还可以使用单位(60 秒)、5m30s (5 分钟和 30 秒)和 1h (1 小时)指定时间值。 | 1000 | long |
runLoggingLevel (scheduler) | 消费者日志轮询轮询时启动/完成日志行。此选项允许您为其配置日志级别。 | TRACE | LoggingLevel |
scheduledExecutorService (scheduler) | 允许配置用于使用者的自定义/共享线程池。默认情况下,每个使用者都有自己的单个线程池。 | ScheduledExecutor 服务 | |
调度程序 (scheduler) | 使用来自 camel-spring 或 camel-quartz2 组件的 cron 调度程序 | none | ScheduledPollConsumer Scheduler |
schedulerProperties (scheduler) | 在使用自定义调度程序或任何基于 Spring 的调度程序时配置额外属性。 | map | |
startScheduler (scheduler) | 调度程序是否应自动启动。 | true | 布尔值 |
timeUnit (scheduler) | 初始延迟和延迟选项的时间单位。 | 毫秒 | TimeUnit |
useFixedDelay (scheduler) | 控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。 | true | 布尔值 |