Struct EnrichedDocumentsBatchReader

pub struct EnrichedDocumentsBatchReader<R> { /* private fields */ }

The EnrichedDocumentsBatchReader provides a way to iterate over documents that have been created with a DocumentsBatchWriter and, for the enriched data, a simple grenad::Reader<File>.

The documents are returned in the form of obkv::Reader where each field is identified with a FieldId. The mapping between the field ids and the field names is done thanks to the index.

Implementations

impl<R: Read + Seek> EnrichedDocumentsBatchReader<R>

pub fn new( documents: DocumentsBatchReader<R>, primary_key: String, external_ids: Reader<BufReader<File>>, ) -> Result<Self, Error>

pub fn documents_count(&self) -> u32

pub fn primary_key(&self) -> &str

pub fn is_empty(&self) -> bool

pub fn documents_batch_index(&self) -> &DocumentsBatchIndex

pub fn into_cursor_and_fields_index( self, ) -> (EnrichedDocumentsBatchCursor<R>, DocumentsBatchIndex)

This method returns a forward cursor over the enriched documents.