package api.v25

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Ping (PingRequest, PingResponse)

  api.v25.proto:21

  message PingRequest

  api.v25.proto:36

  (message has no fields)

  message PingResponse

  api.v25.proto:38

  • string version = 1

• rpc AllocateIDs (AllocateIDsRequest, AllocateIDsResponse)

  api.v25.proto:22

  message AllocateIDsRequest

  api.v25.proto:48

  • uint64 how_many = 1

  • LeaseType lease_type = 2

  message AllocateIDsResponse

  api.v25.proto:53

  • uint64 start = 1

  • uint64 end = 2

    inclusive

• rpc SignInUser (SignInUserRequest, SignInUserResponse)

  api.v25.proto:24

  message SignInUserRequest

  api.v25.proto:58

  • string user_id = 1

  • string password = 2

  • string refresh_token = 3

  message SignInUserResponse

  api.v25.proto:64

  • string access_jwt = 1

  • string refresh_jwt = 2

• rpc Alter (AlterRequest, AlterResponse)

  api.v25.proto:25

  message AlterRequest

  api.v25.proto:69

  • AlterOp op = 1

  • string ns_name = 2

  • string schema = 3

  • bool run_in_background = 4

  • string predicate_to_drop = 5

  • string type_to_drop = 6

  message AlterResponse

  api.v25.proto:78

  (message has no fields)

• rpc RunDQL (RunDQLRequest, RunDQLResponse)

  api.v25.proto:26

  message RunDQLRequest

  api.v25.proto:95

  • string ns_name = 1

  • string dql_query = 2

  • map<string, string> vars = 3

  • bool read_only = 4

  • bool best_effort = 5

  • RespFormat resp_format = 6

  message RunDQLResponse

  api.v25.proto:104

  • optional TxnContext txn = 1

  • bytes query_result = 2

    could be rdf or json

  • map<string, string> blank_uids = 3

    mapping of blank_node => uid in hex

  • optional Latency latency = 4

  • optional Metrics metrics = 5

• rpc CreateNamespace (CreateNamespaceRequest, CreateNamespaceResponse)

  api.v25.proto:28

  message CreateNamespaceRequest

  api.v25.proto:134

  • string ns_name = 1

  message CreateNamespaceResponse

  api.v25.proto:138

  (message has no fields)

• rpc DropNamespace (DropNamespaceRequest, DropNamespaceResponse)

  api.v25.proto:29

  message DropNamespaceRequest

  api.v25.proto:140

  • string ns_name = 1

  message DropNamespaceResponse

  api.v25.proto:144

  (message has no fields)

• rpc UpdateNamespace (UpdateNamespaceRequest, UpdateNamespaceResponse)

  api.v25.proto:30

  message UpdateNamespaceRequest

  api.v25.proto:146

  • string ns_name = 1

  • string rename_to_ns = 2

  message UpdateNamespaceResponse

  api.v25.proto:151

  (message has no fields)

• rpc ListNamespaces (ListNamespacesRequest, ListNamespacesResponse)

  api.v25.proto:31

  message ListNamespacesRequest

  api.v25.proto:153

  (message has no fields)

  message ListNamespacesResponse

  api.v25.proto:155

  • map<string, Namespace> ns_list = 1

• rpc InitiateSnapshotStream (InitiateSnapshotStreamRequest, InitiateSnapshotStreamResponse)

  api.v25.proto:32

  message InitiateSnapshotStreamRequest

  api.v25.proto:164

  (message has no fields)

  message InitiateSnapshotStreamResponse

  api.v25.proto:166

  • repeated uint32 groups = 1

• rpc StreamSnapshot (stream StreamSnapshotRequest, StreamSnapshotResponse)

  api.v25.proto:33

  message StreamSnapshotRequest

  api.v25.proto:170

  • uint32 group_id = 1

  • optional KVS pairs = 2

  message StreamSnapshotResponse

  api.v25.proto:175

  • bool done = 1

Used in: AlterRequest

• NONE = 0

• DROP_ALL = 1

• DROP_ALL_IN_NS = 2

• DROP_DATA_IN_NS = 3

• DROP_PREDICATE_IN_NS = 4

• DROP_TYPE_IN_NS = 5

• SCHEMA_IN_NS = 6

Used in: StreamSnapshotRequest

• bytes data = 1

• bool done = 2

Used in: RunDQLResponse

• uint64 parsing_ns = 1

• uint64 processing_ns = 2

• uint64 resp_encoding_ns = 3

• uint64 assign_timestamp_ns = 4

• uint64 total_ns = 5

Used in: AllocateIDsRequest

• NS = 0

• UID = 1

• TS = 2

Used in: RunDQLResponse

• map<string, uint64> uids_touched = 1

  uids_touched is the map of number of uids read for each attribute/predicate.

Used in: ListNamespacesResponse

• string name = 1

• uint64 id = 2

Used in: RunDQLRequest

• JSON = 0

• RDF = 1

Used in: RunDQLResponse

• uint64 start_ts = 1

• uint64 commit_ts = 2

• bool aborted = 3

• repeated string keys = 4

  List of keys to be used for conflict detection.

• repeated string preds = 5

  List of predicates involved in this transaction.

• string hash = 6