KinoSearch-0.315 - Search engine library.

Documentation

KSx::Search::ProximityQuery - Query matching an ordered list of terms.
KinoSearch - Search engine library.
KinoSearch::Analysis::Analyzer - Tokenize/modify/filter text.
KinoSearch::Analysis::CaseFolder - Normalize case, facilitating case-insensitive search.
KinoSearch::Analysis::PolyAnalyzer - Multiple Analyzers in series.
KinoSearch::Analysis::Stemmer - Reduce related words to a shared root.
KinoSearch::Analysis::Stopalizer - Suppress a "stoplist" of common words.
KinoSearch::Analysis::Tokenizer - Split a string into tokens.
KinoSearch::Docs::Cookbook - KinoSearch recipes.
KinoSearch::Docs::Cookbook::CustomQuery - Sample subclass of Query.
KinoSearch::Docs::Cookbook::CustomQueryParser - Sample subclass of QueryParser.
KinoSearch::Docs::Cookbook::FastUpdates - Near real-time index updates.
KinoSearch::Docs::DevGuide - Quick-start guide to hacking on KinoSearch.
KinoSearch::Docs::DocIDs - Characteristics of KinoSearch document ids.
KinoSearch::Docs::FileFormat - Overview of index file format.
KinoSearch::Docs::FileLocking - Manage indexes on shared volumes.
KinoSearch::Docs::IRTheory - Crash course in information retrieval.
KinoSearch::Docs::Tutorial - Step-by-step introduction to KinoSearch.
KinoSearch::Docs::Tutorial::Analysis - How to choose and use Analyzers.
KinoSearch::Docs::Tutorial::BeyondSimple - A more flexible app structure.
KinoSearch::Docs::Tutorial::FieldType - Specify per-field properties and behaviors.
KinoSearch::Docs::Tutorial::Highlighter - Augment search results with highlighted excerpts.
KinoSearch::Docs::Tutorial::QueryObjects - Use Query objects instead of query strings.
KinoSearch::Docs::Tutorial::Simple - Bare-bones search app.
KinoSearch::Document::Doc - A document.
KinoSearch::Document::HitDoc - A document read from an index.
KinoSearch::Highlight::Highlighter - Create and highlight excerpts.
KinoSearch::Index::BackgroundMerger - Consolidate index segments in the background.
KinoSearch::Index::DataReader - Abstract base class for reading index data.
KinoSearch::Index::DataWriter - Write data to an index.
KinoSearch::Index::DeletionsWriter - Abstract base class for marking documents as deleted.
KinoSearch::Index::DocReader - Retrieve stored documents.
KinoSearch::Index::IndexManager - Policies governing index updating, locking, and file deletion.
KinoSearch::Index::IndexReader - Read from an inverted index.
KinoSearch::Index::Indexer - Build inverted indexes.
KinoSearch::Index::Lexicon - Iterator for a field's terms.
KinoSearch::Index::LexiconReader - Read Lexicon data.
KinoSearch::Index::PolyReader - Multi-segment implementation of IndexReader.
KinoSearch::Index::PostingList - Term-Document pairings.
KinoSearch::Index::PostingListReader - Read postings data.
KinoSearch::Index::SegReader - Single-segment IndexReader.
KinoSearch::Index::SegWriter - Write one segment of an index.
KinoSearch::Index::Segment - Warehouse for information about one segment of an inverted index.
KinoSearch::Index::Similarity - Judge how well a document matches a query.
KinoSearch::Index::Snapshot - Point-in-time index file list.
KinoSearch::Object::BitVector - An array of bits.
KinoSearch::Object::Err - Exception.
KinoSearch::Object::Obj - Base class for all KinoSearch objects.
KinoSearch::Plan::Architecture - Configure major components of an index.
KinoSearch::Plan::BlobType - Default behaviors for binary fields.
KinoSearch::Plan::FieldType - Define a field's behavior.
KinoSearch::Plan::FullTextType - Full-text search field type.
KinoSearch::Plan::Schema - User-created specification for an inverted index.
KinoSearch::Plan::StringType - Non-tokenized text type.
KinoSearch::Search::ANDQuery - Intersect multiple result sets.
KinoSearch::Search::Collector - Process hits.
KinoSearch::Search::Collector::BitCollector - Collector which records doc nums in a BitVector.
KinoSearch::Search::Compiler - Query-to-Matcher compiler.
KinoSearch::Search::Hits - Access search results.
KinoSearch::Search::IndexSearcher - Execute searches against a single index.
KinoSearch::Search::LeafQuery - Leaf node in a tree created by QueryParser.
KinoSearch::Search::MatchAllQuery - Query which matches all documents.
KinoSearch::Search::Matcher - Match a set of document ids.
KinoSearch::Search::NOTQuery - Invert the result set of another Query.
KinoSearch::Search::NoMatchQuery - Query which matches no documents.
KinoSearch::Search::ORQuery - Union multiple result sets.
KinoSearch::Search::PhraseQuery - Query matching an ordered list of terms.
KinoSearch::Search::PolyQuery - Base class for composite Query objects.
KinoSearch::Search::PolySearcher - Aggregate results from multiple Searchers.
KinoSearch::Search::Query - A specification for a search query.
KinoSearch::Search::QueryParser - Transform a string into a Query object.
KinoSearch::Search::RangeQuery - Match a range of values.
KinoSearch::Search::RequiredOptionalQuery - Join results for two Queries, one required, one optional.
KinoSearch::Search::Searcher - Base class for searching collections of documents.
KinoSearch::Search::SortRule - Element of a SortSpec.
KinoSearch::Search::SortSpec - Specify a custom sort order for search results.
KinoSearch::Search::Span - An offset, a length, and a weight.
KinoSearch::Search::TermQuery - Query which matches individual terms.
KinoSearch::Store::FSFolder - File System implementation of Folder.
KinoSearch::Store::Folder - Abstract class representing a directory.
KinoSearch::Store::Lock - Abstract class representing an interprocess mutex lock.
KinoSearch::Store::LockErr - Lock exception.
KinoSearch::Store::LockFactory - Create Locks.
KinoSearch::Store::RAMFolder - In-memory Folder implementation.

Modules

KSx::Index::ByteBufDocReader - Read a Doc as a fixed-width byte array.
KSx::Index::ByteBufDocWriter - Write a Doc as a fixed-width byte array.
KSx::Index::LongFieldSim - Similarity optimized for long fields.
KSx::Index::ZlibDocReader - Compressed doc storage.
KSx::Index::ZlibDocWriter - Compressed doc storage.
KSx::Remote::SearchClient - Connect to a remote SearchServer.
KSx::Remote::SearchServer - Make a Searcher remotely accessible.
KSx::Search::Filter - Build a caching filter based on results of a Query.
KSx::Search::MockScorer - Matcher with arbitrary docs and scores.
KSx::Simple - Basic search engine.
KinoSearch::Analysis::Token - Redacted.
KinoSearch::Analysis::TokenBatch - Removed.

Provides

KinoSearch in lib/KinoSearch.pm
KinoSearch::Analysis::Analyzer in lib/KinoSearch/Analysis/Analyzer.pm
KinoSearch::Analysis::CaseFolder in lib/KinoSearch/Analysis/CaseFolder.pm
KinoSearch::Analysis::Inversion in lib/KinoSearch/Analysis/Inversion.pm
KinoSearch::Analysis::PolyAnalyzer in lib/KinoSearch/Analysis/PolyAnalyzer.pm
KinoSearch::Analysis::Stemmer in lib/KinoSearch/Analysis/Stemmer.pm
KinoSearch::Analysis::Stopalizer in lib/KinoSearch/Analysis/Stopalizer.pm
KinoSearch::Analysis::Tokenizer in lib/KinoSearch/Analysis/Tokenizer.pm
KinoSearch::Architecture in lib/KinoSearch/Architecture.pm
KinoSearch::Doc in lib/KinoSearch/Doc.pm
KinoSearch::Document::Doc in lib/KinoSearch/Document/Doc.pm
KinoSearch::Document::HitDoc in lib/KinoSearch/Document/HitDoc.pm
KinoSearch::FieldType in lib/KinoSearch/FieldType.pm
KinoSearch::FieldType::BlobType in lib/KinoSearch/FieldType/BlobType.pm
KinoSearch::FieldType::Float32Type in lib/KinoSearch/FieldType/Float32Type.pm
KinoSearch::FieldType::Float64Type in lib/KinoSearch/FieldType/Float64Type.pm
KinoSearch::FieldType::FullTextType in lib/KinoSearch/FieldType/FullTextType.pm
KinoSearch::FieldType::Int32Type in lib/KinoSearch/FieldType/Int32Type.pm
KinoSearch::FieldType::Int64Type in lib/KinoSearch/FieldType/Int64Type.pm
KinoSearch::FieldType::StringType in lib/KinoSearch/FieldType/StringType.pm
KinoSearch::Highlight::HeatMap in lib/KinoSearch/Highlight/HeatMap.pm
KinoSearch::Highlight::Highlighter in lib/KinoSearch/Highlight/Highlighter.pm
KinoSearch::Index::BackgroundMerger in lib/KinoSearch/Index/BackgroundMerger.pm
KinoSearch::Index::DataReader in lib/KinoSearch/Index/DataReader.pm
KinoSearch::Index::DataWriter in lib/KinoSearch/Index/DataWriter.pm
KinoSearch::Index::DeletionsReader in lib/KinoSearch/Index/DeletionsReader.pm
KinoSearch::Index::DeletionsWriter in lib/KinoSearch/Index/DeletionsWriter.pm
KinoSearch::Index::DocReader in lib/KinoSearch/Index/DocReader.pm
KinoSearch::Index::DocVector in lib/KinoSearch/Index/DocVector.pm
KinoSearch::Index::DocWriter in lib/KinoSearch/Index/DocWriter.pm
KinoSearch::Index::FilePurger in lib/KinoSearch/Index/FilePurger.pm
KinoSearch::Index::HighlightReader in lib/KinoSearch/Index/HighlightReader.pm
KinoSearch::Index::HighlightWriter in lib/KinoSearch/Index/HighlightWriter.pm
KinoSearch::Index::Indexer in lib/KinoSearch/Index/Indexer.pm
KinoSearch::Index::IndexManager in lib/KinoSearch/Index/IndexManager.pm
KinoSearch::Index::IndexReader in lib/KinoSearch/Index/IndexReader.pm
KinoSearch::Index::Inverter in lib/KinoSearch/Index/Inverter.pm
KinoSearch::Index::Lexicon in lib/KinoSearch/Index/Lexicon.pm
KinoSearch::Index::LexiconReader in lib/KinoSearch/Index/LexiconReader.pm
KinoSearch::Index::LexiconWriter in lib/KinoSearch/Index/LexiconWriter.pm
KinoSearch::Index::PolyLexicon in lib/KinoSearch/Index/PolyLexicon.pm
KinoSearch::Index::PolyReader in lib/KinoSearch/Index/PolyReader.pm
KinoSearch::Index::Posting in lib/KinoSearch/Index/Posting.pm
KinoSearch::Index::Posting::MatchPosting in lib/KinoSearch/Index/Posting/MatchPosting.pm
KinoSearch::Index::Posting::RichPosting in lib/KinoSearch/Index/Posting/RichPosting.pm
KinoSearch::Index::Posting::ScorePosting in lib/KinoSearch/Index/Posting/ScorePosting.pm
KinoSearch::Index::PostingList in lib/KinoSearch/Index/PostingList.pm
KinoSearch::Index::PostingListReader in lib/KinoSearch/Index/PostingListReader.pm
KinoSearch::Index::PostingListWriter in lib/KinoSearch/Index/PostingListWriter.pm
KinoSearch::Index::SegLexicon in lib/KinoSearch/Index/SegLexicon.pm
KinoSearch::Index::Segment in lib/KinoSearch/Index/Segment.pm
KinoSearch::Index::SegPostingList in lib/KinoSearch/Index/SegPostingList.pm
KinoSearch::Index::SegReader in lib/KinoSearch/Index/SegReader.pm
KinoSearch::Index::SegWriter in lib/KinoSearch/Index/SegWriter.pm
KinoSearch::Index::Similarity in lib/KinoSearch/Index/Similarity.pm
KinoSearch::Index::Snapshot in lib/KinoSearch/Index/Snapshot.pm
KinoSearch::Index::SortCache in lib/KinoSearch/Index/SortCache.pm
KinoSearch::Index::SortReader in lib/KinoSearch/Index/SortReader.pm
KinoSearch::Index::SortWriter in lib/KinoSearch/Index/SortWriter.pm
KinoSearch::Index::TermInfo in lib/KinoSearch/Index/TermInfo.pm
KinoSearch::Index::TermVector in lib/KinoSearch/Index/TermVector.pm
KinoSearch::Indexer in lib/KinoSearch/Indexer.pm
KinoSearch::Obj::BitVector in lib/KinoSearch/Obj/BitVector.pm
KinoSearch::Object::BitVector in lib/KinoSearch/Object/BitVector.pm
KinoSearch::Object::ByteBuf in lib/KinoSearch/Object/ByteBuf.pm
KinoSearch::Object::CharBuf in lib/KinoSearch/Object/CharBuf.pm
KinoSearch::Object::Err in lib/KinoSearch/Object/Err.pm
KinoSearch::Object::Hash in lib/KinoSearch/Object/Hash.pm
KinoSearch::Object::Host in lib/KinoSearch/Object/Host.pm
KinoSearch::Object::I32Array in lib/KinoSearch/Object/I32Array.pm
KinoSearch::Object::LockFreeRegistry in lib/KinoSearch/Object/LockFreeRegistry.pm
KinoSearch::Object::Num in lib/KinoSearch/Object/Num.pm
KinoSearch::Object::Obj in lib/KinoSearch/Object/Obj.pm
KinoSearch::Object::VArray in lib/KinoSearch/Object/VArray.pm
KinoSearch::Object::ViewByteBuf in lib/KinoSearch.pm
KinoSearch::Object::ViewCharBuf in lib/KinoSearch.pm
KinoSearch::Object::VTable in lib/KinoSearch/Object/VTable.pm
KinoSearch::Object::ZombieCharBuf in lib/KinoSearch.pm
KinoSearch::Plan::Architecture in lib/KinoSearch/Plan/Architecture.pm
KinoSearch::Plan::BlobType in lib/KinoSearch/Plan/BlobType.pm
KinoSearch::Plan::FieldType in lib/KinoSearch/Plan/FieldType.pm
KinoSearch::Plan::Float32Type in lib/KinoSearch/Plan/Float32Type.pm
KinoSearch::Plan::Float64Type in lib/KinoSearch/Plan/Float64Type.pm
KinoSearch::Plan::FullTextType in lib/KinoSearch/Plan/FullTextType.pm
KinoSearch::Plan::Int32Type in lib/KinoSearch/Plan/Int32Type.pm
KinoSearch::Plan::Int64Type in lib/KinoSearch/Plan/Int64Type.pm
KinoSearch::Plan::Schema in lib/KinoSearch/Plan/Schema.pm
KinoSearch::Plan::StringType in lib/KinoSearch/Plan/StringType.pm
KinoSearch::QueryParser in lib/KinoSearch/QueryParser.pm
KinoSearch::Schema in lib/KinoSearch/Schema.pm
KinoSearch::Search::ANDQuery in lib/KinoSearch/Search/ANDQuery.pm
KinoSearch::Search::ANDScorer in lib/KinoSearch/Search/ANDScorer.pm
KinoSearch::Search::BitVecMatcher in lib/KinoSearch/Search/BitVecMatcher.pm
KinoSearch::Search::Collector in lib/KinoSearch/Search/Collector.pm
KinoSearch::Search::Collector::BitCollector in lib/KinoSearch/Search/Collector/BitCollector.pm
KinoSearch::Search::Collector::SortCollector in lib/KinoSearch/Search/Collector/SortCollector.pm
KinoSearch::Search::Compiler in lib/KinoSearch/Search/Compiler.pm
KinoSearch::Search::HitCollector in lib/KinoSearch/Search/HitCollector.pm
KinoSearch::Search::HitCollector::BitCollector in lib/KinoSearch/Search/HitCollector/BitCollector.pm
KinoSearch::Search::HitQueue in lib/KinoSearch/Search/HitQueue.pm
KinoSearch::Search::Hits in lib/KinoSearch/Search/Hits.pm
KinoSearch::Search::IndexSearcher in lib/KinoSearch/Search/IndexSearcher.pm
KinoSearch::Search::LeafQuery in lib/KinoSearch/Search/LeafQuery.pm
KinoSearch::Search::MatchAllQuery in lib/KinoSearch/Search/MatchAllQuery.pm
KinoSearch::Search::MatchDoc in lib/KinoSearch/Search/MatchDoc.pm
KinoSearch::Search::Matcher in lib/KinoSearch/Search/Matcher.pm
KinoSearch::Search::NoMatchQuery in lib/KinoSearch/Search/NoMatchQuery.pm
KinoSearch::Search::NOTQuery in lib/KinoSearch/Search/NOTQuery.pm
KinoSearch::Search::NOTScorer in lib/KinoSearch/Search/NOTScorer.pm
KinoSearch::Search::ORQuery in lib/KinoSearch/Search/ORQuery.pm
KinoSearch::Search::ORScorer in lib/KinoSearch/Search/ORScorer.pm
KinoSearch::Search::PhraseQuery in lib/KinoSearch/Search/PhraseQuery.pm
KinoSearch::Search::PolyCompiler in lib/KinoSearch/Search/PolyCompiler.pm
KinoSearch::Search::PolyQuery in lib/KinoSearch/Search/PolyQuery.pm
KinoSearch::Search::PolySearcher in lib/KinoSearch/Search/PolySearcher.pm
KinoSearch::Search::Query in lib/KinoSearch/Search/Query.pm
KinoSearch::Search::QueryParser in lib/KinoSearch/Search/QueryParser.pm
KinoSearch::Search::RangeQuery in lib/KinoSearch/Search/RangeQuery.pm
KinoSearch::Search::RequiredOptionalQuery in lib/KinoSearch/Search/RequiredOptionalQuery.pm
KinoSearch::Search::RequiredOptionalScorer in lib/KinoSearch/Search/RequiredOptionalScorer.pm
KinoSearch::Search::Searchable in lib/KinoSearch/Search/Searchable.pm
KinoSearch::Search::Searcher in lib/KinoSearch/Search/Searcher.pm
KinoSearch::Search::Similarity in lib/KinoSearch/Search/Similarity.pm
KinoSearch::Search::SortRule in lib/KinoSearch/Search/SortRule.pm
KinoSearch::Search::SortSpec in lib/KinoSearch/Search/SortSpec.pm
KinoSearch::Search::Span in lib/KinoSearch/Search/Span.pm
KinoSearch::Search::TermQuery in lib/KinoSearch/Search/TermQuery.pm
KinoSearch::Search::TopDocs in lib/KinoSearch/Search/TopDocs.pm
KinoSearch::Searcher in lib/KinoSearch/Searcher.pm
KinoSearch::Store::FileHandle in lib/KinoSearch/Store/FileHandle.pm
KinoSearch::Store::Folder in lib/KinoSearch/Store/Folder.pm
KinoSearch::Store::FSFileHandle in lib/KinoSearch/Store/FSFileHandle.pm
KinoSearch::Store::FSFolder in lib/KinoSearch/Store/FSFolder.pm
KinoSearch::Store::InStream in lib/KinoSearch/Store/InStream.pm
KinoSearch::Store::Lock in lib/KinoSearch/Store/Lock.pm
KinoSearch::Store::LockErr in lib/KinoSearch/Store/LockErr.pm
KinoSearch::Store::LockFactory in lib/KinoSearch/Store/LockFactory.pm
KinoSearch::Store::OutStream in lib/KinoSearch/Store/OutStream.pm
KinoSearch::Store::RAMFile in lib/KinoSearch/Store/RAMFile.pm
KinoSearch::Store::RAMFileHandle in lib/KinoSearch/Store/RAMFileHandle.pm
KinoSearch::Store::RAMFolder in lib/KinoSearch/Store/RAMFolder.pm
KinoSearch::Test in lib/KinoSearch/Test.pm
KinoSearch::Test::Util::BBSortEx in lib/KinoSearch/Test/Util/BBSortEx.pm
KinoSearch::Util::BitVector in lib/KinoSearch/Util/BitVector.pm
KinoSearch::Util::Debug in lib/KinoSearch/Util/Debug.pm
KinoSearch::Util::IndexFileNames in lib/KinoSearch/Util/IndexFileNames.pm
KinoSearch::Util::Json in lib/KinoSearch/Util/Json.pm
KinoSearch::Util::MemoryPool in lib/KinoSearch/Util/MemoryPool.pm
KinoSearch::Util::PriorityQueue in lib/KinoSearch/Util/PriorityQueue.pm
KinoSearch::Util::SortExternal in lib/KinoSearch/Util/SortExternal.pm
KinoSearch::Util::Stepper in lib/KinoSearch/Util/Stepper.pm
KinoSearch::Util::StringHelper in lib/KinoSearch/Util/StringHelper.pm
KSx::Search::FilterCompiler in lib/KSx/Search/Filter.pm
KSx::Search::FilterScorer in lib/KSx/Search/Filter.pm
KSx::Search::LongFieldSim in lib/KSx/Search/LongFieldSim.pm
KSx::Search::ProximityQuery in lib/KSx/Search/ProximityQuery.pm

Examples

Other files

Changes for version 0.315

Omit LockFreeRegistry test from CPAN distro.