php8.5
/
Download
Home/ Manual/ solr / solrclient/ SolrClient::deleteById

SolrClient::deleteById

PHP function Edit on GitHub ✎

(PECL solr >= 0.9.2)

Delete by Id

Description

SolrClient::deleteById(string $id): SolrUpdateResponse

Deletes the document with the specified ID. Where ID is the value of the uniqueKey field declared in the schema

Parameters

id

The value of the uniqueKey field declared in the schema

Return Values

Returns a SolrUpdateResponse 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 process the request.

See Also

  • SolrClient::deleteByIds
  • SolrClient::deleteByQuery
  • SolrClient::deleteByQueries

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