[11.x] Add ->whereJsonOverlaps() for mysql

[parkourben99]

This feature PR adds json_overlaps for mysql.

I was using ->whereJsonContains() to check if the json field contained a value. This then evolved to check if an array of values overlaps with what is in the database.

json_overlaps

Compares two JSON documents. Returns true (1) if the two document have any key-value pairs or array elements in common. If both arguments are scalars, the function performs a simple equality test. If either argument is NULL, the function returns NULL.

This function serves as counterpart to JSON_CONTAINS(), which requires all elements of the array searched for to be present in the array searched in. Thus, JSON_CONTAINS() performs an AND operation on search keys, while JSON_OVERLAPS() performs an OR operation.

Example usage:

User::whereJsonOverlaps('languages', ['en', 'fr'])->exists();
User::whereJsonDoesntOverlap('languages', ['en', 'fr'])->exists();

[staudenmeir]

Did you look into whether and how this is also supported by the other DBMS?

[parkourben99]

Did you look into whether and how this is also supported by the other DBMS?

No, only looked at MySql as that is what I needed. Other databases could be supported in another pull request.

[GonzaloGPF]

Thanks for this addition!
But I have a question, could you subquery values to search?

I mean, I would like to do following

$q->whereJsonOverlaps('levels', function ($subQuery) use ($user) {
    $subQuery->select('level')
        ->from('user')
        ->where('users.id', $user->id);

The bindings of that sql looks like this:

[
  0 => 1 // the user->id
  1 => "{}" // the subquery
]

So I guess it produces a {} when receiving a clousure or I'm missing something?

Thanks!

[parkourben99]

Thanks for this addition! But I have a question, could you subquery values to search?

I mean, I would like to do following

$q->whereJsonOverlaps('levels', function ($subQuery) use ($user) {
    $subQuery->select('level')
        ->from('user')
        ->where('users.id', $user->id);

The bindings of that sql looks like this:

[
  0 => 1 // the user->id
  1 => "{}" // the subquery
]

So I guess it produces a {} when receiving a clousure or I'm missing something?

Thanks!

A callback will not work, as that is not how json_overlaps works