编译
- 作者仓库星标 340
- 许可证 Apache-2.0
- 作者仓库 skywalking-banyandb
- 领域
- 工程开发
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 94 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @apache · Apache-2.0
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
第1步:生成protobuf和mock代码
首先运行`make generate`。这会通过mockgen从`.proto`定义和模拟文件重新生成`.pb.go`文件。每当出现以下情况时,都需要执行此步骤: 添加或修改了原型文件 (`.proto`),mockgen 使用的 Go 接口已更改 如果生成失败,请检查:
第 2 步:构建所有二进制文件
运行`make build`编译所有项目组件:ui、banyand、bydbctl、mcp、fodc/agent、fodc/proxy。二进制文件输出到每个组件的`build/bin/dev/`目录。
# Compiling SkyWalking BanyanDB
Follow these steps to compile the project.
## Step 1: Generate protobuf and mock code
Run `make generate` first. This regenerates `.pb.go` files from `.proto` definitions and mock files via mockgen.
This step is **required** whenever:
- Proto files (`.proto`) have been added or modified
- Go interfaces used by mockgen have changed
If generate fails, check:
- `protoc` and Go protobuf plugins are installed
- Proto file syntax is valid
- Interface signatures match mock expectations
## Step 2: Build all binaries
Run `make build` to compile all project components: ui, banyand, bydbctl, mcp, fodc/agent, fodc/proxy.
Binaries are output to each component's `build/bin/dev/` directory.
## Troubleshooting
- **Missing fields in .pb.go**: Proto files were updated but `make generate` was not run. Run it first.
- **Mock generation failures**: An interface changed but the mock wasn't regenerated. `make generate` fixes this.
- **Import errors**: Check import aliases match CLAUDE.md conventions (e.g., `commonv1`, `databasev1`).
## Other useful targets
- `make clean` — clean all build artifacts
- `make clean-build` — clean only build binaries
- `make lint` — run linters
- `make test` — run tests
章节与文件索引
按说明文件中的顺序排列。
第1步:生成protobuf和mock代码
第 2 步:构建所有二进制文件
故障排除
其他有用的目标
文件/命令 -> make generate · .pb.go · .proto · protoc · make build · build/bin/dev/ · commonv1 · databasev1
内容校验值 -> 2b31c9a193f0
当前原文的自动摘译,尚未人工审校。
第1步:生成protobuf和mock代码
首先运行
make generate。这会通过mockgen从.proto定义和模拟文件重新生成.pb.go文件。每当以下情况时都需要执行此步骤: 添加或修改了原型文件(.proto) 已更改mockgen使用的Go接口已更改 如果生成失败,请检查:故障排除
.pb.go 中缺少字段:Proto 文件已更新,但
make generate未运行。首先运行它。模拟生成失败:接口发生更改,但模拟未重新生成。make generate解决了这个问题。导入错误:检查导入别名是否匹配 CLAUDE.md 约定(例如,commonv1、databasev1)。其他有用的目标
make clean— 清理所有构建工件make clean-build— 仅清理构建二进制文件make lint— 运行 lintermake test— 运行测试