NAME
Circa - a Search Engine/Indexer running with Mysql
DESCRIPTION
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
Notes:
Accents are removed on search and when indexed
Search are case unsensitive (mmmh what my english ? ;-)
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.
SYNOPSIS
See Search::Circa::Search, Search::Circa::Indexer
FREQUENTLY ASKED QUESTIONS
Q: Where are clients for example ?
A: See in demo directory. For command line, see *.pl file, for CGI, take a look in cgi-bin/
Q: Where are global parameters to connect to Circa ?
A: Use lib/CircaConf.pm 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: May be something like this:
$ circa_admin +create +add=http://monsite.com +parse_new=1 +depth_max
Q : Did you succed to use Circa with mod_perl ?
A: Yes
SEE ALSO
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
Search::Circa::Parser : Manage Parser of Indexer
Public interface
You use this method behind Search::Circa::Indexer and Search::Circa::Search object
- connect($user, $password, $db, $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
-
Close connection to MySQL
- pre_tbl
-
Get or set the prefix for table name for use Circa with more than one time on a same database
- fill_template($masque,$vars)
-
$masque : Path of template $vars : hash ref with keys/val to substitue
Give template with remplaced variables Ex: if $$vars{age}=12, and $masque have
J'ai <? $age ?> ans,
this function give:
J'ai 12 ans,
- fetch_first($requete)
-
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 input if debug level for script is upper than $level
- prompt($message, $default_value)
-
Ask in STDIN for a parameter and return value
AUTHOR
Alain BARBET alian@alianwebserver.com