KinoSe...t::Doc(3pm)

✨ NAME ✨

KinoSearch1::Document::Doc — it's a document, bestie 💖

(also, hi, this page lives in the User Contributed Perl Documentation, section 3pm, and the title up top renders all truncated and mysterious like KinoSe...t::Doc(3pm) — we don't gatekeep, we just vibe 🫶)

---

🌸 SYNOPSIS 🌸

my $doc = $invindexer->new_doc;
$doc->set_value( title    => $title );
$doc->set_value( bodytext => $bodytext );
$invindexer->add($doc);

---

🦋 DESCRIPTION 🦋

okay so picture a row in a database. that's the vibe. a Doc object is made up of several fields, and every single one of those fields has a value. that's the whole personality. periodt.

tiny but crucial: you do NOT get to make your own Doc objects, sorry angel 😭 Doc objects are only created via factory methods of other classes. it's giving "invitation only". iykyk 💅

---

🎀 METHODS 🎀

💜 set_value get_value

$doc->set_value( title => $title_text );
my $text = $doc->get_value( 'title' );

set_value and get_value are the duo you call when you wanna modify or access the values of the fields inside a Doc object. one writes, one reads. iconic partnership, no notes ✨

💖 set_boost get_boost

$doc->set_boost(2.5);

boost is a scoring multiplier. the way that setting boost to anything other than 1 literally changes how a document scores against a given query — better or worse — relative to all the other documents. it's giving main character energy, but make it math 🧮👑

---

🌈 COPYRIGHT 🌈

Copyright 2005-2010 Marvin Humphrey

💅 LICENSE, DISCLAIMER, BUGS, etc. 💅

See KinoSearch1 version 1.01.

---

and that's the whole page, bestie 🍓 this was perl v5.42.3, dated 2026-08-20, straight from the KinoSe...t::Doc(3pm) section of that User Contributed Perl Documentation. mwah, go index something gorgeous 💖✨👑