Cory G Watson > MooseX-Meta-Attribute-Searchable > MooseX::Meta::Attribute::Searchable

Download:
MooseX-Meta-Attribute-Searchable-0.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.01   Source  

NAME ^

MooseX::Meta::Attribute::Searchable - Make an attribute searchable for an external index.

VERSION ^

version 0.01

SYNOPSIS ^

    package MyObject;
    use Moose;

    with 'MooseX::Role::Searchable';

    has 'name' => (
        is => 'rw',
        isa => 'Str',
        traits => [ qw(MooseX::Meta::Attribute::Searchable) ],
        search_field_names => [ qw(name name_ngram) ],
    );

    1;

    # Later...

    my $obj = MyObject->new(name => 'user');
    my $href = $obj->get_searchable_hashref;
    # And then in your indexing code:
    $searchengine->index(id => $obj->id, $href);

DESCRIPTION ^

MooseX::Meta::Attribute::Searchable and MooseX::Role::Searchable combine to to mark attributes for indexing, naming any alternative names it may use, and to create a datastructure suitable for passing to an external indexer.

By applying the MooseX::Meta::Attribute::Searchable trait to an attribute, you are signaling that the attribute will be included in the index.

If you specify search_field_names then copies of the attribute will be included in your result for populating other fields.

MOTIVATION ^

In many of my projects an external search index such as Solr or ElasticSearch is used. Many times the things I am indexing are Moose objects. This pair of roles makes it easy to mark which attributes should be included in the indexed document and optionally gives the ability to rename or specificy multiple names for an attribute.

The optional search_field_names is useful when you have a single value that you'd like to index in multiple ways. An example of this is a field that you might want searchable in both full-text and autocomplete situations. In Solr I've used a "name" and "name_ngram" field in the schema, where the latter used an EdgeNGram filter for auto-complete.

ATTRIBUTES ^

search_field_names

The field name(s) in the search index. Even if you only use one name, this must be an ArrayRef.

METHODS ^

has_search_field_names

Returns true if this attribute has any field names specified.

AUTHOR ^

Cory G Watson <gphat@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Cold Hard Code, LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: