SolrClient::ping

(PECL solr >= 0.9.2)

SolrClient::pingChecks if Solr server is still up

Description

public SolrPingResponse SolrClient::ping ( void )

Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server.

Parameters

This function has no parameters.

Return Values

Returns a SolrPingResponse object on success and throws an exception on failure.

Errors/Exceptions

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to satisfy the request.

Examples

Example #1 SolrClient::ping() example

<?php
$options 
= array
(
    
'hostname' => SOLR_SERVER_HOSTNAME,
    
'login'    => SOLR_SERVER_USERNAME,
    
'password' => SOLR_SERVER_PASSWORD,
    
'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$pingresponse $client->ping();

?>

The above example will output something similar to:


add a note add a note

User Contributed Notes 1 note

up
-1
ricardo at forleven dot com
3 months ago
class Search extends Solr
{
    protected $searchEngine;

    function __construct()
    {
        $this->searchEngine = $this->connect();
    }

    public function checkAlive()
    {
        $searchEngine = $this->searchEngine;

        if($searchEngine->ping())
        {
            return true;
        }
        else
        {
            return false;
        }
    }
}
To Top