---
name: "Wiki::Toolkit::Search::SII"
section: "3pm"
platform: "linux"
package: "libwiki-toolkit-perl"
version: "0.86-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Wiki::Toolkit::Search::SII"
---

# Wiki::Toolkit::Search::SII(3pm)

Search::InvertedIndex plugin for Wiki::Toolkit.

## NAME

Wiki::Toolkit::Search::SII - Search::InvertedIndex plugin for Wiki::Toolkit.

## SYNOPSIS

```
  my $indexdb = Search::InvertedIndex::DB::Mysql->new( ... );
  my $search = Wiki::Toolkit::Search::SII->new( indexdb => $indexdb );
  my %wombat_nodes = $search->search_nodes("wombat");
```

Provides search-related methods for Wiki::Toolkit.

See also Wiki::Toolkit::Search::Base, for methods not documented here.

## METHODS

- **new**

  ```
    # EITHER
    my $indexdb = Search::InvertedIndex::DB::Mysql->new(
                     -db_name    => $dbname,
                     -username   => $dbuser,
                     -password   => $dbpass,
             -hostname   => '',
                     -table_name => 'siindex',
                     -lock_mode  => 'EX' );
    # OR
    my $indexdb = Search::InvertedIndex::DB::DB_File_SplitHash->new(
                     -map_name  => "/home/wiki/indexes.db",
                     -lock_mode => "EX" );
    # THEN
    my $search = Wiki::Toolkit::Search::SII->new( indexdb => $indexdb );
  ```

  Takes only one parameter, which is mandatory. `"indexdb"` must be a `"Search::InvertedIndex::DB::*"` object.

## SEE ALSO

Wiki::Toolkit, Wiki::Toolkit::Search::Base.