PHPackages                             morebec/orkestra-postgresql-document-store - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. morebec/orkestra-postgresql-document-store

ActiveLibrary

morebec/orkestra-postgresql-document-store
==========================================

Orkestra Component allowing to easily use postgreSQL as a Document Store.

v2.5.6(3y ago)14181Apache-2.0PHPPHP >=7.4

Since Apr 26Pushed 3y ago1 watchersCompare

[ Source](https://github.com/Morebec/orkestra-postgresql-document-store)[ Packagist](https://packagist.org/packages/morebec/orkestra-postgresql-document-store)[ RSS](/packages/morebec-orkestra-postgresql-document-store/feed)WikiDiscussions 2.x Synced 1mo ago

READMEChangelogDependencies (8)Versions (23)Used By (1)

PostgreSQLDocumentStore
=======================

[](#postgresqldocumentstore)

Implementation of a Document Store using PostgreSQL's JSONB features. It is based on `doctrine/dbal` for accessing the database internally.

Installation
------------

[](#installation)

```
composer require morebec/orkestra-postgresql-document-store
```

Usage
-----

[](#usage)

The Document Store uses `doctrine/dbal` for accessing the database. Therefore, it requires a DBAL Connection as a constructor dependency. It also relies on a `ClockInterface` from the `morebec/orkestra-date-time`component in order to access the current date time.

```
use Doctrine\DBAL\Configuration;
use Doctrine\DBAL\DriverManager;
use Morebec\Orkestra\DateTime\SystemClock;
use Morebec\Orkestra\PostgreSqlDocumentStore\PostgreSqlDocumentStore;
use Morebec\Orkestra\PostgreSqlDocumentStore\PostgreSqlDocumentStoreConfiguration;

$connection = DriverManager::getConnection([
    'url' => '...'
], new Configuration());

$config = new PostgreSqlDocumentStoreConfiguration();
$clock = new SystemClock();
$store = new PostgreSqlDocumentStore($connection, $config, $clock);
```

The second parameter corresponds to the configuration of the DocumentStore. This configuration class can be used to alter the behaviour of the document store.

### Inserting Documents

[](#inserting-documents)

To insert a document in a collection:

```
/** @var Morebec\Orkestra\PostgreSqlDocumentStore\PostgreSqlDocumentStore $store */
$store->insertDocument('users', 'usr123456789', [
    'id' => 'usr123456789',
    'username' => 'jane.doe',
    'fullname' => 'Jane Doe',
    'emailAddress' => 'jane.doe@email.com'
]);
```

If the collection does not exist, it will be created automatically.

### Finding Documents

[](#finding-documents)

Finding elements can be performed using the `findOneDocument` and `findManyDocuments` methods of the document store. These methods accept either a string representing a PostgreSQL json query or a `Filter`which is a simple API for a query builder with the document store:

```
use Morebec\Orkestra\PostgreSqlDocumentStore\Filter\Filter;
use Morebec\Orkestra\PostgreSqlDocumentStore\Filter\FilterOperator;

$store->insertDocument('users', 'usr123456789', [
    'id' => 'usr123456789',
    'username' => 'jane.doe',
    'fullname' => 'Jane Doe',
    'emailAddress' => 'jane.doe@email.com',
    'preferredLanguage' => 'ENGLISH'
]);

// Finds a document by its ID.
$store->findOneDocument('users', Filter::findById('usr123456789'));

// Finds a document by a single field:
$store->findOneDocument('users', Filter::findByField('username', FilterOperator::EQUAL(), 'jane.doe'));

// Finds a document by a multiple criteria
$store->findOneDocument('users',
    Filter::where('username', FilterOperator::EQUAL(), 'jane.doe')
    ->or('preferredLanguage', FilterOperator::IS_NOT(), null)
);

// You can also use strings to have greater control over the query:
$store->findOneDocument('users', 'data->>fullname = \'Jane Doe\'');
```

> If you are using the `Filter` query builder, the values are automatically escaped using prepared statements placeholders. However if you are using a string for a query, the values will not be escaped, and you must make sure that you are not introducing potential loopholes for SQL Injections.

> Internally a column `data` with type `JSONB` is added to every created collection table. This is why if you are doing a string query, you must specify the `data` column.

> For even greater control, the document store exposes a `getConnection` method which returns the `DBAL` connection which you can use to make more complex queries using doctrine's Query Builder or raw connection.

### Updating Documents

[](#updating-documents)

To update a document, use the `updateDocument` method. This method does not support partial documents, and therefore overwrites the document in the store with the provided one:

```
use Morebec\Orkestra\PostgreSqlDocumentStore\PostgreSqlDocumentStore;

/** @var $store  PostgreSqlDocumentStore **/
$store->updateDocument('users', 'usr123456789', [
    'id' => 'usr123456789',
    'username' => 'jane.doe',
    'fullname' => 'Jane A. Doe',
    'emailAddress' => 'new.jane.doe@email.com',
    'preferredLanguage' => 'FRENCH'
]);
```

### Removing Documents

[](#removing-documents)

Removing a document can be done as follows:

```
use Morebec\Orkestra\PostgreSqlDocumentStore\PostgreSqlDocumentStore;

/** @var $store  PostgreSqlDocumentStore **/
$store->removeDocument('users', 'usr123456789');
```

### Changing table names prefix.

[](#changing-table-names-prefix)

In order to have better control over the collection tables it manages, the document store adds a prefix to any table that it creates.

This prefix can be configured in the document store configuration:

```
use Morebec\Orkestra\PostgreSqlDocumentStore\PostgreSqlDocumentStoreConfiguration;

$config = new PostgreSqlDocumentStoreConfiguration();

$config->collectionPrefix = 'you_prefix_';
```

### Transaction Management

[](#transaction-management)

If you need to use transactions for your operations, you can do this by accessing the DBAL connection:

```
$connection = $store->getConnection();

$connection->transactional(static function() use ($store) {
    $store->insertDocument('users', 'usr123456789', [
        'id' => 'usr123456789',
        'username' => 'jane.doe',
        'fullname' => 'Jane Doe',
        'emailAddress' => 'jane.doe@email.com',
        'preferredLanguage' => 'ENGLISH'
    ]);

    $store->insertDocument('users', 'usrABCDEFGHI', [
        'id' => 'usrABCDEFGHI',
        'username' => 'john.doe',
        'fullname' => 'John Doe',
        'emailAddress' => 'john.doe@email.com',
        'preferredLanguage' => 'SPANISH'
    ]);
});
```

Testing
-------

[](#testing)

To run the tests execute the following command:

```
vendor/bin/phpunit tests/
```

It is required to have an instance of postgresql running with a password-less role `postgres` and a database named `postgres`. To easily get this setup and running a `docker-compose` configuration file is available at the root of this project.

To run it simply execute the following command:

```
docker-compose up -d
```

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~33 days

Recently: every ~58 days

Total

22

Last Release

1134d ago

PHP version history (2 changes)2.0PHP >=7.3

v2.3.3PHP >=7.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/10d7f5561446f2d4df4413803946e9f77175155d241f78bd65c0dd94e6caffc5?d=identicon)[jwillp](/maintainers/jwillp)

---

Top Contributors

[![jwillp](https://avatars.githubusercontent.com/u/5913483?v=4)](https://github.com/jwillp "jwillp (1 commits)")

---

Tags

documentdocument-storejsonjsonborkestraphppostgresql

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/morebec-orkestra-postgresql-document-store/health.svg)

```
[![Health](https://phpackages.com/badges/morebec-orkestra-postgresql-document-store/health.svg)](https://phpackages.com/packages/morebec-orkestra-postgresql-document-store)
```

###  Alternatives

[sonata-project/entity-audit-bundle

Audit for Doctrine Entities

644989.8k1](/packages/sonata-project-entity-audit-bundle)[overtrue/laravel-versionable

Make Laravel model versionable.

585308.0k5](/packages/overtrue-laravel-versionable)[elgg/elgg

Elgg is an award-winning social networking engine, delivering the building blocks that enable businesses, schools, universities and associations to create their own fully-featured social networks and applications.

1.7k15.7k3](/packages/elgg-elgg)[neos/flow

Flow Application Framework

862.0M449](/packages/neos-flow)[neos/flow-development-collection

Flow packages in a joined repository for pull requests.

144179.3k3](/packages/neos-flow-development-collection)[rias/statamic-redirect

28298.4k](/packages/rias-statamic-redirect)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)