Interface JdbcEndpointBuilderFactory.JdbcEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- JdbcEndpointBuilderFactory
public static interface JdbcEndpointBuilderFactory.JdbcEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the JDBC component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default JdbcEndpointBuilderFactory.AdvancedJdbcEndpointBuilder
advanced()
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
allowNamedParameters(boolean allowNamedParameters)
Whether to allow using named parameters in the queries.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
allowNamedParameters(String allowNamedParameters)
Whether to allow using named parameters in the queries.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
outputClass(String outputClass)
Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
outputType(String outputType)
Determines the output the producer should use.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
outputType(org.apache.camel.component.jdbc.JdbcOutputType outputType)
Determines the output the producer should use.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
parameters(String key, Object value)
Optional parameters to the java.sql.Statement.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
parameters(Map values)
Optional parameters to the java.sql.Statement.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
readSize(int readSize)
The default maximum number of rows that can be read by a polling query.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
readSize(String readSize)
The default maximum number of rows that can be read by a polling query.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
resetAutoCommit(boolean resetAutoCommit)
Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
resetAutoCommit(String resetAutoCommit)
Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
transacted(boolean transacted)
Whether transactions are in use.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
transacted(String transacted)
Whether transactions are in use.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
useGetBytesForBlob(boolean useGetBytesForBlob)
To read BLOB columns as bytes instead of string data.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
useGetBytesForBlob(String useGetBytesForBlob)
To read BLOB columns as bytes instead of string data.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
useHeadersAsParameters(boolean useHeadersAsParameters)
Set this option to true to use the prepareStatementStrategy with named parameters.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
useHeadersAsParameters(String useHeadersAsParameters)
Set this option to true to use the prepareStatementStrategy with named parameters.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
useJDBC4ColumnNameAndLabelSemantics(boolean useJDBC4ColumnNameAndLabelSemantics)
Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name.default JdbcEndpointBuilderFactory.JdbcEndpointBuilder
useJDBC4ColumnNameAndLabelSemantics(String useJDBC4ColumnNameAndLabelSemantics)
Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name.
-
-
-
Method Detail
-
advanced
default JdbcEndpointBuilderFactory.AdvancedJdbcEndpointBuilder advanced()
-
allowNamedParameters
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder allowNamedParameters(boolean allowNamedParameters)
Whether to allow using named parameters in the queries. The option is a: <code>boolean</code> type. Default: true Group: producer- Parameters:
allowNamedParameters
- the value to set- Returns:
- the dsl builder
-
allowNamedParameters
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder 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: producer- Parameters:
allowNamedParameters
- the value to set- Returns:
- the dsl builder
-
outputClass
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder outputClass(String outputClass)
Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
outputClass
- the value to set- Returns:
- the dsl builder
-
outputType
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder outputType(org.apache.camel.component.jdbc.JdbcOutputType outputType)
Determines the output the producer should use. The option is a: <code>org.apache.camel.component.jdbc.JdbcOutputType</code> type. Default: SelectList Group: producer- Parameters:
outputType
- the value to set- Returns:
- the dsl builder
-
outputType
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder outputType(String outputType)
Determines the output the producer should use. The option will be converted to a <code>org.apache.camel.component.jdbc.JdbcOutputType</code> type. Default: SelectList Group: producer- Parameters:
outputType
- the value to set- Returns:
- the dsl builder
-
parameters
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder parameters(String key, Object value)
Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: producer- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
parameters
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder parameters(Map values)
Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: producer- Parameters:
values
- the values- Returns:
- the dsl builder
-
readSize
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder readSize(int readSize)
The default maximum number of rows that can be read by a polling query. The default value is 0. The option is a: <code>int</code> type. Group: producer- Parameters:
readSize
- the value to set- Returns:
- the dsl builder
-
readSize
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder readSize(String readSize)
The default maximum number of rows that can be read by a polling query. The default value is 0. The option will be converted to a <code>int</code> type. Group: producer- Parameters:
readSize
- the value to set- Returns:
- the dsl builder
-
resetAutoCommit
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder resetAutoCommit(boolean resetAutoCommit)
Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag, you can set the resetAutoCommit flag to be false, and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx. The option is a: <code>boolean</code> type. Default: true Group: producer- Parameters:
resetAutoCommit
- the value to set- Returns:
- the dsl builder
-
resetAutoCommit
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder resetAutoCommit(String resetAutoCommit)
Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag, you can set the resetAutoCommit flag to be false, and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx. The option will be converted to a <code>boolean</code> type. Default: true Group: producer- Parameters:
resetAutoCommit
- the value to set- Returns:
- the dsl builder
-
transacted
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder transacted(boolean transacted)
Whether transactions are in use. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
transacted
- the value to set- Returns:
- the dsl builder
-
transacted
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder transacted(String transacted)
Whether transactions are in use. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
transacted
- the value to set- Returns:
- the dsl builder
-
useGetBytesForBlob
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useGetBytesForBlob(boolean useGetBytesForBlob)
To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
useGetBytesForBlob
- the value to set- Returns:
- the dsl builder
-
useGetBytesForBlob
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useGetBytesForBlob(String useGetBytesForBlob)
To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
useGetBytesForBlob
- the value to set- Returns:
- the dsl builder
-
useHeadersAsParameters
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useHeadersAsParameters(boolean useHeadersAsParameters)
Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders, and use headers with the dynamic values for the query placeholders. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
useHeadersAsParameters
- the value to set- Returns:
- the dsl builder
-
useHeadersAsParameters
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useHeadersAsParameters(String useHeadersAsParameters)
Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders, and use headers with the dynamic values for the query placeholders. The option will be converted to a <code>boolean</code> type. Default: false Group: producer- Parameters:
useHeadersAsParameters
- the value to set- Returns:
- the dsl builder
-
useJDBC4ColumnNameAndLabelSemantics
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useJDBC4ColumnNameAndLabelSemantics(boolean useJDBC4ColumnNameAndLabelSemantics)
Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true. The option is a: <code>boolean</code> type. Default: true Group: producer- Parameters:
useJDBC4ColumnNameAndLabelSemantics
- the value to set- Returns:
- the dsl builder
-
useJDBC4ColumnNameAndLabelSemantics
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useJDBC4ColumnNameAndLabelSemantics(String useJDBC4ColumnNameAndLabelSemantics)
Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true. The option will be converted to a <code>boolean</code> type. Default: true Group: producer- Parameters:
useJDBC4ColumnNameAndLabelSemantics
- the value to set- Returns:
- the dsl builder
-
-