You are browsing a version that is no longer maintained.
Maintained
2.15 (upcoming) 2.14.0 (current)
Unmaintained
2.13 2.12 2.11 2.10 2.9 2.8 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0 1.3 1.2 1.1 1.0

Slave Okay Queries

slaveOkay was deprecated in 1.2 - please use Read Preference instead.

Documents

You can configure an entire document to send all reads to the slaves by using the slaveOkay flag:

<?php/** @Document(slaveOkay=true) */class User{    /** @Id */    private $id;}

Now all reads involving the User document will be sent to a slave.

Queries

If you want to instruct individual queries to read from a slave you can use the slaveOkay() method on the query builder.

<?php$qb = $dm->createQueryBuilder('User')    ->slaveOkay(true);$query = $qb->getQuery();$users = $query->execute();

The data in the query above will be read from a slave. Even if you have a @ReferenceOne or @ReferenceMany resulting from the query above it will be initialized and loaded from a slave.

<?php/** @Document */class User{    /** @ReferenceMany(targetDocument="Account") */    private $accounts;}

Now when you query and iterate over the accounts, they will be loaded from a slave:

<?php$qb = $dm->createQueryBuilder('User')    ->slaveOkay(true);$query = $qb->getQuery();$users = $query->execute();foreach ($users as $user) {    foreach ($user->getAccounts() as $account) {        echo $account->getName();    }}