umadb-proto 0.5.4

Protocol buffer definitions and gRPC service for UmaDB event store
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# 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.

```rust
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.

```rust
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](https://github.com/umadb-io/umadb), a high-performance open-source event store built for Dynamic Consistency Boundaries.

## License

Licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.