diff --git a/docs-cn/04-connect/index.md b/docs-cn/04-connect/index.md index 618d879040b76a14efd78bbcdfb0172deb71d58d..014103781a80b25ec418b6a8febcebd5f199463d 100644 --- a/docs-cn/04-connect/index.md +++ b/docs-cn/04-connect/index.md @@ -17,12 +17,12 @@ import InstallOnLinux from "../14-reference/03-connector/_windows_install.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/) +TDengine 提供 RESTful 接口，容许在任何平台的任何应用程序通过它访问TDengine运行实例，详细介绍请看 [REST API](https://docs.taosdata.com/reference/restful-api/)。除 REST API 之外，TDengine 还提供多种编程语言的连接器方便用户开发应用程序，其中包括 C/C++、Java、Python、Go、Node.js、C# 等。 本节介绍如何使用连接器建立与 TDengine 的连接，给出连接器安装、连接的简单说明。关于各连接器的详细功能说明，请查看[连接器](https://docs.taosdata.com/reference/connector/) ## 连接器建立连接的方式 连接器建立连接的方式，TDengine提供两种: - 1. 通过 taosAdapter 组件提供的 RESTful API 建立与 taosd 的连接，这种连接方式下文中简称"RESTful 连接“ + 1. 通过 taosAdapter 组件提供的 REST API 建立与 taosd 的连接，这种连接方式下文中简称"RESTful 连接“ 2. 通过客户端驱动程序 taosc 直接与服务端程序 taosd 建立连接，这种连接方式下文中简称“本地连接”。 无论使用何种方式建立连接，连接器都提供了相同或相似的 API 操作数据库，都可以执行 SQL 语句，只是初始化连接的方式稍有不同，用户在使用上不会感到什么差别。 diff --git a/docs-cn/14-reference/02-restful-api/02-restful-api.mdx b/docs-cn/14-reference/02-restful-api/02-restful-api.mdx index 7df29edaf6267fbc2112521fedc8f745ca40ddb2..e37f518f950fd833c5f0acbe8828970159cf6b48 100644 --- a/docs-cn/14-reference/02-restful-api/02-restful-api.mdx +++ b/docs-cn/14-reference/02-restful-api/02-restful-api.mdx @@ -1,8 +1,8 @@ --- -title: RESTful API +title: REST API --- -为支持各种不同类型平台的开发，TDengine 提供符合 REST 设计标准的 API，即 RESTful API。为最大程度降低学习成本，不同于其他数据库 RESTful API 的设计方法，TDengine 直接通过 HTTP POST 请求 BODY 中包含的 SQL 语句来操作数据库，仅需要一个 URL。RESTful 连接器的使用参见[视频教程](https://www.taosdata.com/blog/2020/11/11/1965.html)。 +为支持各种不同类型平台的开发，TDengine 提供符合 REST 设计标准的 API，即 REST API。为最大程度降低学习成本，不同于其他数据库 REST API 的设计方法，TDengine 直接通过 HTTP POST 请求 BODY 中包含的 SQL 语句来操作数据库，仅需要一个 URL。RESTful 连接器的使用参见[视频教程](https://www.taosdata.com/blog/2020/11/11/1965.html)。 注意：与原生连接器的一个区别是，RESTful 接口是无状态的，因此 `USE db_name` 指令没有效果，所有对表名、超级表名的引用都需要指定数据库名前缀。（从 2.2.0.0 版本开始，支持在 RESTful url 中指定 db_name，这时如果 SQL 语句中没有指定数据库名前缀的话，会使用 url 中指定的这个 db_name。从 2.4.0.0 版本开始，RESTful 默认由 taosAdapter 提供，要求必须在 url 中指定 db_name。） @@ -302,6 +302,6 @@ HTTP 请求 URL 采用 `sqlutc` 时，返回结果集的时间戳将采用 UTC - httpDbNameMandatory: 是否必须在 RESTful url 中指定默认的数据库名。默认为 0，即关闭此检查。如果设置为 1，那么每个 RESTful url 中都必须设置一个默认数据库名，否则无论此时执行的 SQL 语句是否需要指定数据库，都会返回一个执行错误，拒绝执行此 SQL 语句。 :::note -如果使用 taosd 提供的 RESTful API, 那么以上配置需要写在 taosd 的配置文件 taos.cfg 中。如果使用 taosAdaper 提供的 RESTful API, 那么需要参考 taosAdaper [对应的配置方法](/reference/taosadapter/)。 +如果使用 taosd 提供的 REST API, 那么以上配置需要写在 taosd 的配置文件 taos.cfg 中。如果使用 taosAdaper 提供的 REST API, 那么需要参考 taosAdaper [对应的配置方法](/reference/taosadapter/)。 ::: diff --git a/docs-cn/14-reference/02-restful-api/_category_.yml b/docs-cn/14-reference/02-restful-api/_category_.yml index 736836846eef118e51ab802811151e26646684e9..57a20d8458e937f60c41806be4392ebb2d13e0f7 100644 --- a/docs-cn/14-reference/02-restful-api/_category_.yml +++ b/docs-cn/14-reference/02-restful-api/_category_.yml @@ -1 +1 @@ -label: RESTful API +label: REST API