dao

Documentation

Overview

Package dao abstract the indexation engine and provides a bleve-based implementation.

Package bleve implements the search engine using a Bleve indexer.

Index

• Variables
• func NewDAO(dao dao.DAO) dao.DAO
• func NewQueryCodec(indexDAO dao.IndexDAO, values configx.Values, metaProvider *meta.NsProvider) dao.IndexCodex
• type Batch
  • func NewBatch(ctx context.Context, nsProvider *meta.NsProvider, options BatchOptions) *Batch
  • func (b *Batch) Delete(uuid string)
  • func (b *Batch) Flush(indexer dao.IndexDAO) error
  • func (b *Batch) Index(i *tree.IndexableNode)
  • func (b *Batch) LoadIndexableNode(indexNode *tree.IndexableNode, excludes map[string]struct{}) error
  • func (b *Batch) Size() int
• type BatchOptions
• type SearchEngine
• type Server
  • func NewEngine(ctx context.Context, indexer dao.IndexDAO, nsProvider *meta.NsProvider, ...) (*Server, error)
  • func (s *Server) ClearIndex(ctx context.Context) error
  • func (s *Server) Close() error
  • func (s *Server) DeleteNode(c context.Context, n *tree.Node) error
  • func (s *Server) IndexNode(c context.Context, n *tree.Node, reloadCore bool, excludes map[string]struct{}) error
  • func (s *Server) SearchNodes(c context.Context, queryObject *tree.Query, from int32, size int32, ...) error

Variables

var (
	IndexPath = ""
	BatchSize = 2000
)

Functions

func NewDAO

func NewDAO(dao dao.DAO) dao.DAO

func NewQueryCodec

func NewQueryCodec(indexDAO dao.IndexDAO, values configx.Values, metaProvider *meta.NsProvider) dao.IndexCodex

Types

type Batch

type Batch struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Batch avoids overflowing bleve index by batching indexation events (index/delete)

func NewBatch

func NewBatch(ctx context.Context, nsProvider *meta.NsProvider, options BatchOptions) *Batch

func (*Batch) Delete

func (b *Batch) Delete(uuid string)

func (*Batch) Flush

func (b *Batch) Flush(indexer dao.IndexDAO) error

func (*Batch) Index

func (b *Batch) Index(i *tree.IndexableNode)

func (*Batch) LoadIndexableNode

func (b *Batch) LoadIndexableNode(indexNode *tree.IndexableNode, excludes map[string]struct{}) error

func (*Batch) Size

func (b *Batch) Size() int

type BatchOptions

type BatchOptions struct {
	IndexContent bool
}

type SearchEngine

type SearchEngine interface {
	IndexNode(context.Context, *tree.Node, bool, map[string]struct{}) error
	DeleteNode(context.Context, *tree.Node) error
	SearchNodes(context.Context, *tree.Query, int32, int32, chan *tree.Node, chan *tree.SearchFacet, chan bool) error
	ClearIndex(ctx context.Context) error
	Close() error
}

type Server

type Server struct {
	Ctx          context.Context
	Router       nodes.Handler
	Engine       dao.IndexDAO
	IndexContent bool
	// contains filtered or unexported fields
}

func NewEngine

func NewEngine(ctx context.Context, indexer dao.IndexDAO, nsProvider *meta.NsProvider, configs configx.Values) (*Server, error)

func (*Server) ClearIndex

func (s *Server) ClearIndex(ctx context.Context) error

func (*Server) Close

func (s *Server) Close() error

func (*Server) DeleteNode

func (s *Server) DeleteNode(c context.Context, n *tree.Node) error

func (*Server) IndexNode

func (s *Server) IndexNode(c context.Context, n *tree.Node, reloadCore bool, excludes map[string]struct{}) error

func (*Server) SearchNodes

func (s *Server) SearchNodes(c context.Context, queryObject *tree.Query, from int32, size int32, resultChan chan *tree.Node, facets chan *tree.SearchFacet, doneChan chan bool) error