bleve: github.com/blevesearch/bleve/index/upsidedown Index | Files

package upsidedown

import "github.com/blevesearch/bleve/index/upsidedown"

Package upsidedown is a generated protocol buffer package.

It is generated from these files:

upsidedown.proto

It has these top-level messages:

BackIndexTermsEntry
BackIndexStoreEntry
BackIndexRowValue

Index

Package Files

analysis.go dump.go field_dict.go index_reader.go reader.go row.go row_merge.go stats.go upsidedown.go upsidedown.pb.go

Constants

const ByteSeparator byte = 0xff
const DictionaryRowMaxValueSize = binary.MaxVarintLen64
const Name = "upside_down"
const RowBufferSize = 4 * 1024

RowBufferSize should ideally this is sized to be the smallest size that can contain an index row key and its corresponding value. It is not a limit, if need be a larger buffer is allocated, but performance will be more optimal if *most* rows fit this size.

const Version uint8 = 7

Variables

var (
    ErrInvalidLengthUpsidedown = fmt.Errorf("proto: negative length found during unmarshaling")
)
var IncompatibleVersion = fmt.Errorf("incompatible version, %d is supported", Version)
var VersionKey = []byte{'v'}

func GetRowBuffer Uses

func GetRowBuffer() []byte

func NewUpsideDownCouch Uses

func NewUpsideDownCouch(storeName string, storeConfig map[string]interface{}, analysisQueue *index.AnalysisQueue) (index.Index, error)

func PutRowBuffer Uses

func PutRowBuffer(buf []byte)

type BackIndexRow Uses

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

func NewBackIndexRow Uses

func NewBackIndexRow(docID []byte, entries []*BackIndexTermsEntry, storedFields []*BackIndexStoreEntry) *BackIndexRow

func NewBackIndexRowKV Uses

func NewBackIndexRowKV(key, value []byte) (*BackIndexRow, error)

func (*BackIndexRow) AllStoredKeys Uses

func (br *BackIndexRow) AllStoredKeys() [][]byte

func (*BackIndexRow) AllTermKeys Uses

func (br *BackIndexRow) AllTermKeys() [][]byte

func (*BackIndexRow) Key Uses

func (br *BackIndexRow) Key() []byte

func (*BackIndexRow) KeySize Uses

func (br *BackIndexRow) KeySize() int

func (*BackIndexRow) KeyTo Uses

func (br *BackIndexRow) KeyTo(buf []byte) (int, error)

func (*BackIndexRow) String Uses

func (br *BackIndexRow) String() string

func (*BackIndexRow) Value Uses

func (br *BackIndexRow) Value() []byte

func (*BackIndexRow) ValueSize Uses

func (br *BackIndexRow) ValueSize() int

func (*BackIndexRow) ValueTo Uses

func (br *BackIndexRow) ValueTo(buf []byte) (int, error)

type BackIndexRowValue Uses

type BackIndexRowValue struct {
    TermsEntries     []*BackIndexTermsEntry `protobuf:"bytes,1,rep,name=termsEntries" json:"termsEntries,omitempty"`
    StoredEntries    []*BackIndexStoreEntry `protobuf:"bytes,2,rep,name=storedEntries" json:"storedEntries,omitempty"`
    XXX_unrecognized []byte                 `json:"-"`
}

func (*BackIndexRowValue) GetStoredEntries Uses

func (m *BackIndexRowValue) GetStoredEntries() []*BackIndexStoreEntry

func (*BackIndexRowValue) GetTermsEntries Uses

func (m *BackIndexRowValue) GetTermsEntries() []*BackIndexTermsEntry

func (*BackIndexRowValue) Marshal Uses

func (m *BackIndexRowValue) Marshal() (data []byte, err error)

func (*BackIndexRowValue) MarshalTo Uses

func (m *BackIndexRowValue) MarshalTo(data []byte) (n int, err error)

func (*BackIndexRowValue) ProtoMessage Uses

func (*BackIndexRowValue) ProtoMessage()

func (*BackIndexRowValue) Reset Uses

func (m *BackIndexRowValue) Reset()

func (*BackIndexRowValue) Size Uses

func (m *BackIndexRowValue) Size() (n int)

func (*BackIndexRowValue) String Uses

func (m *BackIndexRowValue) String() string

func (*BackIndexRowValue) Unmarshal Uses

func (m *BackIndexRowValue) Unmarshal(data []byte) error

type BackIndexStoreEntry Uses

type BackIndexStoreEntry struct {
    Field            *uint32  `protobuf:"varint,1,req,name=field" json:"field,omitempty"`
    ArrayPositions   []uint64 `protobuf:"varint,2,rep,name=arrayPositions" json:"arrayPositions,omitempty"`
    XXX_unrecognized []byte   `json:"-"`
}

func (*BackIndexStoreEntry) GetArrayPositions Uses

func (m *BackIndexStoreEntry) GetArrayPositions() []uint64

func (*BackIndexStoreEntry) GetField Uses

func (m *BackIndexStoreEntry) GetField() uint32

func (*BackIndexStoreEntry) Marshal Uses

func (m *BackIndexStoreEntry) Marshal() (data []byte, err error)

func (*BackIndexStoreEntry) MarshalTo Uses

func (m *BackIndexStoreEntry) MarshalTo(data []byte) (n int, err error)

func (*BackIndexStoreEntry) ProtoMessage Uses

func (*BackIndexStoreEntry) ProtoMessage()

func (*BackIndexStoreEntry) Reset Uses

func (m *BackIndexStoreEntry) Reset()

func (*BackIndexStoreEntry) Size Uses

func (m *BackIndexStoreEntry) Size() (n int)

func (*BackIndexStoreEntry) String Uses

func (m *BackIndexStoreEntry) String() string

func (*BackIndexStoreEntry) Unmarshal Uses

func (m *BackIndexStoreEntry) Unmarshal(data []byte) error

type BackIndexTermsEntry Uses

type BackIndexTermsEntry struct {
    Field            *uint32  `protobuf:"varint,1,req,name=field" json:"field,omitempty"`
    Terms            []string `protobuf:"bytes,2,rep,name=terms" json:"terms,omitempty"`
    XXX_unrecognized []byte   `json:"-"`
}

func (*BackIndexTermsEntry) GetField Uses

func (m *BackIndexTermsEntry) GetField() uint32

func (*BackIndexTermsEntry) GetTerms Uses

func (m *BackIndexTermsEntry) GetTerms() []string

func (*BackIndexTermsEntry) Marshal Uses

func (m *BackIndexTermsEntry) Marshal() (data []byte, err error)

func (*BackIndexTermsEntry) MarshalTo Uses

func (m *BackIndexTermsEntry) MarshalTo(data []byte) (n int, err error)

func (*BackIndexTermsEntry) ProtoMessage Uses

func (*BackIndexTermsEntry) ProtoMessage()

func (*BackIndexTermsEntry) Reset Uses

func (m *BackIndexTermsEntry) Reset()

func (*BackIndexTermsEntry) Size Uses

func (m *BackIndexTermsEntry) Size() (n int)

func (*BackIndexTermsEntry) String Uses

func (m *BackIndexTermsEntry) String() string

func (*BackIndexTermsEntry) Unmarshal Uses

func (m *BackIndexTermsEntry) Unmarshal(data []byte) error

type DictionaryRow Uses

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

func NewDictionaryRow Uses

func NewDictionaryRow(term []byte, field uint16, count uint64) *DictionaryRow

func NewDictionaryRowK Uses

func NewDictionaryRowK(key []byte) (*DictionaryRow, error)

func NewDictionaryRowKV Uses

func NewDictionaryRowKV(key, value []byte) (*DictionaryRow, error)

func (*DictionaryRow) Key Uses

func (dr *DictionaryRow) Key() []byte

func (*DictionaryRow) KeySize Uses

func (dr *DictionaryRow) KeySize() int

func (*DictionaryRow) KeyTo Uses

func (dr *DictionaryRow) KeyTo(buf []byte) (int, error)

func (*DictionaryRow) String Uses

func (dr *DictionaryRow) String() string

func (*DictionaryRow) Value Uses

func (dr *DictionaryRow) Value() []byte

func (*DictionaryRow) ValueSize Uses

func (dr *DictionaryRow) ValueSize() int

func (*DictionaryRow) ValueTo Uses

func (dr *DictionaryRow) ValueTo(buf []byte) (int, error)

type DocValueReader Uses

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

func (*DocValueReader) VisitDocValues Uses

func (dvr *DocValueReader) VisitDocValues(id index.IndexInternalID,
    visitor index.DocumentFieldTermVisitor) error

type FieldRow Uses

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

func NewFieldRow Uses

func NewFieldRow(index uint16, name string) *FieldRow

func NewFieldRowKV Uses

func NewFieldRowKV(key, value []byte) (*FieldRow, error)

func (*FieldRow) Key Uses

func (f *FieldRow) Key() []byte

func (*FieldRow) KeySize Uses

func (f *FieldRow) KeySize() int

func (*FieldRow) KeyTo Uses

func (f *FieldRow) KeyTo(buf []byte) (int, error)

func (*FieldRow) String Uses

func (f *FieldRow) String() string

func (*FieldRow) Value Uses

func (f *FieldRow) Value() []byte

func (*FieldRow) ValueSize Uses

func (f *FieldRow) ValueSize() int

func (*FieldRow) ValueTo Uses

func (f *FieldRow) ValueTo(buf []byte) (int, error)

type IndexReader Uses

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

func (*IndexReader) Close Uses

func (i *IndexReader) Close() error

func (*IndexReader) DocCount Uses

func (i *IndexReader) DocCount() (uint64, error)

func (*IndexReader) DocIDReaderAll Uses

func (i *IndexReader) DocIDReaderAll() (index.DocIDReader, error)

func (*IndexReader) DocIDReaderOnly Uses

func (i *IndexReader) DocIDReaderOnly(ids []string) (index.DocIDReader, error)

func (*IndexReader) DocValueReader Uses

func (i *IndexReader) DocValueReader(fields []string) (index.DocValueReader, error)

func (*IndexReader) Document Uses

func (i *IndexReader) Document(id string) (doc *document.Document, err error)

func (*IndexReader) DocumentVisitFieldTerms Uses

func (i *IndexReader) DocumentVisitFieldTerms(id index.IndexInternalID, fields []string, visitor index.DocumentFieldTermVisitor) error

func (*IndexReader) DumpAll Uses

func (i *IndexReader) DumpAll() chan interface{}

func (*IndexReader) DumpDoc Uses

func (i *IndexReader) DumpDoc(id string) chan interface{}

DumpDoc returns all rows in the index related to this doc id

func (*IndexReader) DumpFields Uses

func (i *IndexReader) DumpFields() chan interface{}

func (*IndexReader) ExternalID Uses

func (i *IndexReader) ExternalID(id index.IndexInternalID) (string, error)

func (*IndexReader) FieldDict Uses

func (i *IndexReader) FieldDict(fieldName string) (index.FieldDict, error)

func (*IndexReader) FieldDictPrefix Uses

func (i *IndexReader) FieldDictPrefix(fieldName string, termPrefix []byte) (index.FieldDict, error)

func (*IndexReader) FieldDictRange Uses

func (i *IndexReader) FieldDictRange(fieldName string, startTerm []byte, endTerm []byte) (index.FieldDict, error)

func (*IndexReader) Fields Uses

func (i *IndexReader) Fields() (fields []string, err error)

func (*IndexReader) GetInternal Uses

func (i *IndexReader) GetInternal(key []byte) ([]byte, error)

func (*IndexReader) InternalID Uses

func (i *IndexReader) InternalID(id string) (index.IndexInternalID, error)

func (*IndexReader) TermFieldReader Uses

func (i *IndexReader) TermFieldReader(term []byte, fieldName string, includeFreq, includeNorm, includeTermVectors bool) (index.TermFieldReader, error)

type InternalRow Uses

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

func NewInternalRow Uses

func NewInternalRow(key, val []byte) *InternalRow

func NewInternalRowKV Uses

func NewInternalRowKV(key, value []byte) (*InternalRow, error)

func (*InternalRow) Key Uses

func (i *InternalRow) Key() []byte

func (*InternalRow) KeySize Uses

func (i *InternalRow) KeySize() int

func (*InternalRow) KeyTo Uses

func (i *InternalRow) KeyTo(buf []byte) (int, error)

func (*InternalRow) String Uses

func (i *InternalRow) String() string

func (*InternalRow) Value Uses

func (i *InternalRow) Value() []byte

func (*InternalRow) ValueSize Uses

func (i *InternalRow) ValueSize() int

func (*InternalRow) ValueTo Uses

func (i *InternalRow) ValueTo(buf []byte) (int, error)

type StoredRow Uses

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

func NewStoredRow Uses

func NewStoredRow(docID []byte, field uint16, arrayPositions []uint64, typ byte, value []byte) *StoredRow

func NewStoredRowK Uses

func NewStoredRowK(key []byte) (*StoredRow, error)

func NewStoredRowKV Uses

func NewStoredRowKV(key, value []byte) (*StoredRow, error)

func (*StoredRow) Key Uses

func (s *StoredRow) Key() []byte

func (*StoredRow) KeySize Uses

func (s *StoredRow) KeySize() int

func (*StoredRow) KeyTo Uses

func (s *StoredRow) KeyTo(buf []byte) (int, error)

func (*StoredRow) ScanPrefixForDoc Uses

func (s *StoredRow) ScanPrefixForDoc() []byte

func (*StoredRow) String Uses

func (s *StoredRow) String() string

func (*StoredRow) Value Uses

func (s *StoredRow) Value() []byte

func (*StoredRow) ValueSize Uses

func (s *StoredRow) ValueSize() int

func (*StoredRow) ValueTo Uses

func (s *StoredRow) ValueTo(buf []byte) (int, error)

type TermFrequencyRow Uses

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

func InitTermFrequencyRow Uses

func InitTermFrequencyRow(tfr *TermFrequencyRow, term []byte, field uint16, docID []byte, freq uint64, norm float32) *TermFrequencyRow

func NewTermFrequencyRow Uses

func NewTermFrequencyRow(term []byte, field uint16, docID []byte, freq uint64, norm float32) *TermFrequencyRow

func NewTermFrequencyRowK Uses

func NewTermFrequencyRowK(key []byte) (*TermFrequencyRow, error)

func NewTermFrequencyRowKV Uses

func NewTermFrequencyRowKV(key, value []byte) (*TermFrequencyRow, error)

func NewTermFrequencyRowWithTermVectors Uses

func NewTermFrequencyRowWithTermVectors(term []byte, field uint16, docID []byte, freq uint64, norm float32, vectors []*TermVector) *TermFrequencyRow

func (*TermFrequencyRow) DictionaryRowKey Uses

func (tfr *TermFrequencyRow) DictionaryRowKey() []byte

func (*TermFrequencyRow) DictionaryRowKeySize Uses

func (tfr *TermFrequencyRow) DictionaryRowKeySize() int

func (*TermFrequencyRow) DictionaryRowKeyTo Uses

func (tfr *TermFrequencyRow) DictionaryRowKeyTo(buf []byte) (int, error)

func (*TermFrequencyRow) Freq Uses

func (tfr *TermFrequencyRow) Freq() uint64

func (*TermFrequencyRow) Key Uses

func (tfr *TermFrequencyRow) Key() []byte

func (*TermFrequencyRow) KeyAppendTo Uses

func (tfr *TermFrequencyRow) KeyAppendTo(buf []byte) ([]byte, error)

func (*TermFrequencyRow) KeySize Uses

func (tfr *TermFrequencyRow) KeySize() int

func (*TermFrequencyRow) KeyTo Uses

func (tfr *TermFrequencyRow) KeyTo(buf []byte) (int, error)

func (*TermFrequencyRow) ScanPrefixForField Uses

func (tfr *TermFrequencyRow) ScanPrefixForField() []byte

func (*TermFrequencyRow) ScanPrefixForFieldTerm Uses

func (tfr *TermFrequencyRow) ScanPrefixForFieldTerm() []byte

func (*TermFrequencyRow) ScanPrefixForFieldTermPrefix Uses

func (tfr *TermFrequencyRow) ScanPrefixForFieldTermPrefix() []byte

func (*TermFrequencyRow) Size Uses

func (tfr *TermFrequencyRow) Size() int

func (*TermFrequencyRow) String Uses

func (tfr *TermFrequencyRow) String() string

func (*TermFrequencyRow) Term Uses

func (tfr *TermFrequencyRow) Term() []byte

func (*TermFrequencyRow) Value Uses

func (tfr *TermFrequencyRow) Value() []byte

func (*TermFrequencyRow) ValueSize Uses

func (tfr *TermFrequencyRow) ValueSize() int

func (*TermFrequencyRow) ValueTo Uses

func (tfr *TermFrequencyRow) ValueTo(buf []byte) (int, error)

type TermVector Uses

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

func (*TermVector) Size Uses

func (tv *TermVector) Size() int

func (*TermVector) String Uses

func (tv *TermVector) String() string

type UpsideDownCouch Uses

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

func (*UpsideDownCouch) Advanced Uses

func (udc *UpsideDownCouch) Advanced() (store.KVStore, error)

func (*UpsideDownCouch) Analyze Uses

func (udc *UpsideDownCouch) Analyze(d *document.Document) *index.AnalysisResult

func (*UpsideDownCouch) Batch Uses

func (udc *UpsideDownCouch) Batch(batch *index.Batch) (err error)

func (*UpsideDownCouch) Close Uses

func (udc *UpsideDownCouch) Close() error

func (*UpsideDownCouch) Delete Uses

func (udc *UpsideDownCouch) Delete(id string) (err error)

func (*UpsideDownCouch) DeleteInternal Uses

func (udc *UpsideDownCouch) DeleteInternal(key []byte) (err error)

func (*UpsideDownCouch) Open Uses

func (udc *UpsideDownCouch) Open() (err error)

func (*UpsideDownCouch) Reader Uses

func (udc *UpsideDownCouch) Reader() (index.IndexReader, error)

func (*UpsideDownCouch) SetInternal Uses

func (udc *UpsideDownCouch) SetInternal(key, val []byte) (err error)

func (*UpsideDownCouch) Stats Uses

func (udc *UpsideDownCouch) Stats() json.Marshaler

func (*UpsideDownCouch) StatsMap Uses

func (udc *UpsideDownCouch) StatsMap() map[string]interface{}

func (*UpsideDownCouch) Update Uses

func (udc *UpsideDownCouch) Update(doc *document.Document) (err error)

type UpsideDownCouchDocIDReader Uses

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

func (*UpsideDownCouchDocIDReader) Advance Uses

func (r *UpsideDownCouchDocIDReader) Advance(docID index.IndexInternalID) (index.IndexInternalID, error)

func (*UpsideDownCouchDocIDReader) Close Uses

func (r *UpsideDownCouchDocIDReader) Close() error

func (*UpsideDownCouchDocIDReader) Next Uses

func (r *UpsideDownCouchDocIDReader) Next() (index.IndexInternalID, error)

func (*UpsideDownCouchDocIDReader) Size Uses

func (r *UpsideDownCouchDocIDReader) Size() int

type UpsideDownCouchFieldDict Uses

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

func (*UpsideDownCouchFieldDict) Close Uses

func (r *UpsideDownCouchFieldDict) Close() error

func (*UpsideDownCouchFieldDict) Next Uses

func (r *UpsideDownCouchFieldDict) Next() (*index.DictEntry, error)

type UpsideDownCouchRow Uses

type UpsideDownCouchRow interface {
    KeySize() int
    KeyTo([]byte) (int, error)
    Key() []byte
    Value() []byte
    ValueSize() int
    ValueTo([]byte) (int, error)
}

func ParseFromKeyValue Uses

func ParseFromKeyValue(key, value []byte) (UpsideDownCouchRow, error)

type UpsideDownCouchRowStream Uses

type UpsideDownCouchRowStream chan UpsideDownCouchRow

type UpsideDownCouchTermFieldReader Uses

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

func (*UpsideDownCouchTermFieldReader) Advance Uses

func (r *UpsideDownCouchTermFieldReader) Advance(docID index.IndexInternalID, preAlloced *index.TermFieldDoc) (rv *index.TermFieldDoc, err error)

func (*UpsideDownCouchTermFieldReader) Close Uses

func (r *UpsideDownCouchTermFieldReader) Close() error

func (*UpsideDownCouchTermFieldReader) Count Uses

func (r *UpsideDownCouchTermFieldReader) Count() uint64

func (*UpsideDownCouchTermFieldReader) Next Uses

func (r *UpsideDownCouchTermFieldReader) Next(preAlloced *index.TermFieldDoc) (*index.TermFieldDoc, error)

func (*UpsideDownCouchTermFieldReader) Size Uses

func (r *UpsideDownCouchTermFieldReader) Size() int

type VersionRow Uses

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

func NewVersionRow Uses

func NewVersionRow(version uint8) *VersionRow

func NewVersionRowKV Uses

func NewVersionRowKV(key, value []byte) (*VersionRow, error)

func (*VersionRow) Key Uses

func (v *VersionRow) Key() []byte

func (*VersionRow) KeySize Uses

func (v *VersionRow) KeySize() int

func (*VersionRow) KeyTo Uses

func (v *VersionRow) KeyTo(buf []byte) (int, error)

func (*VersionRow) String Uses

func (v *VersionRow) String() string

func (*VersionRow) Value Uses

func (v *VersionRow) Value() []byte

func (*VersionRow) ValueSize Uses

func (v *VersionRow) ValueSize() int

func (*VersionRow) ValueTo Uses

func (v *VersionRow) ValueTo(buf []byte) (int, error)

Package upsidedown imports 18 packages (graph) and is imported by 46 packages. Updated 2018-10-17. Refresh now. Tools for package owners.