View on
MetaCPAN is shutting down
For details read Perl NOC. After June 25th this page will redirect to
Alain Barbet > Search-Circa-1.18 > Search::Circa



Annotate this POD

View/Report Bugs
Module Version: 1.18   Source  


Search::Circa - a Search Engine / Indexer running with Mysql


This is Search::Circa, a module who provide functions to perform search on Circa, a www search engine running with Mysql. Circa is for your Web site, or for a list of sites. It indexes like Altavista does. It can read, add and parse all url's found in a page. It add url and word to MySQL for use it at search.

Circa can be used for index 100 to 100 000 url


Search::Circa::Search work with Search::Circa::Indexer result. Search::Circa::Search is a Perl interface, but it's exist on this package a PHP client too.

Search::Circa is root class for Search::Circa::Indexer and Search::Circa::Search.


See Search::Circa::Search, Search::Circa::Indexer



Q: Where are clients for example ?

A: See in demo directory. For command line, see circa_admin and circa_search,, for CGI, take a look in cgi-bin/circa, they are installed with make cgi.

Q: Where are global parameters to connect to Circa ?

A: Use lib/ file

Q : What is an account for Circa ?

A: It's like a project, or a databse. A namespace for what you want.

Q : How I begin with indexer ?

A: See man page of circa_admin

Q : Did you succed to use Circa with mod_perl ?

A: Yes

Public interface ^

You use this method behind Search::Circa::Indexer and Search::Circa::Search object

connect user, password, database, host

Connect Circa to MySQL. Return 1 on succes, 0 else

  • user : Utilisateur MySQL
  • password : Mot de passe MySQL
  • db : Database MySQL
  • bost : Adr IP du serveur MySQL

Connect Circa to MySQL. Return 1 on succes, 0 else


Close connection to MySQL. This method is called with DESTROY method of this class.


Get or set the prefix for table name for use Circa with more than one time on a same database

fill_template masque, ref_hash
  • masque : Path of template
  • vars : hash ref with keys/val to substitue

Give template with remplaced variables Ex:

 $circa->fill_template('A <? $age ?> ans', ('age' => '12 ans'));

Will return:

  J'ai 12 ans,
fetch_first request

Execute request SQL on db and return first row. In list context, retun full row, else return just first column.

trace level, msg

Print message msg on standart output error if debug level for script is upper than level.

prompt message, default_value

Ask in STDIN for a parameter with message and default_value and return value


Search::Circa::Indexer, Indexer module

Search::Circa::Search, Searcher module

Search::Circa::Annuaire, Manage directory of Circa

Search::Circa::Url, Manage url of Circa

Search::Circa::Categorie, Manage categorie of Circa


$Revision: 1.18 $



syntax highlighting: