Download the PHP package baril/sqlout without Composer
On this page you can find all versions of the php package baril/sqlout. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package sqlout
Sqlout :dolphin:
Sqlout is a MySQL driver for Laravel Scout. It indexes the data into a dedicated table of the MySQL database, and uses a fulltext index to search. It is meant for small-sized projects, for which bigger solutions such as ElasticSearch would be an overkill.
Sqlout is different than Scout's native Database
engine because it indexes
data in a separate, dedicated table, and uses a fulltext index. Sqlout has more
features such as field weights and word stemming.
Sqlout is compatible with Laravel 5.8+ to 12.x and Scout 7.1+ / 8.x / 9.x / 10.x (credit goes to ikari7789 for Laravel 9 and 10 / Scout 9 and 10 support).
You can find the full API documentation here.
Version compatibility
Laravel | Scout | Sqlout |
---|---|---|
11.x / 12.x | 10.x | 5.1+ |
9.x / 10.x | 10.x | 5.x |
8.x / 9.x | 9.x | 4.x |
8.x | 8.x | 3.x |
7.x | 8.x | 2.0 |
6.x | 8.x | 2.0 |
6.x | 7.1 / 7.2 | 1.x / 2.0 |
5.8 | 7.1 / 7.2 | 1.x / 2.0 |
Setup
Require the package:
Publish the configuration:
If you're not using package discovery, manually add the service providers
(Scout's and Sqlout's) to your config/app.php
file:
Migrate your database:
This will create a searchindex
table in your database (the table name can
be customized in the config file).
If you want to index models that belong to different connections, you need
a table for Sqlout on each connection. To create the table on a connection that
is not the default connection, you can call the sqlout:make-migration
command
and pass the name of the connection:
Making a model searchable
The example above is similar to what is described in Scout's documentation, with the following differences/additions:
- The model uses the
Baril\Sqlout\Searchable
trait instead ofLaravel\Scout\Searchable
. - The
$weight
property can be used to "boost" some fields. The default value is 1.
Once this is done, you can index your data using Scout's Artisan command:
Your models will also be indexed automatically on save.
Searching
Basics
See Scout's documentation for more details.
Sqlout's builder also provides the following additional methods:
Using scopes
With Sqlout, you can also use your model scopes on the search builder,
as if it was a query builder on the model itself. Similarly, all calls to the
where
method on the search builder will be
forwarded to the model's query builder.
:warning: Keep in mind that these forwarded scopes will actually be applied to a subquery (the main query here being the one on the
searchindex
table). This means that for example a scope that adds anorder by
clause won't have any effect. See below for the proper way to order results.
If the name of your scope collides with the name of a method of the
Baril\Sqlout\Builder
object, you can wrap your scope into the scope
method:
Search modes
MySQL's fulltext search comes in 3 flavours:
- natural language mode,
- natural language mode with query expansion,
- boolean mode.
Sqlout's default mode is "natural language" (but this can be changed in the config file).
You can also switch between all 3 modes on a per-query basis, by using the following methods:
Ordering the results
If no order is specified, the results will be ordered by score (most relevant first). But you can also order the results by any column of your table.
In the example below, the results will be ordered by status first, and then by descending score.
Filters, tokenizer, stopwords and stemming
In your config file, you can customize the way the indexed content and search terms will be processed:
In the example, the stemmer comes from the package wamania/php-stemmer
,
but any class with a stem
method, or anything callable such as a closure, will do.
All versions of sqlout with dependencies
illuminate/database Version ^8.79|^9.46|^10.0|^11.0|^12.0
illuminate/support Version ^8.79|^9.46|^10.0|^11.0|^12.0
laravel/scout Version ^9.0|^10.0