Package org.apache.camel.builder.endpoint.dsl

Interface SqlEndpointBuilderFactory.SqlEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder, SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Enclosing interface:

SqlEndpointBuilderFactory

public static interface SqlEndpointBuilderFactory.SqlEndpointBuilder
extends SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder, SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Builder for endpoint for the SQL component.

Method Summary

Modifier and Type	Method	Description
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	advanced()
default SqlEndpointBuilderFactory.SqlEndpointBuilder	allowNamedParameters(boolean allowNamedParameters)	Whether to allow using named parameters in the queries.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	allowNamedParameters(String allowNamedParameters)	Whether to allow using named parameters in the queries.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	dataSource(Object dataSource)	Sets the DataSource to use to communicate with the database at endpoint level.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	dataSource(String dataSource)	Sets the DataSource to use to communicate with the database at endpoint level.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	outputClass(String outputClass)	Specify the full package and class name to use as conversion when outputType=SelectOne.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	outputHeader(String outputHeader)	Store the query result in a header instead of the message body.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	outputType(String outputType)	Make the output of consumer or producer to SelectList as List of Map, or SelectOne as single Java object in the following way: a) If the query has only single column, then that JDBC Column object is returned.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	outputType(SqlEndpointBuilderFactory.SqlOutputType outputType)	Make the output of consumer or producer to SelectList as List of Map, or SelectOne as single Java object in the following way: a) If the query has only single column, then that JDBC Column object is returned.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	separator(char separator)	The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	separator(String separator)	The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, breakBatchOnConsumeFail, breakBatchOnConsumeFail, bridgeErrorHandler, bridgeErrorHandler, delay, delay, expectedUpdateCount, expectedUpdateCount, greedy, greedy, initialDelay, initialDelay, maxMessagesPerPoll, maxMessagesPerPoll, onConsume, onConsumeBatchComplete, onConsumeFailed, repeatCount, repeatCount, routeEmptyResultSet, routeEmptyResultSet, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, transacted, transacted, useFixedDelay, useFixedDelay, useIterator, useIterator

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

batch, batch, lazyStartProducer, lazyStartProducer, noop, noop, useMessageBodyForSql, useMessageBodyForSql

Method Detail

advanced

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder advanced()

Specified by:

advanced in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

advanced in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

allowNamedParameters

default SqlEndpointBuilderFactory.SqlEndpointBuilder allowNamedParameters(boolean allowNamedParameters)

Whether to allow using named parameters in the queries. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

allowNamedParameters in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

allowNamedParameters in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

allowNamedParameters - the value to set

Returns:

the dsl builder

allowNamedParameters

default SqlEndpointBuilderFactory.SqlEndpointBuilder allowNamedParameters(String allowNamedParameters)

Whether to allow using named parameters in the queries. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

allowNamedParameters in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

allowNamedParameters in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

allowNamedParameters - the value to set

Returns:

the dsl builder

dataSource

default SqlEndpointBuilderFactory.SqlEndpointBuilder dataSource(Object dataSource)

Sets the DataSource to use to communicate with the database at endpoint level. The option is a: <code>javax.sql.DataSource</code> type. Group: common

Specified by:

dataSource in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

dataSource in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

dataSource - the value to set

Returns:

the dsl builder

dataSource

default SqlEndpointBuilderFactory.SqlEndpointBuilder dataSource(String dataSource)

Sets the DataSource to use to communicate with the database at endpoint level. The option will be converted to a <code>javax.sql.DataSource</code> type. Group: common

Specified by:

dataSource in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

dataSource in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

dataSource - the value to set

Returns:

the dsl builder

outputClass

default SqlEndpointBuilderFactory.SqlEndpointBuilder outputClass(String outputClass)

Specify the full package and class name to use as conversion when outputType=SelectOne. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

outputClass in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

outputClass in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

outputClass - the value to set

Returns:

the dsl builder

outputHeader

default SqlEndpointBuilderFactory.SqlEndpointBuilder outputHeader(String outputHeader)

Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

outputHeader in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

outputHeader in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

outputHeader - the value to set

Returns:

the dsl builder

outputType

default SqlEndpointBuilderFactory.SqlEndpointBuilder outputType(SqlEndpointBuilderFactory.SqlOutputType outputType)

Make the output of consumer or producer to SelectList as List of Map, or SelectOne as single Java object in the following way: a) If the query has only single column, then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column, then it will return a Map of that result. c) If the outputClass is set, then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows, it throws an non-unique result exception. StreamList streams the result of the query using an Iterator. This can be used with the Splitter EIP in streaming mode to process the ResultSet in streaming fashion. The option is a: <code>org.apache.camel.component.sql.SqlOutputType</code> type. Default: SelectList Group: common

Specified by:

outputType in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

outputType in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

outputType - the value to set

Returns:

the dsl builder

outputType

default SqlEndpointBuilderFactory.SqlEndpointBuilder outputType(String outputType)

Make the output of consumer or producer to SelectList as List of Map, or SelectOne as single Java object in the following way: a) If the query has only single column, then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column, then it will return a Map of that result. c) If the outputClass is set, then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows, it throws an non-unique result exception. StreamList streams the result of the query using an Iterator. This can be used with the Splitter EIP in streaming mode to process the ResultSet in streaming fashion. The option will be converted to a <code>org.apache.camel.component.sql.SqlOutputType</code> type. Default: SelectList Group: common

Specified by:

outputType in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

outputType in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

outputType - the value to set

Returns:

the dsl builder

separator

default SqlEndpointBuilderFactory.SqlEndpointBuilder separator(char separator)

The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders. Notice if you use named parameters, then a Map type is used instead. The default value is comma. The option is a: <code>char</code> type. Default: , Group: common

Specified by:

separator in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

separator in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

separator - the value to set

Returns:

the dsl builder

separator

default SqlEndpointBuilderFactory.SqlEndpointBuilder separator(String separator)

The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders. Notice if you use named parameters, then a Map type is used instead. The default value is comma. The option will be converted to a <code>char</code> type. Default: , Group: common

Specified by:

separator in interface SqlEndpointBuilderFactory.SqlEndpointConsumerBuilder

Specified by:

separator in interface SqlEndpointBuilderFactory.SqlEndpointProducerBuilder

Parameters:

separator - the value to set

Returns:

the dsl builder