package pb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Heartbeat (api.Payload, stream api.Payload)

  pb.proto:442

• rpc IsPeer (RaftContext, PeerResponse)

  pb.proto:445

  message PeerResponse

  pb.proto:432

  • bool status = 1

• rpc JoinCluster (RaftContext, api.Payload)

  pb.proto:444

• rpc RaftMessage (stream RaftBatch, api.Payload)

  pb.proto:443

  message RaftBatch

  pb.proto:436

  • optional RaftContext context = 1

  • optional api.Payload payload = 2

• rpc Backup (BackupRequest, Status)

  pb.proto:469

  message BackupRequest

  pb.proto:501

  • uint64 read_ts = 1

  • uint64 since_ts = 2

  • uint32 group_id = 3

  • string unix_ts = 4

  • string destination = 5

  • string access_key = 6

  • string secret_key = 7

  • string session_token = 8

  • bool anonymous = 9

    True if no credentials should be used to access the S3 or minio bucket. For example, when using a bucket with a public policy.

  • repeated string predicates = 10

    The predicates to backup. All other predicates present in the group (e.g stale data from a predicate move) will be ignored.

• rpc Export (ExportRequest, Status)

  pb.proto:470

  message ExportRequest

  pb.proto:520

  • uint32 group_id = 1

    Group id to back up.

  • uint64 read_ts = 2

  • int64 unix_ts = 3

  • string format = 4

• rpc MovePredicate (MovePredicatePayload, api.Payload)

  pb.proto:472

  message MovePredicatePayload

  pb.proto:409

  • string predicate = 1

  • uint32 source_gid = 2

  • uint32 dest_gid = 3

  • uint64 txn_ts = 4

• rpc Mutate (Mutations, api.TxnContext)

  pb.proto:464

  Data serving RPCs.

• rpc ReceivePredicate (stream KVS, api.Payload)

  pb.proto:471

• rpc Schema (SchemaRequest, SchemaResult)

  pb.proto:468

  message SchemaRequest

  pb.proto:341

  Schema messages.

  • uint32 group_id = 1

  • repeated string predicates = 2

  • repeated string fields = 3

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

  • repeated string types = 4

  message SchemaResult

  pb.proto:362

  • repeated SchemaNode schema = 1

• rpc ServeTask (Query, Result)

  pb.proto:465

  message Query

  pb.proto:52

  • 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.

  • optional SrcFunction src_func = 6

    Function to generate or filter UIDs.

  • bool reverse = 7

    Whether this is a reverse edge.

  • optional FacetParams facet_param = 8

    which facets to fetch

  • optional FilterTree facets_filter = 9

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

  • bool expand_all = 10

    expand all language variants.

  • uint64 read_ts = 13

  • int32 cache = 14

  message Result

  pb.proto:83

  • repeated List uid_matrix = 1

  • repeated ValueList value_matrix = 2

  • repeated uint32 counts = 3

  • bool intersect_dest = 4

  • repeated FacetsList facet_matrix = 5

  • repeated LangList lang_matrix = 6

  • bool list = 7

• rpc Sort (SortMessage, SortResult)

  pb.proto:467

  message SortMessage

  pb.proto:99

  • repeated Order order = 1

  • repeated List uid_matrix = 2

  • int32 count = 3

    Return this many elements.

  • int32 offset = 4

    Skip this many elements.

  • uint64 read_ts = 13

  message SortResult

  pb.proto:108

  • repeated List uid_matrix = 1

• rpc StreamSnapshot (stream Snapshot, stream KVS)

  pb.proto:466

• rpc AssignUids (Num, AssignedIds)

  pb.proto:456

• rpc CommitOrAbort (api.TxnContext, api.TxnContext)

  pb.proto:458

• rpc Connect (Member, ConnectionState)

  pb.proto:450

  These 3 endpoints are for handling membership.

  message ConnectionState

  pb.proto:175

  • optional Member member = 1

  • optional MembershipState state = 2

  • uint64 max_pending = 3

    Used to determine the timstamp for reading after bulk load

• rpc Oracle (api.Payload, stream OracleDelta)

  pb.proto:454

• rpc ShouldServe (Tablet, Tablet)

  pb.proto:455

• rpc StreamMembership (api.Payload, stream MembershipState)

  pb.proto:452

• rpc Timestamps (Num, AssignedIds)

  pb.proto:457

• rpc TryAbort (TxnTimestamps, OracleDelta)

  pb.proto:459

  message TxnTimestamps

  pb.proto:428

  • repeated uint64 ts = 1

• rpc UpdateMembership (Group, api.Payload)

  pb.proto:451

Used as response type in: Zero.AssignUids, Zero.Timestamps

• uint64 startId = 1

• uint64 endId = 2

• uint64 read_only = 5

  The following is used for read only transactions.

A key stored in the format used for writing backups.

• BackupKey.KeyType type = 1

• string attr = 2

• uint64 uid = 3

• uint64 start_uid = 4

• string term = 5

• uint32 count = 6

Used in: BackupKey

• UNKNOWN = 0

• DATA = 1

• INDEX = 2

• REVERSE = 3

• COUNT = 4

• COUNT_REV = 5

• SCHEMA = 6

• TYPE = 7

A posting list stored in the format used for writing backups.

• repeated uint64 uids = 1

• repeated Posting postings = 2

• uint64 commit_ts = 3

• repeated uint64 splits = 4

Used in: TableIndex

• bytes key = 1

• uint32 offset = 2

• uint32 len = 3

• Checksum.Algorithm algo = 1

  For storing type of Checksum algorithm used

• uint64 sum = 2

Used in: Checksum

• CRC32C = 0

• XXHash64 = 1

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.

• Posting.ValType 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 api.Facet facets = 9

Used in: DirectedEdge

• SET = 0

• DEL = 1

Used in: FacetParams

• string key = 1

• string alias = 2

Used in: Query

• bool all_keys = 1

  keys should be in sorted order.

• repeated FacetParam param = 2

Used in: FacetsList

• repeated api.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 as request type in: Zero.UpdateMembership

Used as field type in: MembershipState

• map<uint64, Member> members = 1

  Raft ID is the key.

• map<string, Tablet> tablets = 2

  Predicate + others are key.

• uint64 snapshot_ts = 3

  Stores Snapshot transaction ts.

• uint64 checksum = 4

  Stores a checksum.

Used in: KVList, KVS, Proposal

• bytes key = 1

• bytes value = 2

• bytes user_meta = 3

• uint64 version = 4

• uint64 expires_at = 5

• bytes meta = 6

• uint32 stream_id = 10

  Stream id is used to identify which stream the KV came from.

• repeated KV kv = 1

Used as request type in: Worker.ReceivePredicate

Used as response type in: Worker.StreamSnapshot

• repeated KV kv = 1

• bool done = 2

  done used to indicate if the stream of KVS is over.

Used in: Result

• repeated string lang = 1

Used in: MembershipState, ZeroProposal

• string user = 1

• uint64 maxNodes = 2

• int64 expiryTs = 3

• bool enabled = 4

Used in: Query, Result, SortMessage, SortResult

• repeated fixed64 uids = 1

Used in: ManifestChangeSet

• uint64 Id = 1

• ManifestChange.Operation Op = 2

• uint32 Level = 3

  Only used for CREATE

Used in: ManifestChange

• CREATE = 0

• DELETE = 1

• repeated ManifestChange changes = 1

  A set of changes that are applied atomically.

Bulk loader proto.

• bytes key = 1

• fixed64 uid = 2

  Only one should be set.

• optional Posting posting = 3

Member stores information about RAFT group member 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 as request type in: Zero.Connect

Used as field type in: ConnectionState, Group, MembershipState, ZeroProposal

• fixed64 id = 1

• uint32 group_id = 2

• string addr = 3

• bool leader = 4

• bool am_dead = 5

• uint64 last_update = 6

• bool cluster_info_only = 13

MembershipState 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.

Used as response type in: Zero.StreamMembership

Used as field type in: ConnectionState, Proposal

• uint64 counter = 1

  used to find latest membershipState in case of race.

• map<uint32, Group> groups = 2

• map<uint64, Member> zeros = 3

• uint64 maxLeaseId = 4

• uint64 maxTxnTs = 5

• uint64 maxRaftId = 6

• repeated Member removed = 7

• string cid = 8

  Used to uniquely identify the Dgraph cluster.

• optional License license = 9

Used as request type in: Worker.Mutate

Used as field type in: Proposal

• uint32 group_id = 1

• uint64 start_ts = 2

• repeated DirectedEdge edges = 3

• repeated SchemaUpdate schema = 4

• repeated TypeUpdate types = 6

• Mutations.DropOp drop_op = 7

• string drop_value = 8

Used in: Mutations

• NONE = 0

• ALL = 1

• DATA = 2

• TYPE = 3

Used as request type in: Zero.AssignUids, Zero.Timestamps

• uint64 val = 1

• bool read_only = 2

• bool forwarded = 3

  True if this request was forwarded by a peer.

Used as response type in: Zero.Oracle, Zero.TryAbort

Used as field type in: Proposal

• repeated TxnStatus txns = 1

• uint64 max_assigned = 2

• map<uint32, uint64> group_checksums = 3

  implement tmax.

Used in: SortMessage

• string attr = 1

• bool desc = 2

• repeated string langs = 3

Posting messages.

Used in: BackupPostingList, MapEntry, PostingList

• fixed64 uid = 1

• bytes value = 2

• Posting.ValType val_type = 3

• Posting.PostingType posting_type = 4

• bytes lang_tag = 5

  Only set for VALUE_LANG

• string label = 6

• repeated api.Facet facets = 9

• uint32 op = 12

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

• uint64 start_ts = 13

  Meant to use only inmemory

• uint64 commit_ts = 14

  Meant to use only inmemory

Used in: Posting

• REF = 0

  UID

• VALUE = 1

  simple, plain value

• VALUE_LANG = 2

  value with specified language

Used in: DirectedEdge, Posting, SchemaUpdate, TaskValue

• DEFAULT = 0

• BINARY = 1

• INT = 2

  We treat it as int64.

• FLOAT = 3

• BOOL = 4

• DATETIME = 5

• GEO = 6

• UID = 7

• PASSWORD = 8

• STRING = 9

• OBJECT = 10

• optional UidPack pack = 1

  Encoded list of uids in this posting list.

• repeated Posting postings = 2

• uint64 commit_ts = 3

  More inclination towards smaller values.

• repeated uint64 splits = 4

• optional Mutations mutations = 2

• repeated KV kv = 4

• optional MembershipState state = 5

• string clean_predicate = 6

  Delete the predicate which was moved to other group.

• string key = 7

• optional OracleDelta delta = 8

• optional Snapshot snapshot = 9

  Used to tell the group when to take snapshot.

• uint64 index = 10

  Used to store Raft index, in raft.Ready.

Used as request type in: Raft.IsPeer, Raft.JoinCluster

Used as field type in: RaftBatch, Snapshot

• fixed64 id = 1

• uint32 group = 2

• string addr = 3

• uint64 snapshot_ts = 4

Used in: SchemaResult

• string predicate = 1

• string type = 2

• bool index = 3

• repeated string tokenizer = 4

• bool reverse = 5

• bool count = 6

• bool list = 7

• bool upsert = 8

• bool lang = 9

Used in: Mutations, TypeUpdate

• string predicate = 1

• Posting.ValType value_type = 2

• SchemaUpdate.Directive directive = 3

• repeated string tokenizer = 4

• bool count = 5

• bool list = 6

• bool upsert = 8

• bool lang = 9

• bool non_nullable = 10

  Fields required for type system.

• bool non_nullable_list = 11

• string object_type_name = 12

  If value_type is OBJECT, then this represents an object type with a custom name. This field stores said name.

Used in: SchemaUpdate

• NONE = 0

• INDEX = 1

• REVERSE = 2

• DELETE = 3

Used as request type in: Worker.StreamSnapshot

Used as field type in: Proposal

• optional RaftContext context = 1

• uint64 index = 2

• uint64 read_ts = 3

• bool done = 4

  done is used to indicate that snapshot stream was a success.

• uint64 since_ts = 5

  since_ts stores the ts of the last snapshot to support diff snap updates.

• uint64 client_ts = 1

• uint32 group_id = 2

Used in: Query

• string name = 1

• repeated string args = 3

• bool isCount = 4

Status describes a general status response. code: 0 = success, 0 != failure.

Used as response type in: Worker.Backup, Worker.Export

• int32 code = 1

• string msg = 2

• repeated BlockOffset offsets = 1

• bytes bloom_filter = 2

Used as request type in: Zero.ShouldServe

Used as response type in: Zero.ShouldServe

Used as field type in: Group, ZeroProposal

• uint32 group_id = 1

  Served by which group.

• string predicate = 2

• bool force = 3

  Used while moving predicate.

• int64 space = 7

• bool remove = 8

• bool read_only = 9

  If true, do not ask zero to serve any tablets.

Used in: ValueList

• bytes val = 1

• Posting.ValType val_type = 2

Used in: OracleDelta

• uint64 start_ts = 1

• uint64 commit_ts = 2

Used in: Mutations

• string type_name = 1

• repeated SchemaUpdate fields = 2

Used in: UidPack

• uint64 base = 1

• bytes deltas = 2

  deltas contains the deltas encoded with Varints. We don't store deltas as a list of integers, because when the PB is brought to memory, Go would always use 8-bytes per integer. Instead, storing it as a byte slice is a lot cheaper in memory.

• uint32 num_uids = 3

  num_uids is the number of UIDs in the block. We are including this because we want to swtich encoding to groupvarint encoding. Current avaialble open source version implements encoding and decoding for uint32. We want to wrap it around our logic to use it here. Default Blocksize is 256 so uint32 would be sufficient.

Used in: PostingList

• uint32 block_size = 1

• repeated UidBlock blocks = 2

Used in: Result

• repeated TaskValue values = 1

• map<uint32, uint64> snapshot_ts = 1

  Group ID -> Snapshot Ts.

• optional Member member = 2

• optional Tablet tablet = 3

• uint64 maxLeaseId = 4

• uint64 maxTxnTs = 5

• uint64 maxRaftId = 6

• optional api.TxnContext txn = 7

• string key = 8

  Used as unique identifier for proposal id.

• string cid = 9

  Used as unique identifier for the cluster.

• optional License license = 10