Nebula Graph 源码解读 ｜ 客户端的通信秘密——fbthrift

struct Vertex {
  Value vid;
  std::vector<Tag> tags;

  Vertex() = default;
 };

struct Tag {
   1: binary name,
   // List of <prop_name, prop_value>
   2: map<binary, Value> (cpp.template = "std::unordered_map") props,
 } (cpp.type = "nebula::Tag")

 struct Vertex {
   1: Value     vid,
   2: list<Tag> tags,
 } (cpp.type = "nebula::Vertex")

 // Attributes:
 //  - Vid
 //  - Tags
 type Vertex struct {
  Vid *Value `thrift:"vid,1" db:"vid" json:"vid"`
  Tags []*Tag `thrift:"tags,2" db:"tags" json:"tags"`
 }

 func NewVertex(){
  return &Vertex{}
 }

 ...

 func (p *Vertex) Read(iprot thrift.Protocol) error { // 反序列化
  ...
 }

 func (p *Vertex) Write(oprot thrift.Protocol) error { // 序列化
  ...
 }

struct {
  // 设置超时时间，0 代表不超时，单位 ms。默认是 0
  TimeOut time.Duration
  // 每个连接最大空闲时间，当连接超过该时间没有被使用将会被断开和删除，0 表示永久 idle，连接不会关闭。默认是 0
  IdleTime time.Duration
  // max_connection_pool_size: 设置最大连接池连接数量，默认 10
  MaxConnPoolSize int
  // 最小空闲连接数，默认 0
  MinConnPoolSize int
 }

 //管理 Session 特有的信息
 type Session struct {
  // 用于执行命令的时候的身份校验或者消息重试
  sessionID  int64
  // 当前持有的连接
  connection *connection
  // 当前使用的连接池
  connPool   *ConnectionPool
  // 日志工具
  log        Logger
  // 用于保存当前 Session 所用的时区
  timezoneInfo
 }

  // 执行 nGQL，返回的数据类型为 ResultSet，该接口是非线程安全的。
  func (session *Session) Execute(stmt string) (*ResultSet, error) {...}
  // 重新为当前 Session 从连接池中获取连接
  func (session *Session) reConnect() error {...}
  // 做 signout，释放 Session ID，归还 connection 到 pool
  func (session *Session) Release() {

 // 创建新的连接池, 并用输入的服务地址完成初始化
 func NewConnectionPool(addresses []HostAddress, conf PoolConfig, log Logger) (*ConnectionPool, error){...}
 // 验证并获取 Session 实例
 func (pool *ConnectionPool) GetSession(username, password string) (*Session, error) {...}

// 和指定的 ip 和端口的建立连接
func (cn *connection) open(hostAddress HostAddress, timeout time.Duration) error {...}
// 验证用户名和密码
func (cn *connection) authenticate(username, password string) (*graph.AuthResponse, error) {
// 执行 query
func (cn *connection) execute(sessionID int64, stmt string) (*graph.ExecutionResponse, error) {...}
// 通过 SessionId 为 0 发送 "YIELD 1" 来判断连接是否是可用的
func (cn *connection) ping() bool {...}
// 向 graphd 释放 sessionId
func (cn *connection) signOut(sessionID int64) error {...}
// 断开连接
func (cn *connection) close() {...}

 // Initialize connection pool
 pool, err := nebula.NewConnectionPool(hostList, testPoolConfig, log)
 if err != nil {
  log.Fatal(fmt.Sprintf("Fail to initialize the connection pool, host: %s, port: %d, %s", address, port, err.Error()))
 }
 // Close all connections in the pool when program exits
 defer pool.Close()

 // Create session
 session, err := pool.GetSession(username, password)
 if err != nil {
  log.Fatal(fmt.Sprintf("Fail to create a new session from connection pool, username: %s, password: %s, %s",
   username, password, err.Error()))
 }
 // Release session and return connection back to connection pool when program exits
 defer session.Release()

 // Excute a query
 resultSet, err := session.Execute(query)
 if err != nil {
  fmt.Print(err.Error())
 }

+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| p                                                                                                                                                                                                                         |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| <("Tim Duncan" :bachelor{name: "Tim Duncan", speciality: "psychology"} :player{age: 42, name: "Tim Duncan"})<-[:teammate@0 {end_year: 2016, start_year: 2002}]-("Manu Ginobili" :player{age: 41, name: "Manu Ginobili"})> |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Got 1 rows (time spent 11550/12009 us)

 // Excute a query
 resultSet, _ := session.Execute("MATCH p= (v:player{name:"\"Tim Duncan"\"})-[]->(v2) RETURN p")

 // 获取结果的第一行, 第一行的 index 为0
 record, err := resultSet.GetRowValuesByIndex(0)
 if err != nil {
  t.Fatalf(err.Error())
 }

 // 从第一行中取第一列那个 cell 的值
 // 此时 valInCol0 的类型为 ValueWrapper 
 valInCol0, err := record.GetValueByIndex(0)

 // 将 ValueWrapper 转化成 PathWrapper 对象
 pathWrap, err = valInCol0.AsPath()

 // 通过 PathWrapper 的 GetEndNode() 接口直接得到终点
 node, err = pathWrap.GetEndNode()

 // 通过 node 的 Properties() 得到所有属性
 // props 的类型为 map[string]*ValueWrapper
 props, err = node.Properties()