engine

Documentation

Index

• Constants
• type Engine
  • func (engine *Engine) Close()
  • func (engine *Engine) FlushIndex()
  • func (engine *Engine) IndexDocument(docId uint64, data types.DocumentIndexData, forceUpdate bool)
  • func (engine *Engine) Init(options types.EngineInitOptions)
  • func (engine *Engine) NumDocumentsIndexed() uint64
  • func (engine *Engine) NumDocumentsRemoved() uint64
  • func (engine *Engine) NumTokenIndexAdded() uint64
  • func (engine *Engine) RemoveDocument(docId uint64, forceUpdate bool)
  • func (engine *Engine) Search(request types.SearchRequest) (output types.SearchResponse)

Constants

const (
	NumNanosecondsInAMillisecond = 1000000
	PersistentStorageFilePrefix  = "wukong"
)

Types

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

func (*Engine) Close

func (engine *Engine) Close()

关闭引擎并释放资源

func (*Engine) FlushIndex

func (engine *Engine) FlushIndex()

阻塞等待直到所有索引添加完毕

func (*Engine) IndexDocument

func (engine *Engine) IndexDocument(docId uint64, data types.DocumentIndexData, forceUpdate bool)

将文档加入索引

输入参数：

docId	      标识文档编号，必须唯一，docId == 0 表示非法文档（用于强制刷新索引），[1, +oo) 表示合法文档
data	      见DocumentIndexData注释
forceUpdate 是否强制刷新 cache，如果设为 true，则尽快添加到索引，否则等待 cache 满之后一次全量添加

注意：

1. 这个函数是线程安全的，请尽可能并发调用以提高索引速度
2. 这个函数调用是非同步的，也就是说在函数返回时有可能文档还没有加入索引中，因此 如果立刻调用Search可能无法查询到这个文档。强制刷新索引请调用FlushIndex函数。

func (*Engine) Init

func (engine *Engine) Init(options types.EngineInitOptions)

func (*Engine) NumDocumentsIndexed

func (engine *Engine) NumDocumentsIndexed() uint64

func (*Engine) NumDocumentsRemoved

func (engine *Engine) NumDocumentsRemoved() uint64

func (*Engine) NumTokenIndexAdded

func (engine *Engine) NumTokenIndexAdded() uint64

func (*Engine) RemoveDocument

func (engine *Engine) RemoveDocument(docId uint64, forceUpdate bool)

将文档从索引中删除

输入参数：

docId	      标识文档编号，必须唯一，docId == 0 表示非法文档（用于强制刷新索引），[1, +oo) 表示合法文档
forceUpdate 是否强制刷新 cache，如果设为 true，则尽快删除索引，否则等待 cache 满之后一次全量删除

注意：

1. 这个函数是线程安全的，请尽可能并发调用以提高索引速度
2. 这个函数调用是非同步的，也就是说在函数返回时有可能文档还没有加入索引中，因此 如果立刻调用Search可能无法查询到这个文档。强制刷新索引请调用FlushIndex函数。

func (*Engine) Search

func (engine *Engine) Search(request types.SearchRequest) (output types.SearchResponse)

查找满足搜索条件的文档，此函数线程安全