https://github.com/boxed-code/laravel-scout-database

A generic database driver for laravel scout that requires zero configuration.
https://github.com/boxed-code/laravel-scout-database

database laravel mysql scout sqlite

Last synced: 9 days ago
JSON representation

A generic database driver for laravel scout that requires zero configuration.

• Host: GitHub
• URL: https://github.com/boxed-code/laravel-scout-database
• Owner: boxed-code
• Created: 2017-07-07T12:25:11.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-01-24T14:38:55.000Z (12 months ago)
• Last Synced: 2025-12-28T16:59:53.862Z (25 days ago)
• Topics: database, laravel, mysql, scout, sqlite
• Language: PHP
• Homepage:
• Size: 29.3 KB
• Stars: 11
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Laravel Scout Database Driver

[![Latest Stable Version](https://poser.pugx.org/boxed-code/laravel-scout-database/v)](//packagist.org/packages/boxed-code/laravel-scout-database) [![Total Downloads](https://poser.pugx.org/boxed-code/laravel-scout-database/downloads)](//packagist.org/packages/boxed-code/laravel-scout-database) [![License](https://poser.pugx.org/boxed-code/laravel-scout-database/license)](//packagist.org/packages/boxed-code/laravel-scout-database)

[![Tests](https://github.com/boxed-code/laravel-scout-database/actions/workflows/run_tests.yml/badge.svg)](https://github.com/boxed-code/laravel-scout-database/actions/workflows/run_tests.yml)

This is a basic database backed driver [for Laravel Scout](https://laravel.com/docs/5.4/scout). It is intended for use during development to avoid the need to setup an elastic instance or agolia and instead uses your active database configuration. 

Searchable model attributes are JSON encoded an placed in a text column for simplicity, the very primative 'like' operator is used to perform queries. It is fully functional supporting additional where clauses, etc. The driver deliberately avoides using free text queries & indexes as these are somewhat provider specific and would prevent the goal of it being able to operate with any architecture.

This driver is zero configuration, requiring you to only add the service provider & run the migration.

*Requires Scout 8.x or 9.x and PHP >=7.2 or >=8.0*

## Installation

You can install the package via composer:

``` bash

composer require boxed-code/laravel-scout-database

```

You must add the Scout service provider and the package service provider in your app.php config:

```php

// config/app.php

'providers' => [

    ...

    Laravel\Scout\ScoutServiceProvider::class,

    ...

    BoxedCode\Laravel\Scout\DatabaseEngineServiceProvider::class,

],

```

Then run the migrations via the console

```shell

php artisan migrate

```

## Usage

Now you can use Laravel Scout as described in the [official documentation](https://laravel.com/docs/5.4/scout)

## License

The MIT License (MIT).