Skip to content

Latest commit

 

History

History
103 lines (80 loc) · 4.15 KB

FEATURE_FLAGS.md

File metadata and controls

103 lines (80 loc) · 4.15 KB
Raw

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.

  • ALERT_REPORT_TABS
  • ENABLE_ADVANCED_DATA_TYPES
  • PRESTO_EXPAND_DATA
  • SHARE_QUERIES_VIA_KV_STORE
  • TAGGING_SYSTEM
  • CHART_PLUGINS_EXPERIMENTAL

In Testing

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

  • ALERT_REPORTS: (docs)
  • ALLOW_FULL_CSV_EXPORT
  • CACHE_IMPERSONATION
  • CONFIRM_DASHBOARD_DIFF
  • DRILL_TO_DETAIL
  • DYNAMIC_PLUGINS
  • ENABLE_SUPERSET_META_DB: (docs)
  • ESTIMATE_QUERY_COST
  • GLOBAL_ASYNC_QUERIES (docs)
  • HORIZONTAL_FILTER_BAR
  • IMPERSONATE_WITH_EMAIL_PREFIX
  • PLAYWRIGHT_REPORTS_AND_THUMBNAILS
  • RLS_IN_SQLLAB
  • SSH_TUNNELING (docs)
  • USE_ANALAGOUS_COLORS

Stable

These features flags are safe for production. They have been tested and will be supported for the at least the current major version cycle.

Flags on the path to feature launch and flag deprecation/removal

  • DASHBOARD_VIRTUALIZATION
  • DRILL_BY
  • DISABLE_LEGACY_DATASOURCE_EDITOR

Flags retained for runtime configuration

Currently some of our feature flags act as dynamic configurations that can changed on the fly. This acts in contradiction with the typical ephemeral feature flag use case, where the flag is used to mature a feature, and eventually deprecated once the feature is solid. Eventually we'll likely refactor these under a more formal "dynamic configurations" managed independently. This new framework will also allow for non-boolean configurations.

  • ALERTS_ATTACH_REPORTS
  • ALLOW_ADHOC_SUBQUERY
  • DASHBOARD_RBAC (docs)
  • DATAPANEL_CLOSED_BY_DEFAULT
  • DRUID_JOINS
  • EMBEDDABLE_CHARTS
  • EMBEDDED_SUPERSET
  • ENABLE_TEMPLATE_PROCESSING
  • ESCAPE_MARKDOWN_HTML
  • LISTVIEWS_DEFAULT_CARD_VIEW
  • SCHEDULED_QUERIES (docs)
  • SLACK_ENABLE_AVATARS (see superset/config.py for more information)
  • SQLLAB_BACKEND_PERSISTENCE
  • SQL_VALIDATORS_BY_ENGINE (docs)
  • 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.

  • AVOID_COLORS_COLLISION
  • DASHBOARD_CROSS_FILTERS
  • ENABLE_JAVASCRIPT_CONTROLS
  • KV_STORE