View on
T.J. Mather > DBIx-FullTextSearch-0.73 > ftsadmin


Annotate this POD


New  5
Open  0
View/Report Bugs


ftsadmin - command line admin utility for DBIx::FullTextSearch


  ftsadmin jez/hes@test --create zvirata --frontend=string
  ftsadmin jez/hes@test zvirata --index slon 'Slon ma chobot'
  ftsadmin jez/hes@test zvirata --index krtek 'Krtek ma bodliny'
  ftsadmin jez/hes@test zvirata --contains bodliny


ftsadmin is a command line utility for listing, creating and dropping of DBIx::FullTextSearch indexes and for indexing new documents and searching for matches. The schematic listing of ftsadmin arguments is:

  ftsadmin --version
  ftsadmin user/pass@db --list
  ftsadmin user/pass@db --create index_name [ parameters ]
  ftsadmin user/pass@db index_name --index doc_name [ content ]
  ftsadmin user/pass@db index_name --contains list_of_words
  ftsadmin user/pass@db index_name --econtains list_of_words
  ftsadmin user/pass@db index_name --drop

For command --version that return the version information of the underlying DBIx::FullTextSearch module no user or database specification is needed.

For all other commands you need to specify a way to connect to the database. The general way is user@password/database but you can omit the password or even the username part, thus


are all valid database specification (valid semantically, of course; you should specify one that will elad to access to the database).

After the database specification, you can either pass commands that do not operate on existing indexes, or add a name of the index and then commands with possible further arguments.

The command --list lists all available DBIx::FullTextSearch indexes in the database.

The command --create creates new index. The name of the index is the first mandatory parameter after the --create command, after that you can specify index options. For the list of them and their meaning, please see the DBIx::FullTextSearch(3) man page.

If you want to work with existing index, you hve to specify the index name as the second parameter, and as third the command.

To index a document (add new document or update existing document in the index), use the --index command. This is followed by either the document name (file and url frontends) or the name and the content of the document (the default and string frontends).

Commands --contains and --econtains return list of documents as their counterpart DBIx::FullTextSearch methods do.

You can drop existing index with --drop command.

This program is meant as a fast utility that you can use to easily test various storage parameters of the indexes. For production use you'll probably want to write your own Perl code, using the DBIx::FullTextSearch module directly.


(c) 1999 Jan Pazdziora,, at Faculty of Informatics, Masaryk University in Brno, Czech Republic

All rights reserved. This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself.



syntax highlighting: