Skip to content

Adding Database caching info to the docs #1100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nep wants to merge 1 commit into
base: 7.dev
Choose a base branch
from
Open

Adding Database caching info to the docs #1100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/general/system-configuration-overrides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,7 @@ Specify a different [caching driver](optimization/caching.md#caching-drivers) to
| Values | Description |
| --------- | -------------------------------------------------- |
| file | File driver, /system/user/cache/ (default) |
| database | Database driver, uses the DB for caching |
| memcached | Memcached driver, configured with memcached config |
| redis | Redis driver, configured with redis config |
| dummy | Dummy driver, will not cache |
Expand Down Expand Up @@ -1202,7 +1203,7 @@ Example Usage:

### `enable_entry_cloning`

When set to `n`, disables "Clone to New Entry" option and entry cloning globally.
When set to `n`, disables "Clone to New Entry" option and entry cloning globally.

| Value | Behavior |
| ----- | ---------------------------------------------- |
Expand Down Expand Up @@ -1423,7 +1424,7 @@ Example Usage:

### `favicon`

URL to file used as favicon in Control Panel.
URL to file used as favicon in Control Panel.

Example Usage:

Expand Down Expand Up @@ -3040,7 +3041,7 @@ Stream encryption method, when using TLS for sending emails over SMTP.
| STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT | TLS v1.2 (default) |
| STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT | TLS v1.3 (as of PHP 7.4.0) |


Example Usage:

$config['tls_crypto_method'] = STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT;
Expand Down
2 changes: 2 additions & 0 deletions docs/optimization/caching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ By default, ExpressionEngine uses a file-based caching driver, meaning cached it

ExpressionEngine currently supports Memcached and Redis for memory-based caching. You can set which driver is being used in the control panel or via the [cache_driver](general/system-configuration-overrides.md#cache_driver) config override. [Memcached](general/system-configuration-overrides.md#memcached) and [Redis](general/system-configuration-overrides.md#redis) server information can also be set in `config.php`, otherwise ExpressionEngine will try to connect to the default respective ports on localhost.

You can also set caching to Database, which uses the same database for cache data as the rest of your site data. There are pros and cons to this approach. If you can't easily use memcached or redis, database caching can be another way to use RAM-based caching; on the other hand, this can create additional database read and write calls that can be slower than file or memory-based caching choices. Database works well in load balanced environments, where memcache and redis are more difficult to work with due to the difficulty in synchronizing across servers. Test out database caching performance and compare your specific results before committing to it.

A [backup driver](general/system-configuration-overrides.md#cache_driver_backup) can also be specified in the case your primary driver is unavailable. By default, the backup driver is the file driver and it's likely the best failover option due to its reliability, but the backup driver is configurable.

Add-on developers can find more information about using caching drivers to store and retrieve items in the [Cache Class](development/legacy/libraries/cache.md) documentation.
Expand Down