From 3263ffa2c5857bc5048448aa21a0780e2cbd6857 Mon Sep 17 00:00:00 2001 From: Shuduo Sang Date: Mon, 16 Jan 2023 11:00:26 +0800 Subject: [PATCH] docs: update windows/mac status and fixed few typos --- docs/en/02-intro.md | 2 +- docs/en/15-programming/01-connect/01-python.md | 2 +- docs/en/15-programming/02-model.md | 2 +- docs/en/17-taos-sql/04-stable.md | 2 +- docs/en/17-taos-sql/06-select.md | 2 +- docs/en/17-taos-sql/10-function.md | 8 ++++---- docs/en/17-taos-sql/12-distinguished.md | 2 +- docs/en/17-taos-sql/17-json.md | 2 +- docs/en/17-taos-sql/20-keywords.md | 2 +- docs/en/19-tools/01-cli.md | 16 +++++++++++----- .../csharp/native-example/StmtInsertExample.cs | 4 ++-- .../java/com/taos/example/CloudTutorial.java | 2 +- 12 files changed, 26 insertions(+), 20 deletions(-) diff --git a/docs/en/02-intro.md b/docs/en/02-intro.md index 97343cafd1..fef76279f0 100644 --- a/docs/en/02-intro.md +++ b/docs/en/02-intro.md @@ -20,7 +20,7 @@ The major features are listed below: - Supports exporting data via tool [taosDump](../data-out/taosdump/). - Supports writing data to [Prometheus](../data-out/prometheus/). - Supports exporting data via [data subscription](../tmq/). -3. Data Explorer: browse through databases and even run SQL queryies once you login. +3. Data Explorer: browse through databases and even run SQL queries once you login. 4. Visualization: - Supports [Grafana](../visual/grafana/) - Supports Google data studio (to be released soon) diff --git a/docs/en/15-programming/01-connect/01-python.md b/docs/en/15-programming/01-connect/01-python.md index f82c53de8b..3a73fd6906 100644 --- a/docs/en/15-programming/01-connect/01-python.md +++ b/docs/en/15-programming/01-connect/01-python.md @@ -76,7 +76,7 @@ To obtain the value of cloud token and URL, please log in [TDengine Cloud](https ## Connect -Copy code bellow to your editor and run it. If you are using jupyter, assuming you have followed the guide about Jupyter in previous secions, you can copy the code into Jupyter editor in your browser. +Copy code bellow to your editor and run it. If you are using jupyter, assuming you have followed the guide about Jupyter in previous sections, you can copy the code into Jupyter editor in your browser. ```python {{#include docs/examples/python/develop_tutorial.py:connect}} diff --git a/docs/en/15-programming/02-model.md b/docs/en/15-programming/02-model.md index 99730707cd..a24fce8738 100644 --- a/docs/en/15-programming/02-model.md +++ b/docs/en/15-programming/02-model.md @@ -1,6 +1,6 @@ --- title: Data Model -desription: Typical Data Model used in TDengine +description: Typical Data Model used in TDengine --- The data model employed by TDengine is similar to that of a relational database. You have to create databases and tables. You must design the data model based on your own business and application requirements. You should design the STable (an abbreviation for super table) schema to fit your data. This chapter will explain the big picture without getting into syntactical details. diff --git a/docs/en/17-taos-sql/04-stable.md b/docs/en/17-taos-sql/04-stable.md index dbeda21c2b..b8aed1dbe1 100644 --- a/docs/en/17-taos-sql/04-stable.md +++ b/docs/en/17-taos-sql/04-stable.md @@ -34,7 +34,7 @@ column_definition: SHOW STABLES [LIKE tb_name_wildcard]; ``` -The preceding SQL statement shows all supertables in the current TDengine database, including the name, creation time, number of columns, number of tags, and number of subtabels for each supertable. +The preceding SQL statement shows all supertables in the current TDengine database, including the name, creation time, number of columns, number of tags, and number of subtables for each supertable. ### View the CREATE Statement for a Supertable diff --git a/docs/en/17-taos-sql/06-select.md b/docs/en/17-taos-sql/06-select.md index cf35c5b755..75e0a5dedf 100644 --- a/docs/en/17-taos-sql/06-select.md +++ b/docs/en/17-taos-sql/06-select.md @@ -237,7 +237,7 @@ You can also use the NULLS keyword to specify the position of null values. Ascen The LIMIT keyword controls the number of results that are displayed. You can also use the OFFSET keyword to specify the result to display first. `LIMIT` and `OFFSET` are executed after `ORDER BY` in the query execution. You can include an offset in a LIMIT clause. For example, LIMIT 5 OFFSET 2 can also be written LIMIT 2, 5. Both of these clauses display the third through the seventh results. -In a statement that includes a PARTITON BY clause, the LIMIT keyword is performed on each partition, not on the entire set of results. +In a statement that includes a PARTITION BY clause, the LIMIT keyword is performed on each partition, not on the entire set of results. ## SLIMIT diff --git a/docs/en/17-taos-sql/10-function.md b/docs/en/17-taos-sql/10-function.md index f19e13f638..33339761d0 100644 --- a/docs/en/17-taos-sql/10-function.md +++ b/docs/en/17-taos-sql/10-function.md @@ -488,7 +488,7 @@ All functions that return the current time, such as `NOW`, `TODAY`, and `TIMEZON ```sql SELECT NOW() FROM { tb_name | stb_name } [WHERE clause]; -SELECT select_expr FROM { tb_name | stb_name } WHERE ts_col cond_operatior NOW(); +SELECT select_expr FROM { tb_name | stb_name } WHERE ts_col cond_operator NOW(); INSERT INTO tb_name VALUES (NOW(), ...); ``` @@ -572,7 +572,7 @@ SELECT TIMEZONE() FROM { tb_name | stb_name } [WHERE clause]; ```sql SELECT TODAY() FROM { tb_name | stb_name } [WHERE clause]; -SELECT select_expr FROM { tb_name | stb_name } WHERE ts_col cond_operatior TODAY()]; +SELECT select_expr FROM { tb_name | stb_name } WHERE ts_col cond_operator TODAY()]; INSERT INTO tb_name VALUES (TODAY(), ...); ``` @@ -656,7 +656,7 @@ If you input a specific column, the number of non-null values in the column is r SELECT ELAPSED(ts_primary_key [, time_unit]) FROM { tb_name | stb_name } [WHERE clause] [INTERVAL(interval [, offset]) [SLIDING sliding]]; ``` -**Description**：`elapsed` function can be used to calculate the continuous time length in which there is valid data. If it's used with `INTERVAL` clause, the returned result is the calcualted time length within each time window. If it's used without `INTERVAL` caluse, the returned result is the calculated time length within the specified time range. Please be noted that the return value of `elapsed` is the number of `time_unit` in the calculated time length. +**Description**：`elapsed` function can be used to calculate the continuous time length in which there is valid data. If it's used with `INTERVAL` clause, the returned result is the calculated time length within each time window. If it's used without `INTERVAL` caluse, the returned result is the calculated time length within the specified time range. Please be noted that the return value of `elapsed` is the number of `time_unit` in the calculated time length. **Return value type**: Double if the input value is not NULL; @@ -744,7 +744,7 @@ SELECT HYPERLOGLOG(field_name) FROM { tb_name | stb_name } [WHERE clause]; **Description**： The cardinal number of a specific column is returned by using hyperloglog algorithm. The benefit of using hyperloglog algorithm is that the memory usage is under control when the data volume is huge. - However, when the data volume is very small, the result may be not accurate, it's recommented to use `select count(data) from (select unique(col) as data from table)` in this case. + However, when the data volume is very small, the result may be not accurate, it's recommended to use `select count(data) from (select unique(col) as data from table)` in this case. **Return value type**: Integer diff --git a/docs/en/17-taos-sql/12-distinguished.md b/docs/en/17-taos-sql/12-distinguished.md index e816fe615e..17c7f0c445 100644 --- a/docs/en/17-taos-sql/12-distinguished.md +++ b/docs/en/17-taos-sql/12-distinguished.md @@ -109,7 +109,7 @@ SELECT COUNT(*) FROM temp_tb_1 INTERVAL(1m) SLIDING(2m); When using time windows, note the following: -- The window length for aggregation depends on the value of INTERVAL. The minimum interval is 10 ms. You can configure a window as an offset from UTC 0:00. The offset cannot be smaler than the interval. You can use SLIDING to specify the length of time that the window moves forward. +- The window length for aggregation depends on the value of INTERVAL. The minimum interval is 10 ms. You can configure a window as an offset from UTC 0:00. The offset cannot be smaller than the interval. You can use SLIDING to specify the length of time that the window moves forward. Please note that the `timezone` parameter should be configured to be the same value in the `taos.cfg` configuration file on client side and server side. - The result set is in ascending order of timestamp when you aggregate by time window. diff --git a/docs/en/17-taos-sql/17-json.md b/docs/en/17-taos-sql/17-json.md index 1f08197dad..5ea611058e 100644 --- a/docs/en/17-taos-sql/17-json.md +++ b/docs/en/17-taos-sql/17-json.md @@ -55,7 +55,7 @@ description: JSON Data Type 4. Tag Operations - The value of a JSON tag can be altered. Please note that the full JSON will be overriden when doing this. + The value of a JSON tag can be altered. Please note that the full JSON will be overridden when doing this. The name of a JSON tag can be altered. diff --git a/docs/en/17-taos-sql/20-keywords.md b/docs/en/17-taos-sql/20-keywords.md index 9d8d7c4767..d29ed5d018 100644 --- a/docs/en/17-taos-sql/20-keywords.md +++ b/docs/en/17-taos-sql/20-keywords.md @@ -217,7 +217,7 @@ There are about 200 keywords reserved by TDengine, they can't be used as the nam - STableS - STAR - STATE -- STATEMEN +- STATEMENT - STATE_WI - STORAGE - STREAM diff --git a/docs/en/19-tools/01-cli.md b/docs/en/19-tools/01-cli.md index 98cbe97bf7..066e03a581 100644 --- a/docs/en/19-tools/01-cli.md +++ b/docs/en/19-tools/01-cli.md @@ -28,16 +28,22 @@ export TDENGINE_CLOUD_DSN="" ``` - + -Run this command in your Windows terminal to save cloud DSN as variable: +Run this command in your Windows CMD prompt to save cloud DSN as variable: -```bash -set TDENGINE_CLOUD_DSN="" +```cmd +set TDENGINE_CLOUD_DSN= +``` + +Or run this command in your Windows PowerShell environment to save cloud DSN as variable: + +```cmd +$env:TDENGINE_CLOUD_DSN='' ``` - + Run this command in your Mac terminal to save cloud DSN as variable: diff --git a/docs/examples/csharp/native-example/StmtInsertExample.cs b/docs/examples/csharp/native-example/StmtInsertExample.cs index 0a4098091f..41a557ebd4 100644 --- a/docs/examples/csharp/native-example/StmtInsertExample.cs +++ b/docs/examples/csharp/native-example/StmtInsertExample.cs @@ -41,7 +41,7 @@ namespace TDengineExample // 5. execute res = TDengine.StmtExecute(stmt); - CheckStmtRes(res, "faild to execute"); + CheckStmtRes(res, "failed to execute"); // 6. free TaosMultiBind.FreeTaosBind(tags); @@ -90,7 +90,7 @@ namespace TDengineExample int code = TDengine.StmtClose(stmt); if (code != 0) { - Console.WriteLine($"falied to close stmt, {code} reason: {TDengine.StmtErrorStr(stmt)} "); + Console.WriteLine($"failed to close stmt, {code} reason: {TDengine.StmtErrorStr(stmt)} "); } ExitProgram(); } diff --git a/docs/examples/java/src/main/java/com/taos/example/CloudTutorial.java b/docs/examples/java/src/main/java/com/taos/example/CloudTutorial.java index 5ff0855615..a22ff08122 100644 --- a/docs/examples/java/src/main/java/com/taos/example/CloudTutorial.java +++ b/docs/examples/java/src/main/java/com/taos/example/CloudTutorial.java @@ -17,7 +17,7 @@ stmt.execute("INSERT INTO power.d1001 USING power.meters TAGS(California.SanFran ResultSet result = stmt.executeQuery("SELECT ts, current FROM power.meters LIMIT 2"); // ANCHOR_END: query // ANCHOR: meta -// print colum names +// print column names ResultSetMetaData meta = result.getMetaData(); System.out.println(meta.getColumnLabel(1) + "\t" + meta.getColumnLabel(2)); // output: ts current -- GitLab