emqx_bridge_hstreamdb.hocon 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. emqx_bridge_hstreamdb {
  2. config_direction.desc:
  3. """The direction of this bridge, MUST be 'egress'"""
  4. config_direction.label:
  5. """Bridge Direction"""
  6. desc_config.desc:
  7. """Configuration for an HStreamDB action."""
  8. desc_config.label:
  9. """HStreamDB Action Configuration"""
  10. desc_connector.desc:
  11. """Generic configuration for the connector."""
  12. desc_connector.label:
  13. """Connector Generic Configuration"""
  14. desc_name.desc:
  15. """Action name, a human-readable identifier."""
  16. desc_name.label:
  17. """Action Name"""
  18. desc_type.desc:
  19. """The type of the action."""
  20. desc_type.label:
  21. """Action Type"""
  22. local_topic.desc:
  23. """The MQTT topic filter to be forwarded to the HStreamDB. All MQTT 'PUBLISH' messages with the topic
  24. matching the local_topic will be forwarded.<br/>
  25. NOTE: If this action is used as the action of a rule (EMQX rule engine), and also local_topic is
  26. configured, then both the data got from the rule and the MQTT messages that match local_topic
  27. will be forwarded."""
  28. local_topic.label:
  29. """Local Topic"""
  30. record_template.desc:
  31. """The HStream Record template to be forwarded to the HStreamDB. Placeholders supported.<br>
  32. NOTE: When you use `raw record` template (which means the data is not a valid JSON), you should use `read` or `subscription` in HStream to get the data."""
  33. record_template.label:
  34. """HStream Record"""
  35. action_parameters.desc:
  36. """Action specific configuration."""
  37. action_parameters.label:
  38. """Action"""
  39. grpc_flush_timeout.desc:
  40. """Time interval for flushing gRPC calls to the HStreamDB server."""
  41. grpc_flush_timeout.label:
  42. """gRPC Flush Interval"""
  43. aggregation_pool_size.desc:
  44. """The size of the record aggregation pool. A larger aggregation pool size can lead to enhanced parallelization but may also result in reduced efficiency due to smaller batch sizes."""
  45. aggregation_pool_size.label:
  46. """Aggregation Pool Size"""
  47. max_batches.desc:
  48. """Maximum number of unconfirmed batches in the flush queue."""
  49. max_batches.label:
  50. """Max Batches"""
  51. writer_pool_size.desc:
  52. """The size of the writer pool. A larger pool may increase parallelization and concurrent write operations, potentially boosting throughput. Trade-offs include greater memory consumption and possible resource contention."""
  53. writer_pool_size.label:
  54. """Writer Pool Size"""
  55. batch_size.desc:
  56. """Maximum number of insert data clauses that can be sent in a single request."""
  57. batch_size.label:
  58. """Max Batch Append Count"""
  59. batch_interval.desc:
  60. """Maximum interval that is allowed between two successive (batch) request."""
  61. batch_interval.label:
  62. """Max Batch Interval"""
  63. hstreamdb_action.desc:
  64. """Configuration for HStreamDB action."""
  65. hstreamdb_action.label:
  66. """HStreamDB Action Configuration"""
  67. config_connector.desc:
  68. """Configuration for an HStreamDB connector."""
  69. config_connector.label:
  70. """HStreamDB Connector Configuration"""
  71. }