You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@iotdb.apache.org by GitBox <gi...@apache.org> on 2022/11/25 12:26:36 UTC
[GitHub] [iotdb] qiaojialin commented on a diff in pull request #8161: add mqtt broker and rest service document
qiaojialin commented on code in PR #8161:
URL: https://github.com/apache/iotdb/pull/8161#discussion_r1032406483
##########
docs/UserGuide/Reference/Common-Config-Manual.md:
##########
@@ -965,10 +965,182 @@ IoTDB common files for ConfigNode and DataNode are under `conf`.
| Default | 800 |
| Effective | After restarting system |
+
### MQTT Broker Configuration
+* enable\_mqtt\_service
+
+| Name | enable\_mqtt\_service。 |
+|:-----------:|:------------------------------------|
+| Description | Whether to enable the MQTT service |
+| Type | Boolean |
+| Default | False |
+| Effective | Trigger |
+
+* mqtt\_host
+
+| Name | mqtt\_host |
+|:-----------:|:---------------------------------------------|
+| Description | The host to which the MQTT service is bound |
+| Type | String |
+| Default | 0.0.0.0 |
+| Effective | Trigger |
+
+* mqtt\_port
+
+| Name | mqtt\_port |
+|:-----------:|:--------------------------------------------|
+| Description | The port to which the MQTT service is bound |
+| Type | int32 |
+| Default | 1883 |
+| Effective | Trigger |
+
+* mqtt\_handler\_pool\_size
+
+|Name| mqtt\_handler\_pool\_size |
+|:---:|:------------------------------------------------------------|
+|Description| The size of the handler pool used to process MQTT messages |
+|Type| int32 |
+|Default| 1 |
+|Effective| Trigger |
+
+* mqtt\_payload\_formatter
+
+| Name | mqtt\_payload\_formatter |
+|:-----------:|:-------------------------------|
+| Description | MQTT message payload formatter |
+| Type | String |
+| Default | JSON |
+| Effective | Trigger |
+
+* mqtt\_max\_message\_size
+
+| Name | mqtt\_max\_message\_size |
+|:------:|:-----------------------------------------|
+| Description | Maximum length of MQTT message in bytes |
+| Type | int32 |
+| Default | 1048576 |
+| Effective | Trigger |
+
### REST Service Configuration
+* enable_rest_service
+
+|Name| enable_rest_service |
+|:---:|:--------------------------------------|
+|Description| Whether to enable the Rest service |
+|Type| Boolean |
+|Default| false |
+|Effective| After restarting system |
+
+* rest_service_port
+
+|Name| rest_service_port |
+|:---:|:------------------|
+|Description| The Rest service listens to the port number |
+|Type| int32 |
+|Default| 18080 |
+|Effective| After restarting system |
+
+* enable_swagger
+
+|Name| enable_swagger |
+|:---:|:-----------------------|
+|Description| Whether to enable swagger to display rest interface information |
+|Type| Boolean |
+|Default| false |
+|Effective| After restarting system |
+
+* rest_query_default_row_size_limit
+
+|Name| rest_query_default_row_size_limit |
+|:---:|:------------------------------------------------------------------------------------------|
+|Description| The maximum number of rows in a result set that can be returned by a query |
+|Type| int32 |
+|Default| 10000 |
+|Effective| After restarting system |
+
+* cache_expire
+
+|Name| cache_expire |
+|:---:|:--------------------------------------------------------|
+|Description| Expiration time for caching customer login information |
+|Type| int32 |
+|Default| 28800 |
+|Effective| After restarting system |
+
+* cache_max_num
+
+|Name| cache_max_num |
+|:---:|:--------------|
+|Description| The maximum number of users stored in the cache |
+|Type| int32 |
+|Default| 100 |
+|Effective| After restarting system |
+
+* cache_init_num
+
+|Name| cache_init_num |
+|:---:|:---------------|
+|Description| Initial cache capacity |
+|Type| int32 |
+|Default| 10 |
+|Effective| After restarting system |
+
+* enable_https
Review Comment:
cache\_init\_num
##########
docs/UserGuide/Reference/Common-Config-Manual.md:
##########
@@ -965,10 +965,182 @@ IoTDB common files for ConfigNode and DataNode are under `conf`.
| Default | 800 |
| Effective | After restarting system |
+
### MQTT Broker Configuration
+* enable\_mqtt\_service
+
+| Name | enable\_mqtt\_service。 |
+|:-----------:|:------------------------------------|
+| Description | Whether to enable the MQTT service |
+| Type | Boolean |
+| Default | False |
+| Effective | Trigger |
+
+* mqtt\_host
+
+| Name | mqtt\_host |
+|:-----------:|:---------------------------------------------|
+| Description | The host to which the MQTT service is bound |
+| Type | String |
+| Default | 0.0.0.0 |
+| Effective | Trigger |
+
+* mqtt\_port
+
+| Name | mqtt\_port |
+|:-----------:|:--------------------------------------------|
+| Description | The port to which the MQTT service is bound |
+| Type | int32 |
+| Default | 1883 |
+| Effective | Trigger |
+
+* mqtt\_handler\_pool\_size
+
+|Name| mqtt\_handler\_pool\_size |
+|:---:|:------------------------------------------------------------|
+|Description| The size of the handler pool used to process MQTT messages |
+|Type| int32 |
+|Default| 1 |
+|Effective| Trigger |
+
+* mqtt\_payload\_formatter
+
+| Name | mqtt\_payload\_formatter |
+|:-----------:|:-------------------------------|
+| Description | MQTT message payload formatter |
+| Type | String |
+| Default | JSON |
+| Effective | Trigger |
+
+* mqtt\_max\_message\_size
+
+| Name | mqtt\_max\_message\_size |
+|:------:|:-----------------------------------------|
+| Description | Maximum length of MQTT message in bytes |
+| Type | int32 |
+| Default | 1048576 |
+| Effective | Trigger |
+
### REST Service Configuration
+* enable_rest_service
+
+|Name| enable_rest_service |
+|:---:|:--------------------------------------|
+|Description| Whether to enable the Rest service |
+|Type| Boolean |
+|Default| false |
+|Effective| After restarting system |
+
+* rest_service_port
+
+|Name| rest_service_port |
+|:---:|:------------------|
+|Description| The Rest service listens to the port number |
+|Type| int32 |
+|Default| 18080 |
+|Effective| After restarting system |
+
+* enable_swagger
+
+|Name| enable_swagger |
+|:---:|:-----------------------|
+|Description| Whether to enable swagger to display rest interface information |
+|Type| Boolean |
+|Default| false |
+|Effective| After restarting system |
+
+* rest_query_default_row_size_limit
+
+|Name| rest_query_default_row_size_limit |
+|:---:|:------------------------------------------------------------------------------------------|
+|Description| The maximum number of rows in a result set that can be returned by a query |
+|Type| int32 |
+|Default| 10000 |
+|Effective| After restarting system |
+
+* cache_expire
+
+|Name| cache_expire |
+|:---:|:--------------------------------------------------------|
+|Description| Expiration time for caching customer login information |
+|Type| int32 |
+|Default| 28800 |
+|Effective| After restarting system |
+
+* cache_max_num
+
+|Name| cache_max_num |
Review Comment:
```suggestion
|Name| cache\_max\_num |
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@iotdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org