index.mdx

---
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 ConnC from "./_connect_c.mdx";
import ConnR from "./_connect_r.mdx";

TDengine 提高了多种编程语言的连接器方便用户开发应用程序。本节介绍如何使用连接器建立与 TDengine 的连接。

## 连接器建立连接的方式

连接器建立连接的方式，从本质上分为三种:
  1. 通过 taosAdapter 组件提供的 RESTful API 建立连接。
  2. 通过 taosAdapter 组件提供的 WebSocket API 建立连接（目前只有 Java 连接器支持）。
  3. 通过客户端驱动程序直接与服务端程序(taosd)建立连接，这种连接方式下文中简称“本地连接”。

无论使用何种方式建立连接，连接器都提供了相同或相似的 API 操作数据库，都可以执行 SQL 语句，只是初始化连接的方式稍有不同，用户在使用上不会感到太大差别。

关键不同点在于：
1. 使用 RESTful 方式，用户无需安装客户端驱动程序，具有跨平台和易用的优势。
2. WebSocket 方式可以看作对 RESTful 方式的优化，在批量拉取大量数据的场景具有性能优势。
3. 使用本地连接可以体验 TDengine 的全部功能，如[原生接口写入](/reference/connector/cpp#参数绑定-api)、[订阅](reference/connector/cpp#数据订阅接口)等等。

## 安装连接器

<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
```
如果安装了 TDengine 服务端或客户端驱动程序，也可以从本地安装。比如：
```
pip install /usr/local/taos/connector/python
```

</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。

:::

</TabItem>
<TabItem label="Rust" value="rust">

编辑 `Cargo.toml` 添加 `libtaos` 依赖即可。
```toml title=Cargo.toml
[dependencies]
libtaos = { version = "0.4.2"}
```
:::info
Rust 连接器通过不同的特性区分不同的连接方式。如果要建立 RESTful 连接，需要开启 `rest` 特性：
```toml
libtaos = { version = "*", features = ["rest"] }
```

:::

</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/) 的引用即可：

```xml title=csharp.csproj
<ItemGroup>
  <PackageReference Include="TDengine.Connector" Version="1.0.6" />
</ItemGroup>
```
也可通过 dotnet 命令添加：
```
dotnet add package TDengine.Connector
```

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

首先系统上要有 TDeninge 客户端驱动，安装目录下有`connector/jdbc/taos-jdbcdriver-xxx-dist.jar`。然后需要安装 R 的依赖包`RJDBC`：
```r
install.packages("RJDBC")
```

</TabItem>
</Tabs>


## 建立连接

在执行这一步之前，请确保有一个正在运行的，且可以访问到的 TDengine。以下示例代码，都假设 TDengine 安装在本机，且 fqdn（默认 localhost） 和 serverPort（默认 6030） 都使用默认配置。

<Tabs groupId="lang" defaultValue="java">
  <TabItem label="Java" value="java">
    <ConnJava />
  </TabItem>
  <TabItem label="Python" value="python">
    <ConnPythonNative />
  </TabItem>
  <TabItem label="Go" value="go">
      <ConnGo />
  </TabItem>
  <TabItem label="Rust" value="rust">
    <ConnRust />
  </TabItem>
  <TabItem label="Node.js" value="node">
    <ConnNodeNative />
    <ConnNode />
  </TabItem>
  <TabItem label="C#" value="csharp">
    <ConnCSNative />
  </TabItem>
  <TabItem label="R" value="r">
    <ConnR/>
  </TabItem>
  <TabItem label="C" value="c">
    <ConnC />
  </TabItem>
</Tabs>

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

:::