umadb-proto

Crates.ioumadb-proto
lib.rsumadb-proto
version0.3.3
created_at2025-11-14 22:55:03.265435+00
updated_at2026-01-17 15:31:26.651893+00
descriptionProtocol buffer definitions and gRPC service for UmaDB event store
homepagehttps://umadb.io
repositoryhttps://github.com/umadb-io/umadb
max_upload_size
id1933686
size49,339
John Bywater (johnbywater)

documentation

README

umadb-proto

Protocol buffer definitions and gRPC service for UmaDB event store.

Overview

umadb-proto provides the Protocol Buffers (protobuf) definitions and generated gRPC service code for communicating with UmaDB. This crate enables network communication between UmaDB clients and servers.

Features

  • gRPC service definitions for UmaDB operations
  • Protocol buffer messages for events, queries, and append conditions
  • Type conversions between protobuf and umadb-dcb types

Service Operations

The UmaDB gRPC service provides:

  • Read — get events from the event store.
  • Append — write events to the event store.
  • Head — position of the last recorded event.

Usage

This crate is used by umadb-server and umadb-client.

Clients send requests and convert gRPC status details to DCB errors.

use umadb_proto::dcb_error_from_status;
use umadb_proto::v1::dcb_client::DcbClient;
use umadb_proto::v1::{AppendRequest, ReadRequest};

Servers convert DCB errors to gRPC status details and send responses.

use umadb_proto::status_from_dcb_error;
use umadb_proto::v1::dcb_server::DcbServer;
use umadb_proto::v1::{AppendResponse, ReadResponse};

Protocol Buffers

The protobuf definitions are automatically compiled from the umadb.proto file during the build process using tonic-prost-build.

Part of UmaDB

This crate is part of UmaDB, a high-performance open-source event store built for Dynamic Consistency Boundaries.

License

Licensed under either of:

at your option.

Commit count: 978

cargo fmt