Sample Configuration

1 # config/packages/doctrine_mongodb.yaml
doctrine_mongodb:
    connections:
        default:
            server: mongodb://localhost:27017
            options: {}
    default_database: hello_%kernel.environment%
    document_managers:
        default:
            mappings:
                App:
                    is_bundle: false
                    dir: '%kernel.project_dir%/src/Document'
                    prefix: 'App\Document'
                    alias: App
            metadata_cache_driver: array # array, service, apcu, memcached, redis
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:doctrine_mongodb="http://symfony.com/schema/dic/doctrine/odm/mongodb"
    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                        http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine_mongodb:config default-database="hello_%kernel.environment%">
        <doctrine_mongodb:connection id="default" server="mongodb://localhost:27017">
            <doctrine_mongodb:options>
            </doctrine_mongodb:options>
        </doctrine_mongodb:connection>
        <doctrine_mongodb:document-manager id="default">
            <doctrine_mongodb:mapping name="App" is-bundle="false" prefix="App\Document" alias="App" />
            <doctrine_mongodb:metadata-cache-driver type="array" />
        </doctrine_mongodb:document-manager>
    </doctrine_mongodb:config>
</container>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

1 use function Symfony\Component\DependencyInjection\Loader\Configurator\env;
use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->connection('default')
        ->server(env('MONGODB_URL')->default('mongodb://localhost:27017')->resolve())
        ->options([]);

    $config->defaultDatabase('hello_' . param('kernel.environment'));
    $config->documentManager('default')
        ->mapping('App')
            ->isBundle(false)
            ->dir(param('kernel.project_dir') . '/src/Document')
            ->prefix('App\\Document')
            ->alias('App')
        ->metadataCacheDriver('array'); // array, service, apcu, memcached, redis
};
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

}

If each environment requires a different MongoDB connection URI, you can define it as an environment variable and reference it in the bundle's config:

1 # .env
MONGODB_URL=mongodb://localhost:27017
2

1 # config/packages/doctrine_mongodb.yaml
doctrine_mongodb:
    connections:
        default:
            server: '%env(resolve:MONGODB_URL)%'
2
3
4
5

If you wish to use memcached to cache your metadata, you need to configure the Memcached instance; for example, you can do the following:

1 # app/config/config.yml
doctrine_mongodb:
    default_database: hello_%kernel.environment%
    connections:
        default:
            server: mongodb://localhost:27017
            options: {}
    document_managers:
        default:
            mappings:
                App: ~
            metadata_cache_driver:
                type: memcached
                class: Symfony\Component\Cache\Adapter\MemcachedAdapter
                host: localhost
                port: 11211
                instance_class: Memcached
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:doctrine_mongodb="http://symfony.com/schema/dic/doctrine/odm/mongodb"
    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                        http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine_mongodb:config default-database="hello_%kernel.environment%">
        <doctrine_mongodb:document-manager id="default">
            <doctrine_mongodb:mapping name="App" />
            <doctrine_mongodb:metadata-cache-driver type="memcached">
                <doctrine_mongodb:class>Symfony\Component\Cache\Adapter\MemcachedAdapter</doctrine_mongodb:class>
                <doctrine_mongodb:host>localhost</doctrine_mongodb:host>
                <doctrine_mongodb:port>11211</doctrine_mongodb:port>
                <doctrine_mongodb:instance-class>Memcached</doctrine_mongodb:instance-class>
            </doctrine_mongodb:metadata-cache-driver>
        </doctrine_mongodb:document-manager>
        <doctrine_mongodb:connection id="default" server="mongodb://localhost:27017">
            <doctrine_mongodb:options>
            </doctrine_mongodb:options>
        </doctrine_mongodb:connection>
    </doctrine_mongodb:config>
</container>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

1 use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
use Symfony\Component\Cache\Adapter\MemcachedAdapter;
use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->defaultDatabase('hello_' . param('kernel.environment'));
    $config->connection('default')
        ->server('mongodb://localhost:27017')
        ->options([]);

    $config->documentManager('default')
        ->mapping('App')
        ->metadataCacheDriver()
            ->type('memcached')
            ->class(MemcachedAdapter::class)
            ->host('localhost')
            ->port(11211)
            ->instanceClass(\Memcached::class)
    ;
};
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

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 attribute, xml, php or staticphp. This specifies which type of metadata type your mapping uses.
dir Path to the mapping or document 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.project_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 application namespace + Document, for example for an application called App, the prefix would be App\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:

Put all your documents in a directory Document/ inside your project. For example src/Document/.
If you are using xml or php mapping put all your configuration files into either the config/doctrine/ directory (requires Symfony 5.4 or later) or the Resources/config/doctrine/ directory suffixed with mongodb.xml, mongodb.yml or mongodb.php respectively.
Attributes are assumed if a Document/ but no config/doctrine/ or Resources/config/doctrine/ directory is found.

The following configuration shows a bunch of mapping examples:

1 doctrine_mongodb:
    document_managers:
        default:
            mappings:
                App: ~
                App2: xml
                App3: { type: attribute, dir: Documents/ }
                App4: { type: xml, dir: config/doctrine/mapping }
                App5:
                    type: xml
                    dir: my-app-mappings-dir
                    alias: AppAlias
                doctrine_extensions:
                    type: xml
                    dir: "%kernel.project_dir%/src/vendor/DoctrineExtensions/lib/DoctrineExtensions/Documents"
                    prefix: DoctrineExtensions\Documents\
                    alias: DExt
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:doctrine_mongodb="http://symfony.com/schema/dic/doctrine/odm/mongodb"
           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                                http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine_mongodb:config>
        <doctrine_mongodb:document-manager id="default">
            <doctrine_mongodb:mapping name="App1" />
            <doctrine_mongodb:mapping name="App2" type="attribute" dir="Documents/" />
            <doctrine_mongodb:mapping name="App3" type="xml" dir="config/doctrine/mapping" />
            <doctrine_mongodb:mapping name="App4" type="xml" dir="my-app-mappings-dir" alias="AppAlias" />
            <doctrine_mongodb:mapping name="doctrine_extensions"
                                      type="xml"
                                      dir="%kernel.project_dir%/src/vendor/DoctrineExtensions/lib/DoctrineExtensions/Documents"
                                      prefix="DoctrineExtensions\Documents\"
                                      alias="DExt" />
        </doctrine_mongodb:document-manager>
    </doctrine_mongodb:config>
</container>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

1 use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->documentManager('default')
        ->mapping('App')
        ->mapping('App2')
            ->type('xml')
        ->mapping('App3')
            ->type('attribute')
            ->dir('Documents/')
        ->mapping('App4')
            ->type('xml')
            ->dir('config/doctrine/mapping')
        ->mapping('App5')
            ->type('xml')
            ->dir('my-app-mappings-dir')
            ->alias('AppAlias')
        ->mapping('doctrine_extensions')
            ->type('xml')
            ->dir(param('kernel.project_dir') . '/src/vendor/DoctrineExtensions/lib/DoctrineExtensions/Documents')
            ->prefix('DoctrineExtensions\\Documents\\')
            ->alias('DExt')
    ;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

Custom Types

Custom types can come in handy when you're missing a specific mapping type or when you want to replace the existing implementation of a mapping type for your documents.

1 doctrine_mongodb:
    types:
        custom_type: Fully\Qualified\Class\Name
2
3

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:doctrine_mongodb="http://symfony.com/schema/dic/doctrine/odm/mongodb"
           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                                http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine_mongodb:config>
        <doctrine_mongodb:type name="custom_type" class="Fully\Qualified\Class\Name" />
    </doctrine_mongodb:config>
</container>
2
3
4
5
6
7
8
9
10
11
12

1 use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->type('custom_type')
        ->class(\Fully\Qualified\Class\Name::class)
    ;
}
2
3
4
5
6
7

Filters

Filter classes may be used in order to add criteria to ODM queries, regardless of where those queries are created within your application. Typically, filters will limit themselves to operating on a particular class or interface. Filters may also take parameters, which can be used to customize the injected query criteria.

Filters may be registered with a document manager by using the following syntax:

1 doctrine_mongodb:
    document_managers:
        default:
            filters:
                basic_filter:
                    class: Vendor\Filter\BasicFilter
                    enabled: true
                complex_filter:
                    class: Vendor\Filter\ComplexFilter
                    enabled: false
                    parameters:
                        author: bob
                        comments: { $gte: 10 }
                        tags: { $in: [ 'foo', 'bar' ] }
2
3
4
5
6
7
8
9
10
11
12
13
14

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:doctrine="http://symfony.com/schema/dic/doctrine/odm/mongodb"
    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                        http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine:mongodb>
        <doctrine:connection id="default" server="mongodb://localhost:27017" />

        <doctrine:document-manager id="default" connection="default">
            <doctrine:filter name="basic_filter" enabled="true" class="Vendor\Filter\BasicFilter" />
            <doctrine:filter name="complex_filter" enabled="true" class="Vendor\Filter\ComplexFilter">
                <doctrine:parameter name="author">bob</doctrine:parameter>
                <doctrine:parameter name="comments">{ "$gte": 10 }</doctrine:parameter>
                <doctrine:parameter name="tags">{ "$in": [ "foo", "bar" ] }</doctrine:parameter>
            </doctrine:filter>
        </doctrine:document-manager>
    </doctrine:mongodb>
</container>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

1 use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->documentManager('default')
        ->filter('basic_filter')
            ->class(\Vendor\Filter\BasicFilter::class)
            ->enabled(true)
        ->filter('complex_filter')
            ->class(\Vendor\Filter\ComplexFilter::class)
            ->enabled(false)
            ->parameter('author', 'bob')
            ->parameter('comments', [ '$gte' => 10 ])
            ->parameter('tags', [ '$in' => [ 'foo', 'bar' ] ])
    ;
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Unlike ORM, query parameters in MongoDB ODM may be non-scalar values. Since such values are difficult to express in XML, the bundle allows JSON strings to be used in parameter tags. While processing the configuration, the bundle will run the tag contents through json_decode() if the string is wrapped in square brackets or curly braces for arrays and objects, respectively.

Multiple Connections

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

1 doctrine_mongodb:
    default_database: hello_%kernel.environment%
    default_connection: conn2
    default_document_manager: dm2
    connections:
        conn1:
            server: mongodb://localhost:27017
        conn2:
            server: mongodb://localhost:27017
    document_managers:
        dm1:
            connection: conn1
            database: db1
            metadata_cache_driver: array
            mappings:
                App: ~
        dm2:
            connection: conn2
            database: db2
            mappings:
                AnotherApp: ~
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:doctrine_mongodb="http://symfony.com/schema/dic/doctrine/odm/mongodb"
    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                        http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine_mongodb:config
            default-database="hello_%kernel.environment%"
            default-document-manager="dm2"
            default-connection="dm2"
            proxy-namespace="MongoDBODMProxies"
            auto-generate-proxy-classes="true">
        <doctrine_mongodb:connection id="conn1" server="mongodb://localhost:27017">
            <doctrine_mongodb:options>
            </doctrine_mongodb:options>
        </doctrine_mongodb:connection>
        <doctrine_mongodb:connection id="conn2" server="mongodb://localhost:27017">
            <doctrine_mongodb:options>
            </doctrine_mongodb:options>
        </doctrine_mongodb:connection>
        <doctrine_mongodb:document-manager id="dm1" metadata-cache-driver="array" connection="conn1" database="db1">
            <doctrine_mongodb:mapping name="App" />
        </doctrine_mongodb:document-manager>
        <doctrine_mongodb:document-manager id="dm2" connection="conn2" database="db2">
            <doctrine_mongodb:mapping name="AnotherApp" />
        </doctrine_mongodb:document-manager>
    </doctrine_mongodb:config>
</container>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

1 use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->defaultDatabase('hello_' . param('kernel.environment'));
    $config->defaultDocumentManager('dm2');
    $config->defaultConnection('dm2');

    $config->connection('conn1')
        ->server('mongodb://localhost:27017');

    $config->connection('conn2')
        ->server('mongodb://localhost:27017');

    $config->documentManager('dm1')
        ->connection('conn1')
        ->database('db1')
        ->metadataCacheDriver('array')
        ->mapping('App');

    $config->documentManager('dm2')
        ->connection('conn2')
        ->database('db2')
        ->mapping('AnotherApp');
};
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

Now you can retrieve the configured services connection services:

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

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

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

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 and using replicaSet option.

1 doctrine_mongodb:
    # ...
    connections:
        default:
            server: "mongodb://mongodb-01:27017,mongodb-02:27017,mongodb-03:27017/?replicaSet=replSetName"
2
3
4
5

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:doctrine="http://symfony.com/schema/dic/doctrine/odm/mongodb"
           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                        http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine:mongodb>
        <doctrine:connection id="default" server="mongodb://mongodb-01:27017,mongodb-02:27017,mongodb-03:27017/?replicaSet=replSetName" />
    </doctrine:mongodb>
</container>
2
3
4
5
6
7
8
9
10
11
12

1 use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->connection('default')
        ->server('mongodb://mongodb-01:27017,mongodb-02:27017,mongodb-03:27017/?replicaSet=replSetName');
};
2
3
4
5
6

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

Please refer to Replica Sets manual of MongoDB PHP Driver for further details.

Using Authentication on a Database Level

MongoDB supports authentication and authorisation on a database-level. This is mandatory if you have e.g. a publicly accessible MongoDB Server. To make use of this feature you need to configure credentials for each of your connections. Every connection needs also a database to authenticate against. The setting is represented by the authSource connection string. Otherwise you will get a auth failed exception.

1 doctrine_mongodb:
    # ...
    connections:
        default:
            server: "mongodb://localhost:27017"
            options:
                username: someuser
                password: somepass
                authSource: db_you_have_access_to
2
3
4
5
6
7
8
9

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:doctrine="http://symfony.com/schema/dic/doctrine/odm/mongodb"
           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                        http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine:mongodb>
        <doctrine:connection id="default" server="mongodb://localhost:27017" />
            <doctrine:options
                    username="someuser"
                    password="somepass"
                    authSource="db_you_have_access_to"
            >
            </doctrine:options>
        </doctrine:connection>
    </doctrine:mongodb>
</container>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

1 use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->connection('default')
        ->server('mongodb://localhost:27017')
        ->options([
            'username' => 'someuser',
            'password' => 'somepass',
            'authSource' => 'db_you_have_access_to',
        ]);
};
2
3
4
5
6
7
8
9
10
11

Specifying a context service

The MongoDB driver supports receiving a stream context to set SSL and logging options. This can be used to authenticate using SSL certificates. To do so, create a service that creates your logging context:

1 services:
    # ...

    app.mongodb.context_service:
        class: 'resource'
        factory: 'stream_context_create'
        arguments:
            - { ssl: { verify_expiry: true } }
2
3
4
5
6
7
8

1 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $container): void {
    $container->services()
        ->set('app.mongodb.context_service', 'resource')
        ->factory('stream_context_create')
        ->args([
            ['ssl' => ['verify_expiry' => true]],
        ])
    ;
};
2
3
4
5
6
7
8
9
10
11

Note: the class option is not used when creating the service, but has to be provided for the service definition to be valid.

You can then use this service in your configuration:

1 doctrine_mongodb:
    # ...
    connections:
        default:
            server: "mongodb://localhost:27017"
            driver_options:
                context: "app.mongodb.context_service"
2
3
4
5
6
7

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:doctrine="http://symfony.com/schema/dic/doctrine/odm/mongodb"
           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                        http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine:mongodb>
        <doctrine:connection id="default" server="mongodb://localhost:27017" />
            <doctrine:driver-options
                context="app.mongodb.context_service"
            >
            </doctrine:options>
        </doctrine:connection>
    </doctrine:mongodb>
</container>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

1 use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->connection('default')
        ->server('mongodb://localhost:27017')
        ->driverOptions([
            'context' => 'app.mongodb.context_service',
        ]);
};
2
3
4
5
6
7
8
9

Full Default Configuration

1 doctrine_mongodb:
    document_managers:

        # Prototype
        id:
            connection:                        ~
            database:                          ~
            default_document_repository_class: Doctrine\ODM\MongoDB\Repository\DocumentRepository
            default_gridfs_repository_class:   Doctrine\ODM\MongoDB\Repository\DefaultGridFSRepository
            repository_factory:                ~
            persistent_collection_factory:     ~
            logging:                           true
            auto_mapping:                      false
            metadata_cache_driver:
                type:                 ~
                class:                ~
                host:                 ~
                port:                 ~
                instance_class:       ~
            mappings:

                # Prototype
                name:
                    mapping:              true
                    type:                 ~
                    dir:                  ~
                    prefix:               ~
                    alias:                ~
                    is_bundle:            ~
    types:

        # Prototype
        custom_type: Fully\Qualified\Class\Name
    connections:

        # Prototype
        id:
            server:               ~
            options:
                authMechanism:                          ~
                connectTimeoutMS:                       ~
                db:                                     ~
                authSource:                             ~
                journal:                                ~
                password:                               ~
                readPreference:                         ~
                readPreferenceTags:                     ~
                replicaSet:                             ~ # replica set name
                socketTimeoutMS:                        ~
                ssl:                                    ~
                tls:                                    ~
                tlsAllowInvalidCertificates:            ~
                tlsAllowInvalidHostnames:               ~
                tlsCAFile:                              ~
                tlsCertificateKeyFile:                  ~
                tlsCertificateKeyFilePassword:          ~
                tlsDisableCertificateRevocationCheck:   ~
                tlsDisableOCSPEndpointCheck:            ~
                tlsInsecure:                            ~
                username:                               ~
                retryReads:                             ~
                retryWrites:                            ~
                w:                                      ~
                wTimeoutMS:                             ~
            driver_options:
                context:              ~ # stream context to use for connection

    proxy_namespace:      MongoDBODMProxies
    proxy_dir:            "%kernel.cache_dir%/doctrine/odm/mongodb/Proxies"
    auto_generate_proxy_classes:  0
    hydrator_namespace:   Hydrators
    hydrator_dir:         "%kernel.cache_dir%/doctrine/odm/mongodb/Hydrators"
    auto_generate_hydrator_classes:  0
    persistent_collection_namespace: PersistentCollections
    persistent_collection_dir: "%kernel.cache_dir%/doctrine/odm/mongodb/PersistentCollections"
    auto_generate_persistent_collection_classes: 0
    default_document_manager:  ~
    default_connection:   ~
    default_database:     default
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

1 <?xml version="1.0" ?>

<container xmlns="http://symfony.com/schema/dic/services"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:doctrine="http://symfony.com/schema/dic/doctrine/odm/mongodb"
           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
                        http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">

    <doctrine:config
            auto-generate-hydrator-classes="0"
            auto-generate-proxy-classes="0"
            default-connection=""
            default-database="default"
            default-document-manager=""
            hydrator-dir="%kernel.cache_dir%/doctrine/odm/mongodb/Hydrators"
            hydrator-namespace="Hydrators"
            proxy-dir="%kernel.cache_dir%/doctrine/odm/mongodb/Proxies"
            proxy-namespace="Proxies"
    >
        <doctrine:document-manager id="id"
                                   connection=""
                                   database=""
                                   default-document-repository-class=""
                                   default-gridfs-repository-class=""
                                   repository-factory=""
                                   logging="true"
                                   auto-mapping="false"
        >
            <doctrine:metadata-cache-driver type="">
                <doctrine:class></doctrine:class>
                <doctrine:host></doctrine:host>
                <doctrine:port></doctrine:port>
                <doctrine:instance-class></doctrine:instance-class>
            </doctrine:metadata-cache-driver>
            <doctrine:mapping name="name"
                              type=""
                              dir=""
                              prefix=""
                              alias=""
                              is-bundle=""
            />
            <doctrine:profiler enabled="true" pretty="false" />
        </doctrine:document-manager>
        <doctrine:type name="custom_type" class="Fully\Qualified\Class\Name" />
        <doctrine:connection id="conn1" server="mongodb://localhost">
            <doctrine:options
                    authMechanism=""
                    connectTimeoutMS=""
                    db=""
                    authSource=""
                    journal=""
                    password=""
                    readPreference=""
                    replicaSet=""
                    socketTimeoutMS=""
                    ssl=""
                    username=""
                    w=""
                    wTimeoutMS=""
            >
            </doctrine:options>
        </doctrine:connection>
    </doctrine:config>
</container>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

1 use Symfony\Config\DoctrineMongodbConfig;

return static function (DoctrineMongodbConfig $config): void {
    $config->autoGenerateHydratorClasses(0);
    $config->autoGenerateProxyClasses(0);
    $config->defaultConnection('');
    $config->defaultDatabase('default');
    $config->defaultDocumentManager('');
    $config->hydratorDir('%kernel.cache_dir%/doctrine/odm/mongodb/Hydrators');
    $config->hydratorNamespace('Hydrators');
    $config->proxyDir('%kernel.cache_dir%/doctrine/odm/mongodb/Proxies');
    $config->proxyNamespace('Proxies');

    $config->documentManager('id')
        ->connection('')
        ->database('')
        ->defaultDocumentRepositoryClass('')
        ->defaultGridfsRepositoryClass('')
        ->repositoryFactory('')
        ->logging(true)
        ->autoMapping(false)
        ->metadataCacheDriver()
            ->type(null)
            ->class(null)
            ->host(null)
            ->port(null)
            ->instanceClass(null)
        ->mapping('name')
            ->type('')
            ->dir('')
            ->prefix('')
            ->alias('')
            ->isBundle('')
        ->profiler()
            ->enabled(true)
            ->pretty(false)
    ;

    $config->type('custom_type')
        ->class('Fully\Qualified\Class\Name');

    $config->connection('id')
        ->server('mongodb://localhost')
        ->driverOptions([
            'context' => null, // stream context to use for connection
        ])
        ->options([
            'authMechanism' => null,
            'connectTimeoutMS' => null,
            'db' => null,
            'authSource' => null,
            'journal' => null,
            'password' => null,
            'readPreference' => null,
            'readPreferenceTags' => null,
            'replicaSet' => null, // replica set name
            'socketTimeoutMS' => null,
            'ssl' => null,
            'tls' => null,
            'tlsAllowInvalidCertificates' => null,
            'tlsAllowInvalidHostnames' => null,
            'tlsCAFile' => null,
            'tlsCertificateKeyFile' => null,
            'tlsCertificateKeyFilePassword' => null,
            'tlsDisableCertificateRevocationCheck' => null,
            'tlsDisableOCSPEndpointCheck' => null,
            'tlsInsecure' => null,
            'username' => null,
            'retryReads' => null,
            'retryWrites' => null,
            'w' => null,
            'wTimeoutMS' => null,
        ])
};
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

1	# config/packages/doctrine_mongodb.yaml doctrine_mongodb: connections: default: server: mongodb://localhost:27017 options: {} default_database: hello_%kernel.environment% document_managers: default: mappings: App: is_bundle: false dir: '%kernel.project_dir%/src/Document' prefix: 'App\Document' alias: App metadata_cache_driver: array # array, service, apcu, memcached, redis
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

1	<?xml version="1.0" ?> <container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:doctrine_mongodb="http://symfony.com/schema/dic/doctrine/odm/mongodb" xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd http://symfony.com/schema/dic/doctrine/odm/mongodb https://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd"> <doctrine_mongodb:config default-database="hello_%kernel.environment%"> <doctrine_mongodb:connection id="default" server="mongodb://localhost:27017"> <doctrine_mongodb:options> </doctrine_mongodb:options> </doctrine_mongodb:connection> <doctrine_mongodb:document-manager id="default"> <doctrine_mongodb:mapping name="App" is-bundle="false" prefix="App\Document" alias="App" /> <doctrine_mongodb:metadata-cache-driver type="array" /> </doctrine_mongodb:document-manager> </doctrine_mongodb:config> </container>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

1	use function Symfony\Component\DependencyInjection\Loader\Configurator\env; use function Symfony\Component\DependencyInjection\Loader\Configurator\param; use Symfony\Config\DoctrineMongodbConfig; return static function (DoctrineMongodbConfig $config): void { $config->connection('default') ->server(env('MONGODB_URL')->default('mongodb://localhost:27017')->resolve()) ->options([]); $config->defaultDatabase('hello_' . param('kernel.environment')); $config->documentManager('default') ->mapping('App') ->isBundle(false) ->dir(param('kernel.project_dir') . '/src/Document') ->prefix('App\\Document') ->alias('App') ->metadataCacheDriver('array'); // array, service, apcu, memcached, redis };
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

1	# app/config/config.yml doctrine_mongodb: default_database: hello_%kernel.environment% connections: default: server: mongodb://localhost:27017 options: {} document_managers: default: mappings: App: ~ metadata_cache_driver: type: memcached class: Symfony\Component\Cache\Adapter\MemcachedAdapter host: localhost port: 11211 instance_class: Memcached
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

1	doctrine_mongodb: document_managers: default: mappings: App: ~ App2: xml App3: { type: attribute, dir: Documents/ } App4: { type: xml, dir: config/doctrine/mapping } App5: type: xml dir: my-app-mappings-dir alias: AppAlias doctrine_extensions: type: xml dir: "%kernel.project_dir%/src/vendor/DoctrineExtensions/lib/DoctrineExtensions/Documents" prefix: DoctrineExtensions\Documents\ alias: DExt
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

1	doctrine_mongodb: types: custom_type: Fully\Qualified\Class\Name
2
3

1	use Symfony\Config\DoctrineMongodbConfig; return static function (DoctrineMongodbConfig $config): void { $config->type('custom_type') ->class(\Fully\Qualified\Class\Name::class) ; }
2
3
4
5
6
7

1	doctrine_mongodb: default_database: hello_%kernel.environment% default_connection: conn2 default_document_manager: dm2 connections: conn1: server: mongodb://localhost:27017 conn2: server: mongodb://localhost:27017 document_managers: dm1: connection: conn1 database: db1 metadata_cache_driver: array mappings: App: ~ dm2: connection: conn2 database: db2 mappings: AnotherApp: ~
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

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

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

1	doctrine_mongodb: # ... connections: default: server: "mongodb://mongodb-01:27017,mongodb-02:27017,mongodb-03:27017/?replicaSet=replSetName"
2
3
4
5

1	services: # ... app.mongodb.context_service: class: 'resource' factory: 'stream_context_create' arguments: - { ssl: { verify_expiry: true } }
2
3
4
5
6
7
8

1	use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator; return static function (ContainerConfigurator $container): void { $container->services() ->set('app.mongodb.context_service', 'resource') ->factory('stream_context_create') ->args([ ['ssl' => ['verify_expiry' => true]], ]) ; };
2
3
4
5
6
7
8
9
10
11

1	doctrine_mongodb: document_managers: # Prototype id: connection: ~ database: ~ default_document_repository_class: Doctrine\ODM\MongoDB\Repository\DocumentRepository default_gridfs_repository_class: Doctrine\ODM\MongoDB\Repository\DefaultGridFSRepository repository_factory: ~ persistent_collection_factory: ~ logging: true auto_mapping: false metadata_cache_driver: type: ~ class: ~ host: ~ port: ~ instance_class: ~ mappings: # Prototype name: mapping: true type: ~ dir: ~ prefix: ~ alias: ~ is_bundle: ~ types: # Prototype custom_type: Fully\Qualified\Class\Name connections: # Prototype id: server: ~ options: authMechanism: ~ connectTimeoutMS: ~ db: ~ authSource: ~ journal: ~ password: ~ readPreference: ~ readPreferenceTags: ~ replicaSet: ~ # replica set name socketTimeoutMS: ~ ssl: ~ tls: ~ tlsAllowInvalidCertificates: ~ tlsAllowInvalidHostnames: ~ tlsCAFile: ~ tlsCertificateKeyFile: ~ tlsCertificateKeyFilePassword: ~ tlsDisableCertificateRevocationCheck: ~ tlsDisableOCSPEndpointCheck: ~ tlsInsecure: ~ username: ~ retryReads: ~ retryWrites: ~ w: ~ wTimeoutMS: ~ driver_options: context: ~ # stream context to use for connection proxy_namespace: MongoDBODMProxies proxy_dir: "%kernel.cache_dir%/doctrine/odm/mongodb/Proxies" auto_generate_proxy_classes: 0 hydrator_namespace: Hydrators hydrator_dir: "%kernel.cache_dir%/doctrine/odm/mongodb/Hydrators" auto_generate_hydrator_classes: 0 persistent_collection_namespace: PersistentCollections persistent_collection_dir: "%kernel.cache_dir%/doctrine/odm/mongodb/PersistentCollections" auto_generate_persistent_collection_classes: 0 default_document_manager: ~ default_connection: ~ default_database: default
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

Maintained

Unmaintained