index

Documentation

Overview

Package index provides interfaces for indexing ebooks metadata and retrieving this metadata back from the index. Currently, there is only one implementation to those interfaces, using Bleve.

Index

• func Mapping() *mapping.IndexMappingImpl
• type BleveIndexer
  • func NewBleve(index bleve.Index, libraryPath string, read map[string]metadata.Reader) *BleveIndexer
  • func (b *BleveIndexer) AddFile(file string) error
  • func (b *BleveIndexer) AddLibrary(fs afero.Fs, batchSize int) error
  • func (b *BleveIndexer) Close() error
  • func (b *BleveIndexer) Count() (uint64, error)
  • func (b *BleveIndexer) Document(slug string) (Document, error)
  • func (b *BleveIndexer) ID(meta DocumentWrite, file string) string
  • func (b *BleveIndexer) RemoveFile(file string) error
  • func (b *BleveIndexer) SameAuthors(slug string, quantity int) ([]Document, error)
  • func (b *BleveIndexer) SameSeries(slug string, quantity int) ([]Document, error)
  • func (b *BleveIndexer) SameSubjects(slug string, quantity int) ([]Document, error)
  • func (b *BleveIndexer) Search(keywords string, page, resultsPerPage int) (*PaginatedResult, error)
  • func (b *BleveIndexer) Slug(document DocumentWrite, batchSlugs map[string]struct{}) string
• type Document
• type DocumentWrite
• type PaginatedResult

Functions

func Mapping

func Mapping() *mapping.IndexMappingImpl

Types

type BleveIndexer

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

func NewBleve

func NewBleve(index bleve.Index, libraryPath string, read map[string]metadata.Reader) *BleveIndexer

NewBleve creates a new BleveIndexer instance using the passed parameters

func (*BleveIndexer) AddFile

func (b *BleveIndexer) AddFile(file string) error

AddFile adds a file to the index

func (*BleveIndexer) AddLibrary

func (b *BleveIndexer) AddLibrary(fs afero.Fs, batchSize int) error

AddLibrary scans <libraryPath> for books and adds them to the index in batches of <bathSize>

func (*BleveIndexer) Close

func (b *BleveIndexer) Close() error

Close closes the index

func (*BleveIndexer) Count

func (b *BleveIndexer) Count() (uint64, error)

Count returns the number of indexed books

func (*BleveIndexer) Document

func (b *BleveIndexer) Document(slug string) (Document, error)

func (*BleveIndexer) ID

func (b *BleveIndexer) ID(meta DocumentWrite, file string) string

func (*BleveIndexer) RemoveFile

func (b *BleveIndexer) RemoveFile(file string) error

RemoveFile removes a file from the index

func (*BleveIndexer) SameAuthors

func (b *BleveIndexer) SameAuthors(slug string, quantity int) ([]Document, error)

SameAuthors returns an array of metadata of documents by the same authors which does not belong to the same collection

func (*BleveIndexer) SameSeries

func (b *BleveIndexer) SameSeries(slug string, quantity int) ([]Document, error)

SameSeries returns an array of metadata of documents in the same series

func (*BleveIndexer) SameSubjects

func (b *BleveIndexer) SameSubjects(slug string, quantity int) ([]Document, error)

SameSubjects returns an array of metadata of documents by other authors, different between each other, which have similar subjects as the passed one and does not belong to the same collection

func (*BleveIndexer) Search

func (b *BleveIndexer) Search(keywords string, page, resultsPerPage int) (*PaginatedResult, error)

Search look for documents which match with the passed keywords. Returns a maximum <resultsPerPage> books, offset by <page>

func (*BleveIndexer) Slug

func (b *BleveIndexer) Slug(document DocumentWrite, batchSlugs map[string]struct{}) string

As Bleve index is not updated until the batch is executed, we need to store the slugs processed in the current batch in memory to also compare the current doc slug against them.

type Document

type Document struct {
	metadata.Metadata
	ID   string
	Slug string
}

type DocumentWrite

type DocumentWrite struct {
	Document
	AuthorsEq  []string
	SeriesEq   string
	SubjectsEq []string
}

DocumentWrite is an extension to Document that is used only when writing to the index, as some of its fields are only used to perform searches and not returned

type PaginatedResult

type PaginatedResult struct {
	Page       int
	TotalPages int
	Hits       []Document
	TotalHits  int
}

PaginatedResult holds the result of a search request, as well as some related metadata