diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..b873e47b7405bd73b8cb9ef5f90e58c72409977b --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,28 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.3.0 + hooks: + - id: check-yaml + - id: check-json + - id: end-of-file-fixer + - id: trailing-whitespace + +repos: + - repo: https://github.com/psf/black + rev: stable + hooks: + - id: black + +repos: + - repo: https://github.com/pocc/pre-commit-hooks + rev: master + hooks: + - id: cppcheck + args: ["--error-exitcode=0"] + +repos: + - repo: https://github.com/crate-ci/typos + rev: v1.15.7 + hooks: + - id: typos + diff --git a/docs/en/19-tools/04-dbeaver.md b/docs/en/19-tools/04-dbeaver.md new file mode 100644 index 0000000000000000000000000000000000000000..3cb04a73a3199db62d66e715f6dc3e024498a241 --- /dev/null +++ b/docs/en/19-tools/04-dbeaver.md @@ -0,0 +1,38 @@ +--- +sidebar_label: DBeaver +title: DBeaver +description: You can use DBeaver to access your data stored in TDengine and TDengine Cloud. +--- + +[DBeaver](https://dbeaver.io/) is a popular cross-platform database management tool that facilitates data management for developers, database administrators, data analysts, and other users. Starting from version 23.1.1, DBeaver natively supports TDengine and can be used to manage TDengine Cloud as well as TDengine clusters deployed on-premises. + +## Prerequisites + +To use DBeaver to manage TDengine, you need to prepare the following: + +- Install DBeaver. DBeaver supports mainstream operating systems including Windows, macOS, and Linux. Please make sure you download and install the correct version (23.1.1+) and platform package. Please refer to the [official DBeaver documentation](https://github.com/dbeaver/dbeaver/wiki/Installation) for detailed installation steps. +- If you use TDengine Cloud, please [register](https://cloud.tdengine.com/) for an account. + +## Use DBeaver to access TDengine Cloud + +1. Copy TDENGINE_JDBC_URL value. + +``` + +``` + +2. Start the DBeaver application, click the button or menu item to choose **New Database Connection**, and then select **TDengine Cloud** in the **Timeseries** category. + + ![Connect TDengine Cloud with DBeaver](./dbeaver/dbeaver-connect-tdengine-cloud-en.webp) + +3. Configure the TDengine Cloud connection by filling in the JDBC URL value. Click **Test Connection**. If you do not have the TDengine Java connector installed on the local machine, DBeaver will prompt you to download and install it. If the connection is successful, it will be displayed as shown in the following figure. If the connection fails, please check whether the TDengine Cloud service is running properly and whether the JDBC URL is correct. + + ![Configure the TDengine Cloud connection](./dbeaver/dbeaver-connect-tdengine-cloud-test-en.webp) + +4. Use DBeaver to select databases and tables and browse your data stored in TDengine Cloud. + + ![Browse TDengine Cloud data with DBeaver](./dbeaver/dbeaver-browse-data-cloud-en.webp) + +5. You can also manipulate TDengine Cloud data by executing SQL commands. + + ![Use SQL commands to manipulate TDengine Cloud data in DBeaver](./dbeaver/dbeaver-sql-execution-cloud-en.webp) diff --git a/docs/en/19-tools/dbeaver/dbeaver-browse-data-cloud-en.webp b/docs/en/19-tools/dbeaver/dbeaver-browse-data-cloud-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..84424284119ed688e8a5657e2d1be373fc12485e Binary files /dev/null and b/docs/en/19-tools/dbeaver/dbeaver-browse-data-cloud-en.webp differ diff --git a/docs/en/19-tools/dbeaver/dbeaver-browse-data-en.webp b/docs/en/19-tools/dbeaver/dbeaver-browse-data-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..bb2f05a9a1306794601e9d3a537bbb27e7e88823 Binary files /dev/null and b/docs/en/19-tools/dbeaver/dbeaver-browse-data-en.webp differ diff --git a/docs/en/19-tools/dbeaver/dbeaver-config-tdengine-en.webp b/docs/en/19-tools/dbeaver/dbeaver-config-tdengine-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..ff59e96029854b5a8c89460829dda62db8cc1a0a Binary files /dev/null and b/docs/en/19-tools/dbeaver/dbeaver-config-tdengine-en.webp differ diff --git a/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-en.webp b/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..56b2938c9b9cf44f5f03cc0ea2dbeab5843d9086 Binary files /dev/null and b/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-en.webp differ diff --git a/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-test-en.webp b/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-test-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..c15228c8d34426879f8c7198bf8603b7483fff1d Binary files /dev/null and b/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-test-en.webp differ diff --git a/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-en.webp b/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..9dc8286773e5dc0fa8f2d92763dbbcb4e85eecac Binary files /dev/null and b/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-en.webp differ diff --git a/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-test-en.webp b/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-test-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..d22d02e82047d97801a3669fedb22d84191b77ca Binary files /dev/null and b/docs/en/19-tools/dbeaver/dbeaver-connect-tdengine-test-en.webp differ diff --git a/docs/en/19-tools/dbeaver/dbeaver-sql-execution-cloud-en.webp b/docs/en/19-tools/dbeaver/dbeaver-sql-execution-cloud-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..6938c970ac97577798ce7dfe6443f144df54ce9e Binary files /dev/null and b/docs/en/19-tools/dbeaver/dbeaver-sql-execution-cloud-en.webp differ diff --git a/docs/en/19-tools/dbeaver/dbeaver-sql-execution-en.webp b/docs/en/19-tools/dbeaver/dbeaver-sql-execution-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..1f3fc19571f242db918da525ed7da9120847cab3 Binary files /dev/null and b/docs/en/19-tools/dbeaver/dbeaver-sql-execution-en.webp differ diff --git a/docs/en/19-tools/dbeaver/tdengine-cloud-jdbc-dsn-en.webp b/docs/en/19-tools/dbeaver/tdengine-cloud-jdbc-dsn-en.webp new file mode 100644 index 0000000000000000000000000000000000000000..7a8ed8f6d3ab1de3051137c7880f641640746c2f Binary files /dev/null and b/docs/en/19-tools/dbeaver/tdengine-cloud-jdbc-dsn-en.webp differ diff --git a/docs/zh/19-tools/04-dbeaver.md b/docs/zh/19-tools/04-dbeaver.md new file mode 100644 index 0000000000000000000000000000000000000000..3f739c35cc3604ec51133a5ca34f857edb69f680 --- /dev/null +++ b/docs/zh/19-tools/04-dbeaver.md @@ -0,0 +1,42 @@ +--- +sidebar_label: DBeaver +title: DBeaver +description: 使用 DBeaver 存取 TDengine 数据的详细指南 +--- + +DBeaver 是一款流行的跨平台数据库管理工具,方便开发者、数据库管理员、数据分析师等用户管理数据。DBeaver 从 23.1.1 版本开始内嵌支持 TDengine。既支持独立部署的 TDengine 集群也支持 TDengine Cloud。 + +## 前置条件 + +### 安装 DBeaver + +使用 DBeaver 管理 TDengine 需要以下几方面的准备工作。 + +- 安装 DBeaver。DBeaver 支持主流操作系统包括 Windows、macOS 和 Linux。请注意[下载](https://dbeaver.io/download/)正确平台和版本(23.1.1+)的安装包。详细安装步骤请参考 [DBeaver 官方文档](https://github.com/dbeaver/dbeaver/wiki/Installation)。 +- 如果使用 TDengine Cloud,请[注册](https://cloud.taosdata.com/)相应账号。 + +## 使用 DBeaver 访问 TDengine Cloud + +1. 复制 TDENGINE_JDBC_URL 的字符串值。 + +``` + +``` + +2. 启动 DBeaver 应用,点击按钮或菜单项选择“连接到数据库”,然后在时间序列分类栏中选择 TDengine Cloud。 + + ![DBeaver 连接 TDengine Cloud](./dbeaver/dbeaver-connect-tdengine-cloud-zh.webp) + + +3. 配置 TDengine Cloud 连接,填入 JDBC_URL 值。点击“测试连接”,如果本机没有安装 TDengine Java + 连接器,DBeaver 会提示下载安装。连接成功将显示如下图所示。如果显示连接失败,请检查 TDengine Cloud 服务是否启动,JDBC_URL 是否正确。 + + ![配置 TDengine Cloud 连接](./dbeaver/dbeaver-connect-tdengine-cloud-test-zh.webp) + +4. 使用 DBeaver 选择数据库和表可以浏览 TDengine Cloud 服务的数据。 + + ![DBeaver 浏览 TDengine Cloud 数据](./dbeaver/dbeaver-browse-cloud-data-zh.webp) + +5. 也可以通过执行 SQL 命令的方式对 TDengine Cloud 数据进行操作。 + + ![DBeaver SQL 命令 操作 TDengine Cloud](./dbeaver/dbeaver-sql-execution-cloud-zh.webp) diff --git a/docs/zh/19-tools/dbeaver/dbeaver-browse-cloud-data-zh.webp b/docs/zh/19-tools/dbeaver/dbeaver-browse-cloud-data-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..28580c9dfbbea61c1d7225ee4e632ee4258207b8 Binary files /dev/null and b/docs/zh/19-tools/dbeaver/dbeaver-browse-cloud-data-zh.webp differ diff --git a/docs/zh/19-tools/dbeaver/dbeaver-browse-data-zh.webp b/docs/zh/19-tools/dbeaver/dbeaver-browse-data-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..b2faca92b2b6d3fa707c8863de4fb77fdeb49c8f Binary files /dev/null and b/docs/zh/19-tools/dbeaver/dbeaver-browse-data-zh.webp differ diff --git a/docs/zh/19-tools/dbeaver/dbeaver-config-tdengine-zh.webp b/docs/zh/19-tools/dbeaver/dbeaver-config-tdengine-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..c721cf029b3408928bd5daca4ca0a3fe7ed865f5 Binary files /dev/null and b/docs/zh/19-tools/dbeaver/dbeaver-config-tdengine-zh.webp differ diff --git a/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-test-zh.webp b/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-test-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..721fe50cfb8aace700e6528e0c5e5e6525429a86 Binary files /dev/null and b/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-test-zh.webp differ diff --git a/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-zh.webp b/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..b6f12a47082664b8cb29fa841add40443595d8d4 Binary files /dev/null and b/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-cloud-zh.webp differ diff --git a/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-test-zh.webp b/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-test-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..2553ea166ae5d1b08f823e0cf71881cd7da31862 Binary files /dev/null and b/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-test-zh.webp differ diff --git a/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-zh.webp b/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..eff8bd9d21163429005961f2b6ec9594271243d8 Binary files /dev/null and b/docs/zh/19-tools/dbeaver/dbeaver-connect-tdengine-zh.webp differ diff --git a/docs/zh/19-tools/dbeaver/dbeaver-sql-execution-cloud-zh.webp b/docs/zh/19-tools/dbeaver/dbeaver-sql-execution-cloud-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..6efdf48e3e38faea7ed66546fba10c4f1a42460c Binary files /dev/null and b/docs/zh/19-tools/dbeaver/dbeaver-sql-execution-cloud-zh.webp differ diff --git a/docs/zh/19-tools/dbeaver/dbeaver-sql-execution-zh.webp b/docs/zh/19-tools/dbeaver/dbeaver-sql-execution-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..fa95889d7235ce5101dd37f567681d89aa697041 Binary files /dev/null and b/docs/zh/19-tools/dbeaver/dbeaver-sql-execution-zh.webp differ diff --git a/docs/zh/19-tools/dbeaver/tdengine-cloud-jdbc-dsn-zh.webp b/docs/zh/19-tools/dbeaver/tdengine-cloud-jdbc-dsn-zh.webp new file mode 100644 index 0000000000000000000000000000000000000000..bfa474f3ac5f323e59e35b27616951ce3165f942 Binary files /dev/null and b/docs/zh/19-tools/dbeaver/tdengine-cloud-jdbc-dsn-zh.webp differ