gRPC API Reference

armada.proto

Service: Cluster

Cluster service ops.

Service: KV

KV for handling the read/put requests

Service: Tables

API for managing tables.

CreateTableRequest {#createtablerequest}

CreateTableRequest describes the table to be created.

CreateTableResponse {#createtableresponse}

CreateTableResponse describes the newly created table.

DeleteRangeRequest {#deleterangerequest}

DeleteRangeResponse {#deleterangeresponse}

DeleteTableRequest {#deletetablerequest}

DeleteTableRequest describes the table to be deleted.

DeleteTableResponse {#deletetableresponse}

DeleteTableResponse when the table was successfully deleted.

ListTablesRequest {#listtablesrequest}

ListTablesRequest requests the list of currently registered tables.

ListTablesResponse {#listtablesresponse}

FollowerGetTablesResponse contains information about tables stored in the cluster.

Member {#member}

MemberListRequest {#memberlistrequest}

MemberListResponse {#memberlistresponse}

PutRequest {#putrequest}

PutResponse {#putresponse}

RangeRequest {#rangerequest}

RangeResponse {#rangeresponse}

ResponseHeader {#responseheader}

StatusRequest {#statusrequest}

StatusResponse {#statusresponse}

StatusResponse.TablesEntry {#statusresponsetablesentry}

TableInfo {#tableinfo}

TableInfo describes a single table.

TableStatus {#tablestatus}

TxnRequest {#txnrequest}

From google paxosdb paper: Our implementation hinges around a powerful primitive which we call MultiOp. All other database operations except for iteration are implemented as a single call to MultiOp. A MultiOp is applied atomically and consists of three components:

1. A list of tests called guard. Each test in guard checks a single entry in the database. It may check for the absence or presence of a value, or compare with a given value. Two different tests in the guard may apply to the same or different entries in the database. All tests in the guard are applied and MultiOp returns the results. If all tests are true, MultiOp executes t op (see item 2 below), otherwise it executes f op (see item 3 below).
2. A list of database operations called t op. Each operation in the list is either an insert, delete, or lookup operation, and applies to a database entry(ies). Two different operations in the list may apply to the same or different entries in the database. These operations are executed if guard evaluates to true.
3. A list of database operations called f op. Like t op, but executed if guard evaluates to false.

TxnResponse {#txnresponse}

maintenance.proto

Service: Maintenance

Maintenance service provides methods for maintenance purposes.

BackupRequest {#backuprequest}

BackupRequest requests and opens a stream with backup data.

ResetRequest {#resetrequest}

ResetRequest resets either a single or multiple tables in the cluster, meaning that their data will be repopulated from the Leader.

ResetResponse {#resetresponse}

RestoreInfo {#restoreinfo}

RestoreInfo metadata of restore snapshot that is going to be uploaded.

RestoreMessage {#restoremessage}

RestoreMessage contains either info of the table being restored or chunk of a backup data.

RestoreResponse {#restoreresponse}

metrics.proto

Service: Metrics

Metrics service for retrieving Prometheus metrics data via gRPC

MetricsRequest {#metricsrequest}

MetricsRequest is used to request metrics data.

MetricsResponse {#metricsresponse}

MetricsResponse contains the requested metrics data.

mvcc.proto

Command {#command}

CommandResult {#commandresult}

Compare {#compare}

Compare property target for every KV from DB in [key, range_end) with target_union using the operation result. e.g. DB[key].target result target_union.target, that means that for asymmetric operations LESS and GREATER the target property of the key from the DB is the left-hand side of the comparison. Examples:

• DB[key][value] EQUAL target_union.value
• DB[key][value] GREATER target_union.value
• DB[key...range_end][value] GREATER target_union.value
• DB[key][value] LESS target_union.value

KeyValue {#keyvalue}

RequestOp {#requestop}

RequestOp.DeleteRange {#requestopdeleterange}

RequestOp.Put {#requestopput}

RequestOp.Range {#requestoprange}

ResponseOp {#responseop}

ResponseOp.DeleteRange {#responseopdeleterange}

ResponseOp.Put {#responseopput}

ResponseOp.Range {#responseoprange}

Txn {#txn}

Command.CommandType {#commandcommandtype}

Compare.CompareResult {#comparecompareresult}

Compare.CompareTarget {#comparecomparetarget}

replication.proto

Service: Log

Log service provides methods to replicate data from Armada leader's log to Armada followers' logs.

Service: Metadata

Metadata service provides method to get Armada metadata, e.g. tables.

Service: Snapshot

MetadataRequest {#metadatarequest}

MetadataResponse {#metadataresponse}

ReplicateCommand {#replicatecommand}

ReplicateCommandsResponse {#replicatecommandsresponse}

ReplicateCommandsResponse sequence of replication commands

ReplicateErrResponse {#replicateerrresponse}

ReplicateRequest {#replicaterequest}

ReplicateRequest request of the replication data at given leader_index

ReplicateResponse {#replicateresponse}

ReplicateResponse response to the ReplicateRequest

SnapshotChunk {#snapshotchunk}

SnapshotRequest {#snapshotrequest}

Table {#table}

ReplicateError {#replicateerror}

Table.Type {#tabletype}

Scalar Value Types