/ 
KinoSearch-0.30_01
River stage two • 9 direct dependents • 10 total dependents
/ KinoSearch::Store::RAMFolder

NAME

KinoSearch::Store::RAMFolder - In-memory Folder implementation.

SYNOPSIS

my $folder = KinoSearch::Store::RAMFolder->new;

# or sometimes...
my $folder = KinoSearch::Store::RAMFolder->new(
    path   => '/path/to/folder',
);

DESCRIPTION

RAMFolder is an entirely in-memory implementation of KinoSearch::Store::Folder. It serves two main purposes.

First, it's possible to load an existing FSFolder into memory, which can improve search-speed -- if you have that kind of RAM to spare. Needless to say, any FSFolder you try to load this way should be appropriately modest in size.

Second, RAMFolder is handy for testing and development.

CONSTRUCTORS

new( [labeled params] )

my $folder = KinoSearch::Store::RAMFolder->new(
    path   => '/path/to/folder',   # optional
);

  • path - If supplied, attempt to read an FSFolder at that location into memory; otherwise the Folder starts out empty.

INHERITANCE

KinoSearch::Store::RAMFolder isa KinoSearch::Store::Folder isa KinoSearch::Obj.

COPYRIGHT

Copyright 2005-2009 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc.

See KinoSearch version 0.30.