Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
taosdata
TDengine
提交
f24e1792
TDengine
项目概览
taosdata
/
TDengine
1 年多 前同步成功
通知
1187
Star
22018
Fork
4786
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
1
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
TDengine
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
1
Issue
1
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
f24e1792
编写于
4月 22, 2022
作者:
W
wade zhang
提交者:
GitHub
4月 22, 2022
浏览文件
操作
浏览文件
下载
差异文件
Merge pull request #11749 from taosdata/docs/dingbo/replace-restful
docs: replace RESTful API with REST API
上级
74f6eead
5780a5d2
变更
6
隐藏空白更改
内联
并排
Showing
6 changed file
with
9 addition
and
9 deletion
+9
-9
docs-cn/04-connect/index.md
docs-cn/04-connect/index.md
+2
-2
docs-cn/08-advance-feature/04-udf.md
docs-cn/08-advance-feature/04-udf.md
+1
-1
docs-cn/14-reference/02-rest-api/02-rest-api.mdx
docs-cn/14-reference/02-rest-api/02-rest-api.mdx
+3
-3
docs-cn/14-reference/02-rest-api/_category_.yml
docs-cn/14-reference/02-rest-api/_category_.yml
+1
-0
docs-cn/14-reference/02-restful-api/_category_.yml
docs-cn/14-reference/02-restful-api/_category_.yml
+0
-1
docs-cn/17-train-fqa/03-docker.md
docs-cn/17-train-fqa/03-docker.md
+2
-2
未找到文件。
docs-cn/04-connect/index.md
浏览文件 @
f24e1792
...
...
@@ -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
](
/reference/rest-api/
)
。除 REST API 之外,TDengine 还提供多种编程语言的连接器方便用户开发应用程序,其中包括 C/C++、Java、Python、Go、Node.js、C#
等。 本节介绍如何使用连接器建立与 TDengine 的连接,给出连接器安装、连接的简单说明。关于各连接器的详细功能说明,请查看
[
连接器
](
https://docs.taosdata.com/reference/connector/
)
## 连接器建立连接的方式
连接器建立连接的方式,TDengine提供两种:
1.
通过 taosAdapter 组件提供的 REST
ful
API 建立与 taosd 的连接,这种连接方式下文中简称"RESTful 连接“
1.
通过 taosAdapter 组件提供的 REST API 建立与 taosd 的连接,这种连接方式下文中简称"RESTful 连接“
2.
通过客户端驱动程序 taosc 直接与服务端程序 taosd 建立连接,这种连接方式下文中简称“本地连接”。
无论使用何种方式建立连接,连接器都提供了相同或相似的 API 操作数据库,都可以执行 SQL 语句,只是初始化连接的方式稍有不同,用户在使用上不会感到什么差别。
...
...
docs-cn/08-advance-feature/04-udf.md
浏览文件 @
f24e1792
...
...
@@ -21,7 +21,7 @@ title: UDF(用户定义函数)
-
udfNormalFunc 中各参数的具体含义是:
-
data:输入数据。
-
itype:输入数据的类型。这里采用的是短整型表示法,与各种数据类型对应的值可以参见
[
column_meta 中的列类型说明
](
/reference/rest
ful
-api/
)
。例如 4 用于表示 INT 型。
-
itype:输入数据的类型。这里采用的是短整型表示法,与各种数据类型对应的值可以参见
[
column_meta 中的列类型说明
](
/reference/rest-api/
)
。例如 4 用于表示 INT 型。
-
iBytes:输入数据中每个值会占用的字节数。
-
numOfRows:输入数据的总行数。
-
ts:主键时间戳在输入中的列数据(只读)。
...
...
docs-cn/14-reference/02-rest
ful-api/02-restful
-api.mdx
→
docs-cn/14-reference/02-rest
-api/02-rest
-api.mdx
浏览文件 @
f24e1792
---
title: REST
ful
API
title: REST API
---
为支持各种不同类型平台的开发,TDengine 提供符合 REST 设计标准的 API,即 REST
ful 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 提供的 REST
ful API, 那么以上配置需要写在 taosd 的配置文件 taos.cfg 中。如果使用 taosAdaper 提供的 RESTful
API, 那么需要参考 taosAdaper [对应的配置方法](/reference/taosadapter/)。
如果使用 taosd 提供的 REST
API, 那么以上配置需要写在 taosd 的配置文件 taos.cfg 中。如果使用 taosAdaper 提供的 REST
API, 那么需要参考 taosAdaper [对应的配置方法](/reference/taosadapter/)。
:::
docs-cn/14-reference/02-rest-api/_category_.yml
0 → 100644
浏览文件 @
f24e1792
label
:
REST API
docs-cn/14-reference/02-restful-api/_category_.yml
已删除
100644 → 0
浏览文件 @
74f6eead
label
:
RESTful API
docs-cn/17-train-fqa/03-docker.md
浏览文件 @
f24e1792
...
...
@@ -117,9 +117,9 @@ curl -u root:taosdata -d 'show databases' 127.0.0.1:6041/rest/sql
{"status":"succ","head":["name","created_time","ntables","vgroups","replica","quorum","days","keep0,keep1,keep(D)","cache(MB)","blocks","minrows","maxrows","wallevel","fsync","comp","cachelast","precision","update","status"],"column_meta":[["name",8,32],["created_time",9,8],["ntables",4,4],["vgroups",4,4],["replica",3,2],["quorum",3,2],["days",3,2],["keep0,keep1,keep(D)",8,24],["cache(MB)",4,4],["blocks",4,4],["minrows",4,4],["maxrows",4,4],["wallevel",2,1],["fsync",4,4],["comp",2,1],["cachelast",2,1],["precision",8,3],["update",2,1],["status",8,10]],"data":[["test","2021-08-18 06:01:11.021",10000,4,1,1,10,"3650,3650,3650",16,6,100,4096,1,3000,2,0,"ms",0,"ready"],["log","2021-08-18 05:51:51.065",4,1,1,1,10,"30,30,30",1,3,100,4096,1,3000,2,0,"us",0,"ready"]],"rows":2}
```
这条命令,通过 REST
ful 接口
访问 TDengine server,这时连接的是本机的 6041 端口,可见连接成功。
这条命令,通过 REST
API
访问 TDengine server,这时连接的是本机的 6041 端口,可见连接成功。
TDengine REST
ful 接口详情请参考
[
官方文档
](
/reference/restful
-api/
)
。
TDengine REST
API 详情请参考
[
官方文档
](
/reference/rest
-api/
)
。
### 使用 Docker 容器运行 TDengine server 和 taosAdapter
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录