Package org.apache.camel.component.sql

Class SqlComponent

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultComponent
org.apache.camel.support.HealthCheckComponent
org.apache.camel.component.sql.SqlComponent
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@Component("sql") public class SqlComponent extends org.apache.camel.support.HealthCheckComponent
The SQL Component is for working with databases using JDBC queries.

  • Field Summary

    Fields inherited from class org.apache.camel.support.service.BaseService

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

    Constructors
    Constructor
    Description
    SqlComponent()
     
    SqlComponent(Class<? extends org.apache.camel.Endpoint> endpointClass)
     
    SqlComponent(org.apache.camel.CamelContext context)
     
    SqlComponent(org.apache.camel.CamelContext context, Class<? extends org.apache.camel.Endpoint> endpointClass)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.apache.camel.Endpoint
    createEndpoint(String uri, String remaining, Map<String,Object> parameters)
     
    DataSource
    getDataSource()
     
    int
    getFetchSize()
     
    RowMapperFactory
    getRowMapperFactory()
     
    boolean
    isBatchAutoCommitDisabled()
     
    boolean
    isServiceLocationEnabled()
     
    boolean
    isUsePlaceholder()
     
    void
    setBatchAutoCommitDisabled(boolean batchAutoCommitDisabled)
    Whether to optimize batch by turning off auto-commit which can dramatic improve performance, and instead execute as a manual commit after the entire batch operation is complete
    void
    setDataSource(DataSource dataSource)
    Sets the DataSource to use to communicate with the database.
    void
    setFetchSize(int fetchSize)
    Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet objects generated by this Statement.
    void
    setRowMapperFactory(RowMapperFactory rowMapperFactory)
    Factory for creating RowMapper
    void
    setServiceLocationEnabled(boolean serviceLocationEnabled)
    Whether to detect the network address location of the JMS broker on startup.
    void
    setUsePlaceholder(boolean usePlaceholder)
    Sets whether to use placeholder and replace all placeholder characters with ?

    Methods inherited from class org.apache.camel.support.HealthCheckComponent

    isHealthCheckConsumerEnabled, isHealthCheckProducerEnabled, setHealthCheckConsumerEnabled, setHealthCheckProducerEnabled

    Methods inherited from class org.apache.camel.support.DefaultComponent

    afterConfiguration, createEndpoint, createEndpoint, doBuild, doInit, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Constructor Details

    • SqlComponent

      public SqlComponent()

    • SqlComponent

      public SqlComponent(Class<? extends org.apache.camel.Endpoint> endpointClass)

    • SqlComponent

      public SqlComponent(org.apache.camel.CamelContext context)

    • SqlComponent

      public SqlComponent(org.apache.camel.CamelContext context, Class<? extends org.apache.camel.Endpoint> endpointClass)

  • Method Details

    • createEndpoint

      protected org.apache.camel.Endpoint createEndpoint(String uri, String remaining, Map<String,Object> parameters) throws Exception
      Specified by:
      createEndpoint in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception

    • setDataSource

      public void setDataSource(DataSource dataSource)
      Sets the DataSource to use to communicate with the database.

    • getDataSource

      public DataSource getDataSource()

    • setUsePlaceholder

      public void setUsePlaceholder(boolean usePlaceholder)
      Sets whether to use placeholder and replace all placeholder characters with ? sign in the SQL queries.

      This option is default true

    • isUsePlaceholder

      public boolean isUsePlaceholder()

    • getRowMapperFactory

      public RowMapperFactory getRowMapperFactory()

    • setRowMapperFactory

      public void setRowMapperFactory(RowMapperFactory rowMapperFactory)
      Factory for creating RowMapper

    • isServiceLocationEnabled

      public boolean isServiceLocationEnabled()

    • setServiceLocationEnabled

      public void setServiceLocationEnabled(boolean serviceLocationEnabled)
      Whether to detect the network address location of the JMS broker on startup. This information is gathered via reflection on the ConnectionFactory, and is vendor specific. This option can be used to turn this off.

    • isBatchAutoCommitDisabled

      public boolean isBatchAutoCommitDisabled()

    • setBatchAutoCommitDisabled

      public void setBatchAutoCommitDisabled(boolean batchAutoCommitDisabled)
      Whether to optimize batch by turning off auto-commit which can dramatic improve performance, and instead execute as a manual commit after the entire batch operation is complete

    • getFetchSize

      public int getFetchSize()

    • setFetchSize

      public void setFetchSize(int fetchSize)
      Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet objects generated by this Statement. If the value specified is zero, then the hint is ignored. The default value is zero. This is important for processing large result sets: Setting this higher than the default value will increase processing speed at the cost of memory consumption; setting this lower can avoid transferring row data that will never be read by the application.