Source for file Balancer.php
Documentation is available at Balancer.php
* @copyright Copyright 2007 Conduit Internet Technologies, Inc. (http://conduit-it.com)
* @license Apache Licence, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
* 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.
* @author Donovan Jimenez <djimenez@conduit-it.com>, Dan Wolfe
require_once('Apache/Solr/Service.php');
* Reference Implementation for using multiple Solr services in a distribution. Functionality
* routing of read / write operations
* failover (on selection) for multiple read servers
// Configuration for server selection backoff intervals
protected $_useBackoff =
false; // Set to true to use more resillient write server selection
* Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.
* NOTE: inside a phrase fewer characters need escaped, use {@link Apache_Solr_Service::escapePhrase()} instead
static public function escape($value)
* Escape a value meant to be contained in a phrase for special query characters
* Convenience function for creating phrase syntax from a value
static public function phrase($value)
* Constructor. Takes arrays of read and write service instances or descriptions
* @param array $readableServices
* @param array $writeableServices
public function __construct($readableServices =
array(), $writeableServices =
array())
//setup readable services
foreach ($readableServices as $service)
//setup writeable services
foreach ($writeableServices as $service)
return $host .
':' .
$port .
$path;
* Adds a service instance or service descriptor (if it is already
* @throws Exception If service descriptor is not valid
$id =
$this->_getServiceId($service->getHost(), $service->getPort(), $service->getPath());
if (isset
($service['host']) && isset
($service['port']) && isset
($service['path']))
$id =
$this->_getServiceId((string)
$service['host'], (int)
$service['port'], (string)
$service['path']);
throw
new Exception('A Readable Service description array does not have all required elements of host, port, and path');
* Removes a service instance or descriptor from the available services
* @throws Exception If service descriptor is not valid
$id =
$this->_getServiceId($service->getHost(), $service->getPort(), $service->getPath());
if (isset
($service['host']) && isset
($service['port']) && isset
($service['path']))
$id =
$this->_getServiceId((string)
$service['host'], (int)
$service['port'], (string)
$service['path']);
throw
new Exception('A Readable Service description array does not have all required elements of host, port, and path');
* Adds a service instance or service descriptor (if it is already
* @throws Exception If service descriptor is not valid
$id =
$this->_getServiceId($service->getHost(), $service->getPort(), $service->getPath());
if (isset
($service['host']) && isset
($service['port']) && isset
($service['path']))
$id =
$this->_getServiceId((string)
$service['host'], (int)
$service['port'], (string)
$service['path']);
throw
new Exception('A Writeable Service description array does not have all required elements of host, port, and path');
* Removes a service instance or descriptor from the available services
* @throws Exception If service descriptor is not valid
$id =
$this->_getServiceId($service->getHost(), $service->getPort(), $service->getPath());
if (isset
($service['host']) && isset
($service['port']) && isset
($service['path']))
$id =
$this->_getServiceId((string)
$service['host'], (int)
$service['port'], (string)
$service['path']);
throw
new Exception('A Readable Service description array does not have all required elements of host, port, and path');
* Iterate through available read services and select the first with a ping
* that satisfies configured timeout restrictions (or the default)
* @return Apache_Solr_Service
* @throws Exception If there are no read services that meet requirements
// we probably had a communication error, ping the current read service, remove it if it times out
// select one of the read services at random
//convert the array definition to a client object
throw
new Exception('No read services were available');
* Iterate through available write services and select the first with a ping
* that satisfies configured timeout restrictions (or the default)
* @return Apache_Solr_Service
* @throws Exception If there are no write services that meet requirements
// we probably had a communication error, ping the current read service, remove it if it times out
// select one of the read services at random
//convert the array definition to a client object
throw
new Exception('No write services were available');
* Iterate through available write services and select the first with a ping
* that satisfies configured timeout restrictions (or the default). The
* timeout period will increase until a connection is made or the limit is
* reached. This will allow for increased reliability with heavily loaded
* @return Apache_Solr_Service
* @throws Exception If there are no write services that meet requirements
// select one of the read services at random
//convert the array definition to a client object
throw
new Exception('No write services were available. All timeouts exceeded.');
throw
new Exception('No write services were available');
$service->setCreateDocuments($createDocuments);
* Raw Add Method. Takes a raw post body and sends it to the update service. Post body
* should be a complete and well formed "add" xml document.
* @return Apache_Solr_Response
* @throws Exception If an error occurs during the service call
public function add($rawPost)
return $service->add($rawPost);
if ($e->getCode() !=
0) //IF NOT COMMUNICATION ERROR
* Add a Solr Document to the index
* @param Apache_Solr_Document $document
* @param boolean $allowDups
* @param boolean $overwritePending
* @param boolean $overwriteCommitted
* @return Apache_Solr_Response
* @throws Exception If an error occurs during the service call
public function addDocument(Apache_Solr_Document $document, $allowDups =
false, $overwritePending =
true, $overwriteCommitted =
true)
return $service->addDocument($document, $allowDups, $overwritePending, $overwriteCommitted);
if ($e->getCode() !=
0) //IF NOT COMMUNICATION ERROR
* Add an array of Solr Documents to the index all at once
* @param array $documents Should be an array of Apache_Solr_Document instances
* @param boolean $allowDups
* @param boolean $overwritePending
* @param boolean $overwriteCommitted
* @return Apache_Solr_Response
* @throws Exception If an error occurs during the service call
public function addDocuments($documents, $allowDups =
false, $overwritePending =
true, $overwriteCommitted =
true)
return $service->addDocuments($documents, $allowDups, $overwritePending, $overwriteCommitted);
if ($e->getCode() !=
0) //IF NOT COMMUNICATION ERROR
* Send a commit command. Will be synchronous unless both wait parameters are set
* @param boolean $waitFlush
* @param boolean $waitSearcher
* @return Apache_Solr_Response
* @throws Exception If an error occurs during the service call
public function commit($optimize =
true, $waitFlush =
true, $waitSearcher =
true, $timeout =
3600)
return $service->commit($optimize, $waitFlush, $waitSearcher, $timeout);
if ($e->getCode() !=
0) //IF NOT COMMUNICATION ERROR
* Raw Delete Method. Takes a raw post body and sends it to the update service. Body should be
* a complete and well formed "delete" xml document
* @return Apache_Solr_Response
* @throws Exception If an error occurs during the service call
public function delete($rawPost)
return $service->delete($rawPost);
if ($e->getCode() !=
0) //IF NOT COMMUNICATION ERROR
* Create a delete document based on document ID
* @param boolean $fromPending
* @param boolean $fromCommitted
* @return Apache_Solr_Response
* @throws Exception If an error occurs during the service call
public function deleteById($id, $fromPending =
true, $fromCommitted =
true)
return $service->deleteById($id, $fromPending, $fromCommitted);
if ($e->getCode() !=
0) //IF NOT COMMUNICATION ERROR
* Create a delete document based on a query and submit it
* @param string $rawQuery
* @param boolean $fromPending
* @param boolean $fromCommitted
* @return Apache_Solr_Response
* @throws Exception If an error occurs during the service call
public function deleteByQuery($rawQuery, $fromPending =
true, $fromCommitted =
true)
return $service->deleteByQuery($rawQuery, $fromPending, $fromCommitted);
if ($e->getCode() !=
0) //IF NOT COMMUNICATION ERROR
* Send an optimize command. Will be synchronous unless both wait parameters are set
* @param boolean $waitFlush
* @param boolean $waitSearcher
* @return Apache_Solr_Response
* @throws Exception If an error occurs during the service call
public function optimize($waitFlush =
true, $waitSearcher =
true)
return $service->optimize($waitFlush, $waitSearcher);
if ($e->getCode() !=
0) //IF NOT COMMUNICATION ERROR
* Simple Search interface
* @param string $query The raw query string
* @param int $offset The starting offset for result documents
* @param int $limit The maximum number of result documents to return
* @param array $params key / value pairs for query parameters, use arrays for multivalued parameters
* @return Apache_Solr_Response
* @throws Exception If an error occurs during the service call
public function search($query, $offset =
0, $limit =
10, $params =
array())
return $service->search($query, $offset, $limit, $params);
if ($e->getCode() !=
0) //IF NOT COMMUNICATION ERROR
Documentation generated on Tue, 02 Sep 2008 10:45:03 -0400 by phpDocumentor 1.4.0