Skip to content
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

Jump to bottom

TASK: Update documentation to remove deprecated Doctrine connection #2371

Merged
merged 2 commits into from
Jan 4, 2021
Merged

TASK: Update documentation to remove deprecated Doctrine connection #2371

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d0c328
TASK: Update documentation to remove deprecated Doctrine connection
DavidSporer Jan 4, 2021
c37c7ae
TASK: Add mention of MasterSlaveConnection for old dbal versions
albe Jan 4, 2021
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
27 changes: 15 additions & 12 deletions Neos.Flow/Documentation/TheDefinitiveGuide/PartIII/Persistence.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1138,12 +1138,12 @@ Doctrine tries to keep existing data as far as possible, avoiding lossy actions.
``flow:doctrine:migrationversion --version all --add`` to avoid migration
errors later.

Doctrine Connection Wrappers - Master/Slave Connections
Doctrine Connection Wrappers - Primary/Replica Connections
-------------------------------------------------------

Doctrine 2 allows to create Connection wrapper classes, that change the way Doctrine connects
to your database. A common use case is a master/slave replication setup, with one master server
and several slaves that share the load for all reading queries.
to your database. A common use case is a primary/replica setup, with one primary server
and several read replicas that share the load for all reading queries.
Doctrine already provides a wrapper for such a connection and you can configure Flow to use
that connection wrapper by setting the following options in your packages ``Settings.yaml``:

Expand All @@ -1153,28 +1153,31 @@ that connection wrapper by setting the following options in your packages ``Sett
Flow:
persistence:
backendOptions:
wrapperClass: 'Doctrine\DBAL\Connections\MasterSlaveConnection'
master:
wrapperClass: 'Doctrine\DBAL\Connections\PrimaryReadReplicaConnection'
primary:
host: '127.0.0.1' # adjust to your master database host
dbname: 'master' # adjust to your database name
user: 'user' # adjust to your database user
password: 'pass' # adjust to your database password
slaves:
slave1:
replicas:
replica1:
host: '127.0.0.1' # adjust to your slave database host
dbname: 'slave1' # adjust to your database name
dbname: 'replica1' # adjust to your database name
user: 'user' # adjust to your database user
password: 'pass' # adjust to your database password

With this setup, Doctrine will use one of the slave connections picked once per request randomly
.. note::
In doctrine/dbal versions lower then 2.11 the wrapper class was named `MasterSlaveConnection`, so you need to adjust to that if you are such a version.

With this setup, Doctrine will use one of the replica connections picked once per request randomly
albe marked this conversation as resolved.
Show resolved Hide resolved
for all queries until the first writing query (e.g. insert or update) is executed. From that point
on the master server will be used solely. This is to solve the problems of replication lag and
on the primary server will be used solely. This is to solve the problems of replication lag and
possibly inconsistent query results.

.. tip::

You can also setup the master database as a slave, if you want to also use it for load-balancing
reading queries. However, this might lead to higher load on the master database and should be
You can also setup the primary database as a replica, if you want to also use it for load-balancing
reading queries. However, this might lead to higher load on the primary database and should be
well observed.

Known issues
Expand Down