blob: 9fe73da3524ec8e3964557d7e08647654ea886b0 [file] [log] [blame]
{"component":{"kind":"component","name":"sql-stored","title":"SQL Stored Procedure","description":"Perform SQL queries as a JDBC Stored Procedures using Spring JDBC.","deprecated":false,"firstVersion":"2.17.0","label":"database,sql","javaType":"org.apache.camel.component.sql.stored.SqlStoredComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-sql","version":"3.18.1","scheme":"sql-stored","extendsScheme":"","syntax":"sql-stored:template","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelSqlStoredTemplate":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The template","constantName":"org.apache.camel.component.sql.stored.SqlStoredConstants#SQL_STORED_TEMPLATE"},"CamelSqlStoredParameters":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Iterator","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The parameters","constantName":"org.apache.camel.component.sql.stored.SqlStoredConstants#SQL_STORED_PARAMETERS"},"CamelSqlStoredUpdateCount":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The update count","constantName":"org.apache.camel.component.sql.stored.SqlStoredConstants#SQL_STORED_UPDATE_COUNT"}},"properties":{"template":{"kind":"path","displayName":"Template","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the StoredProcedure template to perform"},"batch":{"kind":"parameter","displayName":"Batch","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Enables or disables batch mode"},"dataSource":{"kind":"parameter","displayName":"Data Source","group":"producer","label":"","required":false,"type":"object","javaType":"javax.sql.DataSource","deprecated":false,"autowired":false,"secret":false,"description":"Sets the DataSource to use to communicate with the database."},"function":{"kind":"parameter","displayName":"Function","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether this call is for a function."},"noop":{"kind":"parameter","displayName":"Noop","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If set, will ignore the results of the template and use the existing IN message as the OUT message for the continuation of processing"},"outputHeader":{"kind":"parameter","displayName":"Output Header","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Store the template result in a header instead of the message body. By default, outputHeader == null and the template 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 template result and the original message body is preserved."},"useMessageBodyForTemplate":{"kind":"parameter","displayName":"Use Message Body For Template","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to use the message body as the template and then headers for parameters. If this option is enabled then the template in the uri is not used."},"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."},"templateOptions":{"kind":"parameter","displayName":"Template Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.Object>","prefix":"template.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"Configures the Spring JdbcTemplate with the key/values from the Map"}}}