PHP 8.4.2 Released!

    The SolrClient class

    (PECL solr >= 0.9.2)

    Introduction

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

    Class synopsis

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

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top