PHPackages                             phenix/phenix - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. phenix/phenix

ActiveLibrary[Search & Filtering](/categories/search)

phenix/phenix
=============

Elasticsearch ORM for Laravel/Lumen

0.4.8(3y ago)083.5k↓43.2%2MITPHPPHP >=7.2

Since Jul 16Pushed 3y agoCompare

[ Source](https://github.com/the-phenix/phenix)[ Packagist](https://packagist.org/packages/phenix/phenix)[ Docs](https://github.com/the-phenix/phenix)[ RSS](/packages/phenix-phenix/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (8)Versions (27)Used By (0)

phenix
======

[](#phenix)

AWS Elasticsearch Service for Laravel/Lumen

**NOTE:** This package only caters search, aggregation, and indexing transactions. Other than that, you can refer to [elasticsearch's official documentation](https://www.elastic.co/guide/en/elasticsearch/client/php-api/index.html). **NOTE:** This package is based on elegisandi/aws-elasticsearch-laravel

Installation
------------

[](#installation)

```
composer require the-phenix/phenix

```

Laravel/Lumen Integration
-------------------------

[](#laravellumen-integration)

- Add service provider to your `config/app.php` providers

    ```
    glodzienski\AWSElasticsearchService\ElasticSearchServiceProvider::class

    ```
- Add facade to your `config/app.php` aliases

    ```
    'ElasticSearch' => glodzienski\AWSElasticsearchService\Facades\ElasticSearch::class

    ```
- Set AWS credentials and Elasticsearch config in your `.env` file

    ```
      AWS_ACCESS_KEY_ID
      AWS_SECRET_ACCESS_KEY
      AWS_REGION

      ELASTICSEARCH_ENDPOINT
      ELASTICSEARCH_PORT
      ELASTICSEARCH_SHARDS
      ELASTICSEARCH_REPLICAS
      ELASTICSEARCH_DEFAULT_INDEX
      ELASTICSEARCH_DEFAULT_TYPE
      ELASTICSEARCH_DEFAULT_TIME_FILTER_FIELD

    ```

    When you are already using aws elasticsearch service, set

    ```
      AWS_ELASTICSEARCH_SERVICE=true

    ```

**If you want to configure elasticsearch mappings, settings and/or default type and index, just run:**

```
php artisan vendor:publish --provider=glodzienski\\AWSElasticsearchService\\ElasticSearchServiceProvider

```

**For Lumen:**

- Register service provider to your `bootstrap/app.php`

    ```
    $app->register(glodzienski\AWSElasticsearchService\ElasticSearchServiceProvider::class);

    ```

Basic Usage
-----------

[](#basic-usage)

**Using Facade:**

```