Skip to content

Commit

Permalink
Add array and json overlaps condition builders
Browse files Browse the repository at this point in the history
  • Loading branch information
Tigrov committed Jun 29, 2024
1 parent 48dbbe8 commit d42f5a6
Show file tree
Hide file tree
Showing 8 changed files with 220 additions and 45 deletions.
47 changes: 47 additions & 0 deletions src/Builder/ArrayOverlapsConditionBuilder.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Db\Pgsql\Builder;

use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Exception\InvalidArgumentException;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Exception\NotSupportedException;
use Yiisoft\Db\Expression\ArrayExpression;
use Yiisoft\Db\Expression\ExpressionInterface;
use Yiisoft\Db\Expression\JsonExpression;
use Yiisoft\Db\QueryBuilder\Condition\ArrayOverlapsCondition;
use Yiisoft\Db\QueryBuilder\Condition\Builder\AbstractOverlapsConditionBuilder;

/**
* Builds expressions for {@see ArrayOverlapsCondition} for PostgreSQL Server.
*/
final class ArrayOverlapsConditionBuilder extends AbstractOverlapsConditionBuilder
{
/**
* Build SQL for {@see ArrayOverlapsCondition}.
*
* @param ArrayOverlapsCondition $expression the {@see ArrayOverlapsCondition} to be built.
*
* @throws Exception
* @throws InvalidArgumentException
* @throws InvalidConfigException
* @throws NotSupportedException
*/
public function build(ExpressionInterface $expression, array &$params = []): string
{
$column = $this->prepareColumn($expression->getColumn());
$values = $expression->getValues();

if ($values instanceof JsonExpression) {
$values = new ArrayExpression($values->getValue());
} elseif (!$values instanceof ExpressionInterface) {
$values = new ArrayExpression($values);
}

$values = $this->queryBuilder->buildExpression($values, $params);

return "$column::text[] && $values::text[]";
}
}
47 changes: 47 additions & 0 deletions src/Builder/JsonOverlapsConditionBuilder.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Db\Pgsql\Builder;

use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Exception\InvalidArgumentException;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Exception\NotSupportedException;
use Yiisoft\Db\Expression\ArrayExpression;
use Yiisoft\Db\Expression\ExpressionInterface;
use Yiisoft\Db\Expression\JsonExpression;
use Yiisoft\Db\QueryBuilder\Condition\Builder\AbstractOverlapsConditionBuilder;
use Yiisoft\Db\QueryBuilder\Condition\JsonOverlapsCondition;

/**
* Builds expressions for {@see JsonOverlapsCondition} for PostgreSQL Server.
*/
final class JsonOverlapsConditionBuilder extends AbstractOverlapsConditionBuilder
{
/**
* Build SQL for {@see JsonOverlapsCondition}.
*
* @param JsonOverlapsCondition $expression the {@see JsonOverlapsCondition} to be built.
*
* @throws Exception
* @throws InvalidArgumentException
* @throws InvalidConfigException
* @throws NotSupportedException
*/
public function build(ExpressionInterface $expression, array &$params = []): string
{
$column = $this->prepareColumn($expression->getColumn());
$values = $expression->getValues();

if ($values instanceof JsonExpression) {
$values = new ArrayExpression($values->getValue());
} elseif (!$values instanceof ExpressionInterface) {
$values = new ArrayExpression($values);
}

$values = $this->queryBuilder->buildExpression($values, $params);

return "ARRAY(SELECT jsonb_array_elements($column::jsonb))::text[] && $values::text[]";
}
}
6 changes: 6 additions & 0 deletions src/DQLQueryBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,14 @@
use Yiisoft\Db\Expression\ExpressionBuilderInterface;
use Yiisoft\Db\Expression\JsonExpression;
use Yiisoft\Db\Pgsql\Builder\ArrayExpressionBuilder;
use Yiisoft\Db\Pgsql\Builder\ArrayOverlapsConditionBuilder;
use Yiisoft\Db\Pgsql\Builder\JsonOverlapsConditionBuilder;
use Yiisoft\Db\Pgsql\Builder\StructuredExpressionBuilder;
use Yiisoft\Db\Pgsql\Builder\ExpressionBuilder;
use Yiisoft\Db\Pgsql\Builder\JsonExpressionBuilder;
use Yiisoft\Db\QueryBuilder\AbstractDQLQueryBuilder;
use Yiisoft\Db\QueryBuilder\Condition\ArrayOverlapsCondition;
use Yiisoft\Db\QueryBuilder\Condition\JsonOverlapsCondition;
use Yiisoft\Db\QueryBuilder\Condition\LikeCondition;

use function array_merge;
Expand Down Expand Up @@ -52,7 +56,9 @@ protected function defaultExpressionBuilders(): array
{
return array_merge(parent::defaultExpressionBuilders(), [
ArrayExpression::class => ArrayExpressionBuilder::class,
ArrayOverlapsCondition::class => ArrayOverlapsConditionBuilder::class,
JsonExpression::class => JsonExpressionBuilder::class,
JsonOverlapsCondition::class => JsonOverlapsConditionBuilder::class,
StructuredExpression::class => StructuredExpressionBuilder::class,
Expression::class => ExpressionBuilder::class,
]);
Expand Down
45 changes: 0 additions & 45 deletions tests/CommandTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -182,51 +182,6 @@ public function testDropDefaultValue(): void
$db->close();
}

/**
* @throws Exception
* @throws InvalidConfigException
* @throws Throwable
*
* {@link https://github.com/yiisoft/yii2/issues/15827}
*/
public function testIssue15827(): void
{
$db = $this->getConnection();

$command = $db->createCommand();
$inserted = $command->insert(
'{{array_and_json_types}}',
[
'jsonb_col' => new JsonExpression(['Solution date' => '13.01.2011']),
],
)->execute();

$this->assertSame(1, $inserted);

$found = $command->setSql(
<<<SQL
SELECT *
FROM [[array_and_json_types]]
WHERE [[jsonb_col]] @> '{"Some not existing key": "random value"}'
SQL,
)->execute();

$this->assertSame(0, $found);

$found = $command->setSql(
<<<SQL
SELECT *
FROM [[array_and_json_types]]
WHERE [[jsonb_col]] @> '{"Solution date": "13.01.2011"}'
SQL,
)->execute();

$this->assertSame(1, $found);
$this->assertSame(1, $command->delete('{{array_and_json_types}}')->execute());

$db->close();
}

/**
* @dataProvider \Yiisoft\Db\Pgsql\Tests\Provider\CommandProvider::rawSql
*
Expand Down
13 changes: 13 additions & 0 deletions tests/Provider/QueryBuilderProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -523,4 +523,17 @@ public static function upsert(): array

return $upsert;
}

public static function overlapsCondition(): array
{
$data = parent::overlapsCondition();

$data['null'][1] = 0;
$data['expression'][0] = new Expression("'{0,1,2,7}'");
$data['query expression'][0] = (new Query(static::getDb()))->select(new ArrayExpression([0,1,2,7]));
$data[] = [new Expression('ARRAY[0,1,2,7]'), 1];
$data[] = [new ArrayExpression([0,1,2,7]), 1];

return $data;
}
}
94 changes: 94 additions & 0 deletions tests/QueryBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
use Yiisoft\Db\Expression\ExpressionInterface;
use Yiisoft\Db\Pgsql\Column;
use Yiisoft\Db\Pgsql\Tests\Support\TestTrait;
use Yiisoft\Db\Query\Query;
use Yiisoft\Db\Query\QueryInterface;
use Yiisoft\Db\QueryBuilder\Condition\ArrayOverlapsCondition;
use Yiisoft\Db\QueryBuilder\Condition\JsonOverlapsCondition;
use Yiisoft\Db\Schema\SchemaInterface;
use Yiisoft\Db\Tests\Common\CommonQueryBuilderTest;

Expand Down Expand Up @@ -681,4 +684,95 @@ public function testSelectScalar(array|bool|float|int|string $columns, string $e
{
parent::testSelectScalar($columns, $expected);
}

public function testArrayOverlapsConditionBuilder(): void
{
$db = $this->getConnection();
$qb = $db->getQueryBuilder();

$params = [];
$sql = $qb->buildExpression(new ArrayOverlapsCondition('column', [1, 2, 3]), $params);

$this->assertSame('"column"::text[] && ARRAY[:qp0, :qp1, :qp2]::text[]', $sql);
$this->assertSame([':qp0' => 1, ':qp1' => 2, ':qp2' => 3], $params);

$db->close();
}

public function testJsonOverlapsConditionBuilder(): void
{
$db = $this->getConnection();
$qb = $db->getQueryBuilder();

$params = [];
$sql = $qb->buildExpression(new JsonOverlapsCondition('column', [1, 2, 3]), $params);

$this->assertSame(
'ARRAY(SELECT jsonb_array_elements("column"::jsonb))::text[] && ARRAY[:qp0, :qp1, :qp2]::text[]',
$sql
);
$this->assertSame([':qp0' => 1, ':qp1' => 2, ':qp2' => 3], $params);

$db->close();
}

/** @dataProvider \Yiisoft\Db\Pgsql\Tests\Provider\QueryBuilderProvider::overlapsCondition */
public function testOverlapsCondition(iterable|ExpressionInterface $values, int $expectedCount): void
{
$db = $this->getConnection();
$query = new Query($db);

$count = $query
->from('array_and_json_types')
->where(new ArrayOverlapsCondition('intarray_col', $values))
->count();

$this->assertSame($expectedCount, $count);

$count = $query
->from('array_and_json_types')
->where(new JsonOverlapsCondition('json_col', $values))
->count();

$this->assertSame($expectedCount, $count);

$count = $query
->from('array_and_json_types')
->where(new JsonOverlapsCondition('jsonb_col', $values))
->count();

$this->assertSame($expectedCount, $count);

$db->close();
}

/** @dataProvider \Yiisoft\Db\Pgsql\Tests\Provider\QueryBuilderProvider::overlapsCondition */
public function testOverlapsConditionOperator(iterable|ExpressionInterface $values, int $expectedCount): void
{
$db = $this->getConnection();
$query = new Query($db);

$count = $query
->from('array_and_json_types')
->where(['array overlaps', 'intarray_col', $values])
->count();

$this->assertSame($expectedCount, $count);

$count = $query
->from('array_and_json_types')
->where(['json overlaps', 'json_col', $values])
->count();

$this->assertSame($expectedCount, $count);

$count = $query
->from('array_and_json_types')
->where(['json overlaps', 'jsonb_col', $values])
->count();

$this->assertSame($expectedCount, $count);

$db->close();
}
}
4 changes: 4 additions & 0 deletions tests/Support/Fixture/pgsql.sql
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,10 @@ CREATE TABLE "array_and_json_types" (
jsonarray_col JSON[]
);

INSERT INTO "array_and_json_types" (intarray_col, json_col, jsonb_col) VALUES (null, null, null);
INSERT INTO "array_and_json_types" (intarray_col, json_col, jsonb_col) VALUES ('{1,2,3,null}', '[1,2,3,null]', '[1,2,3,null]');
INSERT INTO "array_and_json_types" (intarray_col, json_col, jsonb_col) VALUES ('{3,4,5}', '[3,4,5]', '[3,4,5]');

CREATE TABLE "T_constraints_1"
(
"C_id" INT NOT NULL PRIMARY KEY,
Expand Down
9 changes: 9 additions & 0 deletions tests/Support/TestTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,13 @@ protected function setFixture(string $fixture): void
{
$this->fixture = $fixture;
}

public static function setUpBeforeClass(): void
{
$db = self::getDb();

DbHelper::loadFixture($db, __DIR__ . '/Fixture/pgsql.sql');

$db->close();
}
}

0 comments on commit d42f5a6

Please sign in to comment.