Skip to content

docs: update python docs #34686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qevolg wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: update python docs #34686

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4e48184
docs: update python docs
qevolg Mar 5, 2026
9ecaccc
chore: update taospy and taos-ws-py version
qevolg Mar 5, 2026
33adcce
docs: correct typo in 'taospy' reference in version history section
qevolg Mar 5, 2026
2d5e8da
docs: update authentication token reference from 'token' to 'bearer_t…
qevolg Mar 10, 2026
1444fd0
docs: update python docs
qevolg Mar 10, 2026
6f70dac
Revert "docs: update python docs"
qevolg Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/07-develop/01-connect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ If you are using Maven to manage your project, simply add the following dependen
- Install a specific version

```shell
pip3 install taospy==2.8.8
pip3 install taospy==2.8.9
```

- Install from GitHub
Expand Down
9 changes: 6 additions & 3 deletions docs/en/14-reference/05-connector/30-python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,11 @@ Supports Python 3.0 and above.

## Version History

Python Connector historical versions (it is recommended to use the latest version of 'taopsy'):
Python Connector historical versions (it is recommended to use the latest version of 'taospy'):

|Python Connector Version | Major Changes | TDengine Version|
| --------- | ----------------------------------------------------------------------------------------------------- | ----------------- |
|2.8.9 | Data subscription supports token authentication | - |
|2.8.8 | Support TOTP authentication and token authentication | - |
|2.8.6 | Support for pandas' read_Sql_table, to_Sql, and read_Sql interface calls | - |
|2.8.5 | Support the SQLAlchemy feature of taos-ws-py | - |
Expand All @@ -89,6 +90,7 @@ WebSocket Connector Historical Versions:

|WebSocket Connector Version | Major Changes | TDengine Version|
| ----------------------- | -------------------------------------------------------------------------------------------------- | ----------------- |
|0.6.6 | Data subscription supports token authentication | - |
|0.6.5 | Support TOTP authentication and token authentication | - |
|0.6.4 | Support reporting connector version information | - |
|0.6.3 | Support configuring the response timeout for WebSocket connections (excluding data subscription) | - |
Expand Down Expand Up @@ -381,7 +383,8 @@ The interface for binding parameters of the standard Stmt.
- client.id: Client ID.
- td.connect.user: Database username.
- td.connect.pass: Database password.
- td.connect.token: Database connection token.
- td.connect.token: Cloud service authentication token.
- td.connect.bearer_token: Database authentication token, with higher authentication priority than username and password.
- auto.offset.reset: Determines the consumption position as either the latest data (latest) or including old data (earliest).
- enable.auto.commit: Whether to allow automatic commit.
- auto.commit.interval.ms: Automatic commit interval.
Expand Down Expand Up @@ -560,7 +563,7 @@ TaosResult object can be iterated over to retrieve queried data.
- client.id: Client ID.
- td.connect.user: Database username.
- td.connect.pass: Database password.
- td.connect.token: Database connection token.
- td.connect.token: Database authentication token, with higher authentication priority than username and password.
- auto.offset.reset: Determines the consumption position as either the latest data (latest) or including old data (earliest).
- enable.auto.commit: Whether to allow automatic submission.
- auto.commit.interval.ms: Automatic submission interval.
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/07-develop/01-connect/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ import ConnectorType from "../../14-reference/05-connector/_connector_type.mdx";
- 指定某个特定版本安装

```bash
pip3 install taospy==2.8.8
pip3 install taospy==2.8.9
```

- 从 GitHub 安装
Expand Down
9 changes: 6 additions & 3 deletions docs/zh/14-reference/05-connector/30-python.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Python Connector 历史版本（建议使用最新版本的 `taospy`）：

| Python Connector 版本 | 主要变化 | TDengine TSDB 版本 |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| 2.8.9 | 数据订阅支持令牌身份验证 | - |
| 2.8.8 | 支持 TOTP 身份验证和令牌身份验证 | - |
| 2.8.6 | 支持 pandas 的 read_sql_table，to_sql 和 read_sql 接口 | - |
| 2.8.5 | 支持 taos-ws-py 的 sqlalchemy 功能 | - |
Expand All @@ -85,7 +86,8 @@ WebSocket Connector 历史版本：

| WebSocket Connector 版本 | 主要变化 | TDengine TSDB 版本 |
| ----------------------- | ------------------------------------------------------------------------------------ | ----------------- |
| 0.6.5 | 支持 TOTP 身份验证和令牌身份验证 | - |
| 0.6.6 | 数据订阅支持令牌身份验证 | - |
| 0.6.5 | 支持 TOTP 身份验证和令牌身份验证 | - |
| 0.6.4 | 支持上报连接器版本信息 | - |
| 0.6.3 | 支持配置 WebSocket 连接的响应超时时间（不含数据订阅） | - |
| 0.6.2 | 修复内存泄漏 | - |
Expand Down Expand Up @@ -381,7 +383,8 @@ TaosResult 对象可以通过循环遍历获取查询到的数据。
- client.id：客户端 id。
- td.connect.user：数据库用户名。
- td.connect.pass：数据库密码。
- td.connect.token：数据库的连接 token。
- td.connect.token：云服务认证 token。
- td.connect.bearer_token：数据库认证 token，认证优先级高于用户名密码。
- auto.offset.reset：来确定消费位置为最新数据（latest）还是包含旧数据（earliest）。
- enable.auto.commit：是否允许自动提交。
- auto.commit.interval.ms：自动提交间隔
Expand Down Expand Up @@ -560,7 +563,7 @@ TaosResult 对象可以通过循环遍历获取查询到的数据。
- client.id：客户端 id。
- td.connect.user：数据库用户名。
- td.connect.pass：数据库密码。
- td.connect.token：数据库的连接 token。
- td.connect.token：数据库认证 token，认证优先级高于用户名密码。
- auto.offset.reset：来确定消费位置为最新数据（latest）还是包含旧数据（earliest）。
- enable.auto.commit：是否允许自动提交。
- auto.commit.interval.ms：自动提交间隔
Expand Down
2 changes: 1 addition & 1 deletion test/cases/83-DocTest/python.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ pip3 install kafka-python==2.1.2
python3 kafka_example_consumer.py

# 21
pip3 install taos-ws-py==0.6.5
pip3 install taos-ws-py==0.6.6
python3 conn_websocket_pandas.py

# 22
Expand Down
2 changes: 1 addition & 1 deletion test/ci/container_build_newmachine.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ docker run \
-v /root/go/pkg/mod:/root/go/pkg/mod \
-v /root/.cache/go-build:/root/.cache/go-build \
-v /root/.cos-local.1:/root/.cos-local.2 \
--rm --ulimit core=-1 tdengine-ci:0.1 sh -c "pip uninstall taospy -y;pip3 install taospy==2.8.8;cd $REP_DIR;rm -rf debug;mkdir -p debug;cd debug;cmake .. -DBUILD_HTTP=false -DBUILD_TOOLS=true -DBUILD_TEST=true -DWEBSOCKET=true -DBUILD_SANITIZER=1 -DTOOLS_SANITIZE=true $CMAKE_BUILD_TYPE -DTOOLS_BUILD_TYPE=Debug -DBUILD_TAOSX=false -DJEMALLOC_ENABLED=0;make -j 10|| exit 1 "
--rm --ulimit core=-1 tdengine-ci:0.1 sh -c "pip uninstall taospy -y;pip3 install taospy==2.8.9;cd $REP_DIR;rm -rf debug;mkdir -p debug;cd debug;cmake .. -DBUILD_HTTP=false -DBUILD_TOOLS=true -DBUILD_TEST=true -DWEBSOCKET=true -DBUILD_SANITIZER=1 -DTOOLS_SANITIZE=true $CMAKE_BUILD_TYPE -DTOOLS_BUILD_TYPE=Debug -DBUILD_TAOSX=false -DJEMALLOC_ENABLED=0;make -j 10|| exit 1 "
# -v ${REP_REAL_PATH}/community/contrib/jemalloc/:${REP_DIR}/community/contrib/jemalloc \

if [[ -d ${WORKDIR}/debugNoSan ]] ;then
Expand Down
6 changes: 3 additions & 3 deletions test/ci/run_case.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ cd $CONTAINER_TESTDIR/$target_dir || {

ulimit -c unlimited

# get python connector and update: taospy 2.8.8 taos-ws-py 0.6.5
pip3 install taospy==2.8.8
pip3 install taos-ws-py==0.6.5
# get python connector and update: taospy 2.8.9 taos-ws-py 0.6.6
pip3 install taospy==2.8.9
pip3 install taos-ws-py==0.6.6
pip3 install pyotp

$TIMEOUT_CMD $cmd
Expand Down
4 changes: 2 additions & 2 deletions test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ dependencies = [
"pluggy==1.5.0",
"pytest-cov==4.1.0",
"pytest>=8.3.4",
"taos-ws-py>=0.6.5",
"taos-ws-py>=0.6.6",
"pytest-xdist>=3.6.1",
"pytz==2025.1",
"requests==2.32.4",
"taospy>=2.8.8",
"taospy>=2.8.9",
"tomli==2.2.1",
"urllib3==2.5.0",
"pywinrm>=0.5.0",
Expand Down
4 changes: 2 additions & 2 deletions test/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ pytest-xdist==3.6.1
pywinrm==0.5.0
PyYAML==6.0.2
requests==2.32.4
taos-ws-py==0.6.5
taospy==2.8.8
taos-ws-py==0.6.6
taospy==2.8.9
threadpool==1.3.2
toml==0.10.2
tzlocal==5.3.1
Expand Down
4 changes: 2 additions & 2 deletions test/uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/ci/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ RUN apt-get install -y locales psmisc sudo tree libgeos-dev libgflags2.2 libgfl
RUN sed -i 's/# en_US.UTF-8/en_US.UTF-8/' /etc/locale.gen && locale-gen
RUN pip3 config set global.index-url http://admin:123456@192.168.0.212:3141/admin/dev/+simple/
RUN pip3 config set global.trusted-host 192.168.0.212
RUN pip3 install taospy==2.8.8 taos-ws-py==0.6.5 pandas psutil fabric2 requests faker simplejson toml pexpect tzlocal distro decorator loguru hyperloglog
RUN pip3 install taospy==2.8.9 taos-ws-py==0.6.6 pandas psutil fabric2 requests faker simplejson toml pexpect tzlocal distro decorator loguru hyperloglog
ENV LANG=en_US.UTF-8 LANGUAGE=en_US.UTF-8 LC_ALL=en_US.UTF-8
RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys E298A3A825C0D65DFD57CBB651716619E084DAB9
RUN add-apt-repository 'deb https://cloud.r-project.org/bin/linux/ubuntu focal-cran40/'
Expand Down
2 changes: 1 addition & 1 deletion tests/ci/container_build_newmachine.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ docker run \
-v /root/go/pkg/mod:/root/go/pkg/mod \
-v /root/.cache/go-build:/root/.cache/go-build \
-v /root/.cos-local.1:/root/.cos-local.2 \
--rm --ulimit core=-1 taos_test:v1.0 sh -c "pip uninstall taospy -y; pip3 install taospy==2.8.8; cd $REP_DIR; rm -rf debug ;mkdir -p debug; cd debug; cmake .. -DBUILD_HTTP=false -DBUILD_TOOLS=true -DBUILD_TEST=ON -DWEBSOCKET=true -DBUILD_SANITIZER=1 -DTOOLS_SANITIZE=true $CMAKE_BUILD_TYPE -DTOOLS_BUILD_TYPE=Debug -DBUILD_TAOSX=false -DJEMALLOC_ENABLED=OFF; make -j 10|| exit 1 "
--rm --ulimit core=-1 taos_test:v1.0 sh -c "pip uninstall taospy -y; pip3 install taospy==2.8.9; cd $REP_DIR; rm -rf debug ;mkdir -p debug; cd debug; cmake .. -DBUILD_HTTP=false -DBUILD_TOOLS=true -DBUILD_TEST=ON -DWEBSOCKET=true -DBUILD_SANITIZER=1 -DTOOLS_SANITIZE=true $CMAKE_BUILD_TYPE -DTOOLS_BUILD_TYPE=Debug -DBUILD_TAOSX=false -DJEMALLOC_ENABLED=OFF; make -j 10|| exit 1 "
# -v ${REP_REAL_PATH}/community/contrib/jemalloc/:${REP_DIR}/community/contrib/jemalloc \

if [[ -d ${WORKDIR}/debugNoSan ]] ;then
Expand Down
2 changes: 1 addition & 1 deletion tests/ci/dockerfile_ci
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ RUN pip3 config set global.index-url http://admin:123456@192.168.0.212:3141/admi
&& pip3 config set global.trusted-host 192.168.0.212 \
&& pip3 install --no-cache-dir -r /home/requirements.txt \
&& pip3 install --no-cache-dir \
taospy==2.8.8 taos-ws-py==0.6.5 pandas psutil codecov fabric2 requests faker simplejson toml \
taospy==2.8.9 taos-ws-py==0.6.6 pandas psutil codecov fabric2 requests faker simplejson toml \
pexpect tzlocal distro decorator loguru hyperloglog websockets

ADD go1.23.4.linux-amd64.tar.gz \
Expand Down
6 changes: 3 additions & 3 deletions tests/parallel_test/run_case.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ md5sum /home/TDinternal/debug/build/lib/libtaos.so
md5sum /usr/lib/libtaosnative.so.1
md5sum /home/TDinternal/debug/build/lib/libtaosnative.so

# get python connector and update: taospy 2.8.8 taos-ws-py 0.6.5
pip3 install taospy==2.8.8
pip3 install taos-ws-py==0.6.5
# get python connector and update: taospy 2.8.9 taos-ws-py 0.6.6
pip3 install taospy==2.8.9
pip3 install taos-ws-py==0.6.6
$TIMEOUT_CMD $cmd
RET=$?
echo "cmd exit code: $RET"
Expand Down
Loading