Lucy::Document::Doc(3pm)

Lucy::Document::Doc3pm

A document.

Usage

    my $doc = Lucy::Document::Doc->new(
        fields => { foo => 'foo foo', bar => 'bar bar' },
    );
    $indexer->add_doc($doc);

Doc objects allow access to field values via hashref overloading:

    $doc->{foo} = 'new value for field "foo"';
    print "foo: $doc->{foo}\n";

Overview

A Doc object is akin to a row in a database, in that it is made up of one or more fields, each of which has a value.

Constructors

new( [labeled params] )

    my $doc = Lucy::Document::Doc->new(
        fields => { foo => 'foo foo', bar => 'bar bar' },
    );
•

fields - Field-value pairs.

•

doc_id - Internal Lucy document id. Default of 0 (an invalid doc id).

Methods

set_doc_id(doc_id)

Set internal Lucy document id.

get_doc_id()

Retrieve internal Lucy document id.

get_fields()

Return the Doc's backing fields hash.

Inheritance

Lucy::Document::Doc isa Lucy::Object::Obj.

Releases

2 releases since Debian 8 (Jessie); the text changed 1 time.

  1. 8
  2. 9

From liblucy-perl 0.3.3-7+b1 in Debian 9 (Stretch). Parsed by carta from the page's man source.