sterntours/trunk/_vendor/doctrine/doctrine-cache-bundle/Resources/doc/reference.rst
Kevin Adametz 33458b2ca3 Update
2020-03-07 19:46:02 +01:00

183 lines
3.2 KiB
ReStructuredText

Built-in Cache Providers Reference
----------------------------------
This is the reference of all the built-in cache providers and their configuration
options:
``apc``
~~~~~~~
This provider defines no configuration options.
``array``
~~~~~~~~~
This provider defines no configuration options.
``chain``
~~~~~~~~~
``providers``
The list of service ids of Doctrine Cache Providers to use. Put the fastest
providers first (e.g. ``array`` cache) and you can skip
``doctrine_cache.providers``.
``couchbase``
~~~~~~~~~~~~~
``connection_id``
Couchbase connection service id
``hostnames``
Couchbase hostname list
``bucket_name``
Couchbase bucket name
``username``
Couchbase username
``password``
Couchbase password
``file_system``
~~~~~~~~~~~~~~~
``extension``
File extension
``directory``
Cache directory
``umask``
Umask to revoke permissions
``mongodb``
~~~~~~~~~~~
``connection_id``
MongoClient service id
``collection_id``
MongoCollection service id
``server``
mongodb server uri
``database_name``
mongodb database name
``collection_name``
mongodb collection name
``memcache``
~~~~~~~~~~~~
``connection_id``
Memcache connection service id
``servers``
Server list
* ``server``
* ``host``, Memcache host
* ``port``, Memcache port
``memcached``
~~~~~~~~~~~~~
``connection_id``
Memcache connection service id
``servers``
Server list
* ``server``
* ``host``, Memcached host
* ``port``, Memcached port
``php_file``
~~~~~~~~~~~~
``extension``
File extension
``directory``
Cache directory
``umask``
Umask to revoke permissions
``redis``
~~~~~~~~~
``connection_id``
Redis connection service id
``host``
Redis host
``port``
Redis port
``password``
Redis password
``timeout``
Redis connection timeout
``database``
Redis database selection (integer)
``persistent``
Whether to use persistent connection or not (bool)
``predis``
~~~~~~~~~~
``client_id``
Provide a client service id to skip the client creation by the bundle
(optional, should be used for advanced configuration)
``scheme``
Connection scheme (tcp)
``host``
Redis host
``port``
Redis port
``password``
Redis password
``timeout``
Redis connection timeout
``database``
Redis database selection (integer)
``options``
Array of predis client options
``riak``
~~~~~~~~
``connection_id``
Riak\Connection service id
``bucket_id``
Riak\Bucket service id
``host``
Riak host
``port``
Riak port
``bucket_name``
Riak bucket name
``bucket_property_list``
Riak bucket configuration (property list)
* ``allow_multiple: false``, riak bucket allow multiple configuration
* ``n_value: 1``, riak bucket n-value configuration
``sqlite3``
~~~~~~~~~~~
``connection_id``
SQLite3 connection service id
``file_name``
SQLite3 database file name
``table_name``
Cache table name
``void``
~~~~~~~~
This provider defines no configuration options.
``xcache``
~~~~~~~~~~
This provider defines no configuration options.
``wincache``
~~~~~~~~~~~~
This provider defines no configuration options.
``zenddata``
~~~~~~~~~~~~
This provider defines no configuration options.