php8.5
Home/ Manual/ solr / solrclient/ SolrClient::ping

SolrClient::ping

PHP function Edit on GitHub ✎

(PECL solr >= 0.9.2)

Checks if Solr server is still up

Description

SolrClient::ping(): SolrPingResponse

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

Parameters 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

SolrClient::ping example

php
<?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:

output

Source: reference/solr/solrclient/ping.xml · from the official PHP manual (php/doc-en)