superset/RESOURCES/FEATURE_FLAGS.md
Elizabeth Thompson bf424e3351
docs: add file for users to see status of feature flags (#13402)
* add file for users to see status of feature flags

* move comment

* update flags per feedback

* move to subfolder and improve docs

* move CODE_OF_CONDUCT to root
2021-03-16 14:11:17 -07:00

2.7 KiB

Superset Feature Flags

This is a list of the current Superset optional features. See config.py for default values. These features can be turned on/off by setting your preferred values in superset_config.py to True/False respectively

In Development

These features are considered unfinished and should only be used on development environments.

  • CLIENT_CACHE
  • DASHBOARD_CACHE
  • DASHBOARD_NATIVE_FILTERS_SET
  • DASHBOARD_RBAC
  • DISABLE_DATASET_SOURCE_EDIT
  • ENABLE_EXPLORE_JSON_CSRF_PROTECTION
  • KV_STORE
  • PRESTO_EXPAND_DATA
  • REMOVE_SLICE_LEVEL_LABEL_COLORS
  • SHARE_QUERIES_VIA_KV_STORE
  • TAGGING_SYSTEM

In Testing

These features are finished but currently being tested. They are usable, but may still contain some bugs.

  • ALERT_REPORTS: (docs)
  • DYNAMIC_PLUGINS: (docs)
  • DASHBOARD_NATIVE_FILTERS
  • GLOBAL_ASYNC_QUERIES (docs)
  • OMNIBAR
  • VERSIONED_EXPORT

Stable

These features flags are safe for production and have been tested.

  • DASHBOARD_CROSS_FILTERS
  • ESCAPE_MARKDOWN_HTML
  • ENABLE_TEMPLATE_PROCESSING
  • LISTVIEWS_DEFAULT_CARD_VIEW
  • ROW_LEVEL_SECURITY
  • SCHEDULED_QUERIES (docs)
  • SQL_VALIDATORS_BY_ENGINE (docs)
  • SQLLAB_BACKEND_PERSISTENCE
  • THUMBNAILS (docs)

Deprecated Flags

These features flags currently default to True and will be removed in a future major release. For this current release you can turn them off by setting your config to False, but it is advised to remove or set these flags in your local configuration to True so that you do not experience any unexpected changes in a future release.

  • ALLOW_DASHBOARD_DOMAIN_SHARDING
  • DISPLAY_MARKDOWN_HTML
  • ENABLE_REACT_CRUD_VIEWS