package protos

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc CheckVersion (Check, Version)

  graphresponse.proto:11

  message Check

  graphresponse.proto:78

  (message has no fields)

  message Version

  graphresponse.proto:80

  • string tag = 1

• rpc Run (Request, Response)

  graphresponse.proto:10

  message Request

  graphresponse.proto:47

  • string query = 1

  • optional Mutation mutation = 2

  • optional SchemaRequest schema = 3

  • map<string, string> vars = 4

    Support for GraphQL like variables.

  message Response

  graphresponse.proto:71

  • repeated Node n = 1

  • optional Latency l = 2

  • map<string, uint64> AssignedUids = 3

  • repeated SchemaNode schema = 4

• rpc AssignUids (Num, List)

  payload.proto:33

  Data serving RPCs.

  message Num

  task.proto:58

  • uint32 group = 1

  • int64 val = 2

  • repeated uint64 uids = 3

• rpc Backup (BackupPayload, BackupPayload)

  payload.proto:45

  message BackupPayload

  payload.proto:16

  BackupPayload is used both as a request and a response. When used in request, groups represents the list of groups that need to be backed up. When used in response, groups represent the list of groups that were backed up.

  • uint64 req_id = 1

    Use req_id to handle duplicate requests.

  • uint32 group_id = 2

    Group id to back up.

  • BackupPayload.Status status = 3

• rpc Echo (Payload, Payload)

  payload.proto:30

  Connection testing RPC.

• rpc JoinCluster (RaftContext, Payload)

  payload.proto:43

  message RaftContext

  task.proto:64

  • fixed64 id = 1

  • uint32 group = 2

  • string addr = 3

• rpc Mutate (Mutations, Payload)

  payload.proto:34

• rpc PredicateAndSchemaData (stream GroupKeys, stream KV)

  payload.proto:36

  message GroupKeys

  task.proto:137

  • uint32 group_id = 1

  • repeated KC keys = 2

  message KV

  task.proto:127

  • bytes key = 1

  • bytes val = 2

• rpc RaftMessage (Payload, Payload)

  payload.proto:42

  RAFT serving RPCs.

• rpc RebuildIndex (RebuildIndexMessage, Payload)

  payload.proto:38

• rpc Schema (SchemaRequest, SchemaResult)

  payload.proto:39

  message SchemaResult

  schema.proto:14

  • repeated SchemaNode schema = 1

• rpc ServeTask (Query, Result)

  payload.proto:35

  message Query

  task.proto:19

  • string attr = 1

  • repeated string langs = 2

    language list for attribute

  • fixed64 after_uid = 3

    Only return UIDs greater than this.

  • bool do_count = 4

    Are we just getting lengths?

  • optional List uid_list = 5

    Exactly one of uids and terms is populated.

  • repeated string src_func = 6

    Function to generate or filter UIDs.

  • bool reverse = 7

    Whether this is a reverse edge.

  • optional Param facet_param = 8

    which facets to fetch

  • optional FilterTree facets_filter = 9

    filtering on facets : has Op (and/or/not) tree

  message Result

  task.proto:37

  • repeated List uid_matrix = 1

  • repeated TaskValue values = 2

  • repeated uint32 counts = 3

  • bool intersect_dest = 4

  • repeated FacetsList facet_matrix = 5

• rpc Sort (SortMessage, SortResult)

  payload.proto:37

  message SortMessage

  task.proto:45

  • string attr = 1

  • repeated string langs = 2

  • repeated List uid_matrix = 3

  • int32 count = 4

    Return this many elements.

  • int32 offset = 5

    Skip this many elements.

  • bool desc = 6

  message SortResult

  task.proto:54

  • repeated List uid_matrix = 1

• rpc UpdateMembership (MembershipUpdate, MembershipUpdate)

  payload.proto:44

  message MembershipUpdate

  task.proto:85

  MembershipUpdate is used to pack together the current membership state of all the nodes in the caller server; and the membership updates recorded by the callee server since the provided lastUpdate.

  • repeated Membership members = 1

  • uint64 last_update = 2

  • bool redirect = 3

  • string redirect_addr = 4

Used in: BackupPayload

• NONE = 0

• SUCCESS = 1

• DUPLICATE = 2

• FAILED = 3

Used in: Mutations

• fixed64 entity = 1

  Subject or source node / UID.

• string attr = 2

  Attribute or predicate. Labels the edge.

• bytes value = 3

  Edge points to a value.

• uint32 value_type = 4

  The type of the value

• fixed64 value_id = 5

  Object or destination node / UID.

• string label = 6

• string lang = 7

• DirectedEdge.Op op = 8

• repeated Facet facets = 9

Used in: DirectedEdge

• SET = 0

• DEL = 1

Used in: DirectedEdge, Facets, NQuad, Posting

• string key = 1

• bytes value = 2

• Facet.ValType val_type = 3

• repeated string tokens = 4

  tokens of value.

• string val = 5

  Only used by the Go client, so that we can parse and tokenize facets on the server.

Used in: Facet

• STRING = 0

• INT = 1

• FLOAT = 2

• BOOL = 3

• DATETIME = 4

Used in: FacetsList

• repeated Facet facets = 1

Used in: Result

• repeated Facets facets_list = 1

Op and Children are internal nodes and Func on leaves.

Used in: Query

• string op = 1

• repeated FilterTree children = 2

• optional Function func = 3

Used in: FilterTree

• string name = 1

  Name of the function : eq, le

• string key = 2

  Facet key over which to run the function.

• repeated string args = 3

  Arguments of the function.

Used in: GroupKeys

• bytes key = 1

• bytes checksum = 2

Used in: Response

• string parsing = 1

• string processing = 2

• string pb = 3

Used as response type in: Worker.AssignUids

Used as field type in: Query, Result, SortMessage, SortResult

• repeated fixed64 uids = 1

Membership stores information about RAFT group membership for a single RAFT node. Note that each server can be serving multiple RAFT groups. Each group would have one RAFT node per server serving that group.

Used in: MembershipUpdate, Proposal

• fixed64 id = 1

• uint32 group_id = 2

• string addr = 3

• bool leader = 4

• bool am_dead = 5

• uint64 last_update = 6

Used in: Request

• repeated NQuad set = 1

• repeated NQuad del = 2

• repeated SchemaUpdate schema = 3

Used as request type in: Worker.Mutate

Used as field type in: Proposal

• uint32 group_id = 1

• repeated DirectedEdge edges = 2

• repeated SchemaUpdate schema = 3

Used in: Mutation

• string subject = 1

• string predicate = 2

• string objectId = 3

• optional Value objectValue = 4

• string label = 5

• string lang = 7

• sint32 objectType = 6

• repeated Facet facets = 8

Used in: Response

• string attribute = 1

• repeated Property properties = 2

• repeated Node children = 3

  Each node can have multiple children

Used in: Query

• bool all_keys = 1

• repeated string keys = 2

Used as request type in: Worker.Echo, Worker.RaftMessage

Used as response type in: Worker.Echo, Worker.JoinCluster, Worker.Mutate, Worker.RaftMessage, Worker.RebuildIndex

• bytes Data = 1

Used in: PostingList

• fixed64 uid = 1

• bytes value = 2

• Posting.ValType val_type = 3

• Posting.PostingType posting_type = 4

• bytes metadata = 5

  for VALUE_LANG: Language, for VALUE_TIMESERIES: timestamp, etc..

• string label = 6

• uint64 commit = 7

  More inclination towards smaller values.

• repeated Facet facets = 8

• uint32 op = 12

  TODO: op is only used temporarily. See if we can remove it from here.

Used in: Posting

• REF = 0

  UID

• VALUE = 1

  simple, plain value

• VALUE_LANG = 2

  value with specified language

Used in: Posting

• DEFAULT = 0

• BINARY = 1

• INT = 2

  We treat it as int64.

• FLOAT = 3

• BOOL = 4

• DATE = 5

• DATETIME = 6

• GEO = 7

• UID = 8

• PASSWORD = 9

• STRING = 10

• repeated Posting postings = 1

• bytes checksum = 2

• uint64 commit = 3

  More inclination towards smaller values.

Used in: Node

• string prop = 1

• optional Value value = 2

• uint32 id = 1

• optional Mutations mutations = 2

• optional Membership membership = 3

• optional RebuildIndexMessage rebuild_index = 4

Used as request type in: Worker.RebuildIndex

Used as field type in: Proposal

• uint32 group_id = 1

• string attr = 2

  For simplicity, just do one attribute per request.

Used in: Response, SchemaResult

• string predicate = 1

• string type = 2

• bool index = 3

• repeated string tokenizer = 4

• bool reverse = 5

Used as request type in: Worker.Schema

Used as field type in: Request

• uint32 group_id = 1

• repeated string predicates = 2

• repeated string fields = 3

  fields can be on of type, index, reverse or tokenizer

Used in: Mutation, Mutations

• string predicate = 1

• uint32 value_type = 2

• SchemaUpdate.Directive directive = 3

• repeated string tokenizer = 4

Used in: SchemaUpdate

• NONE = 0

• INDEX = 1

• REVERSE = 2

Used in: Result

• bytes val = 1

• int32 val_type = 2

Used in: NQuad, Property

• 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