CursusDB 使用教程

原创于 2025-04-06 10:21:40 发布 · 510 阅读

CC 4.0 BY-SA版权

CursusDB 使用教程

cursusdb CursusDB is an open-source distributed in-memory yet persisted document oriented database system with real time capabilities. 项目地址: https://gitcode.com/gh_mirrors/cu/cursusdb

1. 项目目录结构及介绍

CursusDB 是一个开源的分布式内存文档数据库系统，具有实时能力。以下是项目的目录结构及各部分的简要介绍：

cursusdb/
├── cluster/         # 集群相关的代码和启动脚本
├── node/            # 节点相关的代码和启动脚本
├── .gitignore       # Git 忽略文件
├── bundle.sh        # 打包脚本
├── go.mod           # Go 依赖管理文件
├── go.sum           # Go 依赖校验文件
├── license          # 许可证文件
├── readme.md        # 项目说明文件
└── ...             # 其他可能存在的目录和文件

cluster/

包含集群相关的代码以及启动和配置集群所需的脚本。

node/

包含节点相关的代码以及启动和配置节点所需的脚本。

.gitignore

指定在执行 Git 操作时应忽略的文件和目录。

bundle.sh

用于打包项目以便于部署的脚本。

go.mod

记录项目依赖的 Go 模块及其版本。

go.sum

确保下载的模块版本与 go.mod 文件中声明的版本一致。

license

项目的许可证文件，通常是 GPL-3.0 许可。

readme.md

项目的自述文件，包含项目的基本信息和说明。

2. 项目的启动文件介绍

CursusDB 的启动主要涉及两个二进制文件：curode 和 cursus。这两个文件分别用于启动集群和节点。

cluster/ 中的启动文件

cluster/ 目录下的 main.go 文件是集群的入口点，它负责初始化和启动集群服务。

cd cluster
go build .
./curode

node/ 中的启动文件

node/ 目录下的 main.go 文件是节点的入口点，它负责初始化和启动节点服务。

cd node
go build .
./cursus

3. 项目的配置文件介绍

CursusDB 使用 .cursusconfig 文件来配置集群和节点的行为。以下是配置文件的基本结构和一些重要的配置项：

nodes: []
host: 0.0.0.0
tls-node: false
tls-cert: ""
tls-key: ""
tls: false
port: 7681
key: QyjlGfs+AMjvqJd/ovUUA1mBZ3yEq72y8xBQw94a96k=
users:
- YWxleA==:7V8VGHNwVTVC7EktlWS8V3kS/xkLvRg/oODmOeIukDY=
node-reader-size: 2097152
log-max-lines: 1000
join-responses: false
logging: false
timezone: Local
log-query: false
node-read-deadline: 2

nodes: 集群中的节点列表。
host: 集群或节点绑定的主机地址。
tls-node: 是否使用 TLS 连接到节点。
tls-cert: TLS 证书的路径。
tls-key: TLS 私钥的路径。
tls: 是否启用 TLS。
port: 集群或节点监听的端口。
key: 用于认证和加密数据的安全密钥。
users: 数据库用户的列表，包括用户名和安全凭证。
node-reader-size: 节点读取器的大小。
log-max-lines: 日志文件的最大行数。
其他配置项涉及日志记录、节点连接和响应设置等。