Mailing List Archive

Author: creamyg
Date: 2007-03-15 09:32:28 -0700 (Thu, 15 Mar 2007)
New Revision: 2179

Modified:
trunk/perl/lib/KinoSearch/Index/IndexReader.pm
Log:
Improve docs for IndexReader->open, adding lock_factory argument.


Modified: trunk/perl/lib/KinoSearch/Index/IndexReader.pm
===================================================================
--- trunk/perl/lib/KinoSearch/Index/IndexReader.pm 2007-03-15 16:08:36 UTC (rev 2178)
+++ trunk/perl/lib/KinoSearch/Index/IndexReader.pm 2007-03-15 16:32:28 UTC (rev 2179)
@@ -454,7 +454,8 @@
=head2 open

my $reader = KinoSearch::Index::IndexReader->open(
- invindex => MySchema->open('/path/to/invindex'),
+ invindex => MySchema->open('/path/to/invindex'),
+ lock_factory => $lock_factory,
);

IndexReader is an abstract base class; open() functions like a constructor,
@@ -463,6 +464,21 @@
SegReaders. Since each segment is a self-contained inverted index, a
SegReader is in effect a complete index reader.

+open() takes labeled parameters.
+
+=over
+
+=item *
+
+B<invindex> - An object which isa L<KinoSearch::InvIndex>.
+
+=item *
+
+B<lock_factory> - An object which isa L<KinoSearch::Store::LockFactory>.
+Read-locking is off by default; supplying C<lock_factory> turns it on.
+
+=back
+
=head1 METHODS

=head2 max_doc