yamcs.protobuf.database.database_service.proto Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation

Used by external clients to communicate with Yamcs

There is a newer version: 5.10.9

syntax="proto2";

package yamcs.protobuf.archive;

option java_package = "org.yamcs.protobuf";
option java_outer_classname = "DbServiceProto";
option java_multiple_files = true;

import "google/protobuf/empty.proto";

import "yamcs/api/annotations.proto";

service DatabaseApi {

  // List databases
  rpc ListDatabases(google.protobuf.Empty) returns (ListDatabasesResponse) {
    option (yamcs.api.route) = {
      get: "/api/databases"
    };
  }
  
  // Get database
  rpc GetDatabase(GetDatabaseRequest) returns (DatabaseInfo) {
    option (yamcs.api.route) = {
      get: "/api/databases/{name}"
    };
  }
}

message ListDatabasesResponse {
  repeated DatabaseInfo databases = 1;
}

message GetDatabaseRequest {
  // Database name
  optional string name = 1;
}

message DatabaseInfo {
  // Database name
  optional string name = 1;

  // Path on server
  optional string path = 2;
  optional string tablespace = 3;

  // Names of the tables in this database
  repeated string tables = 4;

  // Names of the streams in this database
  repeated string streams = 5;
}