README

简体中文 | English | 日本語 | TDengine 云服务 | 很多职位正在热招中，请看 这里



 目录

- 1. 简介
- 2. 文档
- 3. 前置条件
  - 3.1 Linux 系统
    - 3.1.1 Ubuntu
    - 3.1.2 CentOS
  - 3.2 macOS 系统
  - 3.3 Windows 系统
  - 3.4 克隆仓库
- 4. 构建
  - 4.1 Linux 系统上构建
  - 4.2 macOS 系统上构建
  - 4.3 Windows 系统上构建
- 5. 打包
- 6. 安装
  - 6.1 Linux 系统上安装
  - 6.2 macOS 系统上安装
  - 6.3 Windows 系统上安装
- 7. 快速运行
  - 7.1 Linux 系统上运行
  - 7.2 macOS 系统上运行
  - 7.3 Windows 系统上运行
- 8. 测试
- 9. 版本发布
- 10. 工作流
- 11. 覆盖率
- 12. 成为社区贡献者

 1. 简介

TDengine 是一款开源、高性能、云原生、AI 驱动的时序数据库 (Time-Series Database, TSDB)。TDengine 能被广泛运用于物联网、工业互联网、车联网、IT 运维、金融等领域。除核心的时序数据库功能外，TDengine 还提供缓存、数据订阅、流式计算、AI 智能体等功能，是一极简的时序数据处理平台，最大程度的减小系统设计的复杂度，降低研发和运营成本。与其他时序数据库相比，TDengine 的主要优势如下：

- 高性能：通过创新的存储引擎设计，无论是数据写入还是查询，TDengine 的性能比通用数据库快 10 倍以上，也远超其他时序数据库，存储空间不及通用数据库的 1/10。

- 云原生：通过原生分布式的设计，充分利用云平台的优势，TDengine 提供了水平扩展能力，具备弹性、韧性和可观测性，支持 k8s 部署，可运行在公有云、私有云和混合云上。

- 极简时序数据平台：TDengine 内建消息队列、缓存、流式计算、AI 智能体等功能，应用无需再集成 Kafka/Redis/HBase/Spark 等软件，大幅降低系统的复杂度，降低应用开发和运营成本。

- 分析能力：支持 SQL，同时为时序数据特有的分析提供 SQL 扩展。通过超级表、存储计算分离、分区分片、预计算、自定义函数以及 AI Agent 等技术，TDengine 具备强大的分析能力。

- AI 智能体：内置时序数据智能体 TDgpt, 无缝连接时序数据基础模型、大语言模型、机器学习、传统统计算法等，提供时序数据预测、异常检测、数据补全和数据分类的功能。

- 简单易用：无任何依赖，安装、集群几秒搞定；提供 REST 以及各种语言连接器，与众多第三方工具无缝集成；提供命令行程序，便于管理和即席查询；提供各种运维工具。

- 核心开源：TDengine 的核心代码包括集群功能全部开源，截止到 2022 年 8 月 1 日，全球超过 135.9k 个运行实例，GitHub Star 18.7k，Fork 4.4k，社区活跃。

了解 TDengine 高级功能的完整列表，请 点击。体验 TDengine 最简单的方式是通过 TDengine 云平台。对最新发布的 TDengine 组件 TDgpt，请访问 TDgpt README 了解细节。

 2. 文档

关于完整的使用手册，系统架构和更多细节，请参考 TDengine 或者 TDengine 官方文档。

用户可根据需求选择通过 容器、安装包、Kubernetes 来安装或直接使用无需安装部署的 云服务。本快速指南是面向想自己编译、打包、测试的开发者的。

如果想编译或测试 TDengine 连接器，请访问以下仓库：JDBC 连接器、Go 连接器、Python 连接器、Node.js 连接器、C连接器、Rust 连接器。

 3. 前置条件

TDengine 目前可以在 Linux 和 macOS 平台上安装和运行 (企业版支持 Windows)。任何 OS 的应用也可以选择 taosAdapter 的 RESTful 接口连接服务端 taosd。CPU 支持 X64、ARM64，后续会支持 MIPS64、Alpha64、ARM32、RISC-V 等 CPU 架构。目前不支持使用交叉编译器构建。

如果你想要编译 taosAdapter 或者 taosKeeper，需要安装 Go 1.23 及以上版本。

 3.1 Linux 系统



安装 Linux 必备工具

 3.1.1 Ubuntu

支持 Ubuntu 18.04、20.04、22.04 版本

bash
sudo apt-get update
sudo apt-get install -y gcc cmake build-essential git libjansson-dev \
  libsnappy-dev liblzma-dev zlib1g-dev pkg-config libtool autoconf \
  automake groff


 3.1.2 CentOS

支持 CentOS 8 版本

bash
sudo yum update
yum install -y epel-release gcc gcc-c++ make cmake git perl dnf-plugins-core 
yum config-manager --set-enabled powertools
yum install -y zlib-static xz-devel snappy-devel jansson-devel pkgconfig \
  libatomic-static libstdc++-static libtool autoconf automake groff




 3.2 macOS 系统



安装 macOS 必备工具

根据提示安装依赖工具 brew

bash
brew install argp-standalone gflags pkgconfig




 3.3 Windows 系统



安装 Windows 必备工具

进行中。



 3.4 克隆仓库

通过如下命令将 TDengine 仓库克隆到指定计算机：

bash
git clone https://github.com/taosdata/TDengine.git
cd TDengine


 4. 构建

TDengine 还提供一组辅助工具软件 taosTools，目前它包含 taosBenchmark（曾命名为 taosdemo）和 taosdump 两个软件。默认 TDengine 编译不包含 taosTools，您可以在编译 TDengine 时使用 cmake .. -DBUILD_TOOLS=true 来同时编译 taosTools。

为了构建 TDengine，请使用 CMake 3.13.0 或者更高版本。