xxq250
/
homework-jianmu
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: modify connector compatibility description

This commit is contained in:
t_max 2024-12-09 11:43:25 +08:00
parent d72eacc721
commit 5675f29f91
4 changed files with 40 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/zh/08-operation/12-multi.md
View File

@ -121,7 +121,7 @@ s3migrate database <db_name>;
当 TSDB 时序数据超过 `s3_keeplocal` 参数指定的时间，相关的数据文件会被切分成多个文件块，每个文件块的默认大小是 512M 字节 (`s3_chunkpages * tsdb_pagesize`)。除了最后一个文件块保留在本地文件系统外，其余的文件块会被上传到对象存储服务。 当 TSDB 时序数据超过 `s3_keeplocal` 参数指定的时间，相关的数据文件会被切分成多个文件块，每个文件块的默认大小是 512M 字节 (`s3_chunkpages * tsdb_pagesize`)。除了最后一个文件块保留在本地文件系统外，其余的文件块会被上传到对象存储服务。
```math ```math
上传次数 = 数据文件大小 / (s3_chunkpages * tsdb_pagesize) - 1 \text{上传次数} = \text{数据文件大小} / (s3_chunkpages * tsdb_pagesize) - 1
``` ```
在创建数据库时，可以通过 `s3_chunkpages` 参数调整每个文件块的大小，从而控制每个数据文件的上传次数。 在创建数据库时，可以通过 `s3_chunkpages` 参数调整每个文件块的大小，从而控制每个数据文件的上传次数。
@ -135,7 +135,7 @@ s3migrate database <db_name>;
相邻的多个数据页会作为一个数据块从对象存储下载一次，以减少从对象存储下载的次数。每个数据页的大小，在创建数据库时，通过 `tsdb_pagesize` 参数指定，默认 4K 字节。 相邻的多个数据页会作为一个数据块从对象存储下载一次，以减少从对象存储下载的次数。每个数据页的大小，在创建数据库时，通过 `tsdb_pagesize` 参数指定，默认 4K 字节。
```math ```math
下载次数 = 查询需要的数据块数量 - 已缓存的数据块数量 \text{下载次数} = \text{查询需要的数据块数量} - \text{已缓存的数据块数量}
``` ```
页缓存是内存缓存，节点重启后，再次查询需要重新下载数据。缓存采用 LRU (Least Recently Used) 策略，当缓存空间不足时，最近最少使用的数据将被淘汰。缓存的大小可以通过 `s3PageCacheSize` 参数进行调整，通常来说，缓存越大，下载次数越少。 页缓存是内存缓存，节点重启后，再次查询需要重新下载数据。缓存采用 LRU (Least Recently Used) 策略，当缓存空间不足时，最近最少使用的数据将被淘汰。缓存的大小可以通过 `s3PageCacheSize` 参数进行调整，通常来说，缓存越大，下载次数越少。

29
docs/zh/14-reference/05-connector/20-go.mdx
View File

@ -14,18 +14,35 @@ import RequestId from "./_request_id.mdx";
## 兼容性 ## 兼容性
支持最低 Go 版本 1.14，建议使用最新 Go 版本 支持 Go 版本 1.14及以上版本。
## 支持的平台 ## 支持的平台
原生连接支持的平台和 TDengine 客户端驱动支持的平台一致。 - 原生连接支持的平台和 TDengine 客户端驱动支持的平台一致。
REST 连接支持所有能运行 Go 的平台。 - WebSocket/REST 连接支持所有能运行 Go 的平台。
## 版本支持 ## 版本历史
请参考[版本支持列表](https://github.com/taosdata/driver-go#remind) | driver-go 版本 | 主要变化 | TDengine 版本 |
|:-------------|:-------------------------------------|:------------|
| v3.5.8 | 修复空指针异常 | 3.3.2.0 |
| v3.5.7 | taosWS 和 taosRestful 支持传入 request id | 3.3.2.0 |
| v3.5.6 | 提升 websocket 查询和写入性能 | 3.3.2.0 |
| v3.5.5 | restful 支持跳过 ssl 证书检查 | 3.2.3.0 |
| v3.5.4 | 兼容 TDengine 3.3.0.0 tmq raw data | 3.2.3.0 |
| v3.5.3 | 重构 taosWS | 3.2.3.0 |
| v3.5.2 | websocket 压缩和优化消息订阅性能 | 3.2.3.0 |
| v3.5.1 | 原生 stmt 查询和 geometry 类型支持 | 3.2.1.0 |
| v3.5.0 | 获取消费进度及按照指定进度开始消费 | 3.0.5.0 |
| v3.3.1 | 基于 websocket 的 schemaless 协议写入 | 3.0.4.1 |
| v3.1.0 | 提供贴近 kafka 的订阅 api | 3.0.2.2 |
| v3.0.4 | 新增 request id 相关接口 | 3.0.2.2 |
| v3.0.3 | 基于 websocket 的 statement 写入 | 3.0.1.5 |
| v3.0.2 | 基于 websocket 的数据查询和写入 | 3.0.1.5 |
| v3.0.1 | 基于 websocket 的消息订阅 | 3.0.0.0 |
| v3.0.0 | 适配 TDengine 3.0 查询和写入 | 3.0.0.0 |
## 处理异常 ## 异常和错误码
如果是 TDengine 错误可以通过以下方式获取错误码和错误信息。 如果是 TDengine 错误可以通过以下方式获取错误码和错误信息。

2
docs/zh/14-reference/05-connector/26-rust.mdx
View File

@ -35,7 +35,7 @@ import RequestId from "./_request_id.mdx";
| Rust 连接器版本 | 主要变化 | TDengine 版本 | | Rust 连接器版本 | 主要变化 | TDengine 版本 |
| :---------------- | :-------------------------------------------------- | :-------------- | | :---------------- | :-------------------------------------------------- | :-------------- |
| v0.12.3 | 1. 优化了 WebSocket 查询和插入性能 <br> 2. 支持了 VARBINARY 和 GEOMETRY 类型 | 3.3.0.0 及更高版本 | | v0.12.3 | 1. 优化了 WebSocket 查询和插入性能 <br/> 2. 支持了 VARBINARY 和 GEOMETRY 类型 | 3.3.0.0 及更高版本 |
| v0.12.0 | WS 支持压缩。 | 3.2.3.0 及更高版本 | | v0.12.0 | WS 支持压缩。 | 3.2.3.0 及更高版本 |
| v0.11.0 | TMQ 功能优化。 | 3.2.0.0 | | v0.11.0 | TMQ 功能优化。 | 3.2.0.0 |
| v0.10.0 | WS endpoint 变更。 | 3.1.0.0 | | v0.10.0 | WS endpoint 变更。 | 3.1.0.0 |

36
docs/zh/14-reference/05-connector/40-csharp.mdx
View File

@ -10,35 +10,27 @@ import RequestId from "./_request_id.mdx";
`TDengine.Connector` 是 TDengine 提供的 C# 语言连接器。C# 开发人员可以通过它开发存取 TDengine 集群数据的 C# 应用软件。 `TDengine.Connector` 是 TDengine 提供的 C# 语言连接器。C# 开发人员可以通过它开发存取 TDengine 集群数据的 C# 应用软件。
## 连接方式
`TDengine.Connector` 提供两种形式的连接器
* **原生连接**，通过 TDengine 客户端驱动程序（taosc）原生连接 TDengine 实例，支持数据写入、查询、数据订阅、schemaless 接口和参数绑定接口等功能。
* **WebSocket 连接**，通过 taosAdapter 提供的 WebSocket 接口连接 TDengine 实例，WebSocket 连接实现的功能集合和原生连接有少量不同。（自 v3.0.1 起）
连接方式的详细介绍请参考：[连接方式](../../../develop/connect/#连接方式)
## 兼容性 ## 兼容性
* `TDengine.Connector` 3.1.0 版本进行了完整的重构，不再兼容 3.0.2 及以前版本。3.0.2 文档请参考 [nuget](https://www.nuget.org/packages/TDengine.Connector/3.0.2) - .NET Framework 4.6 及以上版本。
* `TDengine.Connector` 3.x 不兼容 TDengine 2.x，如果在运行 TDengine 2.x 版本的环境下需要使用 C# 连接器请使用 TDengine.Connector 的 1.x 版本。 - .NET 5.0 及以上版本。
- `TDengine.Connector` 3.1.0 版本进行了完整的重构，不再兼容 3.0.2 及以前版本。3.0.2 文档请参考 [nuget](https://www.nuget.org/packages/TDengine.Connector/3.0.2)
- `TDengine.Connector` 3.x 不兼容 TDengine 2.x，如果在运行 TDengine 2.x 版本的环境下需要使用 C# 连接器请使用 TDengine.Connector 的 1.x 版本。
## 支持的平台 ## 支持的平台
支持的平台和 TDengine 客户端驱动支持的平台一致。 - 原生连接支持的平台和 TDengine 客户端驱动支持的平台一致。
- WebSocket 连接支持所有能运行 .NET 运行时的平台。
:::warning ## 版本历史
TDengine 不再支持 32 位 Windows 平台。
:::
## 版本支持 | Connector 版本 | 主要变化 | TDengine 版本 |
|:-------------|:---------------------------|:------------|
| **Connector 版本** | **TDengine 版本** | **主要功能** | | 3.1.4 | 提升 websocket 查询和写入性能 | 3.3.2.0 |
|------------------|------------------|----------------------------| | 3.1.3 | 支持 WebSocket 自动重连 | 3.2.1.0 |
| 3.1.3 | 3.2.1.0/3.1.1.18 | 支持 WebSocket 自动重连 | | 3.1.2 | 修复 schemaless 资源释放 | 3.2.1.0 |
| 3.1.2 | 3.2.1.0/3.1.1.18 | 修复 schemaless 资源释放 | | 3.1.1 | 支持 varbinary 和 geometry 类型 | 3.2.1.0 |
| 3.1.1 | 3.2.1.0/3.1.1.18 | 支持 varbinary 和 geometry 类型 | | 3.1.0 | WebSocket 使用原生实现 | 3.2.1.0 |
| 3.1.0 | 3.2.1.0/3.1.1.18 | WebSocket 使用原生实现 |
## 处理异常 ## 处理异常