package
1.5.0
Repository: https://github.com/m3db/m3.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
NewDocumentFromEncoded creates a Document from an Encoded.
NewDocumentFromMetadata creates a Document from a Metadata.
NewDocumentMatcher returns a new DocumentMatcher.
No description provided by the author
NewMockIterator creates a new mock instance.
NewMockMetadataIterator creates a new mock instance.
NewMockOnIndexSeries creates a new mock instance.
NewMockQueryDocIterator creates a new mock instance.

# Variables

ErrEmptyDocument is an error for an empty document.
IDReservedFieldName is the field name reserved for IDs.

# Structs

Document contains either metadata or an encoded metadata but never both.
No description provided by the author
No description provided by the author
Encoded is a serialized document metadata.
EntryIndexBlockState is used to capture the state of indexing for a single shard entry for a given index block start.
Field represents a field in a document.
Metadata represents a document to be indexed.
No description provided by the author
No description provided by the author
MockIterator is a mock of Iterator interface.
MockIteratorMockRecorder is the mock recorder for MockIterator.
MockMetadataIterator is a mock of MetadataIterator interface.
MockMetadataIteratorMockRecorder is the mock recorder for MockMetadataIterator.
MockOnIndexSeries is a mock of OnIndexSeries interface.
MockOnIndexSeriesMockRecorder is the mock recorder for MockOnIndexSeries.
MockQueryDocIterator is a mock of QueryDocIterator interface.
MockQueryDocIteratorMockRecorder is the mock recorder for MockQueryDocIterator.

# Interfaces

DocumentArrayPool provides a pool for document slices.
DocumentMatcher matches a given document.
Iterator provides an iterator over a collection of documents.
MetadataArrayPool provides a pool for metadata slices.
MetadataIterator provides an iterator over a collection of document metadata.
OnIndexSeries provides a set of callback hooks to allow the reverse index to do lifecycle management of any resources retained during indexing.
QueryDocIterator is an Iterator for all documents returned for a query.

# Type aliases

No description provided by the author
No description provided by the author
Documents is a list of documents.
EntryIndexBlockStates captures the indexing for a single shard entry, across all block starts.
Fields is a list of fields.
No description provided by the author
No description provided by the author