repository·main·Indexed 41 days ago
https://github.com/meilisearch/meilisearch-symfonyA Symfony bundle for seamless integration of the Meilisearch search engine into Symfony applications, featuring support for Doctrine ORM entities and Meilisearch v1.x. Includes CLI commands for index management, data import with atomic index swapping, and settings updates.
This bundle is designed to be compatible with Meilisearch v1.x.
Note that while compatible, some specific Meilisearch features may not be present in the bundle. Check the project's GitHub issues for details on feature availability or enhancements.
To integrate Meilisearch into your Symfony project, install the meilisearch/search-bundle package via Composer.
For support of older versions, you must use the specific older versions of this bundle.
composer require meilisearch/search-bundleTo use the bundle's Doctrine integration features (such as automatically indexing Doctrine entities), ensure you have the following packages installed in your project:
doctrine/ormdoctrine/doctrine-bundleThe repository provides a docker-compose.yml file to orchestrate a local development environment consisting of the meilisearch-symfony package and a Meilisearch instance.
package: Builds the current directory into a container. It is configured to work in /home/package and depends on the meilisearch service. It uses a bind mount to sync the local source code with the container for real-time development.meilisearch: Runs the getmeili/meilisearch-enterprise:latest image.package service:MEILISEARCH_URL: The URL used by the Symfony package to communicate with the Meilisearch instance. Defaults to http://meilisearch:7700 in this configuration.meilisearch service:MEILI_MASTER_KEY: The master key required for authenticated requests to Meilisearch. Set to masterKey in this configuration.MEILI_NO_ANALYTICS: Set to true to disable analytics.docker-compose upThe following options are available for the meilisearch:import command:
| Option | Shortcut | Description |
|---|---|---|
--indices | -i | Comma-separated list of index names to import. |
--update-settings | If present, updates settings related to the indices in the search engine. This is a negatable option (use --no-update-settings to disable). | |
--batch-size | The number of records to process in a single batch. If not provided, the value from the SearchManager configuration is used. | |
--skip-batches | Skip the first N batches and start importing from the N+1 batch. | |
--response-timeout | -t | Timeout in milliseconds to wait for a response from the search engine. |
--swap-indices | Import to temporary indices and use index swap to prevent downtime. |
php bin/console meilisearch:import --indices="index1,index2" --batch-size=100 --swap-indicesThe meilisearch:delete command supports the following options:
-i, --indices : Comma-separated list of index names (VALUE_OPTIONAL)When using Meilisearch bundle commands (which extend IndexCommand), you can filter operations to specific indices using the --indices option.
index1,index2).prefix (from your Meilisearch bundle configuration), the command will automatically prepend the prefix to the name.# Example usage (actual command name depends on the specific implementation)
symphony-cli meilisearch:index:some-action --indices=my_index,another_indexThe meilisearch:clear (alias meili:clear) command accepts the following options:
| Option | Shortcut | Required | Description |
|---|---|---|---|
--indices | -i | Optional | Comma-separated list of index names |
--response-timeout | -t | Required | Timeout (in ms) to get response from the search engine (defaults to self::DEFAULT_RESPONSE_TIMEOUT) |
Options:
-i, --indices="" Comma-separated list of index names
-t, --response-timeout="" Timeout (in ms) to get response from the search engineThe following environment variables and service settings are defined in the docker-compose.yml file for local development.
services:
package:
environment:
- MEILISEARCH_URL=http://meilisearch:7700
volumes:
- ./:/home/package:rw,cached
depends_on:
- meilisearch
meilisearch:
image: getmeili/meilisearch-enterprise:latest
environment:
- MEILI_MASTER_KEY=masterKey
- MEILI_NO_ANALYTICS=trueThe meilisearch:update-settings command supports the following options:
| Option | Shortcut | Requirement | Description |
|---|---|---|---|
--indices | -i | Optional | A comma-separated list of index names to update. |
--response-timeout | -t | Required | Timeout (in ms) to get response from the search engine. |
Note: The --response-timeout has a default value defined within the command if not explicitly provided.
--indices, -i : Comma-separated list of index names
--response-timeout, -t : Timeout (in ms) to get response from the search engineThe meilisearch:create command supports the following options:
| Option | Short | Description |
|---|---|---|
--indices | -i | Comma-separated list of index names |
--update-settings | Update settings related to indices to the search engine (negatable) | |
--response-timeout | -t | Timeout (in ms) to get response from the search engine (default: self::DEFAULT_RESPONSE_TIMEOUT) |
--indices, -i
--update-settings
--response-timeout, -tUse the meilisearch:create command (or its alias meili:create) to create new indexes in Meilisearch based on your configured entities. The command identifies searchable entities and triggers the index creation process on the Meilisearch server. If an entity is an Aggregator, the command will also expand the index creation to include its constituent entities.
# Basic usage to create indexes
php bin/console meilisearch:create
# Create specific indexes using a comma-separated list
php bin/console meilisearch:create --indices="index1,index2"
# Create indexes and update their settings in the search engine
php bin/console meilisearch:create --update-settings
# Set a custom response timeout in milliseconds
php bin/console meilisearch:create --response-timeout=5000