QueryBuilder IndexBy not indexing a result set #7288

New Issue

Open

opened 2026-01-22 15:49:16 +01:00 by admin · 16 comments

admin commented 2026-01-22 15:49:16 +01:00

Owner

Copy Link

Originally created by @SergeC on GitHub (Dec 23, 2023).

Bug Report

Q	A
BC Break	yes
Version	2.17.2

Summary

QueryBuilder ignores indexBy argument and returns the result set indexed by PHP's array-keys.

Current behavior

QueryBuilder returns the result set indexed by PHP's array-keys.

How to reproduce

/* @var EntityRepository $this */
$this
            ->createQueryBuilder(alias: 'j', indexBy: 'j.id')
            ->select('j.value')
            ->andWhere('j.enabled = true')
            ->setMaxResults(10)
            ->getQuery()
            ->getSingleColumnResult();

Expected behavior

QueryBuilder should return the result set indexed by values in the database, specified in the 2nd argument to createQueryBuilder.

Installed dependencies:

doctrine/cache                        2.2.0   PHP Doctrine Cache library is a popular cache implementation that supports many different drivers such as redis, memcache, apc, mongodb and others.
doctrine/collections                  2.1.4   PHP Doctrine Collections library that adds additional functionality on top of PHP arrays.
doctrine/common                       3.4.3   PHP Doctrine Common project is a library that provides additional functionality that other Doctrine projects depend on such as better reflection support, proxies and much more.
doctrine/dbal                         3.7.2   Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management.
doctrine/deprecations                 1.1.2   A small layer on top of trigger_error(E_USER_DEPRECATED) or PSR-3 logging with options to disable all deprecations or selectively for packages.
doctrine/doctrine-bundle              2.11.1  Symfony DoctrineBundle
doctrine/doctrine-migrations-bundle   3.3.0   Symfony DoctrineMigrationsBundle
doctrine/event-manager                2.0.0   The Doctrine Event Manager is a simple PHP event system that was built to be used with the various Doctrine projects.
doctrine/inflector                    2.0.8   PHP Doctrine Inflector is a small library that can perform string manipulations with regard to upper/lowercase and singular/plural forms of words.
doctrine/instantiator                 2.0.0   A small, lightweight utility to instantiate objects in PHP without invoking their constructors
doctrine/lexer                        2.1.0   PHP Doctrine Lexer parser library that can be used in Top-Down, Recursive Descent Parsers.
doctrine/migrations                   3.7.2   PHP Doctrine Migrations project offer additional functionality on top of the database abstraction layer (DBAL) for versioning your database schema and easily deploying changes to it. It is a very easy to us...
doctrine/orm                          2.17.2  Object-Relational-Mapper for PHP
doctrine/persistence                  3.2.0   The Doctrine Persistence project is a set of shared interfaces and functionality that the different Doctrine object mappers share.
doctrine/sql-formatter                1.1.3   a PHP SQL highlighting library

Actual result:

Expected result:

Originally created by @SergeC on GitHub (Dec 23, 2023). ### Bug Report <!-- Fill in the relevant information below to help triage your issue. --> | Q | A |------------ | ------ | BC Break | yes | Version | 2.17.2 #### Summary QueryBuilder ignores indexBy argument and returns the result set indexed by PHP's array-keys. #### Current behavior QueryBuilder returns the result set indexed by PHP's array-keys. #### How to reproduce ```PHP /* @var EntityRepository $this */ $this ->createQueryBuilder(alias: 'j', indexBy: 'j.id') ->select('j.value') ->andWhere('j.enabled = true') ->setMaxResults(10) ->getQuery() ->getSingleColumnResult(); ``` #### Expected behavior QueryBuilder should return the result set indexed by values in the database, specified in the 2nd argument to `createQueryBuilder`. Installed dependencies: ``` doctrine/cache 2.2.0 PHP Doctrine Cache library is a popular cache implementation that supports many different drivers such as redis, memcache, apc, mongodb and others. doctrine/collections 2.1.4 PHP Doctrine Collections library that adds additional functionality on top of PHP arrays. doctrine/common 3.4.3 PHP Doctrine Common project is a library that provides additional functionality that other Doctrine projects depend on such as better reflection support, proxies and much more. doctrine/dbal 3.7.2 Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management. doctrine/deprecations 1.1.2 A small layer on top of trigger_error(E_USER_DEPRECATED) or PSR-3 logging with options to disable all deprecations or selectively for packages. doctrine/doctrine-bundle 2.11.1 Symfony DoctrineBundle doctrine/doctrine-migrations-bundle 3.3.0 Symfony DoctrineMigrationsBundle doctrine/event-manager 2.0.0 The Doctrine Event Manager is a simple PHP event system that was built to be used with the various Doctrine projects. doctrine/inflector 2.0.8 PHP Doctrine Inflector is a small library that can perform string manipulations with regard to upper/lowercase and singular/plural forms of words. doctrine/instantiator 2.0.0 A small, lightweight utility to instantiate objects in PHP without invoking their constructors doctrine/lexer 2.1.0 PHP Doctrine Lexer parser library that can be used in Top-Down, Recursive Descent Parsers. doctrine/migrations 3.7.2 PHP Doctrine Migrations project offer additional functionality on top of the database abstraction layer (DBAL) for versioning your database schema and easily deploying changes to it. It is a very easy to us... doctrine/orm 2.17.2 Object-Relational-Mapper for PHP doctrine/persistence 3.2.0 The Doctrine Persistence project is a set of shared interfaces and functionality that the different Doctrine object mappers share. doctrine/sql-formatter 1.1.3 a PHP SQL highlighting library ``` Actual result:  Expected result: 

admin commented 2026-01-22 15:49:17 +01:00

Author

Owner

Copy Link

@greg0ire commented on GitHub (Dec 23, 2023):

Assuming $this is an entityrepository instance, createQueryBuilder already calls select internally. With your call, you're replacing that select, making sure j.id is no longer selected.

@greg0ire commented on GitHub (Dec 23, 2023): Assuming `$this` is an entityrepository instance, `createQueryBuilder` already calls `select` internally. With your call, you're replacing that select, making sure `j.id` is no longer selected.

admin commented 2026-01-22 15:49:17 +01:00

Author

Owner

Copy Link

@SergeC commented on GitHub (Dec 23, 2023):

In this use-case, I fetch only one column. Which means I need to specify it in select. Doctrine should automatically add indexing column to select statement. Even when I add indexing column to select - nothing changes.

@SergeC commented on GitHub (Dec 23, 2023): In this use-case, I fetch only one column. Which means I need to specify it in select. Doctrine should automatically add indexing column to select statement. Even when I add indexing column to select - nothing changes.  

admin commented 2026-01-22 15:49:17 +01:00

Author

Owner

Copy Link

@greg0ire commented on GitHub (Dec 23, 2023):

Huh, I did not expect that. Maybe it has to do with getSingleColumnResult() . Can you try other possibilities?

@greg0ire commented on GitHub (Dec 23, 2023): Huh, I did not expect that. Maybe it has to do with `getSingleColumnResult()` . Can you try other possibilities?

admin commented 2026-01-22 15:49:17 +01:00

Author

Owner

Copy Link

@SergeC commented on GitHub (Dec 23, 2023):

@SergeC commented on GitHub (Dec 23, 2023):  

admin commented 2026-01-22 15:49:18 +01:00

Author

Owner

Copy Link

@greg0ire commented on GitHub (Dec 23, 2023):

I meant with j.id selected

@greg0ire commented on GitHub (Dec 23, 2023): I meant with `j.id` selected

admin commented 2026-01-22 15:49:18 +01:00

Author

Owner

Copy Link

@SergeC commented on GitHub (Dec 24, 2023):

This adds id to the result set along with array keys.

@SergeC commented on GitHub (Dec 24, 2023):  This adds id to the result set along with array keys.

admin commented 2026-01-22 15:49:19 +01:00

Author

Owner

Copy Link

@greg0ire commented on GitHub (Dec 24, 2023):

Okay. This means this issue really is about index by + getSingleColumnResult.

@greg0ire commented on GitHub (Dec 24, 2023): Okay. This means this issue really is about index by + `getSingleColumnResult`.

admin commented 2026-01-22 15:49:19 +01:00

Author

Owner

Copy Link

@beberlei commented on GitHub (Dec 26, 2023):

I dont understand, where is index by configured here? Maybe i missef it, but this is only a non entity query here, getSingleColumnResult has no index by behavior afair

@beberlei commented on GitHub (Dec 26, 2023): I dont understand, where is index by configured here? Maybe i missef it, but this is only a non entity query here, getSingleColumnResult has no index by behavior afair

admin commented 2026-01-22 15:49:19 +01:00

Author

Owner

Copy Link

@greg0ire commented on GitHub (Dec 26, 2023):

The second argument of EntityRepository::createQueryBuilder() configures it:

f80ef66ffb/lib/Doctrine/ORM/EntityRepository.php (L76-L89)

@greg0ire commented on GitHub (Dec 26, 2023): The second argument of `EntityRepository::createQueryBuilder()` configures it: https://github.com/doctrine/orm/blob/f80ef66ffb68bfa842071e2d818e87a07a2d014e/lib/Doctrine/ORM/EntityRepository.php#L76-L89

admin commented 2026-01-22 15:49:20 +01:00

Author

Owner

Copy Link

@SergeC commented on GitHub (Feb 5, 2024):

@greg0ire @beberlei Any update on this? Any other info needed from my side?

@SergeC commented on GitHub (Feb 5, 2024): @greg0ire @beberlei Any update on this? Any other info needed from my side?

admin commented 2026-01-22 15:49:20 +01:00

Author

Owner

Copy Link

@jurchiks commented on GitHub (Jun 17, 2024):

I just stumbled upon this, good thing I decided to google it.
It is stupid that something like this happens; one would think that indexBy is added implicitly regardless of what the user does with select(), because it is REQUIRED by the code. It should NOT be overridable by user.

I was wondering why my "account balance mapped by account ID" query was returning 0-indexed results, made no goddamn sense, and the subsequent code was clearly doing the wrong thing, when it absolutely shouldn't have. Turns out the problem wasn't in my code, but in Doctrine being dumb yet again... Such an overcomplicated mass of code, and yet.

@jurchiks commented on GitHub (Jun 17, 2024): I just stumbled upon this, good thing I decided to google it. It is stupid that something like this happens; one would think that `indexBy` is added implicitly regardless of what the user does with `select()`, because it is REQUIRED by the code. It should NOT be overridable by user. I was wondering why my "account balance mapped by account ID" query was returning 0-indexed results, made no goddamn sense, and the subsequent code was clearly doing the wrong thing, when it absolutely shouldn't have. Turns out the problem wasn't in my code, but in Doctrine being dumb yet again... Such an overcomplicated mass of code, and yet.

admin commented 2026-01-22 15:49:20 +01:00

Author

Owner

Copy Link

@rasstislav commented on GitHub (Sep 19, 2024):

@greg0ire Hello. Anything new on this issue?

@rasstislav commented on GitHub (Sep 19, 2024): @greg0ire Hello. Anything new on this issue?

admin commented 2026-01-22 15:49:20 +01:00

Author

Owner

Copy Link

@greg0ire commented on GitHub (Sep 19, 2024):

@rasstislav not as far as I can tell. Do you want to work on a fix?

@greg0ire commented on GitHub (Sep 19, 2024): @rasstislav not as far as I can tell. Do you want to work on a fix?

admin commented 2026-01-22 15:49:20 +01:00

Author

Owner

Copy Link

@Asenar commented on GitHub (Nov 29, 2024):

Hi @greg0ire , I have the same issue and I would like to contribute, but I'm not sure where to begin.

Is it a good start to write the test in BasicFunctionalTest ?

<?php

class BasicFunctionalTest {

    // …
    
    public function testSingleColumnIndexedByPrimaryKeyQuery(): void
    {

        $asenar           = new CmsUser();
        $asenar->name     = 'Michaël';
        $asenar->username = 'asenar';
        $this->_em->persist($asenar);
        $this->_em->flush();
        $query = $this->_em->createQuery('select u.name from Doctrine\Tests\Models\CMS\CmsUser u INDEX BY u.username');
        $users = $query->getSingleColumnResult();
        self::assertCount(1, $users);
        self::assertSame(['asenar' => 'Michaël'], $users);
    }
}

@Asenar commented on GitHub (Nov 29, 2024): Hi @greg0ire , I have the same issue and I would like to contribute, but I'm not sure where to begin. Is it a good start to write the test in BasicFunctionalTest ? ```php <?php class BasicFunctionalTest { // … public function testSingleColumnIndexedByPrimaryKeyQuery(): void { $asenar = new CmsUser(); $asenar->name = 'Michaël'; $asenar->username = 'asenar'; $this->_em->persist($asenar); $this->_em->flush(); $query = $this->_em->createQuery('select u.name from Doctrine\Tests\Models\CMS\CmsUser u INDEX BY u.username'); $users = $query->getSingleColumnResult(); self::assertCount(1, $users); self::assertSame(['asenar' => 'Michaël'], $users); } } ```

admin commented 2026-01-22 15:49:21 +01:00

Author

Owner

Copy Link

@greg0ire commented on GitHub (Nov 29, 2024):

Yes, it's a good start 👍

@greg0ire commented on GitHub (Nov 29, 2024): Yes, it's a good start 👍

admin commented 2026-01-22 15:49:21 +01:00

Author

Owner

Copy Link

@Arkemlar commented on GitHub (Oct 25, 2025):

Having to add array_column() cycle on the result dataset because of this, not too cool workaround because it is not OK to do so with large datasets.

@Arkemlar commented on GitHub (Oct 25, 2025): Having to add array_column() cycle on the result dataset because of this, not too cool workaround because it is not OK to do so with large datasets.

admin referenced this issue 2026-01-22 16:07:25 +01:00

[PR #7288] Fix of variable typo in cache usage example #10402

admin referenced this issue 2026-01-22 16:09:56 +01:00

[PR #8790] Backport docs batch #11173

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

3.6.x

2.20.x

dependabot/github_actions/2.20.x/doctrine/dot-github/dot-github/workflows/composer-lint.yml-14.0.0

3.7.x

4.0.x

2.21.x

old-prototype-3.x

3.6.2

3.6.1

3.6.0

2.20.9

3.5.8

3.5.7

3.5.6

3.5.5

2.20.8

3.5.4

3.5.3

2.20.7

3.5.2

2.20.6

3.5.1

3.5.0

3.4.4

3.4.3

3.4.2

2.20.5

3.4.1

3.4.0

3.3.4

2.20.4

3.3.3

2.20.3

3.3.2

2.20.2

3.3.1

2.20.1

3.3.0

3.2.3

2.20.0

2.19.8

3.2.2

2.19.7

3.2.1

2.19.6

3.2.0

3.1.4

3.1.3

2.19.5

3.1.2

2.19.4

3.1.1

2.19.3

2.19.2

2.19.1

3.1.0

2.19.0

3.0.3

2.18.3

3.0.2

2.18.2

3.0.1

2.18.1

3.0.0

2.18.0

2.17.5

3.0.0-RC1

2.17.4

2.17.3

2.17.2

2.17.1

3.0.0-beta2

2.17.0

2.16.3

3.0.0-beta1

2.16.2

2.16.1

2.16.0

2.15.5

2.15.4

2.15.3

2.15.2

2.15.1

2.15.0

2.14.3

2.14.2

2.14.1

2.14.0

2.13.5

2.13.4

2.13.3

2.13.2

2.13.1

2.13.0

2.12.4

2.12.3

2.12.2

2.12.1

2.12.0

2.11.3

2.11.2

2.11.1

2.11.0

2.10.5

2.10.4

2.10.3

2.10.2

2.10.1

2.10.0

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.5

2.7.4

v2.7.3

v2.7.2

v2.7.1

v2.7.0

v2.6.6

v2.6.5

v2.6.4

v2.6.3

v2.6.2

v2.6.1

v2.6.0

v2.5.14

v2.5.13

v2.5.12

v2.5.11

v2.5.10

v2.5.9

v2.5.8

v2.5.7

v2.5.6

v2.5.5

v2.5.4

v2.5.3

v2.5.2

v2.4.8

v2.5.1

v2.5.0

v2.5.0-RC2

v2.5.0-RC1

v2.5.0-beta1

v2.5.0-alpha2

v2.5.0-alpha1

v2.4.7

v2.4.6

v2.4.5

v2.4.4

v2.4.3

v2.3.6

v2.4.2

2.3.5

v2.4.1

v2.4.0

2.4.0-RC2

2.4.0-RC1

2.4.0-BETA2

2.3.4

2.3.3

2.4.0-BETA1

2.3.2

2.3.1

2.3.0

2.3.0-RC4

2.3.0-RC3

2.3.0-RC2

2.2.3

2.3.0-RC1

2.3.0-BETA1

2.1.7

2.2.2

2.2.1

2.1.6

2.2.0

2.2.0-RC1

2.2.0-BETA2

2.2.0-BETA1

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.0.7

2.1.0

2.1.0RC3

2.1.0RC2

2.1.0RC1

2.0.6

2.1.0BETA1

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

2.0.0RC2

2.0.0RC1

2.0.0-BETA4

2.0.0-BETA3

2.0.0-BETA2

2.0.0-BETA1

Labels

Clear labels

BC Break

Bug

Can't Fix

Deprecation

Documentation

DQL

Duplicate

Failing Test

Hacktoberfest

Improvement

Improvement

Incomplete

Invalid

Missing Tests

New Feature

PR Created

pull-request

Mirrored from GitHub Pull Request

Question

Regression

Status: Waiting feedback

Waiting feedback

WIP

Won't Fix

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

admin

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: doctrine/archived-orm#7288