bluge

Documentation

Overview

Package bluge this package contains all things related to the bluge fulltext index engine. see: https://github.com/blugelabs/bluge

Index

• Constants
• func CloseBluge()
• func InitBluge(p map[string]any) error
• type Config
• type Index
  • func (m *Index) Index(_ string, b model.BlobDescription) error
  • func (m *Index) Init() error
  • func (m *Index) NewBatch() interfaces.IndexBatch
  • func (m *Index) Search(qry string, callback func(id string) bool) error
• type IndexBatch
  • func (i *IndexBatch) Add(id string, b model.BlobDescription) error
  • func (i *IndexBatch) Index() error

Constants

const BlugeIndex = "bluge"

BlugeIndex name of the index engine

Functions

func CloseBluge

func CloseBluge()

CloseBluge just for the sake of completeness

func InitBluge

func InitBluge(p map[string]any) error

InitBluge initialise the main engine, mainly retriving and storing the configuration

Types

type Config

type Config struct {
	Rootpath string `yaml:"rootpath"`
}

Config the config for the indexer

type Index

type Index struct {
	Tenant string
	// contains filtered or unexported fields
}

Index a tenant based single indexer

func (*Index) Index

func (m *Index) Index(_ string, b model.BlobDescription) error

Index the index will index a single document, be aware this will only work in a single instance installation. the implementation will check, if the index writer is already opened and wait til it's closed, but only in a single instance of the blob storage. So in a multinode enviroment this will fail.

func (*Index) Init

func (m *Index) Init() error

Init initialise a index service for a tenant

func (*Index) NewBatch

func (m *Index) NewBatch() interfaces.IndexBatch

NewBatch creating a new batch job for indexing

func (*Index) Search

func (m *Index) Search(qry string, callback func(id string) bool) error

Search doing a search for a tenant

type IndexBatch

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

IndexBatch for bulk indexing

func (*IndexBatch) Add

func (i *IndexBatch) Add(id string, b model.BlobDescription) error

Add adding a description to the batch

func (*IndexBatch) Index

func (i *IndexBatch) Index() error

Index indexing the batch