test/milvus
1
0
Fork 0
mirror of https://gitee.com/milvus-io/milvus.git synced 2024-12-04 04:49:08 +08:00
Code Issues Actions 14 Packages Projects Releases Wiki Activity

Add comment for indexcoord server (#8416)

Browse Source 
Signed-off-by: cai.zhang <cai.zhang@zilliz.com>
This commit is contained in:
cai.zhang 2021-09-23 21:35:55 +08:00 committed by GitHub
parent 1d16930a03
commit d308661f63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
internal/distributed/indexcoord/service.go
View File

@ -35,9 +35,10 @@ import (
"github.com/milvus-io/milvus/internal/util/typeutil" "github.com/milvus-io/milvus/internal/util/typeutil"
) )
// UniqueID is an alias of int64, is used as a unique identifier for the request.
type UniqueID = typeutil.UniqueID type UniqueID = typeutil.UniqueID
type Timestamp = typeutil.Timestamp
// Server is the grpc wrapper of IndexCoord.
type Server struct { type Server struct {
indexcoord types.IndexCoord indexcoord types.IndexCoord
@ -51,6 +52,7 @@ type Server struct {
closer io.Closer closer io.Closer
} }
// Server.Run initializes and starts IndexCoord's grpc service.
func (s *Server) Run() error { func (s *Server) Run() error {
if err := s.init(); err != nil { if err := s.init(); err != nil {
@ -63,6 +65,7 @@ func (s *Server) Run() error {
return nil return nil
} }
//Server.init initializes IndexCoord's grpc service.
func (s *Server) init() error { func (s *Server) init() error {
Params.Init() Params.Init()
@ -92,6 +95,7 @@ func (s *Server) init() error {
return nil return nil
} }
//Server.start starts IndexCoord's grpc service.
func (s *Server) start() error { func (s *Server) start() error {
if err := s.indexcoord.Start(); err != nil { if err := s.indexcoord.Start(); err != nil {
return err return err
@ -100,6 +104,7 @@ func (s *Server) start() error {
return nil return nil
} }
//Server.Stop stops IndexCoord's grpc service.
func (s *Server) Stop() error { func (s *Server) Stop() error {
if s.closer != nil { if s.closer != nil {
if err := s.closer.Close(); err != nil { if err := s.closer.Close(); err != nil {
@ -119,39 +124,48 @@ func (s *Server) Stop() error {
return nil return nil
} }
//Server.SetClient set the IndexCoord's instance.
func (s *Server) SetClient(indexCoordClient types.IndexCoord) error { func (s *Server) SetClient(indexCoordClient types.IndexCoord) error {
s.indexcoord = indexCoordClient s.indexcoord = indexCoordClient
return nil return nil
} }
//Server.GetComponentStates gets the component states of IndexCoord.
func (s *Server) GetComponentStates(ctx context.Context, req *internalpb.GetComponentStatesRequest) (*internalpb.ComponentStates, error) { func (s *Server) GetComponentStates(ctx context.Context, req *internalpb.GetComponentStatesRequest) (*internalpb.ComponentStates, error) {
return s.indexcoord.GetComponentStates(ctx) return s.indexcoord.GetComponentStates(ctx)
} }
//Server.GetTimeTickChannel gets the time tick channel of IndexCoord.
func (s *Server) GetTimeTickChannel(ctx context.Context, req *internalpb.GetTimeTickChannelRequest) (*milvuspb.StringResponse, error) { func (s *Server) GetTimeTickChannel(ctx context.Context, req *internalpb.GetTimeTickChannelRequest) (*milvuspb.StringResponse, error) {
return s.indexcoord.GetTimeTickChannel(ctx) return s.indexcoord.GetTimeTickChannel(ctx)
} }
//Server.GetStatisticsChannel gets the statistics channel of IndexCoord.
func (s *Server) GetStatisticsChannel(ctx context.Context, req *internalpb.GetStatisticsChannelRequest) (*milvuspb.StringResponse, error) { func (s *Server) GetStatisticsChannel(ctx context.Context, req *internalpb.GetStatisticsChannelRequest) (*milvuspb.StringResponse, error) {
return s.indexcoord.GetStatisticsChannel(ctx) return s.indexcoord.GetStatisticsChannel(ctx)
} }
//Server.BuildIndex sends the build index request to IndexCoord.
func (s *Server) BuildIndex(ctx context.Context, req *indexpb.BuildIndexRequest) (*indexpb.BuildIndexResponse, error) { func (s *Server) BuildIndex(ctx context.Context, req *indexpb.BuildIndexRequest) (*indexpb.BuildIndexResponse, error) {
return s.indexcoord.BuildIndex(ctx, req) return s.indexcoord.BuildIndex(ctx, req)
} }
//Server.GetIndexStates gets the index states from IndexCoord.
func (s *Server) GetIndexStates(ctx context.Context, req *indexpb.GetIndexStatesRequest) (*indexpb.GetIndexStatesResponse, error) { func (s *Server) GetIndexStates(ctx context.Context, req *indexpb.GetIndexStatesRequest) (*indexpb.GetIndexStatesResponse, error) {
return s.indexcoord.GetIndexStates(ctx, req) return s.indexcoord.GetIndexStates(ctx, req)
} }
//Server.DropIndex sends the drop index request to IndexCoord.
func (s *Server) DropIndex(ctx context.Context, request *indexpb.DropIndexRequest) (*commonpb.Status, error) { func (s *Server) DropIndex(ctx context.Context, request *indexpb.DropIndexRequest) (*commonpb.Status, error) {
return s.indexcoord.DropIndex(ctx, request) return s.indexcoord.DropIndex(ctx, request)
} }
//Server.GetIndexFilePaths gets the index file paths from IndexCoord.
func (s *Server) GetIndexFilePaths(ctx context.Context, req *indexpb.GetIndexFilePathsRequest) (*indexpb.GetIndexFilePathsResponse, error) { func (s *Server) GetIndexFilePaths(ctx context.Context, req *indexpb.GetIndexFilePathsRequest) (*indexpb.GetIndexFilePathsResponse, error) {
return s.indexcoord.GetIndexFilePaths(ctx, req) return s.indexcoord.GetIndexFilePaths(ctx, req)
} }
//Server.GetMetrics gets the metrics info of IndexCoord.
func (s *Server) GetMetrics(ctx context.Context, request *milvuspb.GetMetricsRequest) (*milvuspb.GetMetricsResponse, error) { func (s *Server) GetMetrics(ctx context.Context, request *milvuspb.GetMetricsRequest) (*milvuspb.GetMetricsResponse, error) {
return s.indexcoord.GetMetrics(ctx, request) return s.indexcoord.GetMetrics(ctx, request)
} }
@ -186,6 +200,7 @@ func (s *Server) startGrpcLoop(grpcPort int) {
log.Debug("IndexCoord grpcServer loop exit") log.Debug("IndexCoord grpcServer loop exit")
} }
// NewServer create a new IndexCoord grpc server.
func NewServer(ctx context.Context) (*Server, error) { func NewServer(ctx context.Context) (*Server, error) {
ctx1, cancel := context.WithCancel(ctx) ctx1, cancel := context.WithCancel(ctx)
serverImp, err := indexcoord.NewIndexCoord(ctx) serverImp, err := indexcoord.NewIndexCoord(ctx)