/ 
Solr-0.03
River stage zero No dependents
/ Solr

NAME

Solr - Perl extension for interfacing with Solr, a lucene based search engine.

SYNOPSIS

 use Solr;

 my $solr = Solr->new(schema=>"/home/garafolat/cpan/Solr/schema.xml",
                      port=> "8302",
                      url=> "http://solr.foobar.com",
                      log_dir=> "/var/opt/logs");

 #NOTE: timeout is an optional param for each method and is used by LWP to pass a timeout
 for waiting for a response result code from Solr.  It defaults to 600 seconds if not supplied


 $solr->add($hashRef, $timeout); # Takes a reference to a hash of hashes of fields and values, 
                         creates solr xml, and posts to server defined in constructor.
                         Note: An update is performed by adding a document with an existing 
                         uniqueID field.

 $solr->add_by_file($file, $timeout); # simply posts a file.  The file must be in valid solr 
                         xml add syntax matching your solr server's schema for field requirements.

 $solr->post_file($file,$timeout); # posts file to solr server. Differs from add_by_file only in logging
 
 $solr->delete_by_id($id,$timeout); # Deletes by field declared as uniqueID in solr's schema.xml

 $solr->delete_by_query($query,$timeout); # Delete's by query string provided

 $solr->commit(); # commits adds and deletes

 $solr->optimize($timeout); # issues a post to solr server that causes it to perform an optimze
                            # timeout is an optional parameter expressed in seconds before 
                            # LWP stops waiting for a return result code from Solr.  Defaults
                            # to 600 if not supplied.

 For more details on solr's xml posting used by these methods see:
 http://wiki.apache.org/solr/UpdateXmlMessages#head-f5553a8214869b11708ad5476e05e7b05a024c23


 A Note On Logging
 Solr.pm uses Log4perl for logging.  Log4perl is a perl port of log4j.
 to disable logging set the optional initialization variable disable_logging=>1.

 Further reading on Log4perl can be found at:
 http://search.cpan.org/~mschilli/Log-Log4perl-1.14/lib/Log/Log4perl.pm
 http://www.perl.com/pub/a/2002/09/11/log4perl.html?page=1
 http://log4perl.sourceforge.net/releases/Log-Log4perl/docs/html/Log/Log4perl/FAQ.html

 NOTE on Adding documents
 Currently there is no error checking for in add_by_file and add methods.  It is possible to implement
 such checking using the schema object to compare fields in schema with the data structure passed into add
 or the file referenced in add_by_file.  I haven't implemented this yet, as the simply catching a 
 non zero result code from the solr server is sufficient for my needs in notifying of an error at this time.

DESCRIPTION

This module provides a set of methods for adding (updating) and deleting entries in an existing solr server.

EXPORT

None by default.

THINGS TO DO

-Add options to pass optional parameters to Solr in various post methods -Add solr search query functionality and parsing of: a) xml results b) user defined result formats -Incorporate Error checking of adds and deletes: a) Level 1, check for proper syntax b) Level 2, compare posts against schema for sanity check

If you'd like to make contributions to project, find bugs, or have suggestions for additions, please feel free to email me at the address below.

SEE ALSO

See http://wiki.apache.org/solr/FrontPage for additional documenation on setting up and using solr.

AUTHOR

Timothy Garafola, timothy.garafola@cnet.com

COPYRIGHT AND LICENSE

Copyright (C) 2008 by CNET Networks

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the specific language governing
permissions and limitations under the License.