searchableAs

Author: michaelbaril

README.md

@@ -62,18 +62,43 @@ return [
 ];
 ```
 
-Migrate your database:
+## Creating the index
+
+Models are indexed in a separate table. You can either create a single table
+and use it as a global index for all models, or create 1 index table per model
+(or a mix of both).
+
+### Global index
+
+The default name for the table is `searchindex`. If you want to use a different
+name, you can configure it in `config/scout.php`:
+
+```php
+
+return [
+    // ...
+    'sqlout' => [
+        'table_name' => 'my_custom_index_name',
+        // ...
+    ],
+    // ...
+];
+
+```
+
+Then, migrate your database:
 
 ```bash
 php artisan sqlout:make-migration
 php artisan migrate
 ```
 
-This will create a `searchindex` table in your database (the table name can
-be customized in the config file).
+This will create the `searchindex` table (or whatever name you've configured).
+
+### Different connections
 
 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
+an index table per 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:
 
@@ -82,6 +107,48 @@ php artisan sqlout:make-migration my_other_connection
 php artisan migrate
 ```
 
+### Separate indexes
+
+If you prefer to index each model in a different table, set the global
+index name to an empty string:
+
+```php
+
+return [
+    // ...
+    'sqlout' => [
+        'table_name' => '',
+        // ...
+    ],
+    // ...
+];
+
+```
+
+Each model will be indexed in a table named like the model table
+followed by `_index`, eg. the `Post` model will be index in `posts_index`.
+
+You can configure a different suffix, and also a prefix, in the config file:
+
+```php
+
+return [
+    'prefix' => 'sqlout_',
+    'suffix' => '',
+];
+
+```
+
+You can also customize the table name for each model with the `searchableAs` method
+(see [next section](#making-a-model-searchable)).
+
+Once you're set up, create the index table for your models like this:
+
+```bash
+php artisan sqlout:make-migration --model="\\App\\Models\\Post"
+php artisan migrate
+```
+
 ## Making a model searchable
 
 ```php
@@ -106,6 +173,14 @@ class Post extends Model
             'body' => $this->post_content,
         ];
     }
+
+    // Optionally, you can customize the
+    // name of the table that the model
+    // will be indexed in:
+    public function searchableAs(): string
+    {
+        return 'my_custom_index';
+    }
 }
 ```
 

src/Engine.php

@@ -16,7 +16,7 @@ protected function newSearchQuery($model)
         $query = SearchIndex::query();
         $searchModel = $query->getModel()
                 ->setConnection($model->getConnectionName())
-                ->setTable(config('scout.sqlout.table_name'));
+                ->setTable($model->searchableAs());
         return $query->setModel($searchModel);
     }
 

src/Migrations/MigrateMakeCommand.php

@@ -6,10 +6,14 @@
 use Illuminate\Database\Console\Migrations\MigrateMakeCommand as BaseCommand;
 use Illuminate\Support\Composer;
 use Illuminate\Support\Str;
+use InvalidArgumentException;
 
 class MigrateMakeCommand extends BaseCommand
 {
-    protected $signature = 'sqlout:make-migration {connection? : Name of the connection}
+    protected $signature = 'sqlout:make-migration
+        {connection? : Name of the connection}
+        {table? : Name of the table}
+        {--model= : The model that the index is for}
         {--name= : The name of the migration.}
         {--path= : The location where the migration file should be created.}
         {--realpath : Indicate any provided migration file paths are pre-resolved absolute paths.}
@@ -23,23 +27,38 @@ public function __construct(MigrationCreator $creator, Composer $composer)
 
     public function handle()
     {
-        $connection = $this->input->getArgument('connection') ?? config('database.default');
+        $name = $this->input->getOption('name');
+        
+        if ($modelClass = $this->input->getOption('model')) {
+            if (!class_exists($modelClass)) {
+                throw new InvalidArgumentException("$modelClass class does not exist!");
+            }
+            if (!method_exists($modelClass, 'searchableAs')) {
+                throw new InvalidArgumentException("$modelClass class is not searchable!");
+            }
+            $model = new $modelClass();
+            $connection = $model->getConnectionName();
+            $table = $model->searchableAs();
+            $name = 'create sqlout index for ' . class_basename($modelClass);
+        } else {
+            $connection = $this->input->getArgument('connection') ?? config('database.default');
+            $table = $this->input->getArgument('table') ?? config('scout.sqlout.table_name');
+            $name = "create sqlout index $connection $table";
+        }
 
-        $this->writeSqloutMigration($connection);
+        $this->writeSqloutMigration($name, $connection, $table);
         $this->composer->dumpAutoloads();
 
         if ($this->input->hasOption('migrate') && $this->option('migrate')) {
             $this->call('migrate');
         }
     }
 
-    protected function writeSqloutMigration($connection)
+    protected function writeSqloutMigration($name, $connection, $tableName)
     {
         // Get the name for the migration file:
-        $name = $this->input->getOption('name') ?: 'create_sqlout_index_for_' . $connection;
         $name = Str::snake(trim($name));
         $className = Str::studly($name);
-        $tableName = config('scout.sqlout.table_name');
 
         // Generate the content of the migration file:
         $contents = $this->getMigrationContents($className, $connection, $tableName);

src/Searchable.php

@@ -35,4 +35,17 @@ public function getSearchWeight($field)
     {
         return $this->weights[$field] ?? 1;
     }
+
+    /**
+     * Get the index name for the model when searching.
+     *
+     * @return string
+     */
+    public function searchableAs()
+    {
+        return config(
+            'scout.sqlout.table_name',
+            config('scout.prefix').$this->getTable().config('scout.suffix', '_index')
+        );
+    }
 }

tests/Models/PostOtherSearchIndex.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Baril\Sqlout\Tests\Models;
+
+class PostOtherSearchIndex extends Post
+{
+    protected $table = 'posts';
+
+    public function searchableAs()
+    {
+        return 'other_searchindex';
+    }
+}

tests/SearchTest.php

@@ -6,11 +6,14 @@
 use Baril\Sqlout\SearchIndex;
 use Baril\Sqlout\Tests\Models\Comment;
 use Baril\Sqlout\Tests\Models\Post;
+use Baril\Sqlout\Tests\Models\PostOtherSearchIndex;
 use Illuminate\Contracts\Pagination\Paginator;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Facades\DB as DB;
+use Illuminate\Support\Facades\File;
 use Illuminate\Support\LazyCollection;
 use Laravel\Scout\Builder as ScoutBuilder;
+use Orchestra\Testbench\Database\MigrateProcessor;
 use Wamania\Snowball\StemmerFactory;
 
 class SearchTest extends TestCase
@@ -357,4 +360,41 @@ public function test_paginate()
             array_map(function ($item) { return $item->id; }, $paginator->items())
         );
     }
+
+    public function test_other_index()
+    {
+        $path = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'migrations';
+        File::deleteDirectory($path);
+        File::makeDirectory($path);
+
+        $this->artisan('sqlout:make-migration', [
+            '--model' => PostOtherSearchIndex::class,
+            '--path' => $path,
+            '--realpath' => true,
+        ]);
+
+        $this->assertCount(1, File::allFiles($path));
+
+        $migrator = new MigrateProcessor($this, [
+            '--path' => $path,
+            '--realpath' => true,
+        ]);
+        $migrator->up();
+
+        $this->assertTrue(DB::getSchemaBuilder()->hasTable('other_searchindex'));
+
+        PostOtherSearchIndex::unguard();
+        PostOtherSearchIndex::create([
+            'title' => 'kiki',
+            'body' => 'kuku',
+        ]);
+
+        $this->assertNotEmpty(DB::table('other_searchindex')->get());
+
+        $search = PostOtherSearchIndex::search('kiki');
+        $this->assertEquals(1, $search->count());
+
+        // Cleaning stuff:
+        File::deleteDirectory($path);
+    }
 }

tests/TestCase.php

@@ -4,6 +4,7 @@
 
 use Baril\Sqlout\SqloutServiceProvider;
 use Dotenv\Dotenv;
+use Illuminate\Support\Facades\DB;
 use Laravel\Scout\ScoutServiceProvider;
 use Orchestra\Testbench\TestCase as OrchestraTestCase;
 
@@ -96,12 +97,8 @@ protected function getPackageProviders($app)
     protected function setUp(): void
     {
         parent::setUp();
+        DB::getSchemaBuilder()->dropAllTables();
         $this->loadMigrationsFrom(__DIR__ . '/database/migrations');
-        \DB::enableQueryLog();
-    }
-
-    protected function dumpQueryLog()
-    {
-        dump(\DB::getQueryLog());
+        DB::enableQueryLog();
     }
 }