提交 1985c316 编写于 作者: G gccgdb1234

docs: format using prettier

上级 dc42b92e
...@@ -10,11 +10,12 @@ taosBenchmark (曾用名 taosdemo ) 是一个用于测试 TDengine 产品性能 ...@@ -10,11 +10,12 @@ taosBenchmark (曾用名 taosdemo ) 是一个用于测试 TDengine 产品性能
taosBenchmark 支持两种配置方式:[命令行参数](#cli)[JSON 配置文件](#json) taosBenchmark 支持两种配置方式:[命令行参数](#cli)[JSON 配置文件](#json)
## 命令行参数 ## 命令行参数
下表列出了命令行参数及简要描述,详细解释请参考 [配置参数详解](#参数详解) 下表列出了命令行参数及简要描述,详细解释请参考 [配置参数详解](#参数详解)
| 选项名称 | 描述 | | 选项名称 | 描述 |
| :--------------------------------------- | --------------------------------------------------------- | | :--------------------------------------- | ------------------------------------------------------------ | --- |
| [-f/--file](#json) | 使用JSON 配置文件指定所有参数, 与命令行其他参数不能同时使用 | | [-f/--file](#json) | 使用 JSON 配置文件指定所有参数, 与命令行其他参数不能同时使用 |
| -c/--config-dir | TDengine 集群配置文件所在的目录,默认路径是 /etc/taos/ | | -c/--config-dir | TDengine 集群配置文件所在的目录,默认路径是 /etc/taos/ |
| -h/--host | 要连接 TDengine 服务端的 FQDN,默认值为 localhost。 | | -h/--host | 要连接 TDengine 服务端的 FQDN,默认值为 localhost。 |
| -P/--port | 要连接的 TDengine 服务器的端口号,默认值为 6030。 | | -P/--port | 要连接的 TDengine 服务器的端口号,默认值为 6030。 |
...@@ -142,7 +143,7 @@ taosBenchmark 支持两种配置方式:[命令行参数](#cli) 和 [JSON 配 ...@@ -142,7 +143,7 @@ taosBenchmark 支持两种配置方式:[命令行参数](#cli) 和 [JSON 配
| 组 | 选项名称 | 描述 | | 组 | 选项名称 | 描述 |
| ------------ | --------------------------------------------- | ----------------------------------------------------------------------------------------- | | ------------ | --------------------------------------------- | ----------------------------------------------------------------------------------------- |
| | filetype | 文件类型,指定哪种测试,对于插入测试,需要为 insert。 | | | filetype | 文件类型,指定哪种测试,对于插入测试,需要为 insert。 |
| | cfgdir | TDengine集群配置文件所在的目录,默认值是 /etc/taos。 | | | cfgdir | TDengine 集群配置文件所在的目录,默认值是 /etc/taos。 |
| | host | TDengine 服务端的 FQDN,默认为 localhost。 | | | host | TDengine 服务端的 FQDN,默认为 localhost。 |
| | port | TDengine 服务器的端口号,默认为 6030。 | | | port | TDengine 服务器的端口号,默认为 6030。 |
| | user | 连接 TDengine 服务端的用户名,默认为 root。 | | | user | 连接 TDengine 服务端的用户名,默认为 root。 |
...@@ -251,8 +252,8 @@ taosBenchmark 支持两种配置方式:[命令行参数](#cli) 和 [JSON 配 ...@@ -251,8 +252,8 @@ taosBenchmark 支持两种配置方式:[命令行参数](#cli) 和 [JSON 配
### 配置文件参数说明 (查询场景) ### 配置文件参数说明 (查询场景)
| 组 | 选项 | 描述 | | 组 | 选项 | 描述 |
| --------------------------------------- | ------------------------ | --------------------------------------------- | ------------ | | --------------------------------------- | ------------------------ | ------------------------------------------------------ |
| | filetype | 文件类型,指定哪种测试,对于查询测试,需要指定为query | | | filetype | 文件类型,指定哪种测试,对于查询测试,需要指定为 query |
| | cfgdir | TDengine 集群配置文件所在的目录。 | | | cfgdir | TDengine 集群配置文件所在的目录。 |
| | host | TDengine 服务端的 FQDN,默认为 localhost。 | | | host | TDengine 服务端的 FQDN,默认为 localhost。 |
| | port | TDengine 服务端的端口号,默认为 6030。 | | | port | TDengine 服务端的端口号,默认为 6030。 |
...@@ -311,7 +312,7 @@ taosBenchmark 支持两种配置方式:[命令行参数](#cli) 和 [JSON 配 ...@@ -311,7 +312,7 @@ taosBenchmark 支持两种配置方式:[命令行参数](#cli) 和 [JSON 配
### 配置文件参数说明(订阅场景) ### 配置文件参数说明(订阅场景)
| 组 | 选项 | 描述 | | 组 | 选项 | 描述 |
| --------------------------------------- | ------------------------ | ------------------------------------------ | | --------------------------------------- | ------------------------ | -------------------------------------------------------- |
| | filetype | 文件类型,指定哪种测试,对于订阅测试,需设置为 subscribe | | | filetype | 文件类型,指定哪种测试,对于订阅测试,需设置为 subscribe |
| | cfgdir | TDengine 集群配置文件的目录。 | | | cfgdir | TDengine 集群配置文件的目录。 |
| | host | TDengine 服务端的 FQDN,默认为 localhost。 | | | host | TDengine 服务端的 FQDN,默认为 localhost。 |
...@@ -333,145 +334,145 @@ taosBenchmark 支持两种配置方式:[命令行参数](#cli) 和 [JSON 配 ...@@ -333,145 +334,145 @@ taosBenchmark 支持两种配置方式:[命令行参数](#cli) 和 [JSON 配
### insert mode ### insert mode
可选项有 taosc, rest, stmt, sml, sml-rest, 分别对应 直接调用 libtao.so 提供的普通写入、restful 接口写入、参数绑定接口写入、schemaless 接口写入、以及taosAdapte 的 schemaless 接口写入 可选项有 taosc, rest, stmt, sml, sml-rest, 分别对应 直接调用 libtao.so 提供的普通写入、restful 接口写入、参数绑定接口写入、schemaless 接口写入、以及 taosAdapte 的 schemaless 接口写入
### insert interval ### insert interval
只有当[interlace rows](#interlace-rows)大于 0 时才起作用。 只有当[interlace rows](#interlace-rows)大于 0 时才起作用。
意味着数据插入线程在为每个子表插入隔行扫描记录后,会等待该值指定的时间间隔后再进行下一轮写入。 意味着数据插入线程在为每个子表插入隔行扫描记录后,会等待该值指定的时间间隔后再进行下一轮写入。
### partial col num ### partial col num
若该值为正数 n 时, 则仅向前 n 列写入,仅当 [insert_mode](#insert-mode) 为 taosc 和 rest 时生效,如果 n 为 0 则是向全部列写入。 若该值为正数 n 时, 则仅向前 n 列写入,仅当 [insert_mode](#insert-mode) 为 taosc 和 rest 时生效,如果 n 为 0 则是向全部列写入。
### batch create tbl num ### batch create tbl num
创建子表时每批次的建表数量,默认为 10。 创建子表时每批次的建表数量,默认为 10。
注:实际的批数不一定与该值相同,当执行的 SQL 语句大于支持的最大长度时,会自动截断再执行,继续创建。 注:实际的批数不一定与该值相同,当执行的 SQL 语句大于支持的最大长度时,会自动截断再执行,继续创建。
### auto create table ### auto create table
仅当 [insert_mode](#insert-mode) 为 taosc, rest, stmt 并且 childtable_exists 为 "no" 时生效,该参数为 "yes" 表示 taosdump 在插入数据时会自动创建不存在的表;为 "no" 则表示要插入的表必须提前创建好。 仅当 [insert_mode](#insert-mode) 为 taosc, rest, stmt 并且 childtable_exists 为 "no" 时生效,该参数为 "yes" 表示 taosdump 在插入数据时会自动创建不存在的表;为 "no" 则表示要插入的表必须提前创建好。
### interlace rows ### interlace rows
如果它的值为 0,意味着逐个子表逐个子表插入,直到上一张子表的数据插入全部完成才会开始插入下一张子表的数据。如果它的值为正数 n,将首先插入 n 条记录到第一张子表,然后插入 n 条记录到第二张子表,依此类推,在为最后一张子表插入了 n 条记录后会回到第一张子表重复这个过程,直到所有子表数据插入完成。 如果它的值为 0,意味着逐个子表逐个子表插入,直到上一张子表的数据插入全部完成才会开始插入下一张子表的数据。如果它的值为正数 n,将首先插入 n 条记录到第一张子表,然后插入 n 条记录到第二张子表,依此类推,在为最后一张子表插入了 n 条记录后会回到第一张子表重复这个过程,直到所有子表数据插入完成。
### record per request ### record per request
每次请求插入的数据行数,也即 batch size,当其设置过大时,TDegnine 客户端驱动会返回相应的错误信息,此时需要调低这个参数的设置以满足写入要求。 每次请求插入的数据行数,也即 batch size,当其设置过大时,TDegnine 客户端驱动会返回相应的错误信息,此时需要调低这个参数的设置以满足写入要求。
### columns ### columns
指定总的普通列的数量。如果同时设置了该参数和[-b/--data-type](#data-type),则最后的结果列数为两者取大。如果 columns 指定的数量大于 [-b/--data-type](#data-type) 指定的列数,则未指定的列类型默认为 INT, 例如: `-l 5 -b float,double`, 那么最后的列为 `FLOAT,DOUBLE,INT,INT,INT`。如果 columns 指定的数量小于或等于 [-b/--data-type](#data-type) 指定的列数,则结果为 [-b/--data-type](#data-type) 指定的列和类型,例如: `-l 3 -b float,double,float,bigint`,那么最后的列为 `FLOAT,DOUBLE,FLOAT,BIGINT` 指定总的普通列的数量。如果同时设置了该参数和[-b/--data-type](#data-type),则最后的结果列数为两者取大。如果 columns 指定的数量大于 [-b/--data-type](#data-type) 指定的列数,则未指定的列类型默认为 INT, 例如: `-l 5 -b float,double`, 那么最后的列为 `FLOAT,DOUBLE,INT,INT,INT`。如果 columns 指定的数量小于或等于 [-b/--data-type](#data-type) 指定的列数,则结果为 [-b/--data-type](#data-type) 指定的列和类型,例如: `-l 3 -b float,double,float,bigint`,那么最后的列为 `FLOAT,DOUBLE,FLOAT,BIGINT`
### tag type ### tag type
设置超级表的标签类型,nchar 和 binary 类型可以同时设置长度,例如: 设置超级表的标签类型,nchar 和 binary 类型可以同时设置长度,例如:
``` ```
taosBenchmark -A INT,DOUBLE,NCHAR,BINARY(16) taosBenchmark -A INT,DOUBLE,NCHAR,BINARY(16)
``` ```
如果没有设置标签类型,默认是两个标签,其类型分别为 INT 和 BINARY(16)。 如果没有设置标签类型,默认是两个标签,其类型分别为 INT 和 BINARY(16)。
注意:在有的 shell 比如 bash 命令里面 “()” 需要转义,则上述指令应为: 注意:在有的 shell 比如 bash 命令里面 “()” 需要转义,则上述指令应为:
``` ```
taosBenchmark -A INT,DOUBLE,NCHAR,BINARY\(16\) taosBenchmark -A INT,DOUBLE,NCHAR,BINARY\(16\)
``` ```
### data type ### data type
指定普通列类型,如果不使用则默认为有三个普通列,其类型分别为 FLOAT, INT, FLOAT。 指定普通列类型,如果不使用则默认为有三个普通列,其类型分别为 FLOAT, INT, FLOAT。
### random ### random
若配置次参数,则随机生成要插入的数据。对于数值类型的 标签列/数据列,其值为该类型取值范围内的随机值。对于 NCHAR 和 BINARY 类型的 标签列/数据列,其值为指定长度范围内的随机字符串。 若配置次参数,则随机生成要插入的数据。对于数值类型的 标签列/数据列,其值为该类型取值范围内的随机值。对于 NCHAR 和 BINARY 类型的 标签列/数据列,其值为指定长度范围内的随机字符串。
### disorder ratio ### disorder ratio
随机乱序时间戳的百分比,最大为 50,即为 50%。随机乱序时间戳为当前应插入数据的时间戳倒退随机乱序范围[disorder-range](#disorder-range)范围内的时间戳。 随机乱序时间戳的百分比,最大为 50,即为 50%。随机乱序时间戳为当前应插入数据的时间戳倒退随机乱序范围[disorder-range](#disorder-range)范围内的时间戳。
### disorder range ### disorder range
随机乱序时间戳的回退范围,只有当[-O/--disorder](#disorder-ratio)大于 0 时才有效,单位与数据库的时间精度相同。 随机乱序时间戳的回退范围,只有当[-O/--disorder](#disorder-ratio)大于 0 时才有效,单位与数据库的时间精度相同。
### prepared rand ### prepared rand
作为数据源预先生成的随机数据的数量,小的 prepare_rand 作为数据源预先生成的随机数据的数量,小的 prepare_rand
会节省内存,但会减少数据种类。若为 1,则生成的所有同类型的数据相同。 会节省内存,但会减少数据种类。若为 1,则生成的所有同类型的数据相同。
### connection pool size ### connection pool size
该配置决定 taosBenchmark 预先建立的与 TDengine 服务端之间的连接的数量。若不配置,则与所指定的线程数相同。 该配置决定 taosBenchmark 预先建立的与 TDengine 服务端之间的连接的数量。若不配置,则与所指定的线程数相同。
### data source ### data source
数据的来源,默认为 taosBenchmark 随机产生,可以配置为 sample,即为使用 sample_file 参数指定的文件内的数据。 数据的来源,默认为 taosBenchmark 随机产生,可以配置为 sample,即为使用 sample_file 参数指定的文件内的数据。
### line protocol ### line protocol
使用行协议插入数据,仅当 [insert_mode](#insert-mode) 为 sml 或 sml-rest 时生效,可选项为 line, telnet, json。 使用行协议插入数据,仅当 [insert_mode](#insert-mode) 为 sml 或 sml-rest 时生效,可选项为 line, telnet, json。
### non stop mode ### non stop mode
指定是否持续写入,若为 "yes" 则 insert_rows 失效,直到 Ctrl + C 停止程序,写入才会停止。默认值为 "no" 指定是否持续写入,若为 "yes" 则 insert_rows 失效,直到 Ctrl + C 停止程序,写入才会停止。默认值为 "no"
注:即使在持续写入模式下 insert_rows 失效,但其也必须被配置为一个非零正整数。 注:即使在持续写入模式下 insert_rows 失效,但其也必须被配置为一个非零正整数。
### tcp transfer ### tcp transfer
telnet 模式下的通信协议,仅当 [insert_mode](#insert-mode) 为 sml-rest 并且 [line_protocol](#line-protocol) 为 telnet 时生效。如果不配置,则默认为 http 协议。 telnet 模式下的通信协议,仅当 [insert_mode](#insert-mode) 为 sml-rest 并且 [line_protocol](#line-protocol) 为 telnet 时生效。如果不配置,则默认为 http 协议。
### normal table ### normal table
仅当 [insert_mode](#insert-mode) 为 taosc, stmt, rest 模式下可以使用,若指定则不创建超级表,只创建普通表。 仅当 [insert_mode](#insert-mode) 为 taosc, stmt, rest 模式下可以使用,若指定则不创建超级表,只创建普通表。
### childtable limit ### childtable limit
仅当 childtable_exists 为 yes 时生效,指定从超级表获取子表列表的上限。 仅当 childtable_exists 为 yes 时生效,指定从超级表获取子表列表的上限。
### childtable offset ### childtable offset
仅当 childtable_exists 为 yes 时生效,指定从超级表获取子表列表时的偏移量,即从第几个子表开始。 仅当 childtable_exists 为 yes 时生效,指定从超级表获取子表列表时的偏移量,即从第几个子表开始。
### sample file ### sample file
指定 csv 格式的文件作为数据源,仅当 data_source 为 sample 时生效。 指定 csv 格式的文件作为数据源,仅当 data_source 为 sample 时生效。
若 csv 文件内的数据行数小于等于 prepared_rand,那么会循环读取 csv 文件数据直到与 prepared_rand 相同;否则则会只读取 prepared_rand 个数的行的数据。也即最终生成的数据行数为二者取小。 若 csv 文件内的数据行数小于等于 prepared_rand,那么会循环读取 csv 文件数据直到与 prepared_rand 相同;否则则会只读取 prepared_rand 个数的行的数据。也即最终生成的数据行数为二者取小。
### use sample ts ### use sample ts
仅当 data_source 为 sample 时生效,表示 sample_file 指定的 csv 文件内是否包含第一列时间戳,默认为 no。 若设置为 yes, 则使用 csv 文件第一列作为时间戳,由于同一子表时间戳不能重复,生成的数据量取决于 csv 文件内的数据行数相同,此时 insert_rows 失效。 仅当 data_source 为 sample 时生效,表示 sample_file 指定的 csv 文件内是否包含第一列时间戳,默认为 no。 若设置为 yes, 则使用 csv 文件第一列作为时间戳,由于同一子表时间戳不能重复,生成的数据量取决于 csv 文件内的数据行数相同,此时 insert_rows 失效。
### tags file ### tags file
仅当 [insert_mode](#insert-mode) 为 taosc, rest 的模式下生效。 仅当 [insert_mode](#insert-mode) 为 taosc, rest 的模式下生效。
最终的 tag 的数值与 childtable_count 有关,如果 csv 文件内的 tag 数据行小于给定的子表数量,那么会循环读取 csv 文件数据直到生成 childtable_count 指定的子表数量;否则则只会读取 childtable_count 行 tag 数据。也即最终生成的子表数量为二者取小。 最终的 tag 的数值与 childtable_count 有关,如果 csv 文件内的 tag 数据行小于给定的子表数量,那么会循环读取 csv 文件数据直到生成 childtable_count 指定的子表数量;否则则只会读取 childtable_count 行 tag 数据。也即最终生成的子表数量为二者取小。
### type ### type
可选值请参考 [TDengine 支持的数据类型](reference/taos-sql/data-type) 可选值请参考 [TDengine 支持的数据类型](reference/taos-sql/data-type)
注:JSON 数据类型比较特殊,只能用于标签,当使用 JSON 类型作为 tag 时有且只能有这一个标签,此时 [count](#count)[len](#len) 代表的意义分别是 JSON tag 内的 key-value pair 的个数和每个 KV pair 的 value 的值的长度,value 默认为 string。 注:JSON 数据类型比较特殊,只能用于标签,当使用 JSON 类型作为 tag 时有且只能有这一个标签,此时 [count](#count)[len](#len) 代表的意义分别是 JSON tag 内的 key-value pair 的个数和每个 KV pair 的 value 的值的长度,value 默认为 string。
### count ### count
指定该类型列连续出现的数量,例如 `"count": 4096` 即可生成 4096 个指定类型的列。 指定该类型列连续出现的数量,例如 `"count": 4096` 即可生成 4096 个指定类型的列。
### len ### len
指定该数据类型的长度,对 NCHAR,BINARY 和 JSON 数据类型有效。如果对其他数据类型配置了该参数,若为 0 , 则代表该列始终都是以 null 值写入;如果不为 0 则被忽略。 指定该数据类型的长度,对 NCHAR,BINARY 和 JSON 数据类型有效。如果对其他数据类型配置了该参数,若为 0 , 则代表该列始终都是以 null 值写入;如果不为 0 则被忽略。
### name ### name
列的名字,若与 count 同时使用,比如 `"name":"current", "count":3`, 则 3 个列的名字分别为 current, current_2. current_3 列的名字,若与 count 同时使用,比如 `"name":"current", "count":3`, 则 3 个列的名字分别为 current, current_2. current_3
### sql ### sql
对于超级表的查询 SQL,在 SQL 命令中保留 "xxxx",程序会自动将其替换为超级表的所有子表名。 对于超级表的查询 SQL,在 SQL 命令中保留 "xxxx",程序会自动将其替换为超级表的所有子表名。
替换为超级表中所有的子表名。 替换为超级表中所有的子表名。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册