api

Documentation

Overview

Package api is all about the DB API. It contains the protobuf definition (under /pb), a Go client (under /client) and a gRPC service for the API backed by the actual DB manager.

Index

• type Config
• type Service
  • func NewService(store kt.TxnDatastoreExtended, network app.Net, conf Config) (*Service, error)
  • func (s *Service) Close() error
  • func (s *Service) Create(ctx context.Context, req *pb.CreateRequest) (*pb.CreateReply, error)
  • func (s *Service) Delete(ctx context.Context, req *pb.DeleteRequest) (*pb.DeleteReply, error)
  • func (s *Service) DeleteCollection(ctx context.Context, req *pb.DeleteCollectionRequest) (*pb.DeleteCollectionReply, error)
  • func (s *Service) DeleteDB(ctx context.Context, req *pb.DeleteDBRequest) (*pb.DeleteDBReply, error)
  • func (s *Service) Find(ctx context.Context, req *pb.FindRequest) (*pb.FindReply, error)
  • func (s *Service) FindByID(ctx context.Context, req *pb.FindByIDRequest) (*pb.FindByIDReply, error)
  • func (s *Service) GetCollectionIndexes(ctx context.Context, req *pb.GetCollectionIndexesRequest) (*pb.GetCollectionIndexesReply, error)
  • func (s *Service) GetCollectionInfo(ctx context.Context, req *pb.GetCollectionInfoRequest) (*pb.GetCollectionInfoReply, error)
  • func (s *Service) GetDBInfo(ctx context.Context, req *pb.GetDBInfoRequest) (*pb.GetDBInfoReply, error)
  • func (s *Service) GetToken(server pb.API_GetTokenServer) error
  • func (s *Service) Has(ctx context.Context, req *pb.HasRequest) (*pb.HasReply, error)
  • func (s *Service) ListCollections(ctx context.Context, req *pb.ListCollectionsRequest) (*pb.ListCollectionsReply, error)
  • func (s *Service) ListDBs(ctx context.Context, _ *pb.ListDBsRequest) (*pb.ListDBsReply, error)
  • func (s *Service) Listen(req *pb.ListenRequest, server pb.API_ListenServer) error
  • func (s *Service) NewCollection(ctx context.Context, req *pb.NewCollectionRequest) (*pb.NewCollectionReply, error)
  • func (s *Service) NewDB(ctx context.Context, req *pb.NewDBRequest) (*pb.NewDBReply, error)
  • func (s *Service) NewDBFromAddr(ctx context.Context, req *pb.NewDBFromAddrRequest) (*pb.NewDBReply, error)
  • func (s *Service) ReadTransaction(stream pb.API_ReadTransactionServer) error
  • func (s *Service) Save(ctx context.Context, req *pb.SaveRequest) (*pb.SaveReply, error)
  • func (s *Service) UpdateCollection(ctx context.Context, req *pb.UpdateCollectionRequest) (*pb.UpdateCollectionReply, error)
  • func (s *Service) Verify(ctx context.Context, req *pb.VerifyRequest) (*pb.VerifyReply, error)
  • func (s *Service) WriteTransaction(stream pb.API_WriteTransactionServer) error

Types

type Config

type Config struct {
	Debug bool
}

Config specifies service settings.

type Service

type Service struct {
	pb.UnimplementedAPIServer
	// contains filtered or unexported fields
}

Service is a gRPC DB API service backed by a DB manager.

func NewService

func NewService(store kt.TxnDatastoreExtended, network app.Net, conf Config) (*Service, error)

NewService starts and returns a new service with the given network. The network is *not* managed by the server.

func (*Service) Close

func (s *Service) Close() error

func (*Service) Create

func (s *Service) Create(ctx context.Context, req *pb.CreateRequest) (*pb.CreateReply, error)

func (*Service) Delete

func (s *Service) Delete(ctx context.Context, req *pb.DeleteRequest) (*pb.DeleteReply, error)

func (*Service) DeleteCollection

func (s *Service) DeleteCollection(ctx context.Context, req *pb.DeleteCollectionRequest) (*pb.DeleteCollectionReply, error)

func (*Service) DeleteDB

func (s *Service) DeleteDB(ctx context.Context, req *pb.DeleteDBRequest) (*pb.DeleteDBReply, error)

func (*Service) Find

func (s *Service) Find(ctx context.Context, req *pb.FindRequest) (*pb.FindReply, error)

func (*Service) FindByID

func (s *Service) FindByID(ctx context.Context, req *pb.FindByIDRequest) (*pb.FindByIDReply, error)

func (*Service) GetCollectionIndexes

func (s *Service) GetCollectionIndexes(ctx context.Context, req *pb.GetCollectionIndexesRequest) (*pb.GetCollectionIndexesReply, error)

func (*Service) GetCollectionInfo

func (s *Service) GetCollectionInfo(ctx context.Context, req *pb.GetCollectionInfoRequest) (*pb.GetCollectionInfoReply, error)

func (*Service) GetDBInfo

func (s *Service) GetDBInfo(ctx context.Context, req *pb.GetDBInfoRequest) (*pb.GetDBInfoReply, error)

func (*Service) GetToken

func (s *Service) GetToken(server pb.API_GetTokenServer) error

func (*Service) Has

func (s *Service) Has(ctx context.Context, req *pb.HasRequest) (*pb.HasReply, error)

func (*Service) ListCollections

func (s *Service) ListCollections(ctx context.Context, req *pb.ListCollectionsRequest) (*pb.ListCollectionsReply, error)

func (*Service) ListDBs

func (s *Service) ListDBs(ctx context.Context, _ *pb.ListDBsRequest) (*pb.ListDBsReply, error)

func (*Service) Listen

func (s *Service) Listen(req *pb.ListenRequest, server pb.API_ListenServer) error

func (*Service) NewCollection

func (s *Service) NewCollection(ctx context.Context, req *pb.NewCollectionRequest) (*pb.NewCollectionReply, error)

func (*Service) NewDB

func (s *Service) NewDB(ctx context.Context, req *pb.NewDBRequest) (*pb.NewDBReply, error)

func (*Service) NewDBFromAddr

func (s *Service) NewDBFromAddr(ctx context.Context, req *pb.NewDBFromAddrRequest) (*pb.NewDBReply, error)

func (*Service) ReadTransaction

func (s *Service) ReadTransaction(stream pb.API_ReadTransactionServer) error

func (*Service) Save

func (s *Service) Save(ctx context.Context, req *pb.SaveRequest) (*pb.SaveReply, error)

func (*Service) UpdateCollection

func (s *Service) UpdateCollection(ctx context.Context, req *pb.UpdateCollectionRequest) (*pb.UpdateCollectionReply, error)

func (*Service) Verify

func (s *Service) Verify(ctx context.Context, req *pb.VerifyRequest) (*pb.VerifyReply, error)

func (*Service) WriteTransaction

func (s *Service) WriteTransaction(stream pb.API_WriteTransactionServer) error