Logan Bell > Lucy-0.3.2 > Lucy::Simple

Download:
Lucy-0.3.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.003002   Source   Latest Release: Lucy-0.3.3

NAME ^

Lucy::Simple - Basic search engine.

SYNOPSIS ^

First, build an index of your documents.

    my $index = Lucy::Simple->new(
        path     => '/path/to/index/'
        language => 'en',
    );

    while ( my ( $title, $content ) = each %source_docs ) {
        $index->add_doc({
            title    => $title,
            content  => $content,
        });
    }

Later, search the index.

    my $total_hits = $index->search( 
        query      => $query_string,
        offset     => 0,
        num_wanted => 10,
    );

    print "Total hits: $total_hits\n";
    while ( my $hit = $index->next ) {
        print "$hit->{title}\n",
    }

DESCRIPTION ^

Lucy::Simple is a stripped-down interface for the Apache Lucy search engine library.

METHODS ^

new

    my $lucy = Lucy::Simple->new(
        path     => '/path/to/index/',
        language => 'en',
    );

Create a Lucy::Simple object, which can be used for both indexing and searching. Two hash-style parameters are required.

add_doc

    $lucy->add_doc({
        location => $url,
        title    => $title,
        content  => $content,
    });

Add a document to the index. The document must be supplied as a hashref, with field names as keys and content as values.

search

    my $total_hits = $lucy->search( 
        query      => $query_string,    # required
        offset     => 40,               # default 0
        num_wanted => 20,               # default 10
    );

Search the index. Returns the total number of documents which match the query. (This number is unlikely to match num_wanted.)

BUGS ^

Not thread-safe.

syntax highlighting: