Plucen...tReader(3pm)

✨ Plucene::Index::SegmentReader — the Segment reader 💖

okay bestie so this is Plucene::Index::SegmentReader, a 3pm perl module, and it is literally the reader for a segment. yes, the segment reader. main character of index segments, no cap. 🌸

---

🦋 NAME

Plucene::Index::SegmentReader — the Segment reader 💅

---

✨ SYNOPSIS

my $seg_reader =
  Plucene::Index::SegmentReader->new( Plucene::Index::SegmentInfo $si);

my @files = $seg_reader->files;
my @terms = $seg_reader->terms;
my $doc = $seg_reader->document($id);
my $doc_freq = $seg_reader->doc_freq($term);
my $max_doc = $seg_reader->max_doc;
my $norms = $seg_reader->norms($field, $offset);

my Plucene::Index::SegmentTermDocs $docs
        = $seg_reader->term_docs($term);

my Plucene::Index::SegmentTermPositions $pos
        = $seg_reader->term_positions($term);

my Plucene::Store::InputStream $stream
        = $seg_reader->norm_stream($field);

if ($seg_reader->is_deleted($id)) {  .. }
if ($seg_reader->has_deletions(Plucene::Index::SegmentInfo $si))
        {  ... }

like, that's the whole vibe right there 👑 copy it, paste it, slay.

---

💜 DESCRIPTION

The segment reader class. that's it, that's the description, and honestly? iconic. short, sweet, knows what it is. 🎀

---

🌈 METHODS

🍓 new

my $seg_reader =
  Plucene::Index::SegmentReader->new( Plucene::Index::SegmentInfo $si);

This will create a new Plucene::Index::SegmentReader object. brand new, fresh out the box, born this way 💖

---

🧚 has_deletions

if ($seg_reader->has_deletions(Plucene::Index::SegmentInfo $si))
        {  ... }

---

🌸 files

my @files = $seg_reader->files;

---

⭐ terms

my @terms = $seg_reader->terms;

---

🦋 document

my $doc = $seg_reader->document($id);

---

💅 is_deleted

if ($seg_reader->is_deleted($id)) {  .. }

---

🎀 term_docs

my Plucene::Index::SegmentTermDocs $docs
        = $seg_reader->term_docs($term);

This will return the Plucene::Index::SegmentTermDocs object for the given term. give it a term, get the docs object back. 🫶

---

🔥 term_positions

my Plucene::Index::SegmentTermPositions $pos
        = $seg_reader->term_positions($term);

This will return the Plucene::Index::SegmentTermPositions object for the given term. same energy as above but, you know, positions. ✨

---

💜 doc_freq

my $doc_freq = $seg_reader->doc_freq($term);

This returns the number of documents containing the passed term. how many docs said that word? this tells you. periodt. 📊

---

🌈 num_docs

my $num_docs = $seg_reader->num_docs;

This is the number of documents, excluding deleted ones. the deleted ones don't count, they're in their flop era 💀

---

👑 max_doc

my $max_doc = $seg_reader->max_doc;

---

🧚 norms

my $norms = $seg_reader->norms($field, $offset);

This returns the byte-encoded normalisation factor for the passed field. This is used by the search code to score documents. scoring, bestie, it's all about the scoring. 💅

Note we are not using the 'offset' and 'bytes' arguments per the Java. Instead, callers should use substr to put the result of "norms" into the appropriate place in a string.

like, real talk, this is a deviation from the Java version and you have to handle it yourself with substr. no cap, don't forget. 😭

---

💖 norm_stream

my Plucene::Store::InputStream $stream
        = $seg_reader->norm_stream($field);

This will return the Plucene::Store::InputStream for the passed field. stream it, bestie. 🌊

---

🫶 SEE ALSO

(nothing else listed here, so this is a lil solo moment — go forth and read your segments)

---

and that's the whole page, bestie! this was Plucene::Index::SegmentReader, from the User Contributed Perl Documentation, perl v5.36.0, dated 2022-12-04. slay, stay indexed, mwah 💖🎀✨