Create custom cache engines

Edit on GitHub
Log an Issue

Overview of database caching

This topic discusses how to use the Magento 2 database for caching. After you complete these tasks, cached objects are stored in the cache and cache_tag Magento 2 database tables. Nothing is stored var/cache or var/page_cache.

This topic discusses how to set up database caching and how to verify database caching is working. We discuss the following options:

  • Using the default cache frontend, in which case you modify di.xml only.
  • Using a custom cache frontend, in which case you modify env.php only.

Database caching—like file-based caching— works well in a development environment but we strongly recommend you use Varnish in production instead. Varnish is designed to accelerate the HTTP protocol.

Prerequisites

Before you continue, if you’re using your own frontend cache, make sure you associate cache frontends with cache types. If you’re using the default frontend cache, you don’t have to do that.

We provide sample configurations at the end of this topic.

Database caching using the default cache frontend

To enable database caching using the default frontend, you must modify <magento_root>/app/etc/di.xml, which is the global deployment injection configuration for the Magento application.

To modify di.xml:

  1. Log in to the Magento server as, or switch to, the Magento file system owner.

  2. Enter the following commands to make a copy of di.xml:

    1

    cd <magento_root>/app/etc

    1

    cp di.xml di.xml.bak

  3. Open di.xml in a text editor and locate the following block:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

    <type name="Magento\Framework\App\Cache\Frontend\Pool">
    <arguments>
        <argument name="frontendSettings" xsi:type="array">
            <item name="page_cache" xsi:type="array">
                <item name="backend_options" xsi:type="array">
                    <item name="cache_dir" xsi:type="string">page_cache</item>
                </item>
            </item>
        </argument>
    </arguments>
</type>
<type name="Magento\Framework\App\Cache\Type\FrontendPool">
    <arguments>
        <argument name="typeFrontendMap" xsi:type="array">
            <item name="full_page" xsi:type="string">page_cache</item>
        </argument>
    </arguments>
</type>

    The <type name="Magento\Framework\App\Cache\Frontend\Pool"> node configures options for the in-memory pool of all frontend cache instances.

    The <type name="Magento\Framework\App\Cache\Type\FrontendPool"> node configures cache frontend options specific to each cache type.

  4. Replace the entire block with the following:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

    <type name="Magento\Framework\App\Cache\Frontend\Pool">
    <arguments>
        <argument name="frontendSettings" xsi:type="array">
            <item name="page_cache" xsi:type="array">
                <item name="backend" xsi:type="string">database</item>
            </item>
            <item name="<your cache id>" xsi:type="array">
                <item name="backend" xsi:type="string">database</item>
            </item>
        </argument>
    </arguments>
</type>
<type name="Magento\Framework\App\Cache\Type\FrontendPool">
    <arguments>
        <argument name="typeFrontendMap" xsi:type="array">
            <item name="backend" xsi:type="string">database</item>
        </argument>
    </arguments>
</type>

    where <your cache id> is your unique cache identifier.

  5. Save your changes to di.xml and exit the text editor.

  6. Continue with Verify database caching is working.

Database caching using a custom cache frontend

This section discusses how to set up database caching with a custom cache frontend.

Due to a known issue, a custom cache frontend still results in some objects being cached to the file system; however, fewer assets are cached compared to file system caching.

To enable database caching using a custom cache frontend, you must modify <magento_root>/app/etc/env.php as follows:

  1. Log in to the Magento server as, or switch to, the Magento file system owner.

  2. Enter the following commands to make a copy of env.php:

    1

    cd <magento_root>/app/etc

    1

    cp env.php env.php.bak

  3. Open env.php in a text editor and add the following anywhere, such as before 'cache_types' =>:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

    'cache' => [
    'frontend' => [
        '<unique frontend id>' => [
             <cache options>
        ],
    ],
    'type' => [
         <cache type 1> => [
             'frontend' => '<unique frontend id>'
        ],
    ],
    'type' => [
         <cache type 2> => [
            'frontend' => '<unique frontend id>'
        ],
    ],
],

    An example is shown in Configuration examples.

  4. Save your changes to env.php and exit the text editor.
  5. Continue with the next section.

Verify database caching is working

To verify database caching is working, clear the current cache directories, go to any cacheable page in a web browser, and verify that data is written to the database and not to the file system.

Use the following steps:

  1. If you haven’t done so already, log in to the Magento server as, or switch to, the Magento file system owner.

  2. Clear the current cache directories:

    1

    rm -rf <magento_root>/var/cache/* <magento_root>/var/page_cache/* <magento_root>/generated/metadata/* <magento_root>/generated/code/*
  3. In a web browser, go to any cacheable page (such as the storefront front door page).

If exceptions display, verify di.xml syntax and try again. (To see exceptions in the browser, you must enable developer mode.)

  1. Enter the following commands:

    1

    ls <magento_root>/var/cache/*

    1

    ls <magento_root>/var/page_cache/*

    Due to a known issue, a custom cache frontend still results in some objects being cached to the file system; however, fewer assets are cached compared to file system caching. If you use the default cache frontend, you don’t have this issue.

  2. Verify both directories are empty; if not, edit di.xml again and correct any issues.

  3. Use a database tool such as phpMyAdmin to verify there is data in the cache and cache_tag tables.

    The following figures show examples. The important thing is that there are rows in the tables. The data in your tables will be different than the following.

    cache table example.

    Sample contents of the cache table with database caching enabled

    cache_tag table example.

    Sample contents of the cache tag table with database caching enabled

Configuration examples

This section contains code sample snippets to refer to when configuring database caching.

Sample di.xml for the default cache frontend

di.xml snippet:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

<type name="Magento\Framework\App\Cache\Frontend\Pool">
    <arguments>
        <argument name="frontendSettings" xsi:type="array">
            <item name="page_cache" xsi:type="array">
                <item name="backend" xsi:type="string">database</item>
            </item>
            <item name="default" xsi:type="array">
                <item name="backend" xsi:type="string">database</item>
            </item>
        </argument>
    </arguments>
</type>
<type name="Magento\Framework\App\Cache\Type\FrontendPool">
    <arguments>
        <argument name="typeFrontendMap" xsi:type="array">
            <item name="backend" xsi:type="string">database</item>
        </argument>
    </arguments>
</type>

Sample env.php for a custom cache frontend

env.php snippet that enables all cache types with a custom frontend named magento_cache:

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

'cache' => [
    'frontend' => [
        'magento_cache' => [
            'backend' => 'database'
        ],
    ],
    'type' => [
        'config' => [
            'frontend' => 'magento_cache'
        ],
        'layout' => [
            'frontend' => 'magento_cache'
        ],
        'block_html' => [
            'frontend' => 'magento_cache'
        ],
        'view_files_fallback' => [
            'frontend' => 'magento_cache'
        ],
        'view_files_preprocessing' => [
            'frontend' => 'magento_cache'
        ],
        'collections' => [
            'frontend' => 'magento_cache'
        ],
        'db_ddl' => [
            'frontend' => 'magento_cache'
        ],
        'eav' => [
            'frontend' => 'magento_cache'
        ],
        'full_page' => [
            'frontend' => 'magento_cache'
        ],
        'translate' => [
            'frontend' => 'magento_cache'
        ],
        'config_integration' => [
            'frontend' => 'magento_cache'
        ],
        'config_integration_api' => [
            'frontend' => 'magento_cache'
        ],
        'config_webservice' => [
            'frontend' => 'magento_cache'
        ],
    ],
],
© 2020 Magento. All rights reserved.