blob: bb864575ae04326ae404e691c3941f3a0487d0c2 [file] [log] [blame]
{"component":{"kind":"component","name":"influxdb","title":"InfluxDB","description":"Interact with InfluxDB, a time series database.","deprecated":false,"firstVersion":"2.18.0","label":"database","javaType":"org.apache.camel.component.influxdb.InfluxDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-influxdb","version":"3.18.1","scheme":"influxdb","extendsScheme":"","syntax":"influxdb:connectionBean","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"camelInfluxDB.RetentionPolicy":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The string that defines the retention policy to the data created by the endpoint","constantName":"org.apache.camel.component.influxdb.InfluxDbConstants#RETENTION_POLICY_HEADER"},"camelInfluxDB.databaseName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the database where the time series will be stored","constantName":"org.apache.camel.component.influxdb.InfluxDbConstants#DBNAME_HEADER"},"camelInfluxDB.query":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Define the query in case of operation query","constantName":"org.apache.camel.component.influxdb.InfluxDbConstants#INFLUXDB_QUERY"}},"properties":{"connectionBean":{"kind":"path","displayName":"Connection Bean","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Connection to the influx database, of class InfluxDB.class"},"autoCreateDatabase":{"kind":"parameter","displayName":"Auto Create Database","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if we want to auto create the database if it's not present"},"batch":{"kind":"parameter","displayName":"Batch","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if this operation is a batch operation or not"},"checkDatabaseExistence":{"kind":"parameter","displayName":"Check Database Existence","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Define if we want to check the database existence while starting the endpoint"},"databaseName":{"kind":"parameter","displayName":"Database Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The name of the database where the time series will be stored"},"operation":{"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"insert","description":"Define if this operation is an insert or a query"},"query":{"kind":"parameter","displayName":"Query","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Define the query in case of operation query"},"retentionPolicy":{"kind":"parameter","displayName":"Retention Policy","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"default","description":"The string that defines the retention policy to the data created by the endpoint"},"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."}}}