Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opsway/doctrine-dbal-postgresql
Add JSON query support to Doctrine DBAL and DQL
https://github.com/opsway/doctrine-dbal-postgresql
dbal doctrine opsway-opensource php postgresql
Last synced: 2 months ago
JSON representation
Add JSON query support to Doctrine DBAL and DQL
- Host: GitHub
- URL: https://github.com/opsway/doctrine-dbal-postgresql
- Owner: opsway
- License: mit
- Created: 2015-04-04T21:39:09.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-20T12:11:38.000Z (4 months ago)
- Last Synced: 2024-03-20T17:50:19.936Z (3 months ago)
- Topics: dbal, doctrine, opsway-opensource, php, postgresql
- Language: PHP
- Size: 115 KB
- Stars: 152
- Watchers: 49
- Forks: 36
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-doctrine - Doctrine DBAL Postgresql - Add JSON query support to Doctrine DBAL and DQL (Related Projects)
README
doctrine-dbal-postgresql
=========================
[](https://packagist.org/packages/opsway/doctrine-dbal-postgresql) [](https://packagist.org/packages/opsway/doctrine-dbal-postgresql) [](https://packagist.org/packages/opsway/doctrine-dbal-postgresql)
This component allows you to manage some native [PostgreSQL](http://www.postgresql.org)
data types, operators and functions with the Doctrine [DBAL](http://www.doctrine-project.org/projects/dbal.html) component.
Usage
-----
Add to composer.json
```bash
php composer.phar require opsway/doctrine-dbal-postgresql ~0.8
```
To use the new types you should register them using the [Custom Mapping Types](https://doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html#custom-mapping-types) feature.
To use the new functions you should register them using the [DQL User Defined Functions](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/cookbook/dql-user-defined-functions.html) 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:
```php
$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
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 | || | TS_CONCAT_OP(expr1, expr2, ....) | (expr1 || expr2 || ...) |
| 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) |