Apache HoraeDB 教程

本教程将引导您了解并初步使用基于Apache HoraeDB的分布式时间序列数据库。

1. 项目目录结构及介绍

在Apache HoraeDB源代码仓库中，目录结构主要如下：

.
├── build                # 构建脚本和配置
├── ci                    # 持续集成相关脚本
├── contrib               # 第三方贡献或附加工具
├── cargo.toml            # Rust项目的主要配置文件
├── Dockerfile            # Docker镜像构建文件
├── docs                  # 文档资料
├── examples              # 示例代码
├── src                    # 主要源代码
│   ├── bin               # 可执行程序
│   └── lib               # 共享库
├── target                # 编译产出物
└── tests                  # 测试用例

• build: 包含构建时使用的配置和脚本。
• ci: 用于持续集成（CI）的脚本。
• contrib: 用户贡献的额外工具或模块。
• cargo.toml: Rust项目的配置文件，定义依赖项和构建设置。
• Dockerfile: 定义了创建Docker镜像的指令。
• docs: 项目相关的文档。
• examples: 示例应用程序和用法演示。
• src/bin: 存放可执行程序的源码，如服务器（horaedb-server）和元数据服务（horaemeta-server）。
• src/lib: 存放共享库的源码，用于实现数据库核心功能。
• target: 编译过程中的中间结果和最终产物。
• tests: 单元测试和其他测试代码。

2. 项目启动文件介绍

HoraeDB包含两个主要的服务组件：

• horaedb-server: 时间序列数据库主服务，处理数据存储和查询请求。
• horaemeta-server: 元数据服务，存储集群配置和元信息。

启动horaedb-server

$ ./target/debug/horaedb-server

启动horaemeta-server

$ ./target/debug/horaemeta-server

请注意，实际运行时可能需要根据配置文件和环境变量进行调整。

3. 项目配置文件介绍

HoraeDB通常通过环境变量或配置文件来设置其行为。默认情况下，配置文件不包含在源代码树中，但您可以创建自定义的配置文件以覆盖默认值。

一个基本的配置文件（例如config.yaml）可以包括如下内容：

server:
  bind_addr: 0.0.0.0:8831    # 数据库服务监听地址
  grpc_port: 5440             # gRPC API端口
  meta_server: localhost:3307 # 元数据服务器地址

meta:
  host: localhost               # 元数据服务主机
  port: 3307                     # 元数据服务端口

cluster:
  id: my_cluster                 # 集群ID
  raft_store:
    path: /path/to/raft/data     # Raft协议数据存储路径

启动服务器时可以通过以下方式指定配置文件：

$ ./horaedb-server --config /path/to/config.yaml
$ ./horaemeta-server --config /path/to/config.yaml

配置文件的具体参数和使用说明应参考官方文档或在源代码中的注释。

以上是HoraeDB的基本介绍和启动指南，更深入的使用和部署细节，建议查阅项目文档和示例代码。祝您使用愉快！