Skip to content

docs: update README to reflect new features #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martin-georgiev merged 1 commit into from
Apr 11, 2025
Merged

docs: update README to reflect new features #341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ private array $tags;

// Use in DQL
$query = $em->createQuery('
SELECT e
FROM App\Entity\Post e
SELECT e
FROM App\Entity\Post e
WHERE CONTAINS(e.tags, ARRAY[:tags]) = TRUE
AND JSON_GET_FIELD(e.data, :field) = :value
');
Expand All @@ -37,13 +37,18 @@ This package provides comprehensive Doctrine support for PostgreSQL features:
### Data Types
- **Array Types**
- Integer arrays (`int[]`, `smallint[]`, `bigint[]`)
- Float arrays (`real[]`, `double precision[]`)
- Text arrays (`text[]`)
- Boolean arrays (`bool[]`)
- JSONB arrays (`jsonb[]`)
- **JSON Types**
- Native JSONB support
- JSON field operations
- JSON construction and manipulation
- **Network Types**
- IP addresses (`inet`, `inet[]`)
- Network CIDR notation (`cidr`, `cidr[]`)
- MAC addresses (`macaddr`, `macaddr[]`)

### PostgreSQL Operators
- **Array Operations**
Expand All @@ -63,13 +68,15 @@ This package provides comprehensive Doctrine support for PostgreSQL features:
- Regular expressions
- **Array Functions**
- Array aggregation (`array_agg`)
- Array manipulation (`array_append`, `array_prepend`)
- Array manipulation (`array_append`, `array_prepend`, `array_remove`, `array_replace`, `array_shuffle`)
- Array dimensions and length
- **JSON Functions**
- JSON construction (`json_build_object`, `jsonb_build_object`)
- JSON manipulation and transformation
- **Date Functions**
- **Aggregate Functions**
- Aggregation with ordering and distinct (`array_agg`, `json_agg`, `jsonb_agg`)
- Special aggregates (`any_value`, `xmlagg`)

Full documentation:
- [Available Types](docs/AVAILABLE-TYPES.md)
Expand Down
Loading