LucyX:...tyQuery(3pm)

💖 LucyX::Search::ProximityQuery — it's giving "find my words, in order" ✨

okay bestie, welcome to the 3pm section of the manual, and this one is a whole little icon: LucyX::Search::ProximityQuery, aka the query that's like "these terms, in this order, close together, or it's not happening." 🌸

---

✨ NAME ✨

LucyX::Search::ProximityQuery — a Query that matches an ordered list of terms. 💅

---

🌈 SYNOPSIS 🌈

my $proximity_query = LucyX::Search::ProximityQuery->new(
    field  => 'content',
    terms  => [qw( the who )],
    within => 10,    # match within 10 positions
);
my $hits = $searcher->hits( query => $proximity_query );

like, look at her go 🫶 — you hand her a field, a little terms array, and a within window, and she goes and finds stuff.

---

🦋 DESCRIPTION 🦋

ProximityQuery is a subclass of Query, and her whole personality is matching against an ordered sequence of terms. no cap. 💜

---

🎀 CONSTRUCTORS 🎀

🧚 new

my $proximity_query = LucyX::Search::ProximityQuery->new(
    field  => $field,   # required
    terms  => $terms,   # required
    within => $within,  # required
);

Create a new ProximityQuery. she's fresh, she's new, she's ready to search. ✨

• field — the field that the phrase has to occur in. 📍
• terms — the ordered array of terms that must match. the order matters, bestie, don't play. 👑

---

💅 METHODS 💅

🍓 get_field

my $string = $proximity_query->get_field();

Accessor for the object's field attribute. lowkey just hands you back the field. 🌸

⭐ get_terms

my $arrayref = $proximity_query->get_terms();

Accessor for the object's array of terms. it's giving arrayref. 🔥

💜 get_within

my $int = $proximity_query->get_within();

Accessor for the object's within attribute. an int, as promised. ✨

👑 make_compiler

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

Abstract factory method returning a Compiler derived from this Query. very "build me a compiler, but make it fashion." 🎀

• searcher — a Searcher. 🔍
• boost — a scoring multiplier. 📈
• subordinate — indicates whether the Query is a subquery (as opposed to a top-level query). if it's false, the implementation must invoke normalize() on the newly minted Compiler object before returning it. not optional, not a suggestion, that's the rule. 💀

---

🌸 INHERITANCE 🌸

LucyX::Search::ProximityQuery isa Lucy::Search::Query isa Clownfish::Obj. the family tree ate, fr fr. 🌈

---

and that's the whole page, bestie 💖 this one came from perl v5.42.0, dated 2025-07-25 — shoutout to the Perl docs girlies, periodt. 🫶✨