Google Git
Sign in
apache / skywalking-banyandb-client-proto

BanyanDB public client Protocol Buffer and gRPC definitions

Mirrored from https://github.com/apache/skywalking-banyandb-client-proto.git
Clone this repo:

Branches

  1. b1c8766 Fix file name. by Wu Sheng · 7 weeks ago main
  2. a477011 Try to fix project description. by 吴晟 Wu Sheng · 7 weeks ago
  3. 7734a83 Refactor CI workflow configuration in ci.yml for improved clarity and consistency. (#1) by Gao Hongtao · 7 weeks ago
  4. 374f5f8 Update README.md to enhance documentation on BanyanDB client proto definitions, including sync process, prerequisites, and project structure. by Gao Hongtao · 7 weeks ago
  5. 164447d Add proto files for Banyandb API including common, database, measure, model, property, stream, and trace definitions by Gao Hongtao · 7 weeks ago

BanyanDB Client Proto Definitions

This repo contains the BanyanDB public client Protocol Buffer / gRPC definitions, plus a small toolchain to:

  • Sync protos from the upstream BanyanDB repo (apache/skywalking-banyandb)
  • Normalize and merge upstream protos into a stable client-facing layout under proto/banyandb/v1/
  • Generate + compile Java from the synced protos to verify the sync is valid (also enforced in CI)

Upstream source of truth

Protos are synced from the Apache SkyWalking BanyanDB repository:

  • Repo: apache/skywalking-banyandb
  • Path: api/proto/banyandb/<module>/v1/*.proto

Locally, this repo maintains a consolidated, client-friendly layout:

  • proto/banyandb/v1/banyandb-common.proto
  • proto/banyandb/v1/banyandb-database.proto
  • proto/banyandb/v1/banyandb-measure.proto
  • proto/banyandb/v1/banyandb-model.proto
  • proto/banyandb/v1/banyandb-property.proto
  • proto/banyandb/v1/banyandb-stream.proto
  • proto/banyandb/v1/banyandb-trace.proto

These files are produced by scripts/sync_proto.py, which also rewrites imports to match the merged layout.

Prerequisites

  • Python: 3.x (for scripts/sync_proto.py)
  • Java: JDK 17 (for compilation verification)
  • Maven: use ./mvnw (recommended) or a system mvn

If you use ./mvnw and hit a permission error, run:

chmod +x mvnw

Sync protos

Preview changes (dry-run)

make sync-proto-dry-run

Or directly (with extra options):

python3 scripts/sync_proto.py --branch main --dry-run

Apply changes

Interactive (asks for confirmation):

make sync-proto

Non-interactive (useful in automation):

python3 scripts/sync_proto.py --branch main --force

Sync only specific module(s)

python3 scripts/sync_proto.py --branch main --module common --module measure --force

Valid modules are: common, database, measure, model, property, stream, trace.

Sync via GitHub Actions (opens a PR)

Run the workflow “Sync Proto Files” (.github/workflows/sync-proto.yml) with an optional branch input (defaults to main).

Verify the sync (generate + compile)

The fastest correctness check after syncing is to generate Java from the protos and compile:

make compile

This runs mvn clean compile (preferring ./mvnw if present), which:

  • Generates Java sources from proto/**/*.proto into target/generated-sources/
  • Compiles them into target/classes/

This is also what CI runs in “Verify Proto Files” (.github/workflows/verify-proto.yml).

Clean

make clean

Project structure

.
├── proto/
│   └── banyandb/
│       └── v1/                 # Consolidated (synced) proto files
├── scripts/
│   └── sync_proto.py           # Sync + merge tool (pulls from upstream GitHub)
├── pom.xml                     # Java compile verification (protoc + javac via Maven)
├── mvnw                        # Maven wrapper (preferred)
├── Makefile                    # Convenience targets
└── README.md

Code of conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please follow the REPORTING GUIDELINES to report unacceptable behavior.

Contact Us

  • Mail list: dev@skywalking.apache.org. Mail to dev-subscribe@skywalking.apache.org, follow the reply to subscribe the mail list.
  • Send Request to join SkyWalking slack mail to the mail list(dev@skywalking.apache.org), we will invite you in.
  • Twitter, ASFSkyWalking
  • QQ Group: 901167865(Recommended), 392443393
  • bilibili B站 视频

License

Apache 2.0 License.