TDengine/docs/zh/05-programming/01-connect/01-python.md
2025-12-04 18:25:02 +08:00

4 KiB
Raw Permalink Blame History

sidebar_label title description
Python 使用 Python 连接器建立连接 使用 Python 连接器建立和 TDengine Cloud 的连接

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

安装连接器

安装前准备

您必须先安装 Python3 和 Pip3。

  • 安装 Python。新版本 taospy 包要求 Python 3.6.2+。早期版本 taospy 包要求 Python 3.7+。taos-ws-py 包要求 Python 3.7+。如果系统上还没有 Python 可参考 Python BeginnersGuide 安装。
  • 安装 Pip3。大部分情况下 Python 的安装包都自带了 pip 工具,如果没有请参考 pip documentation 安装。

用 Pip 安装

如果以前安装过旧版本的 Python 连接器,请提前卸载。

pip3 uninstall taos taospy
pip3 uninstall taos taos-ws-py

安装最新或指定版本 taospytaos-ws-py, 在终端里面执行下面的命令。

# 安装最新版本
pip3 install taospy

# 安装指定版本
pip3 install taospy==2.6.2

# 从 GitHub 安装
pip3 install git+https://github.com/taosdata/taos-connector-python.git
pip3 install taos-ws-py

安装验证

对于 REST 连接,只需验证是否能成功导入 taosrest 模块。可在 Python 交互式 Shell 中输入:

import taosrest

对于 WebSocket 连接,只需验证是否能成功导入 taosws 模块。可在 Python 交互式 Shell 中输入:

import taosws

配置

在您的终端里面执行下面的命令来保存 TDengine Cloud 的 URL 和令牌到系统的环境变量里面:

export TDENGINE_CLOUD_URL="<url>"
export TDENGINE_CLOUD_TOKEN="<token>"
set TDENGINE_CLOUD_URL=<url>
set TDENGINE_CLOUD_TOKEN=<token>
$env:TDENGINE_CLOUD_URL='<url>'
$env:TDENGINE_CLOUD_TOKEN='<token>'

另外您也可以在您的 IDE 的运行配置里面设置这些环境变量。

:::note IMPORTANT 替换 <token> 和 <url> 为您的 TDengine Cloud 实例的令牌和 URL。

获取 TDengine Cloud 的令牌和 URL可以登录TDengine Cloud 后点击左边的”编程“菜单然后选择”Python“。

请注意区分 REST 连接和 WebSocket 连接的 URL。 :::

建立连接

复制下面的代码到您的编辑器,然后执行这段代码。

{{#include docs/examples/python/develop_tutorial.py:connect}}

connect() 函数的所有参数都是可选的关键字参数。下面是连接参数的具体说明:

  • urlTDengine Cloud 的 URL。
  • token: TDengine Cloud 的令牌。
  • timeout: HTTP 请求超时时间。单位为秒。默认为 socket._GLOBAL_DEFAULT_TIMEOUT。一般无需配置。
{{#include docs/examples/python/develop_tutorial_ws.py:connect}}

关于如何写入数据和查询数据,请参考写入数据查询数据

更多关于 REST 接口的详情,请参考 REST 接口