Mapping Configuration¶

Explicit definition of all the mapped documents is the only necessary configuration for the ODM and there are several configuration options that you can control. The following configuration options exist for a mapping:

• type One of annotations, xml, yml, php or staticphp. This specifies which type of metadata type your mapping uses.
• dir Path to the mapping or entity files (depending on the driver). If this path is relative it is assumed to be relative to the bundle root. This only works if the name of your mapping is a bundle name. If you want to use this option to specify absolute paths you should prefix the path with the kernel parameters that exist in the DIC (for example %kernel.root_dir%).
• prefix A common namespace prefix that all documents of this mapping share. This prefix should never conflict with prefixes of other defined mappings otherwise some of your documents cannot be found by Doctrine. This option defaults to the bundle namespace + Document, for example for an application bundle called AcmeHelloBundle, the prefix would be Acme\HelloBundle\Document.
• alias Doctrine offers a way to alias document namespaces to simpler, shorter names to be used in queries or for Repository access.
• is_bundle This option is a derived value from dir and by default is set to true if dir is relative proved by a file_exists() check that returns false. It is false if the existence check returns true. In this case an absolute path was specified and the metadata files are most likely in a directory outside of a bundle.

To avoid having to configure lots of information for your mappings you should follow these conventions:

1. Put all your documents in a directory Document/ inside your bundle. For example Acme/HelloBundle/Document/.
2. If you are using xml, yml or php mapping put all your configuration files into the Resources/config/doctrine/ directory suffixed with mongodb.xml, mongodb.yml or mongodb.php respectively.
3. Annotations is assumed if a Document/ but no Resources/config/doctrine/ directory is found.

The following configuration shows a bunch of mapping examples:

doctrine_mongodb:
    document_managers:
        default:
            mappings:
                MyBundle1: ~
                MyBundle2: yml
                MyBundle3: { type: annotation, dir: Documents/ }
                MyBundle4: { type: xml, dir: Resources/config/doctrine/mapping }
                MyBundle5:
                    type: yml
                    dir: my-bundle-mappings-dir
                    alias: BundleAlias
                doctrine_extensions:
                    type: xml
                    dir: %kernel.root_dir%/../src/vendor/DoctrineExtensions/lib/DoctrineExtensions/Documents
                    prefix: DoctrineExtensions\Documents\
                    alias: DExt

Filters¶

You can easily add filters to a document manager by using the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

doctrine_mongodb:
    document_managers:
        default:
            filters:
                filter-one:
                    class: Class\ExampleOne\Filter\ODM\ExampleFilter
                    enabled: true
                filter-two:
                    class: Class\ExampleTwo\Filter\ODM\ExampleFilter
                    enabled: false

Filters are used to append conditions to the queryBuilder regardless of where the query is generated.

Multiple Connections¶

If you need multiple connections and document managers you can use the following syntax:

Now you can retrieve the configured services connection services:

1
2

$conn1 = $container->get('doctrine_mongodb.odm.conn1_connection');
$conn2 = $container->get('doctrine_mongodb.odm.conn2_connection');

And you can also retrieve the configured document manager services which utilize the above connection services:

1
2

$dm1 = $container->get('doctrine_mongodb.odm.dm1_document_manager');
$dm2 = $container->get('doctrine_mongodb.odm.dm2_document_manager');

Connecting to a pool of mongodb servers on 1 connection¶

It is possible to connect to several mongodb servers on one connection if you are using a replica set by listing all of the servers within the connection string as a comma separated list.

Where mongodb-01, mongodb-02 and mongodb-03 are the machine hostnames. You can also use IP addresses if you prefer.

Retrying Connections and Queries¶

Doctrine MongoDB supports automatically retrying connections and queries after encountering an exception, which is helpful when dealing with situations such as replica set failovers. This alleviates much of the need to catch exceptions from the MongoDB PHP driver in your application and manually retry operations.

You may specify the number of times to retry connections and queries via the retry_connect and retry_query options in the document manager configuration. These options default to zero, which means that no operations will be retried.

Full Default Configuration¶