Download the PHP package jackardios/elastic-migrations without Composer
On this page you can find all versions of the php package jackardios/elastic-migrations. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jackardios/elastic-migrations
More information about jackardios/elastic-migrations
Files in jackardios/elastic-migrations
Package elastic-migrations
Short Description Elasticsearch migrations for Laravel
License MIT
Informations about the package elastic-migrations
Elastic Migrations
Elastic Migrations for Laravel allow you to easily modify and share indices schema across the application's environments.
Contents
- Compatibility
- Installation
- Configuration
- Writing Migrations
- Running Migrations
- Reverting Migrations
- Starting Over
- Migration Status
- Zero Downtime Migration
- Troubleshooting
Compatibility
The current version of Elastic Migrations 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:
If you want to use Elastic Migrations with Lumen framework check this guide.
Configuration
Elastic Migrations uses babenkoivan/elastic-client as a dependency. If you want to change the default client settings (and I'm pretty sure you do), then you need to create the configuration file first:
You can change Elasticsearch host and other client settings in the config/elastic.client.php
file. Please refer to
babenkoivan/elastic-client for more details.
You can also publish Elastic Migrations settings:
This will create the config/elastic.migrations.php
file, which allows you to configure the following options:
table
- the migration table nameconnection
- the database connectionstorage_directory
- the migrations directoryindex_name_prefix
- the indices prefixalias_name_prefix
- the aliases prefix
Finally, don't forget to run Laravel database migrations to create Elastic Migrations table:
Writing Migrations
You can effortlessly create a new migration file using an Artisan console command:
This command creates a migration class in the elastic/migrations
directory.
Every migration includes two methods: up
and down
. up
is used to alternate the index schema and down
is used to revert that action.
You can use ElasticMigrations\Facades\Index
facade to perform basic operations over Elasticsearch indices:
Create Index
You can create an index with the default settings:
You can use a modifier to configure mapping and settings:
There is also the createRaw
method in your disposal:
Finally, it is possible to create an index only if it doesn't exist:
Update Mapping
You can use a modifier to adjust the mapping:
Alternatively, you can use the putMappingRaw
method as follows:
Update Settings
You can use a modifier to change an index configuration:
The same result can be achieved with the putSettingsRaw
method:
It is possible to update analysis settings only on closed indices. The pushSettings
method closes the index,
updates the configuration and opens the index again:
The same can be done with the pushSettingsRaw
method:
Drop Index
You can unconditionally delete the index:
or delete it only if it exists:
Create Alias
You can create an alias with optional filter query:
Delete Alias
You can delete an alias by its name:
More
Finally, you are free to inject Elasticsearch\Client
in the migration constructor and execute any supported by client actions.
Running Migrations
You can either run all migrations:
or run a specific one:
Use the --force
option if you want to execute migrations on production environment:
Reverting Migrations
You can either revert the last executed migrations:
or rollback a specific one:
Use the elastic:migrate:reset
command if you want to revert all previously migrated files:
Starting Over
Sometimes you just want to start over, rollback all the changes and apply them again:
Alternatively you can also drop all existing indices and rerun the migrations:
Migration Status
You can always check which files have been already migrated and what can be reverted by the elastic:migrate:rollback
command (the last batch):
Zero Downtime Migration
Changing an index mapping with zero downtime is not a trivial process and might vary from one project to another. Elastic Migrations library doesn't include such feature out of the box, but you can implement it in your project by following this guide.
Troubleshooting
If you see one of the messages below, follow the instructions:
Migration table is not yet created
- run thephp artisan migrate
commandMigration directory is not yet created
- create a migration file using theelastic:make:migration
command or createmigrations
directory manually
In case one of the commands doesn't work as expected, try to publish configuration:
All versions of elastic-migrations with dependencies
babenkoivan/elastic-client Version ^1.2
babenkoivan/elastic-adapter Version ^2.0