minor #6894 Explain what happens if flush() fails (ThomasLandauer)

weaverryan · weaverryan · commit bb12a8042dfa · 2016-12-14T19:24:36.000-05:00
This PR was merged into the 2.7 branch. Discussion ---------- Explain what happens if `flush()` fails It should be mentioned _somewhere_ in this chapter, how to verify that the entity has really been persisted. What's the best practice here? try...catch? Or (for INSERT) check if $entity->getId() does exist? => Please expand on that. Also, you could list all possible types of exceptions explicitly. Commits ------- 460b74a Integrated improvement by javiereguiluz f3b07bf Explain what happens if `flush()` fails
diff --git a/doctrine.rst b/doctrine.rst
@@ -555,6 +555,12 @@ Take a look at the previous example in more detail:
     ``Product`` objects and then subsequently call ``flush()``, Doctrine will
     execute 100 ``INSERT`` queries using a single prepared statement object.
 
+.. note::
+
+    If the ``flush()`` call fails, a ``Doctrine\ORM\ORMException`` exception
+    is thrown, which you can catch by wrapping the ``flush()`` method in a
+    ``try...catch`` block.
+
 Whether creating or updating objects, the workflow is always the same. In
 the next section, you'll see how Doctrine is smart enough to automatically
 issue an ``UPDATE`` query if the entity already exists in the database.
