PHPackages                             tugmaks/doctrine-walkers - 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. [Database & ORM](/categories/database)
4. /
5. tugmaks/doctrine-walkers

ActiveLibrary[Database & ORM](/categories/database)

tugmaks/doctrine-walkers
========================

Set of doctrine walkers

2.5(1mo ago)024MITPHPPHP ^8.2CI passing

Since Nov 9Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/tugmaks/doctrine-walkers)[ Packagist](https://packagist.org/packages/tugmaks/doctrine-walkers)[ RSS](/packages/tugmaks-doctrine-walkers/feed)WikiDiscussions master Synced yesterday

READMEChangelog (10)Dependencies (43)Versions (15)Used By (0)

[![codecov](https://camo.githubusercontent.com/c5455f6526295a185d978026884a15a9935eeacd916fc5f15f432b435432dd72/68747470733a2f2f636f6465636f762e696f2f67682f7475676d616b732f646f637472696e652d77616c6b6572732f67726170682f62616467652e7376673f746f6b656e3d34595841303035395154)](https://codecov.io/gh/tugmaks/doctrine-walkers)

Doctrine walkers
================

[](#doctrine-walkers)

A collection of custom Doctrine ORM output walkers for commonly used SQL clauses. Each walker can be applied per-query via a query hint without modifying your entities or repository code.

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

[](#installation)

```
composer require tugmaks/doctrine-walkers
```

Walkers
-------

[](#walkers)

- [Distinct on](#distinct-on-walker)
- [Locking](#locking-walker)
- [Nulls](#nulls-walker)
- [Returning](#returning-walker)
- [Tablesample](#tablesample-walker)
- [With ties](#with-ties-walker)

---

Distinct on walker
------------------

[](#distinct-on-walker)

Adds a `DISTINCT ON (expr)` clause to the `SELECT` based on the hint — a PostgreSQL-only feature that keeps only one row per unique value of the specified expression.

### Example via DQL

[](#example-via-dql)

```
$query = $this->entityManager->createQuery('SELECT u FROM App\Entity\User u ORDER BY u.name DESC');

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, DistinctOnWalker::class);
$query->setHint(DistinctOnWalker::DISTINCT_ON, ['u.name']);

$query->getSQL();
```

or

### Example via QueryBuilder

[](#example-via-querybuilder)

```
$query = $this->entityManager->createQueryBuilder()
    ->select('u')
    ->from(User::class, 'u')
    ->orderBy('u.name', 'DESC')
    ->getQuery();

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, DistinctOnWalker::class);
$query->setHint(DistinctOnWalker::DISTINCT_ON, ['u.name']);

$query->getSQL();
```

**Generated SQL:**

```
SELECT DISTINCT ON (u0_.name) u0_.id AS id_0, u0_.name AS name_1 FROM users u0_ ORDER BY u0_.name DESC
```

---

Locking walker
--------------

[](#locking-walker)

Adds a `FOR UPDATE` clause with configurable lock strength and options (`SKIP LOCKED`, `NOWAIT`). Useful for pessimistic locking.

### Example via DQL

[](#example-via-dql-1)

```
$query = $this->entityManager->createQuery('SELECT u FROM App\Entity\User u WHERE id = 1');

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, LockingWalker::class);
$query->setHint(LockingWalker::LOCKING_CLAUSE, new LockingClause(LockStrength::UPDATE, Option::SKIP_LOCKED));

$query->getSQL();
```

or

### Example via QueryBuilder

[](#example-via-querybuilder-1)

```
$query = $this->entityManager->createQueryBuilder()
    ->select('u')
    ->from(User::class, 'u')
    ->where('u.id = 1')
    ->getQuery();

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, LockingWalker::class);
$query->setHint(LockingWalker::LOCKING_CLAUSE, new LockingClause(LockStrength::UPDATE, Option::SKIP_LOCKED));

$query->getSQL();
```

**Generated SQL:**

```
SELECT u0_.id AS id_0, u0_.name AS name_1 FROM users u0_ WHERE u0_.id = 1 FOR UPDATE SKIP LOCKED
```

---

NULLS walker
------------

[](#nulls-walker)

Adds `NULLS FIRST` / `NULLS LAST` to `ORDER BY` clauses. Useful for controlling null sorting order in PostgreSQL.

### Example via DQL

[](#example-via-dql-2)

```
$query = $this->entityManager->createQuery('SELECT u FROM App\Entity\User u ORDER BY u.name DESC');

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, NullsWalker::class);
$query->setHint(NullsWalker::NULLS_RULE, ['u.name' => NULLS::LAST]);

$query->getSQL();
```

or

### Example via QueryBuilder

[](#example-via-querybuilder-2)

```
$query = $this->entityManager->createQueryBuilder()
    ->select('u')
    ->from(User::class, 'u')
    ->orderBy('u.name', 'DESC')
    ->getQuery();

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, NullsWalker::class);
$query->setHint(NullsWalker::NULLS_RULE, ['u.name' => NULLS::LAST]);

$query->getSQL();
```

**Generated SQL:**

```
SELECT u0_.id AS id_0, u0_.name AS name_1 FROM users u0_ ORDER BY u0_.name DESC NULLS LAST
```

---

RETURNING walker
----------------

[](#returning-walker)

Adds a `RETURNING` clause to DQL queries (`SELECT`/`UPDATE`/`DELETE`). Useful when you need to return data from modified rows (PostgreSQL).

Accepts `'*'` (all columns) or an array of specific column names, e.g. `['id', 'name']`.

### SELECT

[](#select)

#### Example via DQL

[](#example-via-dql-3)

```
$query = $this->entityManager->createQuery('SELECT u FROM App\Entity\User u WHERE u.id = 1');

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, ReturningWalker::class);
$query->setHint(ReturningWalker::RETURNING_CLAUSE, new ReturningClause('*'));

$query->getSQL();
```

or

#### Example via QueryBuilder

[](#example-via-querybuilder-3)

```
$query = $this->entityManager->createQueryBuilder()
    ->select('u')
    ->from(User::class, 'u')
    ->where('u.id = 1')
    ->getQuery();

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, ReturningWalker::class);
$query->setHint(ReturningWalker::RETURNING_CLAUSE, new ReturningClause());

$query->getSQL();
```

**Generated SQL:**

```
SELECT u0_.id AS id_0, u0_.name AS name_1 FROM users u0_ WHERE u0_.id = 1 RETURNING *
```

### UPDATE

[](#update)

#### Example via DQL

[](#example-via-dql-4)

```
$query = $this->entityManager->createQuery("UPDATE App\Entity\User u SET u.name = 'new' WHERE u.id = 1");

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, ReturningWalker::class);
$query->setHint(ReturningWalker::RETURNING_CLAUSE, new ReturningClause(['id', 'name']));

$query->getSQL();
```

or

#### Example via QueryBuilder

[](#example-via-querybuilder-4)

```
$query = $this->entityManager->createQueryBuilder()
    ->update(User::class, 'u')
    ->set('u.name', ':name')
    ->where('u.id = :id')
    ->setParameter('name', 'new')
    ->setParameter('id', 1)
    ->getQuery();

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, ReturningWalker::class);
$query->setHint(ReturningWalker::RETURNING_CLAUSE, new ReturningClause(['id', 'name']));

$query->getSQL();
```

**Generated SQL:**

```
UPDATE users SET name = 'new' WHERE id = 1 RETURNING id, name
```

### DELETE

[](#delete)

#### Example via DQL

[](#example-via-dql-5)

```
$query = $this->entityManager->createQuery('DELETE App\Entity\User u WHERE u.id = 1');

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, ReturningWalker::class);
$query->setHint(ReturningWalker::RETURNING_CLAUSE, new ReturningClause());

$query->getSQL();
```

or

#### Example via QueryBuilder

[](#example-via-querybuilder-5)

```
$query = $this->entityManager->createQueryBuilder()
    ->delete(User::class, 'u')
    ->where('u.id = :id')
    ->setParameter('id', 1)
    ->getQuery();

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, ReturningWalker::class);
$query->setHint(ReturningWalker::RETURNING_CLAUSE, new ReturningClause());

$query->getSQL();
```

**Generated SQL:**

```
DELETE FROM users WHERE id = 1 RETURNING *
```

---

Tablesample walker
------------------

[](#tablesample-walker)

Adds a `TABLESAMPLE` clause to the `FROM` clause with support for `BERNOULLI` and `SYSTEM` sampling methods. Useful for sampling rows randomly.

### Example via DQL

[](#example-via-dql-6)

```
$query = $this->entityManager->createQuery('SELECT u FROM App\Entity\User u ORDER BY u.name DESC');

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, TablesampleWalker::class);
$query->setHint(TablesampleWalker::TABLESAMPLE_RULE, [User::class => new Tablesample(TablesampleMethod::BERNOULLI, 0.1) ]);

$query->getSQL();
```

or

### Example via QueryBuilder

[](#example-via-querybuilder-6)

```
$query = $this->entityManager->createQueryBuilder()
    ->select('u')
    ->from(User::class, 'u')
    ->orderBy('u.name', 'DESC')
    ->getQuery();

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, TablesampleWalker::class);
$query->setHint(TablesampleWalker::TABLESAMPLE_RULE, [User::class => new Tablesample(TablesampleMethod::BERNOULLI, 0.1)]);

$query->getSQL();
```

**Generated SQL:**

```
SELECT u0_.id AS id_0, u0_.name AS name_1 FROM users u0_ TABLESAMPLE BERNOULLI(0.1) ORDER BY u0_.name DESC
```

---

`WITH TIES` walker
------------------

[](#with-ties-walker)

Replaces `LIMIT` / `OFFSET` with SQL standard `FETCH NEXT ... ROWS WITH TIES`. Useful for pagination that includes ties.

### Example via DQL

[](#example-via-dql-7)

```
$query = $this->entityManager->createQuery('SELECT u FROM App\Entity\User u ORDER BY u.name DESC')->setMaxResults(5);

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, WithTiesWalker::class);

$query->getSQL();
```

or

### Example via QueryBuilder

[](#example-via-querybuilder-7)

```
$query = $this->entityManager->createQueryBuilder()
    ->select('u')
    ->from(User::class, 'u')
    ->orderBy('u.name', 'DESC')
    ->getQuery()
    ->setMaxResults(5);

$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, WithTiesWalker::class);

$query->getSQL();
```

**Generated SQL:**

```
SELECT u0_.id AS id_0, u0_.name AS name_1 FROM users u0_ ORDER BY u0_.name DESC FETCH NEXT 5 ROWS WITH TIES
```

###  Health Score

45

—

FairBetter than 91% of packages

Maintenance93

Actively maintained with recent releases

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity63

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 ~103 days

Recently: every ~87 days

Total

10

Last Release

33d ago

Major Versions

1.3 → 2.02025-02-01

PHP version history (2 changes)1.0PHP ^8.1

2.1PHP ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/c3c489ffecb0524e5825675ae8a5d14cec43b2264b750c8a04e8674f9b3ce422?d=identicon)[tugmaks](/maintainers/tugmaks)

---

Top Contributors

[![tugmaks](https://avatars.githubusercontent.com/u/3036462?v=4)](https://github.com/tugmaks "tugmaks (52 commits)")

---

Tags

doctrinetablesampledoctrine walkeroutput walkerskip lockednulls lastnulls firstwith tiesreturning

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan, Rector

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/tugmaks-doctrine-walkers/health.svg)

```
[![Health](https://phpackages.com/badges/tugmaks-doctrine-walkers/health.svg)](https://phpackages.com/packages/tugmaks-doctrine-walkers)
```

###  Alternatives

[easycorp/easyadmin-bundle

Admin generator for Symfony applications

4.3k17.9M388](/packages/easycorp-easyadmin-bundle)[laravel-doctrine/orm

An integration library for Laravel and Doctrine ORM

8465.5M96](/packages/laravel-doctrine-orm)[rcsofttech/audit-trail-bundle

Enterprise-grade, high-performance Symfony audit trail bundle. Automatically track Doctrine entity changes with split-phase architecture, multiple transports (HTTP, Queue, Doctrine), and sensitive data masking.

1189.8k](/packages/rcsofttech-audit-trail-bundle)[2lenet/crudit-bundle

The easy like Crud'it Bundle.

1616.4k14](/packages/2lenet-crudit-bundle)[open-dxp/opendxp

Content & Product Management Framework (CMS/PIM)

9421.6k61](/packages/open-dxp-opendxp)[flow-php/doctrine-dbal-bulk

Bulk inserts and updates for Doctrine DBAL

14385.8k4](/packages/flow-php-doctrine-dbal-bulk)

PHPackages © 2026

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