package metadata.proto

Get desktop application:
View/edit binary Protocol Buffers messages

The metadata services definition.

• rpc CreateSchema (CreateSchemaRequest, CreateSchemaResponse)

  metadata.proto:33

  message CreateSchemaRequest

  metadata.proto:250

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string schemaDesc = 3

  message CreateSchemaResponse

  metadata.proto:256

  • optional ResponseHeader header = 1

• rpc ExistSchema (ExistSchemaRequest, ExistSchemaResponse)

  metadata.proto:34

  message ExistSchemaRequest

  metadata.proto:260

  • optional RequestHeader header = 1

  • string schemaName = 2

  message ExistSchemaResponse

  metadata.proto:265

  • optional ResponseHeader header = 1

  • bool exists = 2

• rpc GetSchemas (GetSchemasRequest, GetSchemasResponse)

  metadata.proto:35

  message GetSchemasRequest

  metadata.proto:241

  schema

  • optional RequestHeader header = 1

  message GetSchemasResponse

  metadata.proto:245

  • optional ResponseHeader header = 1

  • repeated Schema schemas = 2

• rpc DropSchema (DropSchemaRequest, DropSchemaResponse)

  metadata.proto:36

  message DropSchemaRequest

  metadata.proto:270

  • optional RequestHeader header = 1

  • string schemaName = 2

  message DropSchemaResponse

  metadata.proto:275

  • optional ResponseHeader header = 1

• rpc CreateTable (CreateTableRequest, CreateTableResponse)

  metadata.proto:37

  message CreateTableRequest

  metadata.proto:314

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string tableName = 3

  • string storageScheme = 4

  • repeated string basePathUris = 5

  • repeated Column columns = 6

  message CreateTableResponse

  metadata.proto:323

  • optional ResponseHeader header = 1

• rpc ExistTable (ExistTableRequest, ExistTableResponse)

  metadata.proto:38

  message ExistTableRequest

  metadata.proto:303

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string tableName = 3

  message ExistTableResponse

  metadata.proto:309

  • optional ResponseHeader header = 1

  • bool exists = 2

• rpc GetTable (GetTableRequest, GetTableResponse)

  metadata.proto:39

  message GetTableRequest

  metadata.proto:280

  table

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string tableName = 3

  • bool withLayouts = 4

    the default value of bool is false in proto3

  message GetTableResponse

  metadata.proto:287

  • optional ResponseHeader header = 1

  • optional Table table = 2

  • repeated Layout layouts = 3

• rpc GetTables (GetTablesRequest, GetTablesResponse)

  metadata.proto:40

  message GetTablesRequest

  metadata.proto:293

  • optional RequestHeader header = 1

  • string schemaName = 2

  message GetTablesResponse

  metadata.proto:298

  • optional ResponseHeader header = 1

  • repeated Table tables = 2

• rpc UpdateRowCount (UpdateRowCountRequest, UpdateRowCountResponse)

  metadata.proto:41

  message UpdateRowCountRequest

  metadata.proto:327

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string tableName = 3

  • uint64 rowCount = 4

  message UpdateRowCountResponse

  metadata.proto:334

  • optional ResponseHeader header = 1

• rpc DropTable (DropTableRequest, DropTableResponse)

  metadata.proto:42

  message DropTableRequest

  metadata.proto:338

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string tableName = 3

  message DropTableResponse

  metadata.proto:344

  • optional ResponseHeader header = 1

• rpc AddLayout (AddLayoutRequest, AddLayoutResponse)

  metadata.proto:43

  message AddLayoutRequest

  metadata.proto:400

  • optional RequestHeader header = 1

  • optional Layout layout = 2

  message AddLayoutResponse

  metadata.proto:405

  • optional ResponseHeader header = 1

• rpc GetLayouts (GetLayoutsRequest, GetLayoutsResponse)

  metadata.proto:44

  message GetLayoutsRequest

  metadata.proto:371

  layout

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string tableName = 3

  message GetLayoutsResponse

  metadata.proto:377

  • optional ResponseHeader header = 1

  • repeated Layout layouts = 2

• rpc GetLayout (GetLayoutRequest, GetLayoutResponse)

  metadata.proto:45

  message GetLayoutRequest

  metadata.proto:382

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string tableName = 3

  • uint64 layoutVersion = 4

    if version = -1, get the latest version

  • GetLayoutRequest.PermissionRange permissionRange = 5

  message GetLayoutResponse

  metadata.proto:395

  • optional ResponseHeader header = 1

  • optional Layout layout = 2

• rpc UpdateLayout (UpdateLayoutRequest, UpdateLayoutResponse)

  metadata.proto:46

  message UpdateLayoutRequest

  metadata.proto:409

  • optional RequestHeader header = 1

  • optional Layout layout = 2

  message UpdateLayoutResponse

  metadata.proto:414

  • optional ResponseHeader header = 1

• rpc CreateRangeIndex (CreateRangeIndexRequest, CreateRangeIndexResponse)

  metadata.proto:47

  message CreateRangeIndexRequest

  metadata.proto:419

  range index

  • optional RequestHeader header = 1

  • optional RangeIndex rangeIndex = 2

  message CreateRangeIndexResponse

  metadata.proto:424

  • optional ResponseHeader header = 1

• rpc GetRangeIndex (GetRangeIndexRequest, GetRangeIndexResponse)

  metadata.proto:48

  message GetRangeIndexRequest

  metadata.proto:428

  • optional RequestHeader header = 1

  • int64 tableId = 2

  message GetRangeIndexResponse

  metadata.proto:433

  • optional ResponseHeader header = 1

  • optional RangeIndex rangeIndex = 2

• rpc UpdateRangeIndex (UpdateRangeIndexRequest, UpdateRangeIndexResponse)

  metadata.proto:49

  message UpdateRangeIndexRequest

  metadata.proto:438

  • optional RequestHeader header = 1

  • optional RangeIndex rangeIndex = 2

  message UpdateRangeIndexResponse

  metadata.proto:443

  • optional ResponseHeader header = 1

• rpc DropRangeIndex (DropRangeIndexRequest, DropRangeIndexResponse)

  metadata.proto:50

  message DropRangeIndexRequest

  metadata.proto:447

  • optional RequestHeader header = 1

  • int64 tableId = 2

  message DropRangeIndexResponse

  metadata.proto:452

  • optional ResponseHeader header = 1

• rpc AddRange (AddRangeRequest, AddRangeResponse)

  metadata.proto:51

  message AddRangeRequest

  metadata.proto:457

  range

  • optional RequestHeader header = 1

  • optional Range range = 2

  message AddRangeResponse

  metadata.proto:462

  • optional ResponseHeader header = 1

• rpc GetRange (GetRangeRequest, GetRangeResponse)

  metadata.proto:52

  message GetRangeRequest

  metadata.proto:466

  • optional RequestHeader header = 1

  • int64 rangeId = 2

  message GetRangeResponse

  metadata.proto:471

  • optional ResponseHeader header = 1

  • optional Range range = 2

• rpc GetRanges (GetRangesRequest, GetRangesResponse)

  metadata.proto:53

  message GetRangesRequest

  metadata.proto:476

  • optional RequestHeader header = 1

  • int64 rangeIndexId = 2

  message GetRangesResponse

  metadata.proto:481

  • optional ResponseHeader header = 1

  • repeated Range ranges = 2

• rpc DeleteRange (DeleteRangeRequest, DeleteRangeResponse)

  metadata.proto:54

  message DeleteRangeRequest

  metadata.proto:486

  • optional RequestHeader header = 1

  • int64 rangeId = 2

  message DeleteRangeResponse

  metadata.proto:491

  • optional ResponseHeader header = 1

• rpc CreateSecondaryIndex (CreateSecondaryIndexRequest, CreateSecondaryIndexResponse)

  metadata.proto:55

  message CreateSecondaryIndexRequest

  metadata.proto:496

  secondary index

  • optional RequestHeader header = 1

  • optional SecondaryIndex secondaryIndex = 2

  message CreateSecondaryIndexResponse

  metadata.proto:501

  • optional ResponseHeader header = 1

• rpc GetSecondaryIndex (GetSecondaryIndexRequest, GetSecondaryIndexResponse)

  metadata.proto:56

  message GetSecondaryIndexRequest

  metadata.proto:505

  • optional RequestHeader header = 1

  • int64 tableId = 2

  message GetSecondaryIndexResponse

  metadata.proto:510

  • optional ResponseHeader header = 1

  • optional SecondaryIndex secondaryIndex = 2

• rpc UpdateSecondaryIndex (UpdateSecondaryIndexRequest, UpdateSecondaryIndexResponse)

  metadata.proto:57

  message UpdateSecondaryIndexRequest

  metadata.proto:515

  • optional RequestHeader header = 1

  • optional SecondaryIndex secondaryIndex = 2

  message UpdateSecondaryIndexResponse

  metadata.proto:520

  • optional ResponseHeader header = 1

• rpc DropSecondaryIndex (DropSecondaryIndexRequest, DropSecondaryIndexResponse)

  metadata.proto:58

  message DropSecondaryIndexRequest

  metadata.proto:524

  • optional RequestHeader header = 1

  • int64 tableId = 2

  message DropSecondaryIndexResponse

  metadata.proto:529

  • optional ResponseHeader header = 1

• rpc AddPath (AddPathRequest, AddPathResponse)

  metadata.proto:59

  message AddPathRequest

  metadata.proto:578

  path

  • optional RequestHeader header = 1

  • optional Path path = 2

  message AddPathResponse

  metadata.proto:583

  • optional ResponseHeader header = 1

• rpc GetPaths (GetPathsRequest, GetPathsResponse)

  metadata.proto:60

  message GetPathsRequest

  metadata.proto:587

  • optional RequestHeader header = 1

  • oneof layoutOrRangeId

    • uint64 layoutId = 2

    • uint64 rangeId = 3

  message GetPathsResponse

  metadata.proto:595

  • optional ResponseHeader header = 1

  • repeated Path paths = 2

• rpc UpdatePath (UpdatePathRequest, UpdatePathResponse)

  metadata.proto:61

  message UpdatePathRequest

  metadata.proto:600

  • optional RequestHeader header = 1

  • optional Path path = 2

  message UpdatePathResponse

  metadata.proto:605

  • optional ResponseHeader header = 1

• rpc DeletePaths (DeletePathsRequest, DeletePathsResponse)

  metadata.proto:62

  message DeletePathsRequest

  metadata.proto:609

  • optional RequestHeader header = 1

  • repeated uint64 pathIds = 2

  message DeletePathsResponse

  metadata.proto:614

  • optional ResponseHeader header = 1

• rpc AddFiles (AddFilesRequest, AddFilesResponse)

  metadata.proto:63

  message AddFilesRequest

  metadata.proto:619

  file

  • optional RequestHeader header = 1

  • repeated File files = 2

  message AddFilesResponse

  metadata.proto:624

  • optional ResponseHeader header = 1

• rpc GetFiles (GetFilesRequest, GetFilesResponse)

  metadata.proto:64

  message GetFilesRequest

  metadata.proto:628

  • optional RequestHeader header = 1

  • uint64 pathId = 2

  message GetFilesResponse

  metadata.proto:633

  • optional ResponseHeader header = 1

  • repeated File files = 2

• rpc GetFileId (GetFileIdRequest, GetFileIdResponse)

  metadata.proto:65

  message GetFileIdRequest

  metadata.proto:638

  • optional RequestHeader header = 1

  • string filePathUri = 2

    the uri of the file containing the storage scheme prefix

  message GetFileIdResponse

  metadata.proto:643

  • optional ResponseHeader header = 1

  • uint64 fileId = 2

• rpc UpdateFile (UpdateFileRequest, UpdateFileResponse)

  metadata.proto:66

  message UpdateFileRequest

  metadata.proto:648

  • optional RequestHeader header = 1

  • optional File file = 2

  message UpdateFileResponse

  metadata.proto:653

  • optional ResponseHeader header = 1

• rpc DeleteFiles (DeleteFilesRequest, DeleteFilesResponse)

  metadata.proto:67

  message DeleteFilesRequest

  metadata.proto:657

  • optional RequestHeader header = 1

  • repeated uint64 fileIds = 2

  message DeleteFilesResponse

  metadata.proto:662

  • optional ResponseHeader header = 1

• rpc CreatePeerPath (CreatePeerPathRequest, CreatePeerPathResponse)

  metadata.proto:68

  message CreatePeerPathRequest

  metadata.proto:667

  peer path

  • optional RequestHeader header = 1

  • optional PeerPath peerPath = 2

  message CreatePeerPathResponse

  metadata.proto:672

  • optional ResponseHeader header = 1

• rpc GetPeerPaths (GetPeerPathsRequest, GetPeerPathsResponse)

  metadata.proto:69

  message GetPeerPathsRequest

  metadata.proto:676

  • optional RequestHeader header = 1

  • oneof pathIdOrPeerId

    • uint64 pathId = 2

    • uint64 peerId = 3

  message GetPeerPathsResponse

  metadata.proto:684

  • optional ResponseHeader header = 1

  • repeated PeerPath peerPaths = 2

• rpc UpdatePeerPath (UpdatePeerPathRequest, UpdatePeerPathResponse)

  metadata.proto:70

  message UpdatePeerPathRequest

  metadata.proto:689

  • optional RequestHeader header = 1

  • uint64 peerPathId = 2

  • string uri = 3

  • repeated Column columns = 4

  message UpdatePeerPathResponse

  metadata.proto:696

  • optional ResponseHeader header = 1

• rpc DeletePeerPaths (DeletePeerPathsRequest, DeletePeerPathsResponse)

  metadata.proto:71

  message DeletePeerPathsRequest

  metadata.proto:700

  • optional RequestHeader header = 1

  • repeated uint64 peerPathIds = 2

  message DeletePeerPathsResponse

  metadata.proto:705

  • optional ResponseHeader header = 1

• rpc CreatePeer (CreatePeerRequest, CreatePeerResponse)

  metadata.proto:72

  message CreatePeerRequest

  metadata.proto:534

  peer

  • optional RequestHeader header = 1

  • optional Peer peer = 2

  message CreatePeerResponse

  metadata.proto:539

  • optional ResponseHeader header = 1

• rpc GetPeer (GetPeerRequest, GetPeerResponse)

  metadata.proto:73

  message GetPeerRequest

  metadata.proto:543

  • optional RequestHeader header = 1

  • oneof idOrName

    • uint64 id = 2

    • string name = 3

  message GetPeerResponse

  metadata.proto:551

  • optional ResponseHeader header = 1

  • optional Peer peer = 2

• rpc UpdatePeer (UpdatePeerRequest, UpdatePeerResponse)

  metadata.proto:74

  message UpdatePeerRequest

  metadata.proto:556

  • optional RequestHeader header = 1

  • optional Peer peer = 2

  message UpdatePeerResponse

  metadata.proto:561

  • optional ResponseHeader header = 1

• rpc DeletePeer (DeletePeerRequest, DeletePeerResponse)

  metadata.proto:75

  message DeletePeerRequest

  metadata.proto:565

  • optional RequestHeader header = 1

  • oneof idOrName

    • uint64 id = 2

    • string name = 3

  message DeletePeerResponse

  metadata.proto:573

  • optional ResponseHeader header = 1

• rpc GetColumns (GetColumnsRequest, GetColumnsResponse)

  metadata.proto:76

  message GetColumnsRequest

  metadata.proto:349

  column

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string tableName = 3

  • bool withStatistics = 4

  message GetColumnsResponse

  metadata.proto:356

  • optional ResponseHeader header = 1

  • repeated Column columns = 2

• rpc UpdateColumn (UpdateColumnRequest, UpdateColumnResponse)

  metadata.proto:77

  message UpdateColumnRequest

  metadata.proto:361

  • optional RequestHeader header = 1

  • optional Column column = 2

  message UpdateColumnResponse

  metadata.proto:366

  • optional ResponseHeader header = 1

• rpc CreateView (CreateViewRequest, CreateViewResponse)

  metadata.proto:78

  message CreateViewRequest

  metadata.proto:742

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string viewName = 3

  • string viewData = 4

  • bool updateIfExists = 5

  message CreateViewResponse

  metadata.proto:750

  • optional ResponseHeader header = 1

• rpc ExistView (ExistViewRequest, ExistViewResponse)

  metadata.proto:79

  message ExistViewRequest

  metadata.proto:731

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string viewName = 3

  message ExistViewResponse

  metadata.proto:737

  • optional ResponseHeader header = 1

  • bool exists = 2

• rpc GetViews (GetViewsRequest, GetViewsResponse)

  metadata.proto:80

  message GetViewsRequest

  metadata.proto:710

  view

  • optional RequestHeader header = 1

  • string schemaName = 2

  message GetViewsResponse

  metadata.proto:715

  • optional ResponseHeader header = 1

  • repeated View views = 2

• rpc GetView (GetViewRequest, GetViewResponse)

  metadata.proto:81

  message GetViewRequest

  metadata.proto:720

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string viewName = 3

  message GetViewResponse

  metadata.proto:726

  • optional ResponseHeader header = 1

  • optional View view = 2

• rpc DropView (DropViewRequest, DropViewResponse)

  metadata.proto:82

  message DropViewRequest

  metadata.proto:754

  • optional RequestHeader header = 1

  • string schemaName = 2

  • string viewName = 3

  message DropViewResponse

  metadata.proto:760

  • optional ResponseHeader header = 1

Used in: CreateTableRequest, GetColumnsResponse, PeerPath, SchemaVersion, UpdateColumnRequest, UpdatePeerPathRequest

• uint64 id = 1

• string name = 2

• string type = 3

• double chunkSize = 4

• double size = 5

• double nullFraction = 6

• uint64 cardinality = 7

• bytes recordStats = 8

• uint64 tableId = 9

Used in: AddFilesRequest, GetFilesResponse, UpdateFileRequest

• uint64 id = 1

• string name = 2

• uint32 numRowGroup = 3

• uint64 minRowId = 4

• uint64 maxRowId = 5

• uint64 pathId = 6

Used in: GetLayoutRequest

• ALL = 0

• READABLE = 1

• READ_WRITE = 2

Used in: AddLayoutRequest, GetLayoutResponse, GetLayoutsResponse, GetTableResponse, UpdateLayoutRequest

• uint64 id = 1

• uint64 version = 2

• uint64 createAt = 3

  The milliseconds since Unix epoch at which this layout is created.

• Permission permission = 4

• string ordered = 5

• repeated Path orderedPaths = 6

• string compact = 7

• repeated Path compactPaths = 8

• string splits = 9

• string projections = 10

• repeated Path projectionPaths = 11

• uint64 tableId = 12

• uint64 schemaVersionId = 13

Used in: AddPathRequest, GetPathsResponse, Layout, UpdatePathRequest

• uint64 id = 1

• string uri = 2

• Path.Type type = 3

• uint64 layoutId = 4

• optional uint64 rangeId = 5

Used in: Path

• ORDERED = 0

• COMPACT = 1

• PROJECTION = 2

Used in: CreatePeerRequest, GetPeerResponse, UpdatePeerRequest

• uint64 id = 1

• string name = 2

• string location = 3

• string host = 4

• int32 port = 5

• string storageScheme = 6

Used in: CreatePeerPathRequest, GetPeerPathsResponse

• uint64 id = 1

• string uri = 2

• repeated Column columns = 3

• uint64 pathId = 4

• uint64 peerId = 5

Used in: Layout, UserHasSchema

• DISABLED = 0

• READ_ONLY = 1

• READ_WRITE = 2

Used in: AddRangeRequest, GetRangeResponse, GetRangesResponse

• uint64 id = 1

• bytes min = 2

• bytes max = 3

• optional uint64 parentId = 4

• uint64 rangeIndexId = 5

Used in: CreateRangeIndexRequest, GetRangeIndexResponse, UpdateRangeIndexRequest

• uint64 id = 1

• string keyColumns = 2

• uint64 tableId = 3

• uint64 schemaVersionId = 4

header

Used in: AddFilesRequest, AddLayoutRequest, AddPathRequest, AddRangeRequest, CreatePeerPathRequest, CreatePeerRequest, CreateRangeIndexRequest, CreateSchemaRequest, CreateSecondaryIndexRequest, CreateTableRequest, CreateViewRequest, DeleteFilesRequest, DeletePathsRequest, DeletePeerPathsRequest, DeletePeerRequest, DeleteRangeRequest, DropRangeIndexRequest, DropSchemaRequest, DropSecondaryIndexRequest, DropTableRequest, DropViewRequest, ExistSchemaRequest, ExistTableRequest, ExistViewRequest, GetColumnsRequest, GetFileIdRequest, GetFilesRequest, GetLayoutRequest, GetLayoutsRequest, GetPathsRequest, GetPeerPathsRequest, GetPeerRequest, GetRangeIndexRequest, GetRangeRequest, GetRangesRequest, GetSchemasRequest, GetSecondaryIndexRequest, GetTableRequest, GetTablesRequest, GetViewRequest, GetViewsRequest, UpdateColumnRequest, UpdateFileRequest, UpdateLayoutRequest, UpdatePathRequest, UpdatePeerPathRequest, UpdatePeerRequest, UpdateRangeIndexRequest, UpdateRowCountRequest, UpdateSecondaryIndexRequest

• string token = 1

Used in: AddFilesResponse, AddLayoutResponse, AddPathResponse, AddRangeResponse, CreatePeerPathResponse, CreatePeerResponse, CreateRangeIndexResponse, CreateSchemaResponse, CreateSecondaryIndexResponse, CreateTableResponse, CreateViewResponse, DeleteFilesResponse, DeletePathsResponse, DeletePeerPathsResponse, DeletePeerResponse, DeleteRangeResponse, DropRangeIndexResponse, DropSchemaResponse, DropSecondaryIndexResponse, DropTableResponse, DropViewResponse, ExistSchemaResponse, ExistTableResponse, ExistViewResponse, GetColumnsResponse, GetFileIdResponse, GetFilesResponse, GetLayoutResponse, GetLayoutsResponse, GetPathsResponse, GetPeerPathsResponse, GetPeerResponse, GetRangeIndexResponse, GetRangeResponse, GetRangesResponse, GetSchemasResponse, GetSecondaryIndexResponse, GetTableResponse, GetTablesResponse, GetViewResponse, GetViewsResponse, UpdateColumnResponse, UpdateFileResponse, UpdateLayoutResponse, UpdatePathResponse, UpdatePeerPathResponse, UpdatePeerResponse, UpdateRangeIndexResponse, UpdateRowCountResponse, UpdateSecondaryIndexResponse

• string token = 1

• int32 errorCode = 2

  errorCode == 0 means success

• string errorMsg = 3

  empty if errorCode == 0

begin domain objects definition

Used in: GetSchemasResponse

• uint64 id = 1

• string name = 2

• string desc = 3

• uint64 id = 1

• repeated Column columns = 2

• uint64 transTs = 3

• uint64 tableId = 4

Used in: CreateSecondaryIndexRequest, GetSecondaryIndexResponse, UpdateSecondaryIndexRequest

• uint64 id = 1

• string keyColumns = 2

• bool unique = 3

• string indexScheme = 4

• uint64 tableId = 5

• uint64 schemaVersionId = 6

Used in: GetTableResponse, GetTablesResponse

• uint64 id = 1

• string name = 2

• string type = 3

• string storageScheme = 4

• uint64 rowCount = 5

• uint64 schemaId = 6

• uint64 id = 1

• string name = 2

• string password = 3

• string email = 4

• uint64 userId = 1

• uint64 schemaId = 2

• Permission permission = 3

Used in: GetViewResponse, GetViewsResponse

• uint64 id = 1

• string name = 2

• string type = 3

• string data = 4

• uint64 schemaId = 5