kythe.io@v0.0.68-0.20240422202219-7225dbc01741/kythe/proto/graph_serving.proto (about)

     1  /*
     2   * Copyright 2018 The Kythe Authors. All rights reserved.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *   http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  syntax = "proto3";
    18  
    19  package kythe.proto.serving.graph;
    20  
    21  option go_package = "kythe.io/kythe/proto/graph_serving_go_proto";
    22  option java_package = "com.google.devtools.kythe.proto";
    23  
    24  import "kythe/proto/schema.proto";
    25  import "kythe/proto/storage.proto";
    26  
    27  // Columnar protocol buffer format for Edges.
    28  //
    29  // Design: https://github.com/kythe/kythe/blob/master/kythe/docs/rfc/2909.md
    30  //
    31  // Columnar key prefix: "eg"-source
    32  message Edges {
    33    kythe.proto.VName source = 1;
    34  
    35    oneof entry {
    36      Index index = 2;
    37      Edge edge = 3;
    38      Target target = 4;
    39    }
    40  
    41    // Index for columnar edges data.
    42    //
    43    // Columnar key: <empty>
    44    message Index {
    45      kythe.proto.schema.Node node = 1;
    46    }
    47  
    48    // A single edge
    49    //
    50    // Columnar key: 10-kind-reverse-ordinal-target
    51    message Edge {
    52      oneof kind {
    53        kythe.proto.schema.EdgeKind kythe_kind = 1;
    54        string generic_kind = 2;
    55      }
    56      // Edge ordinal for this relation to the node.
    57      int32 ordinal = 3;
    58      // Whether the relation is a reverse edge.
    59      bool reverse = 4;
    60  
    61      // TODO(schroederc): add priority grouping
    62      kythe.proto.VName target = 5;
    63    }
    64  
    65    // Edge target node
    66    //
    67    // Columnar key: 20-target
    68    message Target {
    69      kythe.proto.schema.Node node = 1;
    70    }
    71  }