update doc
This commit is contained in:
yihaoDeng
parent
b695541ff6
commit
0ad2de4269
|
|
@ -29,14 +29,23 @@ After modifying configuration file parameters, it is necessary to restart the *t
|
|||
|
||||
### Connection Related
|
||||
|
||||
| Parameter Name | Parameter Description |
|
||||
| :--------------------- | :----------------------------------------------------------- |
|
||||
| firstEp | The endpoint of the first dnode in the cluster to connect to when taosd starts; default value: localhost:6030 |
|
||||
| secondEp | If firstEp cannot connect, attempt to connect to the second dnode's endpoint in the cluster; default value: none |
|
||||
| fqdn | The service address that taosd listens on after startup; default value: the first hostname configured on the server |
|
||||
| serverPort | The port that taosd listens on after startup; default value: 6030 |
|
||||
| numOfRpcSessions | The maximum number of connections a client can create; range: 100-100000; default value: 30000 |
|
||||
| timeToGetAvailableConn | The maximum wait time to obtain an available connection; range: 10-50000000; unit: milliseconds; default value: 500000 |
|
||||
| Parameter Name | support version | Parameter Description |
|
||||
| :--------------------- |:---------------| :----------------------------------------------------------- |
|
||||
| firstEp | | The endpoint of the first dnode in the cluster to connect to when taosd starts; default value: localhost:6030 |
|
||||
| secondEp | | If firstEp cannot connect, attempt to connect to the second dnode's endpoint in the cluster; default value: none |
|
||||
| fqdn | | The service address that taosd listens on after startup; default value: the first hostname configured on the server |
|
||||
| compressMsgSize | | Whether to compress RPC messages; -1: no messages are compressed; 0: all messages are compressed; N (N>0): only messages larger than N bytes are compressed; default value: -1 |
|
||||
| shellActivityTimer | | The duration in seconds for the client to send heartbeats to the mnode; range: 1-120; default value: 3 |
|
||||
| numOfRpcSessions | | The maximum number of RPC connections supported; range: 100-100000; default value: 30000 |
|
||||
| numOfRpcThreads | | The number of threads for RPC data transmission; range: 1-50, default value: half of the CPU cores |
|
||||
| numOfTaskQueueThreads | | The number of threads for the client to process RPC messages, range: 4-16, default value: half of the CPU cores |
|
||||
| rpcQueueMemoryAllowed | | The maximum amount of memory allowed for RPC messages received on a dnode; unit: bytes; range: 104857600-INT64_MAX; default value: 1/10 of server memory |
|
||||
| resolveFQDNRetryTime | Removed in 3.x | The number of retries when FQDN resolution fails |
|
||||
| timeToGetAvailableConn | Removed in 3.3.4.x | The maximum waiting time to obtain an available connection; range: 10-50000000; unit: milliseconds; default value: 500000 |
|
||||
| maxShellConns | Removed in 3.x | The maximum number of connections allowed to be created |
|
||||
| maxRetryWaitTime | | The maximum timeout for reconnection; default value: 10s |
|
||||
| shareConnLimit | Added in 3.3.4.0 | The number of requests that a connection can share; range: 1-512; default value: 10 |
|
||||
| readTimeout | Added in 3.3.4.0 | The minimum timeout for a single request; range: 64-604800; unit: seconds; default value: 900 |
|
||||
|
||||
### Monitoring Related
|
||||
|
||||
|
|
|
|||
|
|
@ -39,6 +39,10 @@ The TDengine client driver provides all the APIs needed for application programm
|
|||
| enableScience | Whether to enable scientific notation for floating-point numbers; 0: disable, 1: enable; default value: 1 |
|
||||
| compressMsgSize | Whether to compress RPC messages; -1: do not compress any messages; 0: compress all messages; N (N>0): compress only messages larger than N bytes; default value: -1 |
|
||||
| queryTableNotExistAsEmpty | Whether to return an empty result set when the queried table does not exist; false: return an error; true: return an empty result set; default value: false |
|
||||
| numOfRpcThreads | The number of threads for RPC data transmission; range: 1-50, default value: half of the CPU cores |
|
||||
| numOfTaskQueueThreads | The number of threads for the client to process RPC messages, range: 4-16, default value: half of the CPU cores |
|
||||
| shareConnLimit | The number of requests that a connection can share; range: 1-512; default value: 10 |
|
||||
| readTimeout | The minimum timeout for a single request; range: 64-604800; unit: seconds; default value: 900 |
|
||||
|
||||
## API
|
||||
|
||||
|
|
|
|||
|
|
@ -27,24 +27,23 @@ taosd 命令行参数如下
|
|||
|
||||
### 连接相关
|
||||
|参数名称|支持版本|参数含义|
|
||||
|-----------------------|----------|-|
|
||||
|firstEp | |taosd 启动时，主动连接的集群中首个 dnode 的 end point，默认值 localhost:6030|
|
||||
|secondEp | |taosd 启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint，无默认值|
|
||||
|fqdn | |taosd 监听的服务地址，默认为所在服务器上配置的第一个 hostname|
|
||||
|serverPort | |taosd 监听的端口，默认值 6030|
|
||||
|compressMsgSize | |是否对 RPC 消息进行压缩；-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩；默认值 -1|
|
||||
|shellActivityTimer | |客户端向 mnode 发送心跳的时长，单位为秒，取值范围 1-120，默认值 3|
|
||||
|numOfRpcSessions | |RPC 支持的最大连接数，取值范围 100-100000，默认值 30000|
|
||||
|numOfRpcThreads | |RPC 线程数目，默认值为 CPU 核数的一半|
|
||||
|numOfTaskQueueThreads | |dnode 处理 RPC 消息的线程数|
|
||||
|statusInterval | |dnode 与 mnode 之间的心跳间隔|
|
||||
|rpcQueueMemoryAllowed | |dnode 允许的 rpc 消息占用的内存最大值，单位 bytes，取值范围 104857600-INT64_MAX，默认值 服务器内存的 1/10 |
|
||||
|resolveFQDNRetryTime | |FQDN 解析失败时的重试次数|
|
||||
|timeToGetAvailableConn | |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，默认值 500000|
|
||||
|maxShellConns | |允许创建的最大链接数|
|
||||
|maxRetryWaitTime | |重连最大超时时间|
|
||||
|shareConnLimit |3.3.4.3 后|内部参数，一个链接可以共享的查询数目，取值范围 1-256，默认值 10|
|
||||
|readTimeout |3.3.4.3 后|内部参数，最小超时时间，取值范围 64-604800，单位为秒，默认值 900|
|
||||
|-----------------------|-------------------------|------------|
|
||||
|firstEp | |taosd 启动时，主动连接的集群中首个 dnode 的 end point，默认值 localhost:6030|
|
||||
|secondEp | |taosd 启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint，无默认值|
|
||||
|fqdn | |taosd 监听的服务地址，默认为所在服务器上配置的第一个 hostname|
|
||||
|serverPort | |taosd 监听的端口，默认值 6030|
|
||||
|compressMsgSize | |是否对 RPC 消息进行压缩；-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩；默认值 -1|
|
||||
|shellActivityTimer | |客户端向 mnode 发送心跳的时长，单位为秒，取值范围 1-120，默认值 3 |
|
||||
|numOfRpcSessions | |RPC 支持的最大连接数，取值范围 100-100000，默认值 30000|
|
||||
|numOfRpcThreads | |RPC 收发数据线程数目，默认值为 CPU 核数的一半|
|
||||
|numOfTaskQueueThreads | |客户端处理 RPC 消息的线程数|
|
||||
|rpcQueueMemoryAllowed | |dnode允许的已经收到的RPC消息占用的内存最大值，单位 bytes，取值范围 104857600-INT64_MAX，默认值为服务器内存的 1/10 |
|
||||
|resolveFQDNRetryTime | 3.x 之后取消 |FQDN 解析失败时的重试次数|
|
||||
|timeToGetAvailableConn | 3.3.4.x之后取消 |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，默认值 500000|
|
||||
|maxShellConns | 3.x 后取消 |允许创建的最大链接数|
|
||||
|maxRetryWaitTime | |重连最大超时时间, 默认值是 10s|
|
||||
|shareConnLimit |3.3.4.x 后|一个链接可以共享的请求的数目，取值范围 1-512，默认值 10|
|
||||
|readTimeout |3.3.4.x 后|单个请求最小超时时间，取值范围 64-604800，单位为秒，默认值 900|
|
||||
|
||||
### 监控相关
|
||||
|参数名称|支持版本|参数含义|
|
||||
|
|
|
|||
|
|
@ -10,17 +10,18 @@ TDengine 客户端驱动提供了应用编程所需要的全部 API，并且在
|
|||
|
||||
### 连接相关
|
||||
|参数名称|支持版本|参数含义|
|
||||
|----------------------|----------|-|
|
||||
|firstEp | |启动时，主动连接的集群中首个 dnode 的 endpoint，缺省值：hostname:6030，若无法获取该服务器的 hostname，则赋值为 localhost|
|
||||
|secondEp | |启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint，没有缺省值|
|
||||
|compressMsgSize | |是否对 RPC 消息进行压缩；-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩；缺省值 -1|
|
||||
|shellActivityTimer | |客户端向 mnode 发送心跳的时长，单位为秒，取值范围 1-120，默认值 3|
|
||||
|numOfRpcSessions | |RPC 支持的最大连接数，取值范围 100-100000，缺省值 30000|
|
||||
|numOfRpcThreads | |RPC 线程数目，默认值为 CPU 核数的一半|
|
||||
|timeToGetAvailableConn| |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，缺省值 500000|
|
||||
|----------------------|----------|-------------|
|
||||
|firstEp | |启动时，主动连接的集群中首个 dnode 的 endpoint，缺省值：hostname:6030，若无法获取该服务器的 hostname，则赋值为 localhost|
|
||||
|secondEp | |启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint，没有缺省值|
|
||||
|compressMsgSize | |是否对 RPC 消息进行压缩；-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩；缺省值 -1|
|
||||
|shellActivityTimer | |客户端向 mnode 发送心跳的时长，单位为秒，取值范围 1-120，默认值 3|
|
||||
|numOfRpcSessions | |RPC 支持的最大连接数，取值范围 100-100000，缺省值 30000|
|
||||
|numOfRpcThreads | |RPC 收发数据线程数目，默认值为 CPU 核数的一半|
|
||||
|numOfTaskQueueThreads | |客户端处理 RPC消息的线程数|
|
||||
|timeToGetAvailableConn| 3.3.4.*之后取消 |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，缺省值 500000|
|
||||
|useAdapter | |内部参数，是否使用 taosadapter，影响 CSV 文件导入|
|
||||
|shareConnLimit |3.3.4.3 后|内部参数，一个链接可以共享的查询数目，取值范围 1-256，默认值 10|
|
||||
|readTimeout |3.3.4.3 后|内部参数，最小超时时间，取值范围 64-604800，单位为秒，默认值 900|
|
||||
|shareConnLimit |3.3.4.x 后|内部参数，一个链接可以共享的查询数目，取值范围 1-256，默认值 10|
|
||||
|readTimeout |3.3.4.x 后|内部参数，最小超时时间，取值范围 64-604800，单位为秒，默认值 900|
|
||||
|
||||
### 查询相关
|
||||
|参数名称|支持版本|参数含义|
|
||||
|
|
|
|||
Loading…
Reference in New Issue