Doctrine Configuration Reference
Edit this pageWarning: You are browsing the documentation for Symfony 2.0, which is no longer maintained.
Read the updated version of this page for Symfony 7.0 (the current stable version).
Doctrine Configuration Reference
1 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
doctrine:
dbal:
default_connection: default
connections:
default:
dbname: database
host: localhost
port: 1234
user: user
password: secret
driver: pdo_mysql
driver_class: MyNamespace\MyDriverImpl
options:
foo: bar
path: "%kernel.data_dir%/data.sqlite"
memory: true
unix_socket: /tmp/mysql.sock
wrapper_class: MyDoctrineDbalConnectionWrapper
charset: UTF8
logging: "%kernel.debug%"
platform_service: MyOwnDatabasePlatformService
mapping_types:
enum: string
conn1:
# ...
types:
custom: Acme\HelloBundle\MyCustomType
orm:
auto_generate_proxy_classes: false
proxy_namespace: Proxies
proxy_dir: "%kernel.cache_dir%/doctrine/orm/Proxies"
default_entity_manager: default # The first defined is used if not set
entity_managers:
default:
# The name of a DBAL connection (the one marked as default is used if not set)
connection: conn1
mappings: # Required
AcmeHelloBundle: ~
class_metadata_factory_name: Doctrine\ORM\Mapping\ClassMetadataFactory
# All cache drivers have to be array, apc, xcache or memcache
metadata_cache_driver: array
query_cache_driver: array
result_cache_driver:
type: memcache
host: localhost
port: 11211
instance_class: Memcache
class: Doctrine\Common\Cache\MemcacheCache
dql:
string_functions:
test_string: Acme\HelloBundle\DQL\StringFunction
numeric_functions:
test_numeric: Acme\HelloBundle\DQL\NumericFunction
datetime_functions:
test_datetime: Acme\HelloBundle\DQL\DatetimeFunction
hydrators:
custom: Acme\HelloBundle\Hydrators\CustomHydrator
em2:
# ...Configuration Overview
This following configuration example shows all the configuration defaults that the ORM resolves to:
1 2 3 4 5 6 7 8 9 10 11
doctrine:
orm:
auto_mapping: true
# the standard distribution overrides this to be true in debug, false otherwise
auto_generate_proxy_classes: false
proxy_namespace: Proxies
proxy_dir: "%kernel.cache_dir%/doctrine/orm/Proxies"
default_entity_manager: default
metadata_cache_driver: array
query_cache_driver: array
result_cache_driver: arrayThere are lots of other configuration options that you can use to overwrite certain classes, but those are for very advanced use-cases only.
Caching Drivers
For the caching drivers you can specify the values "array", "apc", "memcache" or "xcache".
The following example shows an overview of the caching configurations:
1 2 3 4 5 6 7 8 9 10
doctrine:
orm:
auto_mapping: true
metadata_cache_driver: apc
query_cache_driver: xcache
result_cache_driver:
type: memcache
host: localhost
port: 11211
instance_class: MemcacheMapping Configuration
Explicit definition of all the mapped entities is the only necessary configuration for the ORM and there are several configuration options that you can control. The following configuration options exist for a mapping:
typeOne ofannotation,xml,yml,phporstaticphp. This specifies which type of metadata type your mapping uses.dirPath 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%).prefixA common namespace prefix that all entities of this mapping share. This prefix should never conflict with prefixes of other defined mappings otherwise some of your entities cannot be found by Doctrine. This option defaults to the bundle namespace +Entity, for example for an application bundle calledAcmeHelloBundleprefix would beAcme\HelloBundle\Entity.aliasDoctrine offers a way to alias entity namespaces to simpler, shorter names to be used in DQL queries or for Repository access. When using a bundle the alias defaults to the bundle name.is_bundleThis option is a derived value fromdirand by default is set to true if dir is relative proved by afile_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.
Doctrine DBAL Configuration
DoctrineBundle supports all parameters that default Doctrine drivers accept, converted to the XML or YAML naming standards that Symfony enforces. See the Doctrine DBAL documentation for more information. The following block shows all possible configuration keys:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
doctrine:
dbal:
dbname: database
host: localhost
port: 1234
user: user
password: secret
driver: pdo_mysql
# the DBAL driverClass option
driver_class: MyNamespace\MyDriverImpl
# the DBAL driverOptions option
options:
foo: bar
path: "%kernel.data_dir%/data.sqlite"
memory: true
unix_socket: /tmp/mysql.sock
# the DBAL wrapperClass option
wrapper_class: MyDoctrineDbalConnectionWrapper
charset: UTF8
logging: "%kernel.debug%"
platform_service: MyOwnDatabasePlatformService
mapping_types:
enum: string
types:
custom: Acme\HelloBundle\MyCustomTypeIf you want to configure multiple connections in YAML, put them under the
connections key and give them a unique name:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
doctrine:
dbal:
default_connection: default
connections:
default:
dbname: Symfony2
user: root
password: null
host: localhost
customer:
dbname: customer
user: root
password: null
host: localhostThe database_connection service always refers to the default connection,
which is the first one defined or the one configured via the
default_connection parameter.
Each connection is also accessible via the doctrine.dbal.[name]_connection
service where [name] if the name of the connection.
