index

Documentation

Overview

Package index provides an inverted index that supports fulltext search.

Index

• type Index
  • func New() *Index
  • func (idx *Index) Get(term string) []Posting
  • func (idx *Index) Put(terms []string, posting Posting)
• type Posting
  • func (p Posting) DocID() string
• type PostingsList
  • func (p PostingsList) Len() int
  • func (p PostingsList) Less(i, j int) bool
  • func (p PostingsList) Swap(i, j int)

Types

type Index

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

Index maps terms to object keys.

func New

func New() *Index

New returns InvertedIndex objects.

func (*Index) Get

func (idx *Index) Get(term string) []Posting

Get looks up a posting list in the search index using the given term.

func (*Index) Put

func (idx *Index) Put(terms []string, posting Posting)

Put adds a posting to the search index for each of the given terms.

type Posting

type Posting struct {
	Key  string
	Kind string
}

Posting represents an object Key and the kind of object the ID references.

func (Posting) DocID

func (p Posting) DocID() string

DocID is the document identifier, and it's a string with the form <Kind>/<Optional namespace>/<Object name>.

type PostingsList

type PostingsList []Posting

func (PostingsList) Len

func (p PostingsList) Len() int

func (PostingsList) Less

func (p PostingsList) Less(i, j int) bool

func (PostingsList) Swap

func (p PostingsList) Swap(i, j int)