MyGit

opsway/doctrine-dbal-postgresql

Fork: 37 Star: 158 (更新于 2024-10-30 00:39:48)

license: MIT

Language: PHP .

Add JSON query support to Doctrine DBAL and DQL

最后发布版本: v2.0.0 ( 2024-02-20 20:11:39)

GitHub网址

doctrine-dbal-postgresql

Latest Stable Version Total Downloads Latest Unstable Version

This component allows you to manage some native PostgreSQL data types, operators and functions with the Doctrine DBAL component.

Usage

Add to composer.json

php composer.phar require opsway/doctrine-dbal-postgresql ~0.8

To use the new types you should register them using the Custom Mapping Types feature.

To use the new functions you should register them using the DQL User Defined Functions feature.

Custom Types

  • Array Integer (integer[])
  • Array BigInt (bigint[])
  • TsVector (tsvector)

Custom DQL functions

  • CONTAINS - 'OpsWay\Doctrine\ORM\Query\AST\Functions\Contains'
  • CONTAINED - 'OpsWay\Doctrine\ORM\Query\AST\Functions\Contained'
  • GET_JSON_FIELD - 'OpsWay\Doctrine\ORM\Query\AST\Functions\GetJsonField'
  • GET_JSON_FIELD_BY_KEY - 'OpsWay\Doctrine\ORM\Query\AST\Functions\GetJsonFieldByKey'
  • GET_JSON_OBJECT - 'OpsWay\Doctrine\ORM\Query\AST\Functions\GetJsonObject'
  • GET_JSON_OBJECT_TEXT - 'OpsWay\Doctrine\ORM\Query\AST\Functions\GetJsonObjectText'
  • ANY_OP - 'OpsWay\Doctrine\ORM\Query\AST\Functions\Any'
  • ALL_OP - 'OpsWay\Doctrine\ORM\Query\AST\Functions\All'
  • ARR - 'OpsWay\Doctrine\ORM\Query\AST\Functions\Arr'
  • ARR_AGGREGATE - 'OpsWay\Doctrine\ORM\Query\AST\Functions\ArrayAggregate'
  • ARR_APPEND - 'OpsWay\Doctrine\ORM\Query\AST\Functions\ArrayAppend'
  • ARR_REPLACE - 'OpsWay\Doctrine\ORM\Query\AST\Functions\ArrayReplace'
  • REGEXP_REPLACE - 'OpsWay\Doctrine\ORM\Query\AST\Functions\RegexpReplace'
  • ARR_REMOVE - 'OpsWay\Doctrine\ORM\Query\AST\Functions\ArrayRemove'
  • ARR_CONTAINS - 'OpsWay\Doctrine\ORM\Query\AST\Functions\ArrayContains'
  • TO_TSQUERY - 'OpsWay\Doctrine\ORM\Query\AST\Functions\ToTsquery'
  • TO_TSVECTOR - 'OpsWay\Doctrine\ORM\Query\AST\Functions\ToTsvector'
  • TS_CONCAT_OP - 'OpsWay\Doctrine\ORM\Query\AST\Functions\TsConcat'
  • TS_MATCH_OP - 'OpsWay\Doctrine\ORM\Query\AST\Functions\TsMatch'
  • UNNEST - 'OpsWay\Doctrine\ORM\Query\AST\Functions\Unnest'
  • JSON_AGG - 'OpsWay\Doctrine\ORM\Query\AST\Functions\JsonAgg'
  • JSONB_ARRAY_ELEM_TEXT - 'OpsWay\Doctrine\ORM\Query\AST\Functions\JsonbArrayElementsText'

Custom DQL function usage

For an example the CONTAINS function requires your table column in your database to be of the type jsonb. Otherwise PostgreSQL will not recognize the operator needed to perform this action. (@>)

  • Tip: Based on the function you want to use, check if there are any specific column type requirements.

Example query:

$result = $this->em->createQuery(
    'SELECT l FROM Foo\Bar\Baz l WHERE CONTAINS(l.metaData, :value) = true')
    ->setParameter('value', json_encode(['foo'=>'bar']))
    ->getResult();

Setting the column type to jsonb.

/**
 * @var array
 *
 * @ORM\Column(type="json", nullable=true, options={"jsonb": true})
 */
private $metaData;

Note: If you want to use these DQL functions on an existing json field, you will have to alter its column type (running make:migration after adding options={"jsonb": true} will not be enough). This migration is an example of how you can do it:

<?php

declare(strict_types=1);

namespace DoctrineMigrations;

use Doctrine\DBAL\Schema\Schema;
use Doctrine\Migrations\AbstractMigration;

final class VersionXXX extends AbstractMigration
{
    public function up(Schema $schema): void
    {
        $this->addSql('ALTER TABLE "user" ALTER COLUMN roles SET DATA TYPE jsonb');
    }

    public function down(Schema $schema): void
    {
        $this->addSql('ALTER TABLE "user" ALTER COLUMN roles SET DATA TYPE json');
    }
}
Custom Name PostgreSql Usage in DQL Result in SQL
CONTAINS @> CONTAINS(field, :param) (field @> '{value}')
CONTAINED <@ CONTAINED(field, :param) (field <@ '{value}')
GET_JSON_FIELD ->> GET_JSON_FIELD(field, 'json_field') (table_field->>'json_field')
GET_JSON_FIELD_BY_KEY -> GET_JSON_FIELD_BY_KEY(field, 'json_field') (table_field->'json_field')
GET_JSON_OBJECT #> GET_JSON_OBJECT(field, 'json_field') (table_field#>'json_field')
GET_JSON_OBJECT_TEXT #>> GET_JSON_OBJECT_TEXT(field, 'json_field') (table_field#>>'json_field')
ANY_OP ANY ANY_OP(field) ANY(field)
ALL_OP ALL ALL_OP(field) ALL(field)
ARR ARRAY ARR(field) ARRAY[field]
ARR_AGGREGATE array_agg ARR_AGGREGATE(field) array_agg(field)
ARR_APPEND array_append ARR_APPEND(field, :param) array_append(field, param)
ARR_REPLACE array_replace ARR_REPLACE(field, :param1, :param2) array_replace(field, p1, p2)
REGEXP_REPLACE regexp_replace REGEXP_REPLACE(field, :param1, :param2) regexp_replace(field, p1, p2)
ARR_REMOVE array_remove ARR_REMOVE(field, :param) array_remove(field, param)
ARR_CONTAINS && ARR_CONTAINS(field, :param) (field && param)
TO_TSQUERY to_tsquery TO_TSQUERY(:param) to_tsquery('param')
TO_TSVECTOR to_tsvector TO_TSVECTOR(field) to_tsvector(field)
TS_MATCH_OP @@ TS_MATCH_OP(expr1, expr2) expr1 @@ expr2
TS_CONCAT_OP
UNNEST UNNEST UNNEST(field) UNNEST(field)
JSON_AGG json_agg JSON_AGG(expression) json_agg(expression)
JSONB_ARRAY_ELEM_TEXT jsonb_array_elements_text JSONB_ARRAY_ELEM_TEXT(field, 'json_field') jsonb_array_elements_text(field)

最近版本更新:(数据更新于 2024-09-15 06:01:05)

2024-02-20 20:11:39 v2.0.0

2023-07-04 17:32:18 v1.2.0

2023-06-07 20:38:34 v1.1.0

2022-09-18 01:41:12 v1.0.0

2022-03-15 18:06:59 1.0.0-rc1

2018-06-12 04:18:55 v0.8.1

2018-02-07 04:43:54 v0.8.0

2017-08-23 15:24:03 v0.7.4

2015-08-06 01:44:13 v0.7.1

2015-07-30 00:27:01 v0.7.0

主题(topics):

dbal, doctrine, opsway-opensource, php, postgresql

opsway/doctrine-dbal-postgresql同语言 PHP最近更新仓库

2024-11-01 18:37:36 schmittjoh/JMSSerializerBundle

2024-10-31 21:37:53 filamentphp/filament

2024-10-28 00:16:41 symfony/var-dumper

2024-10-28 00:11:41 symfony/symfony

2024-10-11 23:44:26 coollabsio/coolify

2024-10-11 03:27:29 odan/slim4-skeleton