Download the PHP package aman-rawat/elastic-adapter without Composer
On this page you can find all versions of the php package aman-rawat/elastic-adapter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aman-rawat/elastic-adapter
More information about aman-rawat/elastic-adapter
Files in aman-rawat/elastic-adapter
Package elastic-adapter
Short Description Adapter for official PHP Elasticsearch client
License MIT
Informations about the package elastic-adapter
Elastic Adapter
Elastic Adapter is an adapter for official PHP Elasticsearch client. It's designed to simplify basic index and document operations.
Contents
- Compatibility
- Installation
- Index Management
- Document Management
Compatibility
The current version of Elastic Adapter has been tested with the following configuration:
- PHP 7.3-8.0
- Elasticsearch 7.x
- Laravel 6.x-8.x
Installation
The library can be installed via Composer:
Index Management
IndexManager
can be used to manipulate indices. It uses Elasticsearch client as a dependency,
therefore you need to initiate the client before you create an IndexManager
instance:
The manager provides a set of useful methods, which are listed below.
Create
Create an index, either with the default settings and mapping:
or configured according to your needs:
Alternatively, you can create an index using raw input:
Drop
Delete an index:
Put Mapping
Update an index mapping using builder:
or using raw input:
Put Settings
Update an index settings using builder:
or using raw input:
Exists
Check if an index exists:
Open
Open an index:
Close
Close an index:
Put Alias
Create an alias:
Get Aliases
Get index aliases:
Delete Alias
Delete an alias:
Document Management
Similarly to IndexManager
, the DocumentManager
class also depends on Elasticsearch client:
Index
Add a document to the index:
There is also an option to refresh index immediately:
Finally, you can set a custom routing:
Delete
Remove a document from the index:
If you want the index to be refreshed immediately pass true
as the third argument:
You can also set a custom routing:
Finally, you can delete documents using query:
Search
Search documents in the index: