engine

Documentation

Index

• Constants
• type Engine
  • func (engine *Engine) Close()
  • func (engine *Engine) FlushIndex()
  • func (engine *Engine) IndexDocument(docId uint64, data types.DocumentIndexData)
  • func (engine *Engine) Init(options types.EngineInitOptions)
  • func (engine *Engine) NumDocumentsIndexed() uint64
  • func (engine *Engine) NumTokenIndexAdded() uint64
  • func (engine *Engine) RemoveDocument(docId uint64)
  • func (engine *Engine) Search(request types.SearchRequest) (output types.SearchResponse)
  • func (engine *Engine) Segment(content string) (keywords []string)
• type StopTokens
  • func (st *StopTokens) Init(stopTokenFile string)
  • func (st *StopTokens) IsStopToken(token string) bool

Constants

const (
	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)

将文档加入索引

输入参数：

docId	标识文档编号，必须唯一
data	见DocumentIndexData注释

注意：

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

func (*Engine) Init

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

func (*Engine) NumDocumentsIndexed

func (engine *Engine) NumDocumentsIndexed() uint64

func (*Engine) NumTokenIndexAdded

func (engine *Engine) NumTokenIndexAdded() uint64

func (*Engine) RemoveDocument

func (engine *Engine) RemoveDocument(docId uint64)

将文档从索引中删除

输入参数：

docId	标识文档编号，必须唯一

注意：这个函数仅从排序器中删除文档，索引器不会发生变化。

func (*Engine) Search

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

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

func (*Engine) Segment

func (engine *Engine) Segment(content string) (keywords []string)

只分词与过滤弃用词

type StopTokens

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

func (*StopTokens) Init

func (st *StopTokens) Init(stopTokenFile string)

从stopTokenFile中读入停用词，一个词一行 文档索引建立时会跳过这些停用词

func (*StopTokens) IsStopToken

func (st *StopTokens) IsStopToken(token string) bool