package api

Get desktop application:
View/edit binary Protocol Buffers messages

Graph response.

• rpc AllocateIDs (AllocateIDsRequest, AllocateIDsResponse)

  api.proto:29

  message AllocateIDsRequest

  api.proto:219

  • uint64 how_many = 1

  • LeaseType lease_type = 2

  message AllocateIDsResponse

  api.proto:224

  • uint64 start = 1

  • uint64 end = 2

    inclusive

• rpc Alter (Operation, Payload)

  api.proto:24

  message Operation

  api.proto:93

  • string schema = 1

  • string drop_attr = 2

  • bool drop_all = 3

  • Operation.DropOp drop_op = 4

  • string drop_value = 5

    If drop_op is ATTR or TYPE, drop_value holds the name of the predicate or type to delete.

  • bool run_in_background = 6

    run indexes in background.

  message Payload

  api.proto:116

  Worker services.

  • bytes Data = 1

• rpc CheckVersion (Check, Version)

  api.proto:26

  message Check

  api.proto:129

  (message has no fields)

  message Version

  api.proto:131

  • string tag = 1

• rpc CommitOrAbort (TxnContext, TxnContext)

  api.proto:25

• rpc CreateNamespace (CreateNamespaceRequest, CreateNamespaceResponse)

  api.proto:34

  message CreateNamespaceRequest

  api.proto:229

  (message has no fields)

  message CreateNamespaceResponse

  api.proto:231

  • uint64 namespace = 1

• rpc DropNamespace (DropNamespaceRequest, DropNamespaceResponse)

  api.proto:35

  message DropNamespaceRequest

  api.proto:235

  • uint64 namespace = 1

  message DropNamespaceResponse

  api.proto:239

  (message has no fields)

• rpc ListNamespaces (ListNamespacesRequest, ListNamespacesResponse)

  api.proto:36

  message ListNamespacesRequest

  api.proto:241

  (message has no fields)

  message ListNamespacesResponse

  api.proto:243

  • map<uint64, Namespace> namespaces = 1

• rpc Login (LoginRequest, Response)

  api.proto:22

  message LoginRequest

  api.proto:193

  • string userid = 1

  • string password = 2

  • string refresh_token = 3

  • uint64 namespace = 4

• rpc Query (Request, Response)

  api.proto:23

  message Request

  api.proto:39

  • uint64 start_ts = 1

  • string query = 4

  • map<string, string> vars = 5

    Support for GraphQL like variables.

  • bool read_only = 6

  • bool best_effort = 7

  • repeated Mutation mutations = 12

  • bool commit_now = 13

  • Request.RespFormat resp_format = 14

  • string hash = 15

• rpc RunDQL (RunDQLRequest, Response)

  api.proto:28

  message RunDQLRequest

  api.proto:205

  • string dql_query = 1

  • map<string, string> vars = 2

  • bool read_only = 3

  • bool best_effort = 4

  • Request.RespFormat resp_format = 5

• rpc StreamExtSnapshot (stream StreamExtSnapshotRequest, stream StreamExtSnapshotResponse)

  api.proto:32

  message StreamExtSnapshotRequest

  api.proto:261

  • uint32 group_id = 1

  • bool forward = 2

  • optional StreamPacket pkt = 3

  message StreamExtSnapshotResponse

  api.proto:267

  • bool finish = 1

• rpc UpdateExtSnapshotStreamingState (UpdateExtSnapshotStreamingStateRequest, UpdateExtSnapshotStreamingStateResponse)

  api.proto:31

  message UpdateExtSnapshotStreamingStateRequest

  api.proto:251

  • bool start = 1

  • bool finish = 2

  • bool drop_data = 3

  message UpdateExtSnapshotStreamingStateResponse

  api.proto:257

  • repeated uint32 groups = 1

Used in: NQuad

• string key = 1

• bytes value = 2

• Facet.ValType val_type = 3

• repeated string tokens = 4

  tokens of value.

• string alias = 5

  not stored, only used for query.

Used in: Facet

• STRING = 0

• INT = 1

• FLOAT = 2

• BOOL = 3

• DATETIME = 4

• string access_jwt = 1

• string refresh_jwt = 2

Used in: Response

• uint64 parsing_ns = 1

• uint64 processing_ns = 2

• uint64 encoding_ns = 3

• uint64 assign_timestamp_ns = 4

• uint64 total_ns = 5

Used in: AllocateIDsRequest

• NS = 0

• UID = 1

• TS = 2

Used in: Response

• repeated string value = 1

Used in: Response

• map<string, uint64> num_uids = 1

  num_uids is the map of number of uids processed by each attribute.

Used in: Request

• bytes set_json = 1

• bytes delete_json = 2

• bytes set_nquads = 3

• bytes del_nquads = 4

• repeated NQuad set = 5

• repeated NQuad del = 6

• string cond = 9

  This is being used for upserts.

• bool commit_now = 14

  This field is a duplicate of the one in Request and placed here for convenience.

Used in: Mutation

• string subject = 1

• string predicate = 2

• string object_id = 3

• optional Value object_value = 4

• string lang = 6

• repeated Facet facets = 7

• uint64 namespace = 8

Used in: ListNamespacesResponse

• uint64 id = 1

Used in: Operation

• NONE = 0

• ALL = 1

• DATA = 2

• ATTR = 3

• TYPE = 4

Used in: Request, RunDQLRequest

• JSON = 0

• RDF = 1

Used as response type in: Dgraph.Login, Dgraph.Query, Dgraph.RunDQL

• bytes json = 1

• optional TxnContext txn = 2

• optional Latency latency = 3

• optional Metrics metrics = 4

  Metrics contains all metrics related to the query.

• map<string, string> uids = 12

  uids contains a mapping of blank_node => uid for the node. It only returns uids that were created as part of a mutation.

• bytes rdf = 13

• map<string, ListOfString> hdrs = 14

Used in: StreamExtSnapshotRequest

• bytes data = 1

• bool done = 2

Used as request type in: Dgraph.CommitOrAbort

Used as response type in: Dgraph.CommitOrAbort

Used as field type in: Response

• 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

• repeated string uids = 1

Used in: NQuad

• oneof val

  • string default_val = 1

  • bytes bytes_val = 2

  • int64 int_val = 3

  • bool bool_val = 4

  • string str_val = 5

  • double double_val = 6

  • bytes geo_val = 7

    Geo data in WKB format

  • bytes date_val = 8

  • bytes datetime_val = 9

  • string password_val = 10

  • uint64 uid_val = 11

  • bytes bigfloat_val = 12

  • bytes vfloat32_val = 13