michael-s-molina commented on a change in pull request #18976: URL: https://github.com/apache/superset/pull/18976#discussion_r817609009
########## File path: docs/docs/installation/cache.mdx ########## @@ -7,37 +7,36 @@ version: 1 ## Caching -Superset uses [Flask-Caching](https://flask-caching.readthedocs.io/) for caching purpose. For security reasons, -there are two separate cache configs for Superset's own metadata (`CACHE_CONFIG`) and charting data queried from -connected datasources (`DATA_CACHE_CONFIG`). However, Query results from SQL Lab are stored in another backend -called `RESULTS_BACKEND`, See [Async Queries via Celery](/docs/installation/async-queries-celery) for details. - -Configuring caching is as easy as providing `CACHE_CONFIG` and `DATA_CACHE_CONFIG` in your +Superset uses [Flask-Caching](https://flask-caching.readthedocs.io/) for caching purpose. Default caching options +can be set by overriding the `DEFAULT_CACHE_CONFIG` in your `superset_config.py`. Unless overridden, the default +cache type will be set to `SimpleCache` when running in debug mode, and `NullCache` otherwise. + +Currently there are five separate cache configurations to provide additional security and more granular customization options: +- Metadata cache (optional): `CACHE_CONFIG` +- Charting data queried from datasets (optional): `DATA_CACHE_CONFIG` +- SQL Lab query results (optional): `RESULTS_BACKEND`. See [Async Queries via Celery](/docs/installation/async-queries-celery) for details +- Dashboard filter state (required): `FILTER_STATE_CACHE_CONFIG`. +- Explore chart form data (required): `EXPLORE_FORM_DATA_CACHE_CONFIG` + +Configuring caching is as easy as providing a custom cache config in your `superset_config.py` that complies with [the Flask-Caching specifications](https://flask-caching.readthedocs.io/en/latest/#configuring-flask-caching). - Flask-Caching supports various caching backends, including Redis, Memcached, SimpleCache (in-memory), or the -local filesystem. +local filesystem. Custom cache backends are also supported. See [here](https://flask-caching.readthedocs.io/en/latest/#custom-cache-backends) for specifics. +Note that Dashboard and Explore caching is required, and configuring the application with either of these caches set to `NullCache` will +cause the application to fail on startup. Also keep in mind, tht when running Superset on a multi-worker setup, a dedicated cache is required. Review comment: ```suggestion cause the application to fail on startup. Also, keep in mind that when running Superset on a multi-worker setup, a dedicated cache is required. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
