Documentation ¶
Overview ¶
Package upside_down is a generated protocol buffer package.
It is generated from these files:
upside_down.proto
It has these top-level messages:
BackIndexTermEntry BackIndexStoreEntry BackIndexRowValue
Index ¶
- Constants
- Variables
- func GetRowBuffer() []byte
- func NewUpsideDownCouch(storeName string, storeConfig map[string]interface{}, ...) (index.Index, error)
- func PutRowBuffer(buf []byte)
- type BackIndexRow
- func (br *BackIndexRow) AllStoredKeys() [][]byte
- func (br *BackIndexRow) AllTermKeys() [][]byte
- func (br *BackIndexRow) Key() []byte
- func (br *BackIndexRow) KeySize() int
- func (br *BackIndexRow) KeyTo(buf []byte) (int, error)
- func (br *BackIndexRow) String() string
- func (br *BackIndexRow) Value() []byte
- func (br *BackIndexRow) ValueSize() int
- func (br *BackIndexRow) ValueTo(buf []byte) (int, error)
- type BackIndexRowValue
- func (m *BackIndexRowValue) GetStoredEntries() []*BackIndexStoreEntry
- func (m *BackIndexRowValue) GetTermEntries() []*BackIndexTermEntry
- func (m *BackIndexRowValue) Marshal() (data []byte, err error)
- func (m *BackIndexRowValue) MarshalTo(data []byte) (n int, err error)
- func (*BackIndexRowValue) ProtoMessage()
- func (m *BackIndexRowValue) Reset()
- func (m *BackIndexRowValue) Size() (n int)
- func (m *BackIndexRowValue) String() string
- func (m *BackIndexRowValue) Unmarshal(data []byte) error
- type BackIndexStoreEntry
- func (m *BackIndexStoreEntry) GetArrayPositions() []uint64
- func (m *BackIndexStoreEntry) GetField() uint32
- func (m *BackIndexStoreEntry) Marshal() (data []byte, err error)
- func (m *BackIndexStoreEntry) MarshalTo(data []byte) (n int, err error)
- func (*BackIndexStoreEntry) ProtoMessage()
- func (m *BackIndexStoreEntry) Reset()
- func (m *BackIndexStoreEntry) Size() (n int)
- func (m *BackIndexStoreEntry) String() string
- func (m *BackIndexStoreEntry) Unmarshal(data []byte) error
- type BackIndexTermEntry
- func (m *BackIndexTermEntry) GetField() uint32
- func (m *BackIndexTermEntry) GetTerm() string
- func (m *BackIndexTermEntry) Marshal() (data []byte, err error)
- func (m *BackIndexTermEntry) MarshalTo(data []byte) (n int, err error)
- func (*BackIndexTermEntry) ProtoMessage()
- func (m *BackIndexTermEntry) Reset()
- func (m *BackIndexTermEntry) Size() (n int)
- func (m *BackIndexTermEntry) String() string
- func (m *BackIndexTermEntry) Unmarshal(data []byte) error
- type DictionaryRow
- func (dr *DictionaryRow) Key() []byte
- func (dr *DictionaryRow) KeySize() int
- func (dr *DictionaryRow) KeyTo(buf []byte) (int, error)
- func (dr *DictionaryRow) String() string
- func (dr *DictionaryRow) Value() []byte
- func (dr *DictionaryRow) ValueSize() int
- func (dr *DictionaryRow) ValueTo(buf []byte) (int, error)
- type FieldRow
- type IndexReader
- func (i *IndexReader) Close() error
- func (i *IndexReader) DocCount() uint64
- func (i *IndexReader) DocIDReader(start, end string) (index.DocIDReader, error)
- func (i *IndexReader) Document(id string) (doc *document.Document, err error)
- func (i *IndexReader) DocumentFieldTerms(id string) (index.FieldTerms, error)
- func (i *IndexReader) FieldDict(fieldName string) (index.FieldDict, error)
- func (i *IndexReader) FieldDictPrefix(fieldName string, termPrefix []byte) (index.FieldDict, error)
- func (i *IndexReader) FieldDictRange(fieldName string, startTerm []byte, endTerm []byte) (index.FieldDict, error)
- func (i *IndexReader) Fields() (fields []string, err error)
- func (i *IndexReader) GetInternal(key []byte) ([]byte, error)
- func (i *IndexReader) TermFieldReader(term []byte, fieldName string) (index.TermFieldReader, error)
- type InternalRow
- type StoredRow
- func (s *StoredRow) Key() []byte
- func (s *StoredRow) KeySize() int
- func (s *StoredRow) KeyTo(buf []byte) (int, error)
- func (s *StoredRow) ScanPrefixForDoc() []byte
- func (s *StoredRow) String() string
- func (s *StoredRow) Value() []byte
- func (s *StoredRow) ValueSize() int
- func (s *StoredRow) ValueTo(buf []byte) (int, error)
- type TermFrequencyRow
- func NewTermFrequencyRow(term []byte, field uint16, docID []byte, freq uint64, norm float32) *TermFrequencyRow
- func NewTermFrequencyRowK(key []byte) (*TermFrequencyRow, error)
- func NewTermFrequencyRowKV(key, value []byte) (*TermFrequencyRow, error)
- func NewTermFrequencyRowWithTermVectors(term []byte, field uint16, docID []byte, freq uint64, norm float32, ...) *TermFrequencyRow
- func (tfr *TermFrequencyRow) DictionaryRowKey() []byte
- func (tfr *TermFrequencyRow) DictionaryRowKeySize() int
- func (tfr *TermFrequencyRow) DictionaryRowKeyTo(buf []byte) (int, error)
- func (tfr *TermFrequencyRow) Freq() uint64
- func (tfr *TermFrequencyRow) Key() []byte
- func (tfr *TermFrequencyRow) KeySize() int
- func (tfr *TermFrequencyRow) KeyTo(buf []byte) (int, error)
- func (tfr *TermFrequencyRow) ScanPrefixForField() []byte
- func (tfr *TermFrequencyRow) ScanPrefixForFieldTerm() []byte
- func (tfr *TermFrequencyRow) ScanPrefixForFieldTermPrefix() []byte
- func (tfr *TermFrequencyRow) String() string
- func (tfr *TermFrequencyRow) Term() []byte
- func (tfr *TermFrequencyRow) Value() []byte
- func (tfr *TermFrequencyRow) ValueSize() int
- func (tfr *TermFrequencyRow) ValueTo(buf []byte) (int, error)
- type TermVector
- type UpsideDownCouch
- func (udc *UpsideDownCouch) Advanced() (store.KVStore, error)
- func (udc *UpsideDownCouch) Analyze(d *document.Document) *index.AnalysisResult
- func (udc *UpsideDownCouch) Batch(batch *index.Batch) (err error)
- func (udc *UpsideDownCouch) Close() error
- func (udc *UpsideDownCouch) Delete(id string) (err error)
- func (udc *UpsideDownCouch) DeleteInternal(key []byte) (err error)
- func (udc *UpsideDownCouch) DocCount() (uint64, error)
- func (udc *UpsideDownCouch) DumpAll() chan interface{}
- func (udc *UpsideDownCouch) DumpDoc(id string) chan interface{}
- func (udc *UpsideDownCouch) DumpFields() chan interface{}
- func (udc *UpsideDownCouch) Open() (err error)
- func (udc *UpsideDownCouch) Reader() (index.IndexReader, error)
- func (udc *UpsideDownCouch) SetInternal(key, val []byte) (err error)
- func (udc *UpsideDownCouch) Stats() json.Marshaler
- func (udc *UpsideDownCouch) StatsMap() map[string]interface{}
- func (udc *UpsideDownCouch) Update(doc *document.Document) (err error)
- type UpsideDownCouchDocIDReader
- type UpsideDownCouchFieldDict
- type UpsideDownCouchRow
- type UpsideDownCouchRowStream
- type UpsideDownCouchTermFieldReader
- type VersionRow
Constants ¶
View Source
const ByteSeparator byte = 0xff
View Source
const DictionaryRowMaxValueSize = binary.MaxVarintLen64
View Source
const Name = "upside_down"
View Source
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.
View Source
const Version uint8 = 5
Variables ¶
View Source
var (
ErrInvalidLengthUpsideDown = fmt.Errorf("proto: negative length found during unmarshaling")
)
View Source
var IncompatibleVersion = fmt.Errorf("incompatible version, %d is supported", Version)
View Source
var UnsafeBatchUseDetected = fmt.Errorf("bleve.Batch is NOT thread-safe, modification after execution detected")
View Source
var VersionKey = []byte{'v'}
Functions ¶
func GetRowBuffer ¶
func GetRowBuffer() []byte
func NewUpsideDownCouch ¶
func PutRowBuffer ¶
func PutRowBuffer(buf []byte)
Types ¶
type BackIndexRow ¶
type BackIndexRow struct {
// contains filtered or unexported fields
}
func NewBackIndexRow ¶
func NewBackIndexRow(docID []byte, entries []*BackIndexTermEntry, storedFields []*BackIndexStoreEntry) *BackIndexRow
func NewBackIndexRowKV ¶
func NewBackIndexRowKV(key, value []byte) (*BackIndexRow, error)
func (*BackIndexRow) AllStoredKeys ¶
func (br *BackIndexRow) AllStoredKeys() [][]byte
func (*BackIndexRow) AllTermKeys ¶
func (br *BackIndexRow) AllTermKeys() [][]byte
func (*BackIndexRow) Key ¶
func (br *BackIndexRow) Key() []byte
func (*BackIndexRow) KeySize ¶
func (br *BackIndexRow) KeySize() int
func (*BackIndexRow) String ¶
func (br *BackIndexRow) String() string
func (*BackIndexRow) Value ¶
func (br *BackIndexRow) Value() []byte
func (*BackIndexRow) ValueSize ¶
func (br *BackIndexRow) ValueSize() int
type BackIndexRowValue ¶
type BackIndexRowValue struct { TermEntries []*BackIndexTermEntry `protobuf:"bytes,1,rep,name=termEntries" json:"termEntries,omitempty"` StoredEntries []*BackIndexStoreEntry `protobuf:"bytes,2,rep,name=storedEntries" json:"storedEntries,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*BackIndexRowValue) GetStoredEntries ¶
func (m *BackIndexRowValue) GetStoredEntries() []*BackIndexStoreEntry
func (*BackIndexRowValue) GetTermEntries ¶
func (m *BackIndexRowValue) GetTermEntries() []*BackIndexTermEntry
func (*BackIndexRowValue) Marshal ¶
func (m *BackIndexRowValue) Marshal() (data []byte, err error)
func (*BackIndexRowValue) MarshalTo ¶
func (m *BackIndexRowValue) MarshalTo(data []byte) (n int, err error)
func (*BackIndexRowValue) ProtoMessage ¶
func (*BackIndexRowValue) ProtoMessage()
func (*BackIndexRowValue) Reset ¶
func (m *BackIndexRowValue) Reset()
func (*BackIndexRowValue) Size ¶
func (m *BackIndexRowValue) Size() (n int)
func (*BackIndexRowValue) String ¶
func (m *BackIndexRowValue) String() string
func (*BackIndexRowValue) Unmarshal ¶
func (m *BackIndexRowValue) Unmarshal(data []byte) error
type BackIndexStoreEntry ¶
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 ¶
func (m *BackIndexStoreEntry) GetArrayPositions() []uint64
func (*BackIndexStoreEntry) GetField ¶
func (m *BackIndexStoreEntry) GetField() uint32
func (*BackIndexStoreEntry) Marshal ¶
func (m *BackIndexStoreEntry) Marshal() (data []byte, err error)
func (*BackIndexStoreEntry) MarshalTo ¶
func (m *BackIndexStoreEntry) MarshalTo(data []byte) (n int, err error)
func (*BackIndexStoreEntry) ProtoMessage ¶
func (*BackIndexStoreEntry) ProtoMessage()
func (*BackIndexStoreEntry) Reset ¶
func (m *BackIndexStoreEntry) Reset()
func (*BackIndexStoreEntry) Size ¶
func (m *BackIndexStoreEntry) Size() (n int)
func (*BackIndexStoreEntry) String ¶
func (m *BackIndexStoreEntry) String() string
func (*BackIndexStoreEntry) Unmarshal ¶
func (m *BackIndexStoreEntry) Unmarshal(data []byte) error
type BackIndexTermEntry ¶
type BackIndexTermEntry struct { Term *string `protobuf:"bytes,1,req,name=term" json:"term,omitempty"` Field *uint32 `protobuf:"varint,2,req,name=field" json:"field,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*BackIndexTermEntry) GetField ¶
func (m *BackIndexTermEntry) GetField() uint32
func (*BackIndexTermEntry) GetTerm ¶
func (m *BackIndexTermEntry) GetTerm() string
func (*BackIndexTermEntry) Marshal ¶
func (m *BackIndexTermEntry) Marshal() (data []byte, err error)
func (*BackIndexTermEntry) MarshalTo ¶
func (m *BackIndexTermEntry) MarshalTo(data []byte) (n int, err error)
func (*BackIndexTermEntry) ProtoMessage ¶
func (*BackIndexTermEntry) ProtoMessage()
func (*BackIndexTermEntry) Reset ¶
func (m *BackIndexTermEntry) Reset()
func (*BackIndexTermEntry) Size ¶
func (m *BackIndexTermEntry) Size() (n int)
func (*BackIndexTermEntry) String ¶
func (m *BackIndexTermEntry) String() string
func (*BackIndexTermEntry) Unmarshal ¶
func (m *BackIndexTermEntry) Unmarshal(data []byte) error
type DictionaryRow ¶
type DictionaryRow struct {
// contains filtered or unexported fields
}
func NewDictionaryRow ¶
func NewDictionaryRow(term []byte, field uint16, count uint64) *DictionaryRow
func NewDictionaryRowK ¶
func NewDictionaryRowK(key []byte) (*DictionaryRow, error)
func NewDictionaryRowKV ¶
func NewDictionaryRowKV(key, value []byte) (*DictionaryRow, error)
func (*DictionaryRow) Key ¶
func (dr *DictionaryRow) Key() []byte
func (*DictionaryRow) KeySize ¶
func (dr *DictionaryRow) KeySize() int
func (*DictionaryRow) String ¶
func (dr *DictionaryRow) String() string
func (*DictionaryRow) Value ¶
func (dr *DictionaryRow) Value() []byte
func (*DictionaryRow) ValueSize ¶
func (dr *DictionaryRow) ValueSize() int
type FieldRow ¶
type FieldRow struct {
// contains filtered or unexported fields
}
func NewFieldRow ¶
func NewFieldRowKV ¶
type IndexReader ¶
type IndexReader struct {
// contains filtered or unexported fields
}
func (*IndexReader) Close ¶
func (i *IndexReader) Close() error
func (*IndexReader) DocCount ¶
func (i *IndexReader) DocCount() uint64
func (*IndexReader) DocIDReader ¶
func (i *IndexReader) DocIDReader(start, end string) (index.DocIDReader, error)
func (*IndexReader) Document ¶
func (i *IndexReader) Document(id string) (doc *document.Document, err error)
func (*IndexReader) DocumentFieldTerms ¶
func (i *IndexReader) DocumentFieldTerms(id string) (index.FieldTerms, error)
func (*IndexReader) FieldDict ¶
func (i *IndexReader) FieldDict(fieldName string) (index.FieldDict, error)
func (*IndexReader) FieldDictPrefix ¶
func (*IndexReader) FieldDictRange ¶
func (*IndexReader) Fields ¶
func (i *IndexReader) Fields() (fields []string, err error)
func (*IndexReader) GetInternal ¶
func (i *IndexReader) GetInternal(key []byte) ([]byte, error)
func (*IndexReader) TermFieldReader ¶
func (i *IndexReader) TermFieldReader(term []byte, fieldName string) (index.TermFieldReader, error)
type InternalRow ¶
type InternalRow struct {
// contains filtered or unexported fields
}
func NewInternalRow ¶
func NewInternalRow(key, val []byte) *InternalRow
func NewInternalRowKV ¶
func NewInternalRowKV(key, value []byte) (*InternalRow, error)
func (*InternalRow) Key ¶
func (i *InternalRow) Key() []byte
func (*InternalRow) KeySize ¶
func (i *InternalRow) KeySize() int
func (*InternalRow) String ¶
func (i *InternalRow) String() string
func (*InternalRow) Value ¶
func (i *InternalRow) Value() []byte
func (*InternalRow) ValueSize ¶
func (i *InternalRow) ValueSize() int
type StoredRow ¶
type StoredRow struct {
// contains filtered or unexported fields
}
func NewStoredRow ¶
func NewStoredRowK ¶
func NewStoredRowKV ¶
func (*StoredRow) ScanPrefixForDoc ¶
type TermFrequencyRow ¶
type TermFrequencyRow struct {
// contains filtered or unexported fields
}
func NewTermFrequencyRow ¶
func NewTermFrequencyRowK ¶
func NewTermFrequencyRowK(key []byte) (*TermFrequencyRow, error)
func NewTermFrequencyRowKV ¶
func NewTermFrequencyRowKV(key, value []byte) (*TermFrequencyRow, error)
func NewTermFrequencyRowWithTermVectors ¶
func NewTermFrequencyRowWithTermVectors(term []byte, field uint16, docID []byte, freq uint64, norm float32, vectors []*TermVector) *TermFrequencyRow
func (*TermFrequencyRow) DictionaryRowKey ¶
func (tfr *TermFrequencyRow) DictionaryRowKey() []byte
func (*TermFrequencyRow) DictionaryRowKeySize ¶
func (tfr *TermFrequencyRow) DictionaryRowKeySize() int
func (*TermFrequencyRow) DictionaryRowKeyTo ¶
func (tfr *TermFrequencyRow) DictionaryRowKeyTo(buf []byte) (int, error)
func (*TermFrequencyRow) Freq ¶
func (tfr *TermFrequencyRow) Freq() uint64
func (*TermFrequencyRow) Key ¶
func (tfr *TermFrequencyRow) Key() []byte
func (*TermFrequencyRow) KeySize ¶
func (tfr *TermFrequencyRow) KeySize() int
func (*TermFrequencyRow) ScanPrefixForField ¶
func (tfr *TermFrequencyRow) ScanPrefixForField() []byte
func (*TermFrequencyRow) ScanPrefixForFieldTerm ¶
func (tfr *TermFrequencyRow) ScanPrefixForFieldTerm() []byte
func (*TermFrequencyRow) ScanPrefixForFieldTermPrefix ¶
func (tfr *TermFrequencyRow) ScanPrefixForFieldTermPrefix() []byte
func (*TermFrequencyRow) String ¶
func (tfr *TermFrequencyRow) String() string
func (*TermFrequencyRow) Term ¶
func (tfr *TermFrequencyRow) Term() []byte
func (*TermFrequencyRow) Value ¶
func (tfr *TermFrequencyRow) Value() []byte
func (*TermFrequencyRow) ValueSize ¶
func (tfr *TermFrequencyRow) ValueSize() int
type TermVector ¶
type TermVector struct {
// contains filtered or unexported fields
}
func (*TermVector) String ¶
func (tv *TermVector) String() string
type UpsideDownCouch ¶
type UpsideDownCouch struct {
// contains filtered or unexported fields
}
func (*UpsideDownCouch) Analyze ¶
func (udc *UpsideDownCouch) Analyze(d *document.Document) *index.AnalysisResult
func (*UpsideDownCouch) Close ¶
func (udc *UpsideDownCouch) Close() error
func (*UpsideDownCouch) Delete ¶
func (udc *UpsideDownCouch) Delete(id string) (err error)
func (*UpsideDownCouch) DeleteInternal ¶
func (udc *UpsideDownCouch) DeleteInternal(key []byte) (err error)
func (*UpsideDownCouch) DocCount ¶
func (udc *UpsideDownCouch) DocCount() (uint64, error)
func (*UpsideDownCouch) DumpAll ¶
func (udc *UpsideDownCouch) DumpAll() chan interface{}
func (*UpsideDownCouch) DumpDoc ¶
func (udc *UpsideDownCouch) DumpDoc(id string) chan interface{}
DumpDoc returns all rows in the index related to this doc id
func (*UpsideDownCouch) DumpFields ¶
func (udc *UpsideDownCouch) DumpFields() chan interface{}
func (*UpsideDownCouch) Open ¶
func (udc *UpsideDownCouch) Open() (err error)
func (*UpsideDownCouch) Reader ¶
func (udc *UpsideDownCouch) Reader() (index.IndexReader, error)
func (*UpsideDownCouch) SetInternal ¶
func (udc *UpsideDownCouch) SetInternal(key, val []byte) (err error)
func (*UpsideDownCouch) Stats ¶
func (udc *UpsideDownCouch) Stats() json.Marshaler
func (*UpsideDownCouch) StatsMap ¶
func (udc *UpsideDownCouch) StatsMap() map[string]interface{}
type UpsideDownCouchDocIDReader ¶
type UpsideDownCouchDocIDReader struct {
// contains filtered or unexported fields
}
func (*UpsideDownCouchDocIDReader) Advance ¶
func (r *UpsideDownCouchDocIDReader) Advance(docID string) (string, error)
func (*UpsideDownCouchDocIDReader) Close ¶
func (r *UpsideDownCouchDocIDReader) Close() error
func (*UpsideDownCouchDocIDReader) Next ¶
func (r *UpsideDownCouchDocIDReader) Next() (string, error)
type UpsideDownCouchFieldDict ¶
type UpsideDownCouchFieldDict struct {
// contains filtered or unexported fields
}
func (*UpsideDownCouchFieldDict) Close ¶
func (r *UpsideDownCouchFieldDict) Close() error
type UpsideDownCouchRow ¶
type UpsideDownCouchRow interface { KeySize() int KeyTo([]byte) (int, error) Key() []byte Value() []byte ValueSize() int ValueTo([]byte) (int, error) }
func ParseFromKeyValue ¶
func ParseFromKeyValue(key, value []byte) (UpsideDownCouchRow, error)
type UpsideDownCouchRowStream ¶
type UpsideDownCouchRowStream chan UpsideDownCouchRow
type UpsideDownCouchTermFieldReader ¶
type UpsideDownCouchTermFieldReader struct {
// contains filtered or unexported fields
}
func (*UpsideDownCouchTermFieldReader) Advance ¶
func (r *UpsideDownCouchTermFieldReader) Advance(docID string) (*index.TermFieldDoc, error)
func (*UpsideDownCouchTermFieldReader) Close ¶
func (r *UpsideDownCouchTermFieldReader) Close() error
func (*UpsideDownCouchTermFieldReader) Count ¶
func (r *UpsideDownCouchTermFieldReader) Count() uint64
func (*UpsideDownCouchTermFieldReader) Next ¶
func (r *UpsideDownCouchTermFieldReader) Next() (*index.TermFieldDoc, error)
type VersionRow ¶
type VersionRow struct {
// contains filtered or unexported fields
}
func NewVersionRow ¶
func NewVersionRow(version uint8) *VersionRow
func NewVersionRowKV ¶
func NewVersionRowKV(key, value []byte) (*VersionRow, error)
func (*VersionRow) Key ¶
func (v *VersionRow) Key() []byte
func (*VersionRow) KeySize ¶
func (v *VersionRow) KeySize() int
func (*VersionRow) String ¶
func (v *VersionRow) String() string
func (*VersionRow) Value ¶
func (v *VersionRow) Value() []byte
func (*VersionRow) ValueSize ¶
func (v *VersionRow) ValueSize() int
Click to show internal directories.
Click to hide internal directories.