{"component":{"kind":"component","name":"mybatis","title":"MyBatis","description":"Performs a query, poll, insert, update or delete in a relational database using MyBatis.","deprecated":false,"firstVersion":"2.7.0","label":"database,sql","javaType":"org.apache.camel.component.mybatis.MyBatisComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-mybatis","version":"3.18.1","scheme":"mybatis","extendsScheme":"","syntax":"mybatis:statement","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelMyBatisResult":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The response returned from MtBatis in any of the operations. For instance an INSERT could return the auto-generated key, or number of rows etc.","constantName":"org.apache.camel.component.mybatis.MyBatisConstants#MYBATIS_RESULT"},"CamelMyBatisStatementName":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The statementName used (for example: insertAccount).","constantName":"org.apache.camel.component.mybatis.MyBatisConstants#MYBATIS_STATEMENT_NAME"}},"properties":{"statement":{"kind":"path","displayName":"Statement","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The statement name in the MyBatis XML mapping file which maps to the query, insert, update or delete operation you wish to evaluate."},"maxMessagesPerPoll":{"kind":"parameter","displayName":"Max Messages Per Poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it."},"onConsume":{"kind":"parameter","displayName":"On Consume","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Statement to run after data has been processed in the route"},"routeEmptyResultSet":{"kind":"parameter","displayName":"Route Empty Result Set","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether allow empty resultset to be routed to the next hop"},"sendEmptyMessageWhenIdle":{"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"transacted":{"kind":"parameter","displayName":"Transacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables transaction. If enabled then if processing an exchange failed then the consumer breaks out processing any further exchanges to cause a rollback eager."},"useIterator":{"kind":"parameter","displayName":"Use Iterator","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Process resultset individually or as a list"},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."},"processingStrategy":{"kind":"parameter","displayName":"Processing Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.component.mybatis.MyBatisProcessingStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom MyBatisProcessingStrategy"},"executorType":{"kind":"parameter","displayName":"Executor Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.ibatis.session.ExecutorType","enum":["SIMPLE","REUSE","BATCH"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIMPLE","description":"The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates."},"inputHeader":{"kind":"parameter","displayName":"Input Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"User the header value for input parameters instead of the message body. By default, inputHeader == null and the input parameters are taken from the message body. If outputHeader is set, the value is used and query parameters will be taken from the header instead of the body."},"outputHeader":{"kind":"parameter","displayName":"Output Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"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. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time."},"statementType":{"kind":"parameter","displayName":"Statement Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.mybatis.StatementType","enum":["SelectOne","SelectList","Insert","InsertList","Update","UpdateList","Delete","DeleteList"],"deprecated":false,"autowired":false,"secret":false,"description":"Mandatory to specify for the producer to control which kind of operation to invoke."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."},"backoffErrorThreshold":{"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."},"delay":{"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."},"runLoggingLevel":{"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."},"scheduler":{"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.Object>","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."}}}