The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

mycontextadmin - command line admin utility for MyConText

SYNOPSIS

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

DESCRIPTION

Mycontextadmin is a command line utility for listing, creating and dropping of MyConText indexes and for indexing new documents and searching for matches. The schematic listing of mycontextadmin arguments is:

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

For command --version that return the version information of the underlying MyConText 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

        jezek/heslo@test
        jezek@test
        test

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 MyConText 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 MyConText(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 MyConText 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 MyConText module directly.

AUTHOR

(c) 1999 Jan Pazdziora, adelton@fi.muni.cz, http://www.fi.muni.cz/~adelton/ 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.

SEE ALSO

MyConText(3).