From e0d399652612de9ddf663ff317f4e50ce3d98e2d Mon Sep 17 00:00:00 2001 From: dingbo Date: Mon, 18 Apr 2022 11:42:53 +0800 Subject: [PATCH] docs: refine get-started page and connect page --- docs-cn/03-get-started/03-get-started.md | 47 ++++++++-------- docs-cn/03-get-started/_pkg_install.mdx | 53 ++++++++++++++++--- docs-cn/03-get-started/_pkg_list.mdx | 48 ----------------- docs-cn/03-get-started/_src_install.mdx | 3 -- docs-cn/04-connect/_connect_c.mdx | 2 +- ..._connect_cs_native.mdx => _connect_cs.mdx} | 2 +- docs-cn/04-connect/_connect_java.mdx | 6 ++- docs-cn/04-connect/_connect_python.mdx | 3 ++ docs-cn/04-connect/_connect_python_native.mdx | 8 --- docs-cn/04-connect/_connect_r.mdx | 2 +- docs-cn/04-connect/_connect_restful.mdx | 22 -------- docs-cn/04-connect/_connect_rust.mdx | 2 +- docs-cn/04-connect/{index.mdx => index.md} | 17 +++--- 13 files changed, 94 insertions(+), 121 deletions(-) delete mode 100644 docs-cn/03-get-started/_pkg_list.mdx delete mode 100644 docs-cn/03-get-started/_src_install.mdx rename docs-cn/04-connect/{_connect_cs_native.mdx => _connect_cs.mdx} (76%) create mode 100644 docs-cn/04-connect/_connect_python.mdx delete mode 100644 docs-cn/04-connect/_connect_python_native.mdx delete mode 100644 docs-cn/04-connect/_connect_restful.mdx rename docs-cn/04-connect/{index.mdx => index.md} (94%) diff --git a/docs-cn/03-get-started/03-get-started.md b/docs-cn/03-get-started/03-get-started.md index 3e0aaa0621..af6797c927 100644 --- a/docs-cn/03-get-started/03-get-started.md +++ b/docs-cn/03-get-started/03-get-started.md @@ -1,9 +1,22 @@ --- title: 立即开始 +description: "从 Docker，安装包或使用 apt-get 快速安装 TDengine, 通过命令行程序 taos shell 和工具 taosdemo 快速体验 TDengine 功能" --- -## 从 Docker 快速开始 +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import PkgInstall from "./\_pkg_install.mdx"; +import AptGetInstall from "./\_apt_get_install.mdx"; + +## 安装 +TDengine 包括服务端、客户端和周边生态工具软件，目前 2.0 版服务端仅在 Linux 系统上安装和运行，后续将支持 Windows、macOS 等系统。客户端可以在 Windows 或 Linux 上安装和运行。在任何操作系统上的应用都可以使用 RESTful 接口连接 TDengine，其中 2.4 之后版本默认使用单独运行的独立组件 taosAdapter 提供 http 服务和更多数据写入方式, taosAdapter 需要手动启动。 +2.4 之前的版本中 TDengine 服务端，以及所有服务端 lite 版，均使用由 taosd 内置的 http 服务。 + +TDengine 支持 X64/ARM64/MIPS64/Alpha64 硬件平台，后续将支持 ARM32、RISC-V 等 CPU 架构。 + + + 如果已经安装了 docker， 只需执行下面的命令。 ```shell @@ -35,30 +48,20 @@ docker exec -it bash 暂时不建议生产环境采用 Docker 来部署 TDengine 的客户端或服务端，但在开发环境下或初次尝试时，使用 Docker 方式部署是十分方便的。特别是，利用 Docker，可以方便地在 macOS 和 Windows 环境下尝试 TDengine。 ::: + + + + + + + + -## 安装 +如果您希望对 TDengine 贡献代码或对内部实现感兴趣，请参考我们的 [TDengine GitHub 主页](https://github.com/taosdata/TDengine) 下载源码构建和安装. -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import PkgInstall from "./\_pkg_install.mdx"; -import AptGetInstall from "./\_apt_get_install.mdx"; -import SrcInstall from "./\_src_install.mdx"; +下载其他组件、最新 Beta 版及之前版本的安装包，请点击[这里](https://www.taosdata.com/cn/all-downloads/)。 -TDengine 包括服务端、客户端和周边生态工具软件，目前 2.0 版服务端仅在 Linux 系统上安装和运行，后续将支持 Windows、macOS 等系统。客户端可以在 Windows 或 Linux 上安装和运行。在任何操作系统上的应用都可以使用 RESTful 接口连接 TDengine，其中 2.4 之后版本默认使用单独运行的独立组件 taosAdapter 提供 http 服务和更多数据写入方式, taosAdapter 需要手动启动。 -2.4 之前的版本中 TDengine 服务端，以及所有服务端 lite 版，均使用由 taosd 内置的 http 服务。 - -TDengine 支持 X64/ARM64/MIPS64/Alpha64 硬件平台，后续将支持 ARM32、RISC-V 等 CPU 架构。 - - - - - - - - - - - + ## 启动 diff --git a/docs-cn/03-get-started/_pkg_install.mdx b/docs-cn/03-get-started/_pkg_install.mdx index 658f964ffb..13047f9980 100644 --- a/docs-cn/03-get-started/_pkg_install.mdx +++ b/docs-cn/03-get-started/_pkg_install.mdx @@ -1,6 +1,4 @@ -import PkgList from "./_pkg_list.mdx"; - -使用安装包安装 TDengine 非常简单，从下载到安装成功仅仅只要几秒钟。 +TDengine 的安装非常简单，从下载到安装成功仅仅只要几秒钟。 为方便使用，从 2.4.0.10 开始，标准的服务端安装包包含了 taos、taosd、taosAdapter、taosdump、taosBenchmark、TDinsight 安装脚本和示例代码；如果您只需要用到服务端程序和客户端连接的 C/C++ 语言支持，也可以仅下载 lite 版本的安装包。 @@ -8,8 +6,51 @@ import PkgList from "./_pkg_list.mdx"; 发布版本包括稳定版和 Beta 版，Beta 版含有更多新功能。正式上线或测试建议安装稳定版。您可以根据需要选择下载： -**所有下载** + + +具体的安装方法，请参见[安装包的安装和卸载](/operation/pkg-install)。 -https://www.taosdata.com/all-downloads +下载其他组件、最新 Beta 版及之前版本的安装包，请点击[这里](https://www.taosdata.com/all-downloads) -具体的安装方法，请参见 [安装包的安装和卸载](/operation/pkg-install) 以及 [视频教程](https://www.taosdata.com/blog/2020/11/11/1941.html)。 +请点击[这里](https://github.com/taosdata/TDengine/releases) 查看 Release Notes。 diff --git a/docs-cn/03-get-started/_pkg_list.mdx b/docs-cn/03-get-started/_pkg_list.mdx deleted file mode 100644 index 1ed8a10717..0000000000 --- a/docs-cn/03-get-started/_pkg_list.mdx +++ /dev/null @@ -1,48 +0,0 @@ -**最新安装包** - - - -**所有下载** - -https://www.taosdata.com/all-downloads diff --git a/docs-cn/03-get-started/_src_install.mdx b/docs-cn/03-get-started/_src_install.mdx deleted file mode 100644 index 2004d73fe0..0000000000 --- a/docs-cn/03-get-started/_src_install.mdx +++ /dev/null @@ -1,3 +0,0 @@ -如果您希望对 TDengine 贡献代码或对内部实现感兴趣，请参考我们的 [TDengine GitHub 主页](https://github.com/taosdata/TDengine) 下载源码构建和安装. - -下载其他组件、最新 Beta 版及之前版本的安装包，请点击[这里](https://www.taosdata.com/cn/all-downloads/)。 diff --git a/docs-cn/04-connect/_connect_c.mdx b/docs-cn/04-connect/_connect_c.mdx index 4d6f1cfe1b..b4f774c77f 100644 --- a/docs-cn/04-connect/_connect_c.mdx +++ b/docs-cn/04-connect/_connect_c.mdx @@ -1,3 +1,3 @@ -```c +```c title="本地连接" {{#include docs-examples/c/connect_example.c}} ``` diff --git a/docs-cn/04-connect/_connect_cs_native.mdx b/docs-cn/04-connect/_connect_cs.mdx similarity index 76% rename from docs-cn/04-connect/_connect_cs_native.mdx rename to docs-cn/04-connect/_connect_cs.mdx index b8f1948456..52a2702b6c 100644 --- a/docs-cn/04-connect/_connect_cs_native.mdx +++ b/docs-cn/04-connect/_connect_cs.mdx @@ -1,4 +1,4 @@ -```csharp +```csharp title="本地连接" {{#include docs-examples/csharp/ConnectExample.cs}} ``` :::info diff --git a/docs-cn/04-connect/_connect_java.mdx b/docs-cn/04-connect/_connect_java.mdx index c4e2453c6e..a95c1a1766 100644 --- a/docs-cn/04-connect/_connect_java.mdx +++ b/docs-cn/04-connect/_connect_java.mdx @@ -4,6 +4,8 @@ ```java title="RESTful 连接" {{#include docs-examples/java/src/main/java/com/taos/example/RESTConnectExample.java:main}} ``` -```java title="WebSocket 连接" {4} +使用RESTful 连接时，如果查询数据量比较大，还可开启批量拉取功能。 +```java title="开启批量拉取功能" {4} {{#include docs-examples/java/src/main/java/com/taos/example/WSConnectExample.java:main}} -``` \ No newline at end of file +``` +更多连接参数配置，参考[Java 连接器](/reference/connector/java) \ No newline at end of file diff --git a/docs-cn/04-connect/_connect_python.mdx b/docs-cn/04-connect/_connect_python.mdx new file mode 100644 index 0000000000..0f90860d0c --- /dev/null +++ b/docs-cn/04-connect/_connect_python.mdx @@ -0,0 +1,3 @@ +```python title="本地连接" +{{#include docs-examples/python/connect_exmaple.py}} +``` \ No newline at end of file diff --git a/docs-cn/04-connect/_connect_python_native.mdx b/docs-cn/04-connect/_connect_python_native.mdx deleted file mode 100644 index e3295f15fd..0000000000 --- a/docs-cn/04-connect/_connect_python_native.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```python -{{#include docs-examples/python/connect_exmaple.py}} -``` - -:::info -Python 连接器目前只支持本地连接。 - -::: diff --git a/docs-cn/04-connect/_connect_r.mdx b/docs-cn/04-connect/_connect_r.mdx index 68ab515136..c1eea10151 100644 --- a/docs-cn/04-connect/_connect_r.mdx +++ b/docs-cn/04-connect/_connect_r.mdx @@ -1,3 +1,3 @@ -```r +```r title="本地连接" {{#include docs-examples/R/connect_native.r:demo}} ``` \ No newline at end of file diff --git a/docs-cn/04-connect/_connect_restful.mdx b/docs-cn/04-connect/_connect_restful.mdx deleted file mode 100644 index d68903aa39..0000000000 --- a/docs-cn/04-connect/_connect_restful.mdx +++ /dev/null @@ -1,22 +0,0 @@ -下面用 curl 工具来演示访问 RESTful 接口。在命令行执行下面的命令： - -```bash -curl http://localhost:6041/rest/sql -u root:taosdata -d "select server_version()" -``` - -- `-u` 用于指定访问数据库的用户名和密码。 -- `-d` 用于指定发送要执行的 SQL 语句。它会被放入 POST 请求的 Body 中。 - -如果正常，会返回一个 JSON 字符串，里面包含了服务端的版本。例如： - -```json -{ - "status": "succ", - "head": ["server_version()"], - "column_meta": [["server_version()", 8, 7]], - "data": [["2.4.0.0"]], - "rows": 1 -} -``` - -了解更多：[RESTful API](/reference/restful-api)。 diff --git a/docs-cn/04-connect/_connect_rust.mdx b/docs-cn/04-connect/_connect_rust.mdx index f3631cddf0..7e3ab13649 100644 --- a/docs-cn/04-connect/_connect_rust.mdx +++ b/docs-cn/04-connect/_connect_rust.mdx @@ -1,4 +1,4 @@ -```rust +```rust title="本地连接/RESTful 连接" {{#include docs-examples/rust/nativeexample/examples/connect.rs}} ``` :::note diff --git a/docs-cn/04-connect/index.mdx b/docs-cn/04-connect/index.md similarity index 94% rename from docs-cn/04-connect/index.mdx rename to docs-cn/04-connect/index.md index d9b416fdf8..a27d832b1c 100644 --- a/docs-cn/04-connect/index.mdx +++ b/docs-cn/04-connect/index.md @@ -4,19 +4,18 @@ title: 建立连接 import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -import ConnRest from "./_connect_restful.mdx"; import ConnJava from "./_connect_java.mdx"; import ConnGo from "./_connect_go.mdx"; import ConnRust from "./_connect_rust.mdx"; import ConnNode from "./_connect_node.mdx"; -import ConnPythonNative from "./_connect_python_native.mdx"; -import ConnCSNative from "./_connect_cs_native.mdx"; +import ConnPythonNative from "./_connect_python.mdx"; +import ConnCSNative from "./_connect_cs.mdx"; import ConnC from "./_connect_c.mdx"; import ConnR from "./_connect_r.mdx"; import InstallOnWindows from "../14-reference/03-connector/_linux_install.mdx"; import InstallOnLinux from "../14-reference/03-connector/_windows_install.mdx"; -import VerifyWindows from "../14-reference/03-connector/_verify_linux.mdx"; -import VerifyLinux from "../14-reference/03-connector/_verify_windows.mdx"; +import VerifyLinux from "../14-reference/03-connector/_verify_linux.mdx"; +import VerifyWindows from "../14-reference/03-connector/_verify_windows.mdx"; TDengine 提供RESTful接口，容许在任何平台的任何应用程序通过它访问TDengine运行实例，详细介绍请看 [RESTful API](https://docs.taosdata.com/reference/restful-api/)。除 RESTful 之外，TDengine 还提供多种编程语言的连接器方便用户开发应用程序，其中包括 C/C++、Java、Python、Go、Node.js、C# 、RESTful 等。 本节介绍如何使用连接器建立与 TDengine 的连接，给出连接器安装、连接的简单说明。关于各连接器的详细功能说明，请查看[连接器](https://docs.taosdata.com/reference/connector/) @@ -33,7 +32,7 @@ TDengine 提供RESTful接口，容许在任何平台的任何应用程序通过 2. 使用本地连接可以体验 TDengine 的全部功能，如[原生接口写入](/reference/connector/cpp#参数绑定-api)、[订阅](reference/connector/cpp#数据订阅接口)等等。 -## 安装客户端驱动taosc +## 安装客户端驱动 taosc 如果选择本地连接，而且应用程序不在 TDengine 同一台服务器上运行，你需要先安装客户端驱动，否则可以跳过此一步。为避免客户端驱动和服务端不兼容，请使用一致的版本。 @@ -177,6 +176,12 @@ dotnet add package TDengine.Connector ```R install.packages("RJDBC") ``` + + + +如果已经安装了 TDengine 服务端软件或 TDengine 客户端驱动 taosc， 那么已经安装了 C 连接器，无需额外操作。 +
+ -- GitLab