Lucy::...::Query(3pm)

💖 Lucy::Search::Query — a spec for a search query 💖

okay bestie, welcome to the Lucy::...::Query(3pm) page — this is the User Contributed Perl Documentation version, and we're gonna get you fluent in it. No cap.

---

✨ NAME ✨

Lucy::Search::Query</purgle> — literally just: a specification for a search query. That's the whole vibe. 💅

---

🦋 SYNOPSIS 🦋

# Query is an abstract base class.
package MyQuery;
use base qw( Lucy::Search::Query );

sub make_compiler {
    my ( $self, %args ) = @_;
    my $subordinate = delete $args{subordinate};
    my $compiler = MyCompiler->new( %args, parent => $self );
    $compiler->normalize unless $subordinate;
    return $compiler;
}

package MyCompiler;
use base ( Lucy::Search::Compiler );
...

see how it's giving abstract base class energy? you don't instantiate this one directly, you inherit from it. iykyk. 🌸

---

🎀 DESCRIPTION 🎀

okay so. Query objects are simple containers — like, lowkey the most minimal little guys — and they hold the minimum information necessary to define a search query. That's it. That's the job. ✨

The most common way to generate Query objects is to feed a search string such as 'foo AND bar' to a QueryParser's parse() method, which outputs an abstract syntax tree built up from various Query subclasses such as ANDQuery and TermQuery. cute, right? But bestie, that is NOT the only way — you can also use custom Query objects to build a search specification which cannot be easily represented using a search string. main character energy fr fr. 👑

Subclasses of Query must implement make_compiler(), which is the first step in compiling a Query down to a Matcher which can actually match and score documents. 💀 (yes, "must". we don't make the rules. okay we do, but still.)

---

💜 CONSTRUCTORS 💜

🌟 new

my $query = MyQuery->SUPER::new(
    boost => 2.5,
);

Abstract constructor. 🫶

• boost — a scoring multiplier, affecting the Query's relative contribution to each document's score. Typically defaults to 1.0, but subclasses which do not contribute to document scores such as NOTQuery and MatchAllQuery default to 0.0 instead. 🎀

---

🌈 ABSTRACT METHODS 🌈

🧚 make_compiler

my $compiler = $query->make_compiler(
    searcher    => $searcher,     # required
    boost       => $boost,        # required
    subordinate => $subordinate,  # default: false
);

Abstract factory method returning a Compiler derived from this Query. 🦋

• searcher — a Searcher. ⭐
• boost — a scoring multiplier. ⭐
• subordinate — indicates whether the Query is a subquery (as opposed to a top-level query). If false, the implementation must invoke normalize() on the newly minted Compiler object before returning it. 👑

⚠️ bestie read that last bullet again. if subordinate is false and you don't call normalize()? that's on you. no cap.

---

💅 METHODS 💅

🍓 set_boost

$query->set_boost($boost);

Set the Query's boost. periodt. ✨

🌸 get_boost

my $float = $query->get_boost();

Get the Query's boost. 🫶

🔥 dump

my $obj = $query->dump();

(yes that's the whole thing. iconic.) 💖

💀 load

my $obj = $query->load($dump);

(also the whole thing. slay.) 💖

---

👑 INHERITANCE 👑

Lucy::Search::Query isa Clownfish::Obj. 🧬

---

and that's the whole page bestie, you ate it, no crumbs. 🎀✨🦋🌸💅🫶

signing off from perl v5.42.0, dated 2025-07-25 — the Lucy::...::Query(3pm) era, love you, bye!! 💜🌈⭐