Skip to content

T
TDengine

taosdata / TDengine
1 年多 前同步成功

通知 1185
Star 22016
Fork 4786
T
TDengine
未验证 提交 b0824d55 编写于 作者: sangshuduo's avatar sangshuduo 提交者： GitHub
浏览文件
操作

[TD-11980]<docs>: update taosdemo cmdline options (#10788) 

* [TD-11980]<docs>: refine taosdemo docs

* fix param list

* refine param list

* Update docs.md

* fix taosdemo markdown

* use JSON instead of meta

* add CSV format description

* [TD-11980]<docs>: update taosdemo command line list
Co-authored-by: Nwu champion <cpwu@taosdata.com>
上级 239412c0
隐藏空白更改
内联 并排
Showing with 130 addition and 72 deletion
documentation20/cn/02.getting-started/02.taosdemo/docs.md
浏览文件 @ b0824d55
...@@ -153,41 +153,70 @@ insert delay, avg: 8.31ms, max: 860.12ms, min: 2.00ms ...@@ -153,41 +153,70 @@ insert delay, avg: 8.31ms, max: 860.12ms, min: 2.00ms
``` ```
$ taosBenchmark --help $ taosBenchmark --help
-f, --file=FILE The JSON configuration file to the execution procedure. Currently, we support standard UTF-8 (without BOM) encoded files only. Usage: taosBenchmark [OPTION...]
-u, --user=USER The user name to use when connecting to the server.
-p, --password The password to use when connecting to the server. -f, --file=FILE (**IMPORTANT**) Set JSON configuration file(all
-c, --config-dir=CONFIG_DIR Configuration directory. options are going to read from this JSON file),
-h, --host=HOST TDengine server FQDN to connect. The default host is localhost. which is mutually exclusive with other commandline
-P, --port=PORT The TCP/IP port number to use for the connection. options
-I, --interface=INTERFACE The interface (taosc, rest, and stmt) taosBenchmark uses. By default use 'taosc'. -a, --replia=NUMBER The number of replica when create database,
-d, --database=DATABASE Destination database. By default is 'test'. default is 1.
-a, --replica=REPLICA Set the replica parameters of the database, By default use 1, min: 1, max: 3. -A, --tag-type=TAG_TYPE Data type of tables' tags, default is
-m, --table-prefix=TABLEPREFIX Table prefix name. By default use 'd'. INT,BINARY(16).
-s, --sql-file=FILE The select SQL file. -b, --data-type=COL_TYPE Data type of tables' cols, default is
-N, --normal-table Use normal table flag. FLOAT,INT,FLOAT.
-o, --output=FILE Direct output to the named file. By default use './output.txt'. -B, --interlace-rows=NUMBER The number of interlace rows insert into
-q, --query-mode=MODE Query mode -- 0: SYNC, 1: ASYNC. By default use SYNC. tables, default is 0
-b, --data-type=DATATYPE The data_type of columns, By default use: FLOAT, INT, FLOAT. -c, --config-dir=CONFIG_DIR Configuration directory.
-w, --binwidth=WIDTH The width of data_type 'BINARY' or 'NCHAR'. By default use 64 -C, --chinese Nchar and binary are basic unicode chinese
-l, --columns=COLUMNS The number of columns per record. Demo mode by default is 1 (float, int, float). Max values is 4095 characters, optional.
All of the new column(s) type is INT. If use -b to specify column type, -l will be ignored. -d, --database=DATABASE Name of database, default is test.
-T, --threads=NUMBER The number of threads. By default use 8. -E, --escape-character Use escape character in stable and child table
-i, --insert-interval=NUMBER The sleep time (ms) between insertion. By default is 0. name, optional.
-S, --time-step=TIME_STEP The timestamp step between insertion. By default is 1. -F, --prepared_rand=NUMBER Random data source size, default is 10000.
-B, --interlace-rows=NUMBER The interlace rows of insertion. By default is 0. -g, --debug Debug mode, optional.
-r, --rec-per-req=NUMBER The number of records per request. By default is 30000. -G, --performance Performance mode, optional.
-t, --tables=NUMBER The number of tables. By default is 10000. -h, --host=HOST TDengine server FQDN to connect, default is
-n, --records=NUMBER The number of records per table. By default is 10000. localhost.
-M, --random The value of records generated are totally random. -i, --insert-interval=NUMBER Insert interval for interlace mode in
By default to simulate power equipment scenario. milliseconds, default is 0.
-x, --aggr-func Test aggregation functions after insertion. -I, --interface=IFACE insert mode, default is taosc, options:
-y, --answer-yes Input yes for prompt. taosc|rest|stmt|sml
-O, --disorder=NUMBER Insert order mode--0: In order, 1 ~ 50: disorder ratio. By default is in order. -l, --columns=NUMBER Number of INT data type columns in table, default
-R, --disorder-range=NUMBER Out of order data's range. Unit is ms. By default is 1000. is 0.
-g, --debug Print debug info. -m, --table-prefix=TABLE_PREFIX
-?, --help Give this help list Prefix of child table name, default is d.
--usage Give a short usage message -M, --random Data source is randomly generated, optional.
-V, --version Print program version. -n, --records=NUMBER Number of records for each table, default is
10000.
-N, --normal-table Only create normal table without super table,
optional.
-o, --output=FILE The path of result output file, default is
./output.txt.
-O, --disorder=NUMBER Ratio of inserting data with disorder timestamp,
default is 0.
-p, --password=PASSWORD The password to use when connecting to the server,
default is taosdata.
-P, --port=PORT The TCP/IP port number to use for the connection,
default is 6030.
-r, --rec-per-req=NUMBER Number of records in each insert request, default
is 30000.
-R, --disorder-range=NUMBER Range of disordered timestamp, default is 1000.
-S, --time-step=NUMBER Timestamp step in milliseconds, default is 1.
-t, --tables=NUMBER Number of child tables, default is 10000.
-T, --threads=NUMBER The number of thread when insert data, default is
8.
-u, --user=USER The user name to use when connecting to the
server, default is root.
-w, --binwidth=NUMBER The default length of nchar and binary if not
specified, default is 64.
-x, --aggr-func Query aggregation function after insertion,
optional.
-y, --answer-yes Pass confirmation prompt to continue, optional.
-?, --help Give this help list
--usage Give a short usage message
-V, --version Print program version
Mandatory or optional arguments to long options are also mandatory or optional Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options. for any corresponding short options.
...@@ -198,7 +227,7 @@ Report bugs to <support@taosdata.com>. ...@@ -198,7 +227,7 @@ Report bugs to <support@taosdata.com>.
taosBenchmark 的参数是为了满足数据模拟的需求来设计的。下面介绍几个常用的参数： taosBenchmark 的参数是为了满足数据模拟的需求来设计的。下面介绍几个常用的参数：
``` ```
-I, --interface=INTERFACE The interface (taosc, rest, and stmt) taosBenchmark uses. Default is 'taosc'. -I, --interface=IFACE The interface (taosc, rest, and stmt) taosBenchmark uses. Default is 'taosc'.
``` ```
前面介绍 taosBenchmark 不同接口的性能差异已经提到， -I 参数为选择不同的接口，目前支持 taosc、stmt 和 rest 几种。其中 taosc 为使用 SQL 语句方式进行数据写入；stmt 为使用参数绑定接口进行数据写入；rest 为使用 RESTful 协议进行数据写入。 前面介绍 taosBenchmark 不同接口的性能差异已经提到， -I 参数为选择不同的接口，目前支持 taosc、stmt 和 rest 几种。其中 taosc 为使用 SQL 语句方式进行数据写入；stmt 为使用参数绑定接口进行数据写入；rest 为使用 RESTful 协议进行数据写入。
......
documentation20/en/02.getting-started/02.taosdemo/docs.md
浏览文件 @ b0824d55
...@@ -160,41 +160,70 @@ The complete list of taosBenchmark command-line arguments can be displayed via t ...@@ -160,41 +160,70 @@ The complete list of taosBenchmark command-line arguments can be displayed via t
``` ```
$ taosBenchmark --help $ taosBenchmark --help
-f, --file=FILE The JSON configuration file to the execution procedure. Currently, we support standard UTF-8 (without BOM) encoded files only. Usage: taosBenchmark [OPTION...]
-u, --user=USER The user name to use when connecting to the server.
-p, --password The password to use when connecting to the server. -f, --file=FILE (**IMPORTANT**) Set JSON configuration file(all
-c, --config-dir=CONFIG_DIR Configuration directory. options are going to read from this JSON file),
-h, --host=HOST TDengine server FQDN to connect. The default host is localhost. which is mutually exclusive with other commandline
-P, --port=PORT The TCP/IP port number to use for the connection. options
-I, --interface=INTERFACE The interface (taosc, rest, and stmt) taosBenchmark uses. By default use 'taosc'. -a, --replia=NUMBER The number of replica when create database,
-d, --database=DATABASE Destination database. By default is 'test'. default is 1.
-a, --replica=REPLICA Set the replica parameters of the database, By default use 1, min: 1, max: 3. -A, --tag-type=TAG_TYPE Data type of tables' tags, default is
-m, --table-prefix=TABLEPREFIX Table prefix name. By default use 'd'. INT,BINARY(16).
-s, --sql-file=FILE The select SQL file. -b, --data-type=COL_TYPE Data type of tables' cols, default is
-N, --normal-table Use normal table flag. FLOAT,INT,FLOAT.
-o, --output=FILE Direct output to the named file. By default use './output.txt'. -B, --interlace-rows=NUMBER The number of interlace rows insert into
-q, --query-mode=MODE Query mode -- 0: SYNC, 1: ASYNC. By default use SYNC. tables, default is 0
-b, --data-type=DATATYPE The data_type of columns, By default use: FLOAT, INT, FLOAT. -c, --config-dir=CONFIG_DIR Configuration directory.
-w, --binwidth=WIDTH The width of data_type 'BINARY' or 'NCHAR'. By default use 64 -C, --chinese Nchar and binary are basic unicode chinese
-l, --columns=COLUMNS The number of columns per record. Demo mode by default is 1 (float, int, float). Max values is 4095 characters, optional.
All of the new column(s) type is INT. If use -b to specify column type, -l will be ignored. -d, --database=DATABASE Name of database, default is test.
-T, --threads=NUMBER The number of threads. By default use 8. -E, --escape-character Use escape character in stable and child table
-i, --insert-interval=NUMBER The sleep time (ms) between insertion. By default is 0. name, optional.
-S, --time-step=TIME_STEP The timestamp step between insertion. By default is 1. -F, --prepared_rand=NUMBER Random data source size, default is 10000.
-B, --interlace-rows=NUMBER The interlace rows of insertion. By default is 0. -g, --debug Debug mode, optional.
-r, --rec-per-req=NUMBER The number of records per request. By default is 30000. -G, --performance Performance mode, optional.
-t, --tables=NUMBER The number of tables. By default is 10000. -h, --host=HOST TDengine server FQDN to connect, default is
-n, --records=NUMBER The number of records per table. By default is 10000. localhost.
-M, --random The value of records generated are totally random. -i, --insert-interval=NUMBER Insert interval for interlace mode in
By default to simulate power equipment scenario. milliseconds, default is 0.
-x, --aggr-func Test aggregation functions after insertion. -I, --interface=IFACE insert mode, default is taosc, options:
-y, --answer-yes Input yes for prompt. taosc|rest|stmt|sml
-O, --disorder=NUMBER Insert order mode--0: In order, 1 ~ 50: disorder ratio. By default is in order. -l, --columns=NUMBER Number of INT data type columns in table, default
-R, --disorder-range=NUMBER Out of order data's range. Unit is ms. By default is 1000. is 0.
-g, --debug Print debug info. -m, --table-prefix=TABLE_PREFIX
-?, --help Give this help list Prefix of child table name, default is d.
--usage Give a short usage message -M, --random Data source is randomly generated, optional.
-V, --version Print program version. -n, --records=NUMBER Number of records for each table, default is
10000.
-N, --normal-table Only create normal table without super table,
optional.
-o, --output=FILE The path of result output file, default is
./output.txt.
-O, --disorder=NUMBER Ratio of inserting data with disorder timestamp,
default is 0.
-p, --password=PASSWORD The password to use when connecting to the server,
default is taosdata.
-P, --port=PORT The TCP/IP port number to use for the connection,
default is 6030.
-r, --rec-per-req=NUMBER Number of records in each insert request, default
is 30000.
-R, --disorder-range=NUMBER Range of disordered timestamp, default is 1000.
-S, --time-step=NUMBER Timestamp step in milliseconds, default is 1.
-t, --tables=NUMBER Number of child tables, default is 10000.
-T, --threads=NUMBER The number of thread when insert data, default is
8.
-u, --user=USER The user name to use when connecting to the
server, default is root.
-w, --binwidth=NUMBER The default length of nchar and binary if not
specified, default is 64.
-x, --aggr-func Query aggregation function after insertion,
optional.
-y, --answer-yes Pass confirmation prompt to continue, optional.
-?, --help Give this help list
--usage Give a short usage message
-V, --version Print program version
Mandatory or optional arguments to long options are also mandatory or optional Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options. for any corresponding short options.
...@@ -205,7 +234,7 @@ Report bugs to <support@taosdata.com>. ...@@ -205,7 +234,7 @@ Report bugs to <support@taosdata.com>.
taosBenchmark's parameters are designed to meet the needs of data simulation. A few commonly used parameters are described below. taosBenchmark's parameters are designed to meet the needs of data simulation. A few commonly used parameters are described below.
``` ```
-I, --interface=INTERFACE The interface (taosc, rest, and stmt) taosBenchmark uses. Default is 'taosc'. -I, --interface=IFACE The interface (taosc, rest, and stmt) taosBenchmark uses. Default is 'taosc'.
``` ```
The performance difference between different interfaces of taosBenchmark has been mentioned earlier, the -I parameter is used to select different interfaces, currently taosc, stmt and rest are supported. The -I parameter is used to select different interfaces, currently taosc, stmt and rest are supported. taosc uses SQL statements to write data, stmt uses parameter binding interface to write data, and rest uses RESTful protocol to write data. The performance difference between different interfaces of taosBenchmark has been mentioned earlier, the -I parameter is used to select different interfaces, currently taosc, stmt and rest are supported. The -I parameter is used to select different interfaces, currently taosc, stmt and rest are supported. taosc uses SQL statements to write data, stmt uses parameter binding interface to write data, and rest uses RESTful protocol to write data.
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或