-
-
20 Aug 2010 00:48:58 UTC
- Development release
- Distribution: KinoSearch
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (5)
- Testers (62 / 24 / 1)
- Kwalitee
Bus factor: 0- License: perl_5
- Activity
24 month- Tools
- Download (889.34KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- Marvin Humphrey <marvin at rectangular dot com>
- Dependencies
- JSON::XS
- Lingua::Stem::Snowball
- Lingua::StopWords
- Parse::RecDescent
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
KinoSearch::Docs::DocIDs - Characteristics of KinoSearch document ids.
DESCRIPTION
Document ids are signed 32-bit integers
Document ids in KinoSearch start at 1. Because 0 is never a valid doc id, we can use it as a sentinel value:
while ( my $doc_id = $posting_list->next ) { ... }
Document ids are ephemeral
The document ids used by KinoSearch are associated with a single index snapshot. The moment an index is updated, the mapping of document ids to documents is subject to change.
Since IndexReader objects represent a point-in-time view of an index, document ids are guaranteed to remain static for the life of the reader. However, because they are not permanent, KinoSearch document ids cannot be used as foreign keys to locate records in external data sources. If you truly need a primary key field, you must define it and populate it yourself.
Furthermore, the order of document ids does not tell you anything about the sequence in which documents were added to the index.
COPYRIGHT
Copyright 2008-2010 Marvin Humphrey
LICENSE, DISCLAIMER, BUGS, etc.
See KinoSearch version 0.30.
Module Install Instructions
To install KSx::Simple, copy and paste the appropriate command in to your terminal.
cpanm KSx::Simple
perl -MCPAN -e shell install KSx::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.