Feature Request: Compound Full-Text Indexes

[jpedryc]

Note

Related to previous requests in #724 and #833.

---

Overview

Assuming we're having a coumpound full-text index like:

ALTER TABLE `t` ADD FULLTEXT test_index(firstname, lastname, internal_clientnumber);

Old behaviour

    #[SearchUsingFullText([
        'firstname',
        'lastname',
        'internal_clientnumber'
    ])]
    public function toSearchableArray(): array
    {
        return [
            'firstname'          => $this->firstname,
            'lastname'           => $this->lastname,
            'internal_clientnumber' => $this->internal_clientnumber,
            'generated_fullname' => $this->firstname . $this->lastname,
            'email'              => $this->email,
        ];
    }

SQLSTATE[HY000]: General error: 1191 Can't find FULLTEXT index matching the column list ...

New behaviour

    #[SearchUsingFullText([
        ['firstname', 'lastname', 'internal_clientnumber']
    ])]
    public function toSearchableArray(): array
    {
        return [
            'firstname'          => $this->firstname,
            'lastname'           => $this->lastname,
            'internal_clientnumber' => $this->internal_clientnumber,
            'generated_fullname' => $this->firstname . $this->lastname,
            'email'              => $this->email,
        ];
    }

SELECT *
FROM `client`
WHERE (MATCH (`client`.`firstname`,
              `client`.`lastname`,
              `client`.`internal_clientnumber`) AGAINST ('muster' IN NATURAL LANGUAGE MODE)
       OR `client`.`generated_fullname` LIKE '%muster%'
       OR `client`.`email` LIKE '%muster%')

Arguments

🟢 Pro

Similarly to linked previous requests I mistakenly assumed that the existence of the SearchUsingFullText attribute meant that compound full-text indexes are supported.

🔴 Against

Like mentioned already in #833 (comment) - it can be done using the default query builder.

I felt like the cost of this change is not so heavy compared to already existing similar feature request tickets and that it would be a nice "completion" of the SearchUsingFullText behaviour.

Tests

Did not add any - I believe there are non for the attributes to limit the required migrations? ( 🤔 ) Correct me if I'm wrong on that.

What has been done - I hooked up my local scout package to a bigger internal project and was testing the behaviour and queries like that. There are no breaking changes so the existing tests should run through.

[github-actions]

Thanks for submitting a PR!

Note that draft PR's are not reviewed. If you would like a review, please mark your pull request as ready for review in the GitHub user interface.

Pull requests that are abandoned in draft may be closed due to inactivity.

[jpedryc]

The array method felt nicer, but alternatively could be also rebuild to comma-separated version like:

#[SearchUsingFullText(["col_a, col_b", "col_c"])

"col_a", "col_b" are within the compound full-text index in that case.

[taylorotwell]

I am closing this pull request because it lacks sufficient explanation, tests, or both. It is difficult for us to merge pull requests without these things because the change may introduce breaking changes to the framework.

Feel free to re-submit your change with a thorough explanation of the feature and tests - integration tests are preferred over unit tests. Please include it's benefit to end users; the reasons it does not break any existing features; how it makes building web applications easier, etc.

Thanks!