diff --git a/docs/en/reference/annotations-reference.rst b/docs/en/reference/annotations-reference.rst index e3000ea10..f4705cea4 100644 --- a/docs/en/reference/annotations-reference.rst +++ b/docs/en/reference/annotations-reference.rst @@ -418,6 +418,12 @@ Required attributes: - **name**: Name of the Index - **columns**: Array of columns. +Optional attributes: + +- **options**: Array of platform specific options + + - **where**: SQL WHERE condition to be used for partial indexes. It will only have effect on supported platforms. + Example: .. code-block:: php @@ -1151,6 +1157,12 @@ Required attributes: - **name**: Name of the Index - **columns**: Array of columns. +Optional attributes: + +- **options**: Array of platform specific options + + - **where**: SQL WHERE condition to be used for partial indexes. It will only have effect on supported platforms. + Example: .. code-block:: php diff --git a/doctrine-mapping.xsd b/doctrine-mapping.xsd index fea44a691..2dca26257 100644 --- a/doctrine-mapping.xsd +++ b/doctrine-mapping.xsd @@ -5,9 +5,9 @@ xmlns:orm="http://doctrine-project.org/schemas/orm/doctrine-mapping" elementFormDefault="qualified"> - - + @@ -23,27 +23,27 @@ - + - + - - - - - + + + + + - + @@ -64,7 +64,7 @@ - + @@ -73,7 +73,7 @@ - + @@ -199,7 +199,7 @@ - + @@ -245,7 +245,7 @@ - + @@ -253,33 +253,33 @@ - - - + + + - - - - - + + + + + - + - - - - - + + + + + - + - - - - + + + + - + @@ -299,13 +299,13 @@ - + - + @@ -317,16 +317,17 @@ - + + - + @@ -334,7 +335,7 @@ - + @@ -342,9 +343,10 @@ + - + @@ -352,7 +354,7 @@ - + @@ -361,7 +363,7 @@ - + @@ -509,7 +511,7 @@ - + @@ -528,7 +530,7 @@ - + diff --git a/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php b/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php index 3f46e2c95..89d215a3a 100644 --- a/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php +++ b/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php @@ -102,11 +102,15 @@ class AnnotationDriver extends AbstractAnnotationDriver if ($tableAnnot->indexes !== null) { foreach ($tableAnnot->indexes as $indexAnnot) { $index = array('columns' => $indexAnnot->columns); - + if ( ! empty($indexAnnot->flags)) { $index['flags'] = $indexAnnot->flags; } + if (! empty($indexAnnot->where)) { + $index['where'] = $indexAnnot->where; + } + if ( ! empty($indexAnnot->name)) { $primaryTable['indexes'][$indexAnnot->name] = $index; } else { @@ -118,6 +122,10 @@ class AnnotationDriver extends AbstractAnnotationDriver if ($tableAnnot->uniqueConstraints !== null) { foreach ($tableAnnot->uniqueConstraints as $uniqueConstraintAnnot) { $uniqueConstraint = array('columns' => $uniqueConstraintAnnot->columns); + + if ( ! empty($uniqueConstraintAnnot->where)) { + $uniqueConstraint['where'] = $uniqueConstraintAnnot->where; + } if ( ! empty($uniqueConstraintAnnot->name)) { $primaryTable['uniqueConstraints'][$uniqueConstraintAnnot->name] = $uniqueConstraint; diff --git a/lib/Doctrine/ORM/Mapping/Driver/XmlDriver.php b/lib/Doctrine/ORM/Mapping/Driver/XmlDriver.php index e08ee7ae6..a07f5b36b 100644 --- a/lib/Doctrine/ORM/Mapping/Driver/XmlDriver.php +++ b/lib/Doctrine/ORM/Mapping/Driver/XmlDriver.php @@ -196,11 +196,15 @@ class XmlDriver extends FileDriver $metadata->table['indexes'] = array(); foreach ($xmlRoot->indexes->index as $indexXml) { $index = array('columns' => explode(',', (string) $indexXml['columns'])); - + if (isset($indexXml['flags'])) { $index['flags'] = explode(',', (string) $indexXml['flags']); } - + + if (isset($indexXml['where'])) { + $index['where'] = $indexXml['where']; + } + if (isset($indexXml['name'])) { $metadata->table['indexes'][(string) $indexXml['name']] = $index; } else { @@ -212,17 +216,17 @@ class XmlDriver extends FileDriver // Evaluate if (isset($xmlRoot->{'unique-constraints'})) { $metadata->table['uniqueConstraints'] = array(); - foreach ($xmlRoot->{'unique-constraints'}->{'unique-constraint'} as $unique) { - $columns = explode(',', (string)$unique['columns']); + foreach ($xmlRoot->{'unique-constraints'}->{'unique-constraint'} as $uniqueXml) { + $unique = array('columns' => explode(',', (string) $uniqueXml['columns'])); - if (isset($unique['name'])) { - $metadata->table['uniqueConstraints'][(string)$unique['name']] = array( - 'columns' => $columns - ); + if (isset($uniqueXml['where'])) { + $unique['where'] = $uniqueXml['where']; + } + + if (isset($uniqueXml['name'])) { + $metadata->table['uniqueConstraints'][(string)$uniqueXml['name']] = $unique; } else { - $metadata->table['uniqueConstraints'][] = array( - 'columns' => $columns - ); + $metadata->table['uniqueConstraints'][] = $unique; } } } diff --git a/lib/Doctrine/ORM/Mapping/Driver/YamlDriver.php b/lib/Doctrine/ORM/Mapping/Driver/YamlDriver.php index 2772913cc..6146667a0 100644 --- a/lib/Doctrine/ORM/Mapping/Driver/YamlDriver.php +++ b/lib/Doctrine/ORM/Mapping/Driver/YamlDriver.php @@ -220,27 +220,32 @@ class YamlDriver extends FileDriver } } + if (isset($indexYml['where'])) { + $index['where'] = $indexYml['where']; + } + $metadata->table['indexes'][$indexYml['name']] = $index; } } // Evaluate uniqueConstraints if (isset($element['uniqueConstraints'])) { - foreach ($element['uniqueConstraints'] as $name => $unique) { - if ( ! isset($unique['name'])) { - $unique['name'] = $name; + foreach ($element['uniqueConstraints'] as $name => $uniqueYml) { + if ( ! isset($uniqueYml['name'])) { + $uniqueYml['name'] = $name; } - if (is_string($unique['columns'])) { - $columns = explode(',', $unique['columns']); - $columns = array_map('trim', $columns); + if (is_string($uniqueYml['columns'])) { + $unique = array('columns' => array_map('trim', explode(',', $uniqueYml['columns']))); } else { - $columns = $unique['columns']; + $unique = array('columns' => $uniqueYml['columns']); } - $metadata->table['uniqueConstraints'][$unique['name']] = array( - 'columns' => $columns - ); + if (isset($uniqueYml['where'])) { + $unique['where'] = $uniqueYml['where']; + } + + $metadata->table['uniqueConstraints'][$uniqueYml['name']] = $unique; } } diff --git a/lib/Doctrine/ORM/Mapping/Index.php b/lib/Doctrine/ORM/Mapping/Index.php index ff4532d47..378dd4d67 100644 --- a/lib/Doctrine/ORM/Mapping/Index.php +++ b/lib/Doctrine/ORM/Mapping/Index.php @@ -39,4 +39,9 @@ final class Index implements Annotation * @var array */ public $flags; + + /** + * @var string + */ + public $where; } diff --git a/lib/Doctrine/ORM/Mapping/UniqueConstraint.php b/lib/Doctrine/ORM/Mapping/UniqueConstraint.php index 95d99293f..364cb547c 100644 --- a/lib/Doctrine/ORM/Mapping/UniqueConstraint.php +++ b/lib/Doctrine/ORM/Mapping/UniqueConstraint.php @@ -34,4 +34,9 @@ final class UniqueConstraint implements Annotation * @var array */ public $columns; + + /** + * @var string + */ + public $where; } diff --git a/lib/Doctrine/ORM/Tools/SchemaTool.php b/lib/Doctrine/ORM/Tools/SchemaTool.php index 9bca3ed66..8792c5257 100644 --- a/lib/Doctrine/ORM/Tools/SchemaTool.php +++ b/lib/Doctrine/ORM/Tools/SchemaTool.php @@ -267,14 +267,14 @@ class SchemaTool if( ! isset($indexData['flags'])) { $indexData['flags'] = array(); } - - $table->addIndex($indexData['columns'], is_numeric($indexName) ? null : $indexName, (array)$indexData['flags']); + + $table->addIndex($indexData['columns'], is_numeric($indexName) ? null : $indexName, (array)$indexData['flags'], isset($indexData['where']) ? $indexData['where'] : null); } } if (isset($class->table['uniqueConstraints'])) { foreach ($class->table['uniqueConstraints'] as $indexName => $indexData) { - $table->addUniqueIndex($indexData['columns'], is_numeric($indexName) ? null : $indexName); + $table->addUniqueIndex($indexData['columns'], is_numeric($indexName) ? null : $indexName, isset($indexData['where']) ? $indexData['where'] : null); } } diff --git a/tests/Doctrine/Tests/ORM/Mapping/AbstractMappingDriverTest.php b/tests/Doctrine/Tests/ORM/Mapping/AbstractMappingDriverTest.php index 7a22dc1da..704fa1804 100644 --- a/tests/Doctrine/Tests/ORM/Mapping/AbstractMappingDriverTest.php +++ b/tests/Doctrine/Tests/ORM/Mapping/AbstractMappingDriverTest.php @@ -73,14 +73,15 @@ abstract class AbstractMappingDriverTest extends \Doctrine\Tests\OrmTestCase return $class; } - public function testEntityIndexFlags() + public function testEntityIndexFlagsAndPartialIndexes() { $class = $this->createClassMetadata('Doctrine\Tests\ORM\Mapping\Comment'); $this->assertEquals(array( 0 => array( 'columns' => array('content'), - 'flags' => array('fulltext') + 'flags' => array('fulltext'), + 'where' => 'content IS NOT NULL', ) ), $class->table['indexes']); } @@ -95,7 +96,7 @@ abstract class AbstractMappingDriverTest extends \Doctrine\Tests\OrmTestCase 'ClassMetadata should have uniqueConstraints key in table property when Unique Constraints are set.'); $this->assertEquals(array( - "search_idx" => array("columns" => array("name", "user_email")) + "search_idx" => array("columns" => array("name", "user_email"), 'where' => 'name IS NOT NULL') ), $class->table['uniqueConstraints']); return $class; @@ -938,7 +939,7 @@ abstract class AbstractMappingDriverTest extends \Doctrine\Tests\OrmTestCase * @HasLifecycleCallbacks * @Table( * name="cms_users", - * uniqueConstraints={@UniqueConstraint(name="search_idx", columns={"name", "user_email"})}, + * uniqueConstraints={@UniqueConstraint(name="search_idx", columns={"name", "user_email"}, where="name IS NOT NULL")}, * indexes={@Index(name="name_idx", columns={"name"}), @Index(name="0", columns={"user_email"})}, * options={"foo": "bar", "baz": {"key": "val"}} * ) @@ -1122,7 +1123,7 @@ class User 'orderBy' => NULL, )); $metadata->table['uniqueConstraints'] = array( - 'search_idx' => array('columns' => array('name', 'user_email')), + 'search_idx' => array('columns' => array('name', 'user_email'), 'where' => 'name IS NOT NULL'), ); $metadata->table['indexes'] = array( 'name_idx' => array('columns' => array('name')), 0 => array('columns' => array('user_email')) @@ -1281,7 +1282,7 @@ class Group {} /** * @Entity - * @Table(indexes={@Index(columns={"content"}, flags={"fulltext"})}) + * @Table(indexes={@Index(columns={"content"}, flags={"fulltext"}, where="content IS NOT NULL")}) */ class Comment { @@ -1295,7 +1296,7 @@ class Comment $metadata->setInheritanceType(ClassMetadataInfo::INHERITANCE_TYPE_NONE); $metadata->setPrimaryTable(array( 'indexes' => array( - array('columns' => array('content'), 'flags' => array('fulltext')) + array('columns' => array('content'), 'flags' => array('fulltext'), 'where' => 'content IS NOT NULL') ) )); diff --git a/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.Comment.php b/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.Comment.php index 124aafe1d..e5ac0f8b0 100644 --- a/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.Comment.php +++ b/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.Comment.php @@ -5,7 +5,7 @@ use Doctrine\ORM\Mapping\ClassMetadataInfo; $metadata->setInheritanceType(ClassMetadataInfo::INHERITANCE_TYPE_NONE); $metadata->setPrimaryTable(array( 'indexes' => array( - array('columns' => array('content'), 'flags' => array('fulltext')) + array('columns' => array('content'), 'flags' => array('fulltext'), 'where' => 'content IS NOT NULL') ) )); diff --git a/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.User.php b/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.User.php index 1795793d3..2e32ee229 100644 --- a/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.User.php +++ b/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.User.php @@ -112,11 +112,11 @@ $metadata->mapManyToMany(array( 'orderBy' => NULL, )); $metadata->table['options'] = array( - 'foo' => 'bar', + 'foo' => 'bar', 'baz' => array('key' => 'val') ); $metadata->table['uniqueConstraints'] = array( - 'search_idx' => array('columns' => array('name', 'user_email')), + 'search_idx' => array('columns' => array('name', 'user_email'), 'where' => 'name IS NOT NULL'), ); $metadata->table['indexes'] = array( 'name_idx' => array('columns' => array('name')), 0 => array('columns' => array('user_email')) diff --git a/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.Comment.dcm.xml b/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.Comment.dcm.xml index 659ddccd8..5c061a94a 100644 --- a/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.Comment.dcm.xml +++ b/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.Comment.dcm.xml @@ -8,7 +8,7 @@ - + diff --git a/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.User.dcm.xml b/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.User.dcm.xml index 728425a71..c61962539 100644 --- a/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.User.dcm.xml +++ b/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.User.dcm.xml @@ -19,7 +19,7 @@ - + diff --git a/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.Comment.dcm.yml b/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.Comment.dcm.yml index 2186f6a27..e9e46dece 100644 --- a/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.Comment.dcm.yml +++ b/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.Comment.dcm.yml @@ -7,3 +7,4 @@ Doctrine\Tests\ORM\Mapping\Comment: 0: columns: content flags: fulltext + where: "content IS NOT NULL" diff --git a/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.User.dcm.yml b/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.User.dcm.yml index 6b87472d1..db93190b6 100644 --- a/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.User.dcm.yml +++ b/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.User.dcm.yml @@ -69,11 +69,12 @@ Doctrine\Tests\ORM\Mapping\User: cascade: - all lifecycleCallbacks: - prePersist: [ doStuffOnPrePersist, doOtherStuffOnPrePersistToo ] + prePersist: [ doStuffOnPrePersist, doOtherStuffOnPrePersistToo ] postPersist: [ doStuffOnPostPersist ] uniqueConstraints: search_idx: columns: name,user_email + where: name IS NOT NULL indexes: name_idx: columns: name