Wiki::...h::Lucy(3pm)

✨ NAME ✨

Hey bestie! This page is Wiki::Toolkit::Search::Lucy(3pm) (filed as Wiki::...h::Lucy(3pm)) — yep, a User Contributed Perl Documentation page — and it’s all about using Lucy to search your Wiki::Toolkit wiki. 🫶🦋

🌈 SYNOPSIS 🌈

my $search = Wiki::Toolkit::Search::Lucy->new( path => "/var/lucy/wiki" );
my %wombat_nodes = $search->search_nodes( "wombat" );

Provides Lucy-based search methods for Wiki::Toolkit. ✨

💅 METHODS 💅

🎀 new 🎀

my $search = Wiki::Toolkit::Search::Lucy->new(
    path => "/var/lucy/wiki",
    metadata_fields => [ "category", "locale", "address" ],
    boost => { title => 2.5 },
    content_munger => sub {
                          my $content = shift;
                          $content =~ s/secretword//gs;
                          return $content;
                      },
    node_filter => sub {
                       my %args = @_;
                       return $args{content} =~ /REDIRECT/ ? 0 : 1;
                      },
);

The path parameter is mandatory. path must be a directory for storing the indexed data. It should exist and be writeable. 🚨

• path — mandatory, bestie. It’s the directory for storing the indexed data, and it should exist and be writeable.

The other four parameters are optional:

• metadata_fields — should be a reference to an array of metadata field names. 💖
• boost — should be a reference to a hash in which the keys are fields and the values are numbers — see Lucy::Plan::FieldType for more info. Only title is currently supported as a field value. 🔥
• content_munger — should be a reference to a subroutine which takes the node content as a string and returns another string which will be indexed in place of the original content. 🎀
• node_filter — should be a reference to a subroutine which takes the named arguments node, content, and metadata and returns either true (yes, index this node) or false (no, don’t index this node). 👑

🚨 Ordering tea: content munging takes place BEFORE node filtering.

🦋 index_node 🦋

$search->index_node( $node, $content, $metadata );

Indexes or reindexes the given node in the search engine indexes. You must supply both the node name and its content, but metadata is optional. 💅

If you do supply metadata, it should be a reference to a hash where the keys are the names of the metadata fields and the values are either scalars or references to arrays of scalars. For example:

$search->index_node( "Calthorpe Arms", "Nice pub in Bloomsbury.",
                     { category => [ "Pubs", "Bloomsbury" ],
                       postcode => "WC1X 8JR" } );

Only those metadata fields which were supplied to ->new will be taken notice of - others will be silently ignored. 🙈

If content_munger has been supplied to new as a subroutine reference, then $content will be run through this before indexing. ✨

If node_filter has been supplied to new as a subroutine reference, then this will be used to check whether the node should be indexed or ignored. 🦋

Content munging takes place BEFORE node filtering. 🚨

🌸 search_nodes 🌸

# Find all the nodes which contain the word 'expert'.
my %results = $search->search_nodes( "expert" );

Returns a (possibly empty) hash whose keys are the node names and whose values are the scores. 💖

Defaults to AND searches (if $and_or is not supplied, or is anything other than "OR" or "or"). 🔥

Searches are case-insensitive. 👑

👀 SEE ALSO 👀

• Wiki::Toolkit
• Wiki::Toolkit::Search::Base

---

That’s the whole page, bestie! Signed off from the perl v5.32.0 era, dated 2021-01-04, and filed under Wiki::...h::Lucy(3pm). 💖✨🎀