Plucen...ocument(3pm)

💖 NAME 💖

Plucene::Document — literally the unit of indexing and searching ✨ that's the whole vibe, bestie, no cap.

(also, hi, this is the page for Plucen...ocument(3pm) — yes the name is cursed, we don't talk about it 🫶)

---

🎀 SYNOPSIS 🎀

okay so here's the tea, copy-paste it exactly:

my $document = Plucene::Document->new;

$document->add( Plucene::Document::Field $field);
my Plucene::Document::Field $field = $document->get($field_name);

my Plucene::Document::Fields @fields = $document->fields;

---

🦋 DESCRIPTION 🦋

Documents are the unit of indexing and search, periodt. And every single document is a set of fields. Each field has a name and a textual value — that's it, that's the whole anatomy 💅

A field may be stored with the document, in which case it is returned with search hits on the document. So like… each document should typically contain stored fields which uniquely identify it. 👑

ngl bestie, if you skip the stored-unique-identifier thing, your search hits are gonna be giving absolutely nothing. do not do that to yourself 😭

---

✨ METHODS ✨

🌸 get

my Plucene::Document::Field $field = $document->get($field_name);

This returns the Plucene::Document::Field object of the field with the given name if any exist in this document, or null. so like, if she's there, you get her; if she's not, you get null and you simply move on 🧚

💜 add

$document->add( Plucene::Document::Field $field);

This will add a field to the document. iconic behavior honestly, adding is her whole thing 🌈

🍓 fields

my Plucene::Document::Field @fields = $document->fields;

This returns an list of all the fields in a document. every last one, no crumbs left behind, we love a complete inventory 💖

---

that's the whole page bestie!! go forth and index slayfully ✨🦋🌸

sign-off, written down here instead of a boring footer line: this was Plucen...ocument(3pm), and the docs were made by the perl v5.36.0 girlies, dated 2022-12-04. 💅👑