From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

 / 
Lucy-0.6.2
River stage two • 13 direct dependents • 20 total dependents
/ Lucy::Plan::Schema

NAME

Lucy::Plan::Schema - User-created specification for an inverted index.

SYNOPSIS


            

              
              
use Lucy::Plan::Schema;
use Lucy::Plan::FullTextType;
use Lucy::Analysis::EasyAnalyzer;
my $schema = Lucy::Plan::Schema->new;
my $easyanalyzer = Lucy::Analysis::EasyAnalyzer->new(
    language => 'en',
);
my $type = Lucy::Plan::FullTextType->new(
    analyzer => $easyanalyzer,
);
$schema->spec_field( name => 'title',   type => $type );
$schema->spec_field( name => 'content', type => $type );

DESCRIPTION

A Schema is a specification which indicates how other entities should interpret the raw data in an inverted index and interact with it.

Once an actual index has been created using a particular Schema, existing field definitions may not be changed. However, it is possible to add new fields during subsequent indexing sessions.

CONSTRUCTORS

new


            

              
              
my $schema = Lucy::Plan::Schema->new;

Constructor. Takes no arguments.

METHODS

architecture


            

              
              
my $architecture = $schema->architecture();

Factory method which creates an Architecture object for this index.

spec_field


            

              
              
$schema->spec_field(
    name => $name,  # required
    type => $type,  # required
);

Define the behavior of a field by associating it with a FieldType.

If this method has already been called for the supplied field, it will merely test to verify that the supplied FieldType equals() the existing one.

  • name - The name of the field.

  • type - A FieldType.

fetch_type


            

              
              
my $field_type = $schema->fetch_type($field);

Return the FieldType for the specified field. If the field can’t be found, return undef.

fetch_sim


            

              
              
my $similarity = $schema->fetch_sim($field);
my $similarity = $schema->fetch_sim();  # default: undef

Return the Similarity for the specified field, or undef if either the field can’t be found or it isn’t associated with a Similarity.

num_fields


            

              
              
my $int = $schema->num_fields();

Return the number of fields currently defined.

all_fields


            

              
              
my $arrayref = $schema->all_fields();

Return all the Schema’s field names as an array.

get_architecture


            

              
              
my $architecture = $schema->get_architecture();

Return the Schema instance’s internal Architecture object.

get_similarity


            

              
              
my $similarity = $schema->get_similarity();

Return the Schema instance’s internal Similarity object.

INHERITANCE

Lucy::Plan::Schema isa Clownfish::Obj.