index.mdx 6.4 KB
Newer Older
D
dingbo 已提交
1 2 3
---
title: 建立连接
--- 
B
Bo Ding 已提交
4 5 6 7 8 9 10 11

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";
12 13 14
import ConnPythonNative from "./_connect_python_native.mdx";
import ConnCSNative from "./_connect_cs_native.mdx";
import ConnC from "./_connect_c.mdx";
D
dingbo 已提交
15
import ConnR from "./_connect_r.mdx";
B
Bo Ding 已提交
16

陶建辉(Jeff)'s avatar
陶建辉(Jeff) 已提交
17
TDengine 提供RESTful接口,容许在任何平台的任何应用程序通过它访问TDengine运行实例,详细介绍请看 [RESTful API](https://docs.taosdata.com/reference/restful-api/)。除RESTful之外,TDengine还提供多种编程语言的连接器方便用户开发应用程序,其中包括 C/C++、Java、Python、Go、Node.js、C# 、RESTful 等。 本节介绍如何使用连接器建立与 TDengine 的连接。
B
Bo Ding 已提交
18

D
dingbo 已提交
19
## 连接器建立连接的方式
B
Bo Ding 已提交
20

陶建辉(Jeff)'s avatar
陶建辉(Jeff) 已提交
21 22 23
连接器建立连接的方式,TDengine提供两种:
  1. 通过 taosAdapter 组件提供的 RESTful API 建立与 taosd 的连接,这种连接方式下文中简称" 
  2. 通过客户端驱动程序 taosc 直接与服务端程序 taosd 建立连接,这种连接方式下文中简称“本地连接”。
B
Bo Ding 已提交
24

陶建辉(Jeff)'s avatar
陶建辉(Jeff) 已提交
25
无论使用何种方式建立连接,连接器都提供了相同或相似的 API 操作数据库,都可以执行 SQL 语句,只是初始化连接的方式稍有不同,用户在使用上不会感到什么差别。
B
Bo Ding 已提交
26

D
dingbo 已提交
27
关键不同点在于:
陶建辉(Jeff)'s avatar
陶建辉(Jeff) 已提交
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
1. 使用 RESTful 方式,用户无需安装客户端驱动程序 taosc,具有跨平台易用的优势,但性能要下降30%左右。
2. 使用本地连接可以体验 TDengine 的全部功能,如[原生接口写入](/reference/connector/cpp#参数绑定-api)、[订阅](reference/connector/cpp#数据订阅接口)等等。

## 安装客户端驱动taosc

如果选择本地连接,而且应用程序不在TDengine同一台服务器上运行,你需要先安装客户端驱动,否则可以跳过此一步。

### 安装步骤

<Tabs defaultValue="linux" groupId="os">
  <TabItem value="linux" label="Linux">
    <InstallOnWindows />
  </TabItem>
  <TabItem value="windows" label="Windows">
    <InstallOnLinux />
  </TabItem>
</Tabs>

### 安装验证

以上安装和配置完成后,并确认 TDengine 服务已经正常启动运行,此时可以执行 taos 客户端进行登录。

<Tabs defaultValue="linux" groupId="os">
  <TabItem value="linux" label="Linux">
    <VerifyLinux />
  </TabItem>
  <TabItem value="windows" label="Windows">
    <VerifyWindows />
  </TabItem>
</Tabs>
B
Bo Ding 已提交
58

D
dingbo 已提交
59
## 安装连接器
B
Bo Ding 已提交
60

D
dingbo 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
<Tabs groupId="lang">
<TabItem label="Java" value="java">
  
如果使用 maven 管理项目,只需在 pom.xml 中加入以下依赖。

```xml
<dependency>
  <groupId>com.taosdata.jdbc</groupId>
  <artifactId>taos-jdbcdriver</artifactId>
  <version>2.0.38</version>
</dependency>
```

</TabItem>
<TabItem label="Python" value="python">

使用 `pip` 从 PyPI 安装:
```
pip install taospy
```
从 Git URL 安装:
```
pip install git+https://github.com/taosdata/taos-connector-python.git
```

</TabItem>
<TabItem label="Go" value="go">

编辑 `go.mod` 添加 `driver-go` 依赖即可。
```go-mod title=go.mod
module goexample

go 1.17

require github.com/taosdata/driver-go/v2 develop
```
:::note
driver-go 使用 cgo 封装了 taosc 的 API。cgo 需要使用 gcc 编译 C 的源码。因此需要确保你的系统上有 gcc。
B
Bo Ding 已提交
99

D
dingbo 已提交
100
:::
B
Bo Ding 已提交
101

D
dingbo 已提交
102 103
</TabItem>
<TabItem label="Rust" value="rust">
B
Bo Ding 已提交
104

D
dingbo 已提交
105 106 107 108 109 110 111 112 113 114
编辑 `Cargo.toml` 添加 `libtaos` 依赖即可。
```toml title=Cargo.toml
[dependencies]
libtaos = { version = "0.4.2"}
```
:::info
Rust 连接器通过不同的特性区分不同的连接方式。如果要建立 RESTful 连接,需要开启 `rest` 特性:
```toml
libtaos = { version = "*", features = ["rest"] }
```
B
Bo Ding 已提交
115

D
dingbo 已提交
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
:::

</TabItem>
<TabItem label="Node.js" value="node">

Node.js 连接器通过不同的包提供不同的连接方式。

1. 安装 Node.js 本地连接器
  ```
  npm i td2.0-connector
  ```
  :::note
  推荐Node版本大于等于 `node-v12.8.0` 小于 `node-v13.0.0` 

  :::
2. 安装 Node.js RESTful 连接器
  ```
  npm i td2.0-rest-connector
  ```

</TabItem>
<TabItem label="C#" value="csharp">

编辑项目配置文件中添加 [TDengine.Connector](https://www.nuget.org/packages/TDengine.Connector/) 的引用即可:

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
```xml title=csharp.csproj {12}
<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net6.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
    <StartupObject>TDengineExample.AsyncQueryExample</StartupObject>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="TDengine.Connector" Version="1.0.6" />
  </ItemGroup>

</Project>
D
dingbo 已提交
157 158 159 160 161
```
也可通过 dotnet 命令添加:
```
dotnet add package TDengine.Connector
```
162 163 164 165
:::note 
以下示例代码,均基于 dotnet6.0,如果使用其它版本,可能需要做适当调整。 

:::
D
dingbo 已提交
166 167 168 169

</TabItem>
<TabItem label="R" value="r">

170 171 172
1. 下载 [taos-jdbcdriver-version-dist.jar](https://repo1.maven.org/maven2/com/taosdata/jdbc/taos-jdbcdriver/2.0.38/)。
2. 安装 R 的依赖包`RJDBC`:
```R
D
dingbo 已提交
173 174 175
install.packages("RJDBC")
```
</TabItem>
B
Bo Ding 已提交
176 177 178
</Tabs>


D
dingbo 已提交
179
## 建立连接
180

D
dingbo 已提交
181
在执行这一步之前,请确保有一个正在运行的,且可以访问到的 TDengine。以下示例代码,都假设 TDengine 安装在本机,且 fqdn(默认 localhost) 和 serverPort(默认 6030) 都使用默认配置。
B
Bo Ding 已提交
182

183 184
<Tabs groupId="lang" defaultValue="java">
  <TabItem label="Java" value="java">
D
dingbo 已提交
185
    <ConnJava />
186
  </TabItem>
187
  <TabItem label="Python" value="python">
188 189 190
    <ConnPythonNative />
  </TabItem>
  <TabItem label="Go" value="go">
D
dingbo 已提交
191
      <ConnGo />
192 193
  </TabItem>
  <TabItem label="Rust" value="rust">
D
dingbo 已提交
194
    <ConnRust />
195
  </TabItem>
B
Bo Ding 已提交
196
  <TabItem label="Node.js" value="node">
197
    <ConnNodeNative />
D
dingbo 已提交
198
    <ConnNode />
199 200 201 202
  </TabItem>
  <TabItem label="C#" value="csharp">
    <ConnCSNative />
  </TabItem>
D
dingbo 已提交
203 204 205
  <TabItem label="R" value="r">
    <ConnR/>
  </TabItem>
206 207 208
  <TabItem label="C" value="c">
    <ConnC />
  </TabItem>
B
Bo Ding 已提交
209
</Tabs>
D
dingbo 已提交
210 211 212 213 214 215 216 217

:::tip
在没有安装 TDengine 服务端程序的机器上建立本地连接,需要单独[安装客户端驱动](/reference/connector/#安装客户端驱动)。
为避免客户端驱动和服务端不兼容,请尽量使用一致的版本。另外还要配置好[FQDN](https://www.taosdata.com/blog/2020/09/11/1824.html)。

:::