From 0dbc6a12eea8b42c670965361e43a1702e8d4217 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C3=ABl=20Perrin?= <mperrin@greenflex.com>
Date: Wed, 15 Jan 2014 12:22:59 +0100
Subject: [PATCH] Update mapping documentation for schema support

Updated documentation:

* Annotations
* XML
* Yaml
* PHP
---
 docs/en/reference/annotations-reference.rst | 2 ++
 docs/en/reference/php-mapping.rst           | 1 +
 docs/en/reference/xml-mapping.rst           | 3 ++-
 docs/en/reference/yaml-mapping.rst          | 1 +
 4 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/en/reference/annotations-reference.rst b/docs/en/reference/annotations-reference.rst
index 27271f491..123fb3b2d 100644
--- a/docs/en/reference/annotations-reference.rst
+++ b/docs/en/reference/annotations-reference.rst
@@ -1129,6 +1129,7 @@ Optional attributes:
 
 -  **indexes**: Array of @Index annotations
 -  **uniqueConstraints**: Array of @UniqueConstraint annotations.
+-  **schema**: (>= 2.5) Name of the schema the table lies in.
 
 Example:
 
@@ -1140,6 +1141,7 @@ Example:
      * @Table(name="user",
      *      uniqueConstraints={@UniqueConstraint(name="user_unique",columns={"username"})},
      *      indexes={@Index(name="user_idx", columns={"email"})}
+     *      schema="schema_name"
      * )
      */
     class User { }
diff --git a/docs/en/reference/php-mapping.rst b/docs/en/reference/php-mapping.rst
index d7734ea12..78a721411 100644
--- a/docs/en/reference/php-mapping.rst
+++ b/docs/en/reference/php-mapping.rst
@@ -241,6 +241,7 @@ General Getters
 
 
 -  ``getTableName()``
+-  ``getSchemaName()``
 -  ``getTemporaryIdTableName()``
 
 Identifier Getters
diff --git a/docs/en/reference/xml-mapping.rst b/docs/en/reference/xml-mapping.rst
index 6793b22f6..93e531aa6 100644
--- a/docs/en/reference/xml-mapping.rst
+++ b/docs/en/reference/xml-mapping.rst
@@ -187,7 +187,7 @@ specified as the ``<entity />`` element as a direct child of the
 .. code-block:: xml
 
     <doctrine-mapping>
-        <entity name="MyProject\User" table="cms_users" repository-class="MyProject\UserRepository">
+        <entity name="MyProject\User" table="cms_users" schema="schema_name" repository-class="MyProject\UserRepository">
             <!-- definition here -->
         </entity>
     </doctrine-mapping>
@@ -211,6 +211,7 @@ Optional attributes:
 -  **read-only** - (>= 2.1) Specifies that this entity is marked as read only and not
    considered for change-tracking. Entities of this type can be persisted
    and removed though.
+-  **schema** - (>= 2.5) The schema the table lies in, for platforms that support schemas
 
 Defining Fields
 ~~~~~~~~~~~~~~~
diff --git a/docs/en/reference/yaml-mapping.rst b/docs/en/reference/yaml-mapping.rst
index 1f2e31d34..ea54e277a 100644
--- a/docs/en/reference/yaml-mapping.rst
+++ b/docs/en/reference/yaml-mapping.rst
@@ -74,6 +74,7 @@ of several common elements:
       type: entity
       repositoryClass: Doctrine\Tests\ORM\Mapping\UserRepository
       table: cms_users
+      schema: schema_name # The schema the table lies in, for platforms that support schemas (Optional, >= 2.5)
       readOnly: true
       indexes:
         name_index: