Laravel Scout+TNTSearch使用疑问：过滤失效与关联索引咨询

1. shouldBeSearchable() Not Filtering Published Models During Import #

I’ve run into this exact snag before! The shouldBeSearchable() method works perfectly for real-time model updates (create/edit), but it doesn’t always play nice with the scout:import command out of the box. Here’s why and how to fix it:

Why it’s happening #

By default, scout:import fetches all records from your model’s table first, then checks shouldBeSearchable() on each instance to decide whether to index it. But if you already have closed articles in your index from a previous import, they won’t get removed automatically—you need to explicitly filter the query before importing.

Fixes: #

• Option 1: Override searchableQuery() (Recommended)
  This tells Scout to only fetch records that meet your criteria right from the database, making imports faster and ensuring only valid records are indexed:

  // App\Article.php
  public function searchableQuery()
  {
      return static::query()->where('published', 'open');
  }
  

  Now when you run php artisan scout:import "App\Article", it will only pull in articles where published is open.

• Option 2: Flush Old Index First
  If you already have invalid records in your index, run this to clear them before re-importing:

  php artisan scout:flush "App\Article"
  php artisan scout:import "App\Article"
  

  This ensures any previously indexed closed articles are removed.

• Double-Check Your shouldBeSearchable() Logic
  Make sure the method returns a proper boolean. A common mistake is typos or incorrect comparisons:

  public function shouldBeSearchable()
  {
      // Ensure this returns true ONLY when published is "open"
      return $this->published === 'open';
  }
  

2. Indexing Related Model Data (e.g., User + Profile) #

Absolutely! You can include related data in your Scout index by customizing the toSearchableArray() method on your main model. Here’s how to do it for a User with a Profile:

Step 1: Add Related Data to the Searchable Array #

In your User model, override toSearchableArray() to include fields from the associated Profile:

// App\User.php
public function toSearchableArray()
{
    // Start with the default User attributes
    $array = $this->toArray();

    // Add fields from the related Profile (handle optional profiles with `optional()`)
    $array['profile_bio'] = optional($this->profile)->bio ?? '';
    $array['profile_location'] = optional($this->profile)->location ?? '';
    $array['profile_skills'] = optional($this->profile)->skills ?? '';

    return $array;
}

This will index those Profile fields alongside the User’s own data. Now when you search for a skill or location from a Profile, it will return the associated User model.

Step 2: Sync Index When Related Data Updates #

If the Profile gets updated later, you need to tell Scout to re-index the associated User. Add this to your Profile model:

// App\Profile.php
protected static function booted()
{
    static::updated(function ($profile) {
        // Update the User's index whenever their Profile changes
        $profile->user->searchable();
    });

    // Optional: Do the same for created/deleted events if needed
    static::created(function ($profile) {
        $profile->user->searchable();
    });
}

Step 3: Re-Import the User Model #

Don’t forget to re-import your User models to include the new Profile data in the index:

php artisan scout:import "App\User"

内容的提问来源于stack exchange，提问作者Jesse Luke Orange