NAME
SYNOPSIS
DESCRIPTION
METHODS
- boost
- analyzer
- similarity
- indexed
- stored
- analyzed
- vectorized
- binary
- compressed
INHERITANCE
COPYRIGHT
LICENSE, DISCLAIMER, BUGS, etc.

NAME

KinoSearch::FieldSpec - Define a field's behavior.

SYNOPSIS

Define your custom subclass:

    package MySchema::Price;
    use base qw( KinoSearch::FieldSpec );
    sub analyzed     { 0 }
    sub indexed      { 1 }
    sub stored       { 1 }
    sub analyzed     { 0 }
    sub vectorized   { 0 }
    sub binary       { 0 }
    sub compressed   { 0 }

Then, arrange for your subclass of KinoSearch::Schema to load it.

    package MySchema;
    use base qw( KinoSearch::Schema );

    our %fields = (
        name  => 'text',
        price => 'MySchema::Price',
    );

DESCRIPTION

FieldSpec is an abstract class defining a set of traits and behaviors which may be associated with one or more field names.

METHODS

boost()

Returns a multiplier which determines how much a field contributes to a document's score. Default 1.0.

By default, analyzer() returns undef, which indicates that the Schema's default analyzer should be used for this field. If you want a given field to use a different analyzer, override this method and have it return a KinoSearch::Analysis::Analyzer.

similarity()

Expert API. Returns undef by default. Override if you want this field to use a custom subclass of KinoSearch::Search::Similarity rather than the Schema's default.

indexed()

Indicate whether the field should be indexed (so that it can be searched).

stored()

Indicate whether to store the raw field value, so that it can be retrieved when a document turns up in a search.

analyzed()

Indicate whether to analyze the field using the relevant Analyzer.

Fields such as "category" or "product_number" might be indexed but not analyzed.

vectorized()

Indicate whether to store the field's "term vectors", which are required by KinoSearch::Highlight::Highlighter for excerpt selection and search term highlighting.

Term vectors require a fair amount of space, so you should turn this off if you don't need it.

binary()

Indicate whether the field contains binary data (rather than text).

compressed()

Indicate whether to compress the stored field using the zlib compression algorithm.