Solr
PHP Manual

The SolrClient class

Introduction

Used to send requests to a Solr server. Currently, cloning and serialization of SolrClient instances is not supported.

Class synopsis

SolrClient
final class SolrClient {
/* Constants */
const int SolrClient::SEARCH_SERVLET_TYPE = 1;
const int SolrClient::UPDATE_SERVLET_TYPE = 2;
const int SolrClient::THREADS_SERVLET_TYPE = 4;
const int SolrClient::PING_SERVLET_TYPE = 8;
const int SolrClient::TERMS_SERVLET_TYPE = 16;
const int SolrClient::SYSTEM_SERVLET_TYPE = 32;
const string SolrClient::DEFAULT_SEARCH_SERVLET = select;
const string SolrClient::DEFAULT_UPDATE_SERVLET = update;
const string SolrClient::DEFAULT_THREADS_SERVLET = admin/threads;
const string SolrClient::DEFAULT_PING_SERVLET = admin/ping;
const string SolrClient::DEFAULT_TERMS_SERVLET = terms;
const string SolrClient::DEFAULT_SYSTEM_SERVLET = admin/system;
/* Methods */
public __construct(array $clientOptions)
public SolrUpdateResponse addDocument(SolrInputDocument $doc, bool $overwrite = true, int $commitWithin = 0)
public void addDocuments(array $docs, bool $overwrite = true, int $commitWithin = 0)
public SolrUpdateResponse commit(bool $softCommit = false, bool $waitSearcher = true, bool $expungeDeletes = false)
public SolrUpdateResponse deleteById(string $id)
public SolrUpdateResponse deleteByIds(array $ids)
public SolrUpdateResponse deleteByQueries(array $queries)
public SolrUpdateResponse deleteByQuery(string $query)
public SolrQueryResponse getById(string $id)
public SolrQueryResponse getByIds(array $ids)
public string getDebug()
public array getOptions()
public SolrUpdateResponse optimize(int $maxSegments = 1, bool $softCommit = true, bool $waitSearcher = true)
public SolrPingResponse ping()
public SolrQueryResponse query(SolrParams $query)
public SolrUpdateResponse request(string $raw_request)
public SolrUpdateResponse rollback()
public void setResponseWriter(string $responseWriter)
public bool setServlet(int $type, string $value)
public void system()
public void threads()
public __destruct()
}

Predefined Constants

SolrClient::SEARCH_SERVLET_TYPE

Used when updating the search servlet.

SolrClient::UPDATE_SERVLET_TYPE

Used when updating the update servlet.

SolrClient::THREADS_SERVLET_TYPE

Used when updating the threads servlet.

SolrClient::PING_SERVLET_TYPE

Used when updating the ping servlet.

SolrClient::TERMS_SERVLET_TYPE

Used when updating the terms servlet.

SolrClient::SYSTEM_SERVLET_TYPE

Used when retrieving system information from the system servlet.

SolrClient::DEFAULT_SEARCH_SERVLET

This is the initial value for the search servlet.

SolrClient::DEFAULT_UPDATE_SERVLET

This is the initial value for the update servlet.

SolrClient::DEFAULT_THREADS_SERVLET

This is the initial value for the threads servlet.

SolrClient::DEFAULT_PING_SERVLET

This is the initial value for the ping servlet.

SolrClient::DEFAULT_TERMS_SERVLET

This is the initial value for the terms servlet used for the TermsComponent

SolrClient::DEFAULT_SYSTEM_SERVLET

This is the initial value for the system servlet used to obtain Solr Server information

Table of Contents