talaria.proto

syntax = "proto3";
package talaria;

option java_multiple_files = true;
option java_package = "com.talaria.protos";
option java_outer_classname = "TalariaProtos";

// go package lets the compiler put the generated files relative to
// the path specified in go_out option. With this, you can just give
// --go_out=$GOPATH/src and it would just work as expected. Passing
// talaria at the end will add "package talaria" statement to the
// generated file. Can be overridden by using M go_opt.
option go_package = "github.com/kelindar/talaria/proto;talaria";
// ---------------------------------------------------------------------------
//                              Ingress Service
// ---------------------------------------------------------------------------
// Ingress represents a Talaria ingress frontend.
service Ingress {
  rpc Ingest(IngestRequest) returns (IngestResponse) {}
  rpc IngestWithTable(IngestWithTableRequest) returns (IngestResponse) {}
}

// IngestRequest represents an ingestion request.
message IngestRequest {
  oneof data {
    Batch  batch = 1; // Batch of events
    bytes  orc   = 2; // An orc file
    bytes  csv   = 3; // CSV (comma-separated) file
    string url   = 4; // A url pointing to a file (.orc, .csv)
    bytes parquet = 5; // A parquet file
  }
}

// IngestRequestWithTable  represents an ingestion request with table name specified.
message IngestWithTableRequest {
  repeated string tables  = 1;
  oneof data {
    Batch  batch = 2; // Batch of events
    bytes  orc   = 3; // An orc file
    bytes  csv   = 4; // CSV (comma-separated) file
    string url   = 5; // A url pointing to a file (.orc, .csv)
    bytes parquet = 6; // A parquet file
  }
}

// IngestResponse represents an ingestion response.
message IngestResponse { }


// Batch represents an event batch. It contains a map of strings in order
// to minimize the size.
message Batch {
  map<uint32, bytes> strings = 1;
  repeated Event     events  = 2;
}

// Event represents a single event. Name as well as value columns are
// interned strings which are present in a batch.
message Event {
  map<uint32, Value> value = 1;
}

// Value represents a value
message Value {
  oneof value {
    int32  int32   = 1;
    int64  int64   = 2;
    double float64 = 3;
    uint32 string  = 4;
    bool   bool    = 5;
    int64  time    = 6;
    uint32 json    = 7;
  }
}

// ---------------------------------------------------------------------------
//                              Query Service
// ---------------------------------------------------------------------------

// Ingress represents a Talaria ingress frontend.
service Query {

  // Describe returns the list of schema/table combinations and the metadata
  rpc Describe(DescribeRequest) returns (DescribeResponse) {}

  // DescribeTable returns the columns and its metadata of table given a schema(ex: data)
  rpc DescribeTable(DescribeTableRequest) returns (DescribeTableResponse) {}

  // GetNodes returns the memberlist of talaria cluster.
  rpc GetNodes(GetNodesRequest) returns (GetNodesResponse) {}

  // GetSplits returns the list of splits for a particular table/filter combination
  rpc GetSplits(GetSplitsRequest) returns (GetSplitsResponse) {}

  // GetRows returns the rows for a particular split
  rpc GetRows(GetRowsRequest) returns (GetRowsResponse) {}
}

// DescribeRequest represents an request to list the tables and schemas.
message DescribeRequest { }

// DescribeResponse represents an response that returns tables and their schemas.
message DescribeResponse {
  repeated TableMeta tables  = 1; // The set of table metadata
}

// DescribeTableRequest represents an request to list the table columns and its metadata.
message DescribeTableRequest {
    string name = 1;
}

// DescribeTableResponse represents an response for the given talbe.
message DescribeTableResponse {
  TableMeta table = 1;
}

//TableMeta represents table metadata
message TableMeta {
  string              schema  = 1; // The schema for the table
  string              table   = 2; // The table name
  repeated ColumnMeta columns = 3; // The list of columns of the table
  string              hashby = 4; // The column name used for partitioning.
  string              sortby = 5; // The column name used for sorting.
}

// ColumnMeta represents a column metadata
message ColumnMeta {
  string name    = 1; // The name of the column (eg. tsi)
  string type    = 2; // The SQL type of the column (eg. varchar)
  string comment = 3; // The optional comment for the column
}

// GetNodesRequest represents an request to get cluster nodes info.
message GetNodesRequest {}

// GetNodesResponse represents response for talaria cluster nodes.
message GetNodesResponse {
  repeated Endpoint nodes = 1;
}

// GetSplitsRequest represents an request to get the splits for a table.
message GetSplitsRequest {
  string          schema    = 1; // The schema for the table
  string          table     = 2; // The table name
  repeated string columns   = 3; // The set of desired columns
  repeated string filters   = 4; // The set of filters
  int32           maxSplits = 5; // The maximum splits that should be returned.
  bytes           nextToken = 6; // The cursor representing the next token
}

// GetSplitsResponse represents an response containing the splits for a table.
message GetSplitsResponse {
  repeated Split splits    = 1; // The list of splits that can be queried
  bytes          nextToken = 2; // The cursor representing the next token
}

// Endpoint represents a host/port combination
message Endpoint {
  string host = 1; // The hostname for the endpoint
  int32  port = 2; // The port for the endpoint
}

// Split represents the split information
message Split {
  bytes             splitID = 1; // The split identifier
  repeated Endpoint hosts   = 2; // The set of hosts
}

// GetRowsRequest represents an request to get the rows for a split.
message GetRowsRequest {
  bytes           splitID   = 1; // The split identifier
  repeated string columns   = 2; // The set of desired columns
  int64           maxBytes  = 3; // The maximum bytes that should be returned.
  bytes           nextToken = 4; // The cursor representing the next token
}

// GetRowsResponse represents a response that returns the rows.
message GetRowsResponse {
  repeated Column columns   = 1; // The set of columnar data
  int32           rowCount  = 2; // The number of rows returned
  bytes           nextToken = 3; // The cursor representing the next token
}

// Column represents a column.
message Column {
  oneof value {
    ColumnOfInt32   int32   = 1;
    ColumnOfInt64   int64   = 2;
    ColumnOfFloat64 float64 = 3;
    ColumnOfString  string  = 4;
    ColumnOfBools   bool    = 5;
    ColumnOfInt64   time    = 6;
    ColumnOfString  json    = 7;
  }
}

// Column containing Int32 values
message ColumnOfInt32 {
  repeated bool nulls = 1; // Determines if a value for a corresponding row is null.
  repeated int32 ints = 2; // Values for each row. If row is null then value is ignored.
}

// Column containing Int64 values
message ColumnOfInt64 {
  repeated bool nulls  = 1; // Determines if a value for a corresponding row is null.
  repeated int64 longs = 2; // Values for each row. If row is null then value is ignored.
}

// Column containing Float64 values
message ColumnOfFloat64 {
  repeated bool   nulls   = 1; // Determines if a value for a corresponding row is null.
  repeated double doubles = 2; // Values for each row. If row is null then value is ignored.
}

// Column containing Boolean values
message ColumnOfBools {
  repeated bool nulls = 1; // Determines if a value for a corresponding row is null.
  repeated bool bools = 2; // Values for each row. If row is null then value is ignored.
}

// Column containing String values
message ColumnOfString {
  repeated bool  nulls = 1; // Determines if a value for a corresponding row is null.
  repeated int32 sizes = 2; // Contains the length in bytes for the corresponding element.
  bytes          bytes = 3; // The UTF-8 encoded byte values.
}