PHP Client: other versions:
Overview
Quickstart
- Installation
- Index a document
- Get a document
- Search for a document
- Delete a document
- Delete an index
- Create an index
- Wrap up
Installation
- Version Matrix
- Composer Installation
- --no-dev flag
Configuration
- Inline Host Configuration
- Extended Host Configuration
- Authorization and Encryption
- Set retries
- Enabling the Logger
- Configure the HTTP Handler
- Setting the Connection Pool
- Setting the Connection Selector
- Setting the Serializer
- Setting a custom ConnectionFactory
- Set the Endpoint closure
- Building the client from a configuration hash
Per-request configuration
- Ignoring exceptions
- Providing custom query parameters
- Increasing the Verbosity of responses
- Curl Timeouts
- Enabling Future Mode
- SSL Encryption
Future Mode
- Using Future Mode
- Changing batch size
- Heterogeneous batches are OK
- Caveats to Future mode
Dealing with JSON Arrays and Objects in PHP
- Empty Objects
- Arrays of Objects
- Arrays of empty objects
Index Management Operations
- Create an index
- Create an index (advanced example)
- Delete an index
- Put Settings API
- Get Settings API
- Put Mappings API
- Get Mappings API
- Other APIs in the Indices Namespace
Indexing Documents
- Single document indexing
- Bulk Indexing
Getting Documents
Updating Documents
- Partial document update
- Scripted document update
- Upserts
Deleting documents
Search Operations
- Match Query
- Bool Queries
- A more complicated example
- Scrolling
Namespaces
Security
- HTTP Authentication
- SSL Encryption
- Using Authentication with SSL
Connection Pool
- staticNoPingConnectionPool (default)
- staticConnectionPool
- simpleConnectionPool
- sniffingConnectionPool
- Custom Connection Pool
- Which connection pool to choose? PHP and connection pooling
Selectors
- RoundRobinSelector (Default)
- StickyRoundRobinSelector
- RandomSelector
- Custom Selector
Serializers
- SmartSerializer
- ArrayToJSONSerializer
- EverythingToJSONSerializer
- Implementing your own Serializer
PHP Version Requirement
Breaking changes from 2.x
- Deprecations
- Internal BWC Breaks
Community DSLs
- ElasticsearchDSL
- elasticsearcher
Community Integrations
- Symfony
- Drupal
- Laravel
- Helper
Reference - Endpoints
- Elasticsearch\Client
- Elasticsearch\ClientBuilder
- Elasticsearch\Namespaces\CatNamespace
- Elasticsearch\Namespaces\ClusterNamespace
- Elasticsearch\Namespaces\IndicesNamespace
- Elasticsearch\Namespaces\IngestNamespace
- Elasticsearch\Namespaces\NodesNamespace
- Elasticsearch\Namespaces\SnapshotNamespace
- Elasticsearch\Namespaces\TasksNamespace

IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« PHP Version Requirement Deprecations »

›

Breaking changes from 2.x

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Breaking changes from 2.x

edit

Indices/Analyze Endpoint: filters and char_filters URI parameters have been renamed to filter and char_filter respectively
SearchExists endpoint has been removed (use size=0 and terminate_after=1 instead)
Warmers have been removed because they are no longer useful
Indices/Optimize Endpoint has been removed (use _forcemerge instead)
MoreLikeThis (MLT) endpoint has been removed
DeleteByQuery endpoint has been removed.
Tasks/List and Tasks/Get are now separate endpoints (see: e0cc5f9)
Client requires PHP 5.6.6 or higher

« PHP Version Requirement Deprecations »

Was this helpful?

Feedback

The Search AI Company

ELK Stack

Elastic Cloud

Generative AI

Search

Security

Observability

By solution

Industries

Customer spotlight

Research

Build

Learn

Connect

Breaking changes from 2.x

Breaking changes from 2.x

Follow us

About us

Join us

Partners

Trust & Security

Investor relations

Excellence Awards

About us

Join us

Partners

Trust & Security

Investor relations

Excellence Awards