Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-southeners/laravel-scout-advanced-meilisearch
Advanced Meilisearch integration with Laravel Scout
https://github.com/open-southeners/laravel-scout-advanced-meilisearch
extension laravel laravel-package laravel-scout meilisearch meilisearch-php php php-attributes
Last synced: 3 months ago
JSON representation
Advanced Meilisearch integration with Laravel Scout
- Host: GitHub
- URL: https://github.com/open-southeners/laravel-scout-advanced-meilisearch
- Owner: open-southeners
- License: mit
- Created: 2022-09-04T14:06:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-12T16:21:43.000Z (over 1 year ago)
- Last Synced: 2024-04-24T15:23:58.989Z (10 months ago)
- Topics: extension, laravel, laravel-package, laravel-scout, meilisearch, meilisearch-php, php, php-attributes
- Language: PHP
- Homepage:
- Size: 134 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Laravel Scout Advanced Meilisearch [](https://www.php.net/supported-versions.php) [](https://codecov.io/gh/open-southeners/laravel-scout-advanced-meilisearch) [](https://vscode.dev/github/open-southeners/laravel-scout-advaced-meilisearch)
===
Advanced Meilisearch integration with Laravel Scout.
## Getting started
Install the package using Composer:
```
composer require open-southeners/laravel-scout-advanced-meilisearch
```
### Filterable and sortable attributes
For sending filterable and sortable attributes to your Meilisearch server, configure your already searchable models like so:
```php
use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;
class Tag extends Model
{
use Searchable;
/**
* Get the indexable data array for the model.
*
* @return array
*/
public function toSearchableArray()
{
return [
'id' => $this->id,
'name' => $this->name,
'slug' => $this->slug,
];
}
/**
* Get the search sortable attributes array for the model.
*
* @return array
*/
public function searchableFilters(): array
{
return ['name'];
}
/**
* Get the search sortable attributes array for the model.
*
* @return array
*/
public function searchableSorts(): array
{
return ['slug'];
}
}
```
#### Using PHP attributes
**In case your project is using PHP 8**, you can do this by attributes on the model class or the `toSearchableArray` method:
```php
use Illuminate\Foundation\Auth\User as Authenticatable;
use Laravel\Scout\Searchable;
use OpenSoutheners\LaravelScoutAdvancedMeilisearch\Attributes\ScoutSearchableAttributes;
#[ScoutSearchableAttributes(filterable: ['email'], sortable: ['name'])]
class User extends Authenticatable
{
use Searchable;
/**
* Get the indexable data array for the model.
*
* @return array
*/
public function toSearchableArray()
{
return [
'id' => $this->id,
'name' => $this->name,
'email' => $this->email,
];
}
}
```
And finally run the following artisan command:
```bash
php artisan scout:update "App\Models\User"
```
You could also run this command with `--wait` option which tells the command to wait for the task to finish:
```bash
php artisan scout:update "App\Models\User" --wait
```
Remember to check [the official documentation about these filters and sorts](https://docs.meilisearch.com/learn/getting_started/filtering_and_sorting.html).
### Dumps
Create Meilisearch data dumps (data backups that will be saved on your Meilisearch server), with the following command:
```bash
php artisan scout:dump
```
As `scout:update` command, this also have a `--wait` option:
```bash
php artisan scout:dump --wait
```
[Read more about Meilisearch dumps here](https://docs.meilisearch.com/learn/advanced/dumps.html).
### Tasks
List all tasks via command line, just running the following:
```bash
php artisan scout:tasks
```
**They can be even filtered!** (see more options running it with `--help`)
```bash
php artisan scout:tasks --status=succeeded
```
#### Canceling enqueued tasks
Also can cancel tasks with a very simple command, you can either cancel an specific task or multiple:
```bash
php artisan scout:tasks-cancel 1
```
The previous command will cancel task with UID = 1. If you wish to cancel multiple you could send them separated by comma or using options like:
```bash
php artisan scout:tasks-cancel --before-enqueued=1d
```
So this will cancel all tasks that were enqueued before 1 day (can also send 1m, 1y... **as in the background this is using `Carbon::now()->add()` & `Carbon::now()->sub()` methods**)
#### Prune finished tasks
As canceling tasks won't make them disappear from the tasks history, you can just run the following:
```bash
php artisan scout:tasks-prune
```
Just for safety for debug purposes, **this command does not remove those tasks that failed**, if you wish to do so, run the command with `--include-failed` like so:
```bash
php artisan scout:tasks-prune --include-failed
```
**Don't worry, this will not remove tasks that were enqueued and not finished, as stated by Meilisearch official docs (see link just below).**
[Read more about Meilisearch tasks here](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html#task-workflow).
## Partners
[](https://getskore.com)
## License
This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).