Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Rattenking
TDengine
提交
dc5dfc5f
T
TDengine
项目概览
Rattenking
/
TDengine
与 Fork 源项目一致
Fork自
taosdata / TDengine
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
T
TDengine
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
dc5dfc5f
编写于
8月 29, 2021
作者:
E
Elias Soong
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
[TD-6008] <docs>: add setting default db name in RESTful url.
上级
a7308f4b
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
38 addition
and
36 deletion
+38
-36
documentation20/cn/08.connector/01.java/docs.md
documentation20/cn/08.connector/01.java/docs.md
+1
-1
documentation20/cn/08.connector/docs.md
documentation20/cn/08.connector/docs.md
+37
-35
未找到文件。
documentation20/cn/08.connector/01.java/docs.md
浏览文件 @
dc5dfc5f
...
...
@@ -46,7 +46,7 @@ TDengine 的 JDBC 驱动实现尽可能与关系型数据库驱动保持一致
</tr>
</table>
注意:与 JNI 方式不同,RESTful 接口是无状态的。在使用JDBC-RESTful时,需要在sql中指定表、超级表的数据库名称。例如:
注意:与 JNI 方式不同,RESTful 接口是无状态的。在使用JDBC-RESTful时,需要在sql中指定表、超级表的数据库名称。
(从 TDengine 2.1.8.0 版本开始,也可以在 RESTful url 中指定当前 SQL 语句所使用的默认数据库名。)
例如:
```
sql
INSERT
INTO
test
.
t1
USING
test
.
weather
(
ts
,
temperature
)
TAGS
(
'beijing'
)
VALUES
(
now
,
24
.
6
);
```
...
...
documentation20/cn/08.connector/docs.md
浏览文件 @
dc5dfc5f
...
...
@@ -654,22 +654,23 @@ conn.close()
为支持各种不同类型平台的开发,TDengine 提供符合 REST 设计标准的 API,即 RESTful API。为最大程度降低学习成本,不同于其他数据库 RESTful API 的设计方法,TDengine 直接通过 HTTP POST 请求 BODY 中包含的 SQL 语句来操作数据库,仅需要一个 URL。RESTful 连接器的使用参见
[
视频教程
](
https://www.taosdata.com/blog/2020/11/11/1965.html
)
。
注意:与标准连接器的一个区别是,RESTful 接口是无状态的,因此
`USE db_name`
指令没有效果,所有对表名、超级表名的引用都需要指定数据库名前缀。
注意:与标准连接器的一个区别是,RESTful 接口是无状态的,因此
`USE db_name`
指令没有效果,所有对表名、超级表名的引用都需要指定数据库名前缀。
(从 2.1.8.0 版本开始,支持在 RESTful url 中指定 db_name,这时如果 SQL 语句中没有指定数据库名前缀的话,会使用 url 中指定的这个 db_name。)
### 安装
RESTful
接口不依赖于任何TDengine的库,因此客户端不需要安装任何TDengine的库,只要客户端的开发语言支持HTTP
协议即可。
RESTful
接口不依赖于任何 TDengine 的库,因此客户端不需要安装任何 TDengine 的库,只要客户端的开发语言支持 HTTP
协议即可。
### 验证
在已经安装
TDengine
服务器端的情况下,可以按照如下方式进行验证。
在已经安装
TDengine
服务器端的情况下,可以按照如下方式进行验证。
下面以
Ubuntu环境中使用curl工具(确认已经安装)来验证RESTful
接口的正常。
下面以
Ubuntu 环境中使用 curl 工具(确认已经安装)来验证 RESTful
接口的正常。
下面示例是列出所有的数据库,请把
h1.taosdata.com和6041(缺省值)替换为实际运行的TDengine服务fqdn
和端口号:
下面示例是列出所有的数据库,请把
h1.taosdata.com 和 6041(缺省值)替换为实际运行的 TDengine 服务 fqdn
和端口号:
```
html
curl -H 'Authorization: Basic cm9vdDp0YW9zZGF0YQ==' -d 'show databases;' h1.taosdata.com:6041/rest/sql
```
返回值结果如下表示验证通过:
```
json
{
...
...
@@ -682,22 +683,23 @@ curl -H 'Authorization: Basic cm9vdDp0YW9zZGF0YQ==' -d 'show databases;' h1.taos
}
```
### RESTful连接器的使用
### RESTful
连接器的使用
#### HTTP请求格式
#### HTTP
请求格式
```
http://<fqdn>:<port>/rest/sql
http://<fqdn>:<port>/rest/sql
/[db_name]
```
参数说明:
-
fqnd: 集群中的任一台主机FQDN或IP地址
-
port: 配置文件中httpPort配置项,缺省为6041
-
fqnd: 集群中的任一台主机 FQDN 或 IP 地址
-
port: 配置文件中 httpPort 配置项,缺省为 6041
-
db_name: 可选参数,指定本次所执行的 SQL 语句的默认数据库库名。(从 2.1.8.0 版本开始支持)
例如:http://h1.taos.com:6041/rest/sql
是指向地址为h1.taos.com:6041的url
。
例如:http://h1.taos.com:6041/rest/sql
/test 是指向地址为 h1.taos.com:6041 的 url,并将默认使用的数据库库名设置为 test
。
HTTP
请求的Header里需带有身份认证信息,TDengine支持Basic
认证与自定义认证两种机制,后续版本将提供标准安全的数字签名机制来做身份验证。
HTTP
请求的 Header 里需带有身份认证信息,TDengine 支持 Basic
认证与自定义认证两种机制,后续版本将提供标准安全的数字签名机制来做身份验证。
-
自定义身份认证信息如下所示(
<token>
稍后介绍)
...
...
@@ -711,25 +713,25 @@ Authorization: Taosd <TOKEN>
Authorization: Basic <TOKEN>
```
HTTP
请求的BODY里就是一个完整的SQL语句,SQL语句中的数据表应提供数据库前缀,例如
\<
db-name>.
\<
tb-name>。如果表名不带数据库前缀,系统会返回错误。因为HTTP模块只是一个简单的转发,没有当前DB
的概念。
HTTP
请求的 BODY 里就是一个完整的 SQL 语句,SQL 语句中的数据表应提供数据库前缀,例如
\<
db_name>.
\<
tb_name>。如果表名不带数据库前缀,又没有在 url 中指定数据库名的话,系统会返回错误。因为 HTTP 模块只是一个简单的转发,没有当前 DB
的概念。
使用
curl通过自定义身份认证方式来发起一个
HTTP Request,语法如下:
使用
curl 通过自定义身份认证方式来发起一个
HTTP Request,语法如下:
```
bash
curl
-H
'Authorization: Basic <TOKEN>'
-d
'<SQL>'
<ip>:<PORT>/rest/sql
curl
-H
'Authorization: Basic <TOKEN>'
-d
'<SQL>'
<ip>:<PORT>/rest/sql
/[db_name]
```
或者
```
bash
curl
-u
username:password
-d
'<SQL>'
<ip>:<PORT>/rest/sql
curl
-u
username:password
-d
'<SQL>'
<ip>:<PORT>/rest/sql
/[db_name]
```
其中,
`TOKEN`
为
`{username}:{password}`
经过Base64编码之后的字符串,例如
`root:taosdata`
编码后为
`cm9vdDp0YW9zZGF0YQ==`
其中,
`TOKEN`
为
`{username}:{password}`
经过 Base64 编码之后的字符串,例如
`root:taosdata`
编码后为
`cm9vdDp0YW9zZGF0YQ==`
### HTTP返回格式
### HTTP
返回格式
返回值为
JSON
格式,如下:
返回值为
JSON
格式,如下:
```
json
{
...
...
@@ -747,9 +749,9 @@ curl -u username:password -d '<SQL>' <ip>:<PORT>/rest/sql
说明:
-
status: 告知操作结果是成功还是失败。
-
head: 表的定义,如果不返回结果集,则仅有一列“affected_rows”。(从 2.0.17.0 版本开始,建议不要依赖 head 返回值来判断数据列类型,而推荐使用 column_meta。在未来版本中,有可能会从返回值中去掉 head 这一项。)
-
head: 表的定义,如果不返回结果集,则仅有一列
“affected_rows”。(从 2.0.17.0 版本开始,建议不要依赖 head 返回值来判断数据列类型,而推荐使用 column_meta。在未来版本中,有可能会从返回值中去掉 head 这一项。)
-
column_meta: 从 2.0.17.0 版本开始,返回值中增加这一项来说明 data 里每一列的数据类型。具体每个列会用三个值来说明,分别为:列名、列类型、类型长度。例如
`["current",6,4]`
表示列名为“current”;列类型为 6,也即 float 类型;类型长度为 4,也即对应 4 个字节表示的 float。如果列类型为 binary 或 nchar,则类型长度表示该列最多可以保存的内容长度,而不是本次返回值中的具体数据长度。当列类型是 nchar 的时候,其类型长度表示可以保存的 unicode 字符数量,而不是 bytes。
-
data: 具体返回的数据,一行一行的呈现,如果不返回结果集,那么就仅有[[affected_rows]]。data 中每一行的数据列顺序,与 column_meta 中描述数据列的顺序完全一致。
-
data: 具体返回的数据,一行一行的呈现,如果不返回结果集,那么就仅有
[[affected_rows]]。data 中每一行的数据列顺序,与 column_meta 中描述数据列的顺序完全一致。
-
rows: 表明总共多少行数据。
column_meta 中的列类型说明:
...
...
@@ -766,13 +768,13 @@ column_meta 中的列类型说明:
### 自定义授权码
HTTP
请求中需要带有授权码
`<TOKEN>`
,用于身份识别。授权码通常由管理员提供,可简单的通过发送
`HTTP GET`
请求来获取授权码,操作如下:
HTTP
请求中需要带有授权码
`<TOKEN>`
,用于身份识别。授权码通常由管理员提供,可简单的通过发送
`HTTP GET`
请求来获取授权码,操作如下:
```
bash
curl http://<fqnd>:<port>/rest/login/<username>/<password>
```
其中,
`fqdn`
是TDengine数据库的fqdn或ip地址,port是TDengine服务的端口号,
`username`
为数据库用户名,
`password`
为数据库密码,返回值为
`JSON`
格式,各字段含义如下:
其中,
`fqdn`
是 TDengine 数据库的 fqdn 或 ip 地址,port 是 TDengine 服务的端口号,
`username`
为数据库用户名,
`password`
为数据库密码,返回值为
`JSON`
格式,各字段含义如下:
-
status:请求结果的标志位
...
...
@@ -798,7 +800,7 @@ curl http://192.168.0.1:6041/rest/login/root/taosdata
### 使用示例
-
在
demo库里查询表d1001
的所有记录:
-
在
demo 库里查询表 d1001
的所有记录:
```
bash
curl
-H
'Authorization: Basic cm9vdDp0YW9zZGF0YQ=='
-d
'select * from demo.d1001'
192.168.0.1:6041/rest/sql
...
...
@@ -818,7 +820,7 @@ curl -H 'Authorization: Basic cm9vdDp0YW9zZGF0YQ==' -d 'select * from demo.d1001
}
```
-
创建库demo:
-
创建库
demo:
```
bash
curl
-H
'Authorization: Basic cm9vdDp0YW9zZGF0YQ=='
-d
'create database demo'
192.168.0.1:6041/rest/sql
...
...
@@ -837,9 +839,9 @@ curl -H 'Authorization: Basic cm9vdDp0YW9zZGF0YQ==' -d 'create database demo' 19
### 其他用法
#### 结果集采用
Unix
时间戳
#### 结果集采用
Unix
时间戳
HTTP
请求URL采用
`sqlt`
时,返回结果集的时间戳将采用Unix
时间戳格式表示,例如
HTTP
请求 URL 采用
`sqlt`
时,返回结果集的时间戳将采用 Unix
时间戳格式表示,例如
```
bash
curl
-H
'Authorization: Basic cm9vdDp0YW9zZGF0YQ=='
-d
'select * from demo.d1001'
192.168.0.1:6041/rest/sqlt
...
...
@@ -860,9 +862,9 @@ curl -H 'Authorization: Basic cm9vdDp0YW9zZGF0YQ==' -d 'select * from demo.d1001
}
```
#### 结果集采用
UTC
时间字符串
#### 结果集采用
UTC
时间字符串
HTTP
请求URL采用
`sqlutc`
时,返回结果集的时间戳将采用UTC
时间字符串表示,例如
HTTP
请求 URL 采用
`sqlutc`
时,返回结果集的时间戳将采用 UTC
时间字符串表示,例如
```
bash
curl
-H
'Authorization: Basic cm9vdDp0YW9zZGF0YQ=='
-d
'select * from demo.t1'
192.168.0.1:6041/rest/sqlutc
```
...
...
@@ -884,13 +886,13 @@ HTTP请求URL采用`sqlutc`时,返回结果集的时间戳将采用UTC时间
### 重要配置项
下面仅列出一些与
RESTful接口有关的配置参数,其他系统参数请看配置文件里的说明。(注意:配置修改后,需要重启taosd
服务才能生效)
下面仅列出一些与
RESTful 接口有关的配置参数,其他系统参数请看配置文件里的说明。(注意:配置修改后,需要重启 taosd
服务才能生效)
-
对外提供
RESTful
服务的端口号,默认绑定到 6041(实际取值是 serverPort + 11,因此可以通过修改 serverPort 参数的设置来修改)
-
httpMaxThreads: 启动的线程数量,默认为
2(2.0.17.0版本开始,默认值改为CPU
核数的一半向下取整)
-
restfulRowLimit: 返回结果集(JSON
格式)的最大条数,默认值为
10240
-
httpEnableCompress: 是否支持压缩,默认不支持,目前
TDengine仅支持gzip
压缩格式
-
httpDebugFlag: 日志开关,默认
131。131:仅错误和报警信息,135:调试信息,143:非常详细的调试信息,默认
131
-
对外提供
RESTful
服务的端口号,默认绑定到 6041(实际取值是 serverPort + 11,因此可以通过修改 serverPort 参数的设置来修改)
-
httpMaxThreads: 启动的线程数量,默认为
2(2.0.17.0 版本开始,默认值改为 CPU
核数的一半向下取整)
-
restfulRowLimit: 返回结果集(JSON
格式)的最大条数,默认值为
10240
-
httpEnableCompress: 是否支持压缩,默认不支持,目前
TDengine 仅支持 gzip
压缩格式
-
httpDebugFlag: 日志开关,默认
131。131:仅错误和报警信息,135:调试信息,143:非常详细的调试信息,默认
131
## <a class="anchor" id="csharp"></a>CSharp Connector
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录