View on
MetaCPAN is shutting down
For details read Perl NOC. After June 25th this page will redirect to
Peter Karman > SWISH-Prog-KSx > SWISH::Prog::KSx



Annotate this POD


View/Report Bugs
Module Version: 0.21   Source  


SWISH::Prog::KSx - Swish3 KinoSearch backend


 # create an index
 use SWISH::Prog;
 my $indexer = SWISH::Prog->new(
    invindex   => 'path/to/index.swish',
    aggregator => 'fs',
    indexer    => 'ks',
    config     => 'path/to/swish.conf',
 # then search the index
 my $searcher = SWISH::Prog::KSx::Searcher->new(
    invindex => 'path/to/index.swish',
    config   => 'path/to/swish.conf',
 my $results = $searcher->search('my query')
 while ( my $result = $results->next ) {
    printf("%s : %s\n", $result->score, $result->uri);


STOP: Read the SWISH::Prog documentation before you use this module.

SWISH::Prog::KSx is a KinoSearch-based implementation of Swish3, using the SWISH::3 bindings for libswish3.

See the SWISH::Prog docs for more information about the class hierarchy and history.

See the Swish3 development site at

Why Not Use KinoSearch Directly? ^

You can use KinoSearch directly. Using KinoSearch via SWISH::Prog::KSx offers a few advantages:

Aggregators and Filters

You get to use all of SWISH::Prog's Aggregators and SWISH::Filter support. So you can easily index all kinds of file formats (email, .txt, .html, .xml, .pdf, .doc, .xls, etc) without writing your own parser.


SWISH::3 offers fast and robust XML and HTML parsers with an extensible configuration system, build on top of libxml2.

Simple now, complex later

You can index your content with SWISH::Prog::KSx, then build a more complex searching application directly with KinoSearch.


Peter Karman, <karman at>


Please report any bugs or feature requests to bug-swish-prog-ksx at, or through the web interface at I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.


You can find documentation for this module with the perldoc command.

    perldoc SWISH::Prog::KSx

You can also look for information at:


Copyright 2009 Peter Karman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See for more information.


SWISH::Prog, KinoSearch

syntax highlighting: