2021-03-16 17:11:17 -04:00
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
2022-10-06 07:53:51 -04:00
2021-03-16 17:11:17 -04:00
# Superset Feature Flags
2022-10-06 07:53:51 -04:00
2021-03-16 17:11:17 -04:00
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
2022-10-06 07:53:51 -04:00
2021-03-16 17:11:17 -04:00
These features are considered **unfinished** and should only be used on development environments.
2022-10-06 07:53:51 -04:00
[//]: # "PLEASE KEEP THE LIST SORTED ALPHABETICALLY"
2024-04-11 13:50:06 -04:00
- ALERT_REPORT_TABS
2022-10-06 07:53:51 -04:00
- ENABLE_ADVANCED_DATA_TYPES
2021-03-16 17:11:17 -04:00
- PRESTO_EXPAND_DATA
- SHARE_QUERIES_VIA_KV_STORE
- TAGGING_SYSTEM
2024-01-31 18:44:25 -05:00
- CHART_PLUGINS_EXPERIMENTAL
2021-03-16 17:11:17 -04:00
## In Testing
2022-10-06 07:53:51 -04:00
2021-03-16 17:11:17 -04:00
These features are **finished** but currently being tested. They are usable, but may still contain some bugs.
2022-10-06 07:53:51 -04:00
[//]: # "PLEASE KEEP THE LIST SORTED ALPHABETICALLY"
2024-04-24 17:17:50 -04:00
- ALERT_REPORTS: [(docs) ](https://superset.apache.org/docs/configuration/alerts-reports )
2022-10-06 07:53:51 -04:00
- ALLOW_FULL_CSV_EXPORT
- CACHE_IMPERSONATION
2022-11-08 16:06:19 -05:00
- CONFIRM_DASHBOARD_DIFF
2023-04-21 12:13:45 -04:00
- DRILL_TO_DETAIL
2024-04-24 17:17:50 -04:00
- DYNAMIC_PLUGINS: [(docs) ](https://superset.apache.org/docs/configuration/running-on-kubernetes )
2024-05-10 17:05:19 -04:00
- ENABLE_SUPERSET_META_DB: [(docs) ](https://superset.apache.org/docs/configuration/databases/#querying-across-databases )
2023-04-21 12:13:45 -04:00
- ESTIMATE_QUERY_COST
2022-10-06 07:53:51 -04:00
- GLOBAL_ASYNC_QUERIES [(docs) ](https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries )
2023-04-21 12:13:45 -04:00
- HORIZONTAL_FILTER_BAR
2024-05-30 13:32:39 -04:00
- IMPERSONATE_WITH_EMAIL_PREFIX
2023-10-04 00:51:58 -04:00
- PLAYWRIGHT_REPORTS_AND_THUMBNAILS
2022-10-04 13:44:57 -04:00
- RLS_IN_SQLLAB
2024-04-24 17:17:50 -04:00
- SSH_TUNNELING [(docs) ](https://superset.apache.org/docs/configuration/setup-ssh-tunneling )
2022-10-06 07:53:51 -04:00
- USE_ANALAGOUS_COLORS
2021-03-16 17:11:17 -04:00
## Stable
2022-10-06 07:53:51 -04:00
2024-04-17 11:29:11 -04:00
These features flags are **safe for production** . They have been tested and will be supported for the at least the current major version cycle.
2021-03-16 17:11:17 -04:00
2024-04-17 11:29:11 -04:00
[//]: # "PLEASE KEEP THESE LISTS SORTED ALPHABETICALLY"
### Flags on the path to feature launch and flag deprecation/removal
- DASHBOARD_VIRTUALIZATION
- DRILL_BY
- DISABLE_LEGACY_DATASOURCE_EDITOR
2022-10-06 07:53:51 -04:00
2024-04-17 11:29:11 -04:00
### Flags retained for runtime configuration
2022-10-06 07:53:51 -04:00
- ALERTS_ATTACH_REPORTS
- ALLOW_ADHOC_SUBQUERY
2024-04-24 17:17:50 -04:00
- DASHBOARD_RBAC [(docs) ](https://superset.apache.org/docs/using-superset/first-dashboard#manage-access-to-dashboards )
2023-04-21 12:13:45 -04:00
- DATAPANEL_CLOSED_BY_DEFAULT
2022-10-06 07:53:51 -04:00
- DRUID_JOINS
- EMBEDDABLE_CHARTS
- EMBEDDED_SUPERSET
2021-03-16 17:11:17 -04:00
- ENABLE_TEMPLATE_PROCESSING
2022-10-06 07:53:51 -04:00
- ESCAPE_MARKDOWN_HTML
2021-03-16 17:11:17 -04:00
- LISTVIEWS_DEFAULT_CARD_VIEW
2024-04-24 17:17:50 -04:00
- SCHEDULED_QUERIES [(docs) ](https://superset.apache.org/docs/configuration/alerts-reports )
2021-03-16 17:11:17 -04:00
- SQLLAB_BACKEND_PERSISTENCE
2024-04-24 17:17:50 -04:00
- SQL_VALIDATORS_BY_ENGINE [(docs) ](https://superset.apache.org/docs/configuration/sql-templating )
- THUMBNAILS [(docs) ](https://superset.apache.org/docs/configuration/cache )
2021-03-16 17:11:17 -04:00
## Deprecated Flags
2022-10-06 07:53:51 -04:00
2021-03-16 17:11:17 -04:00
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.
2022-10-06 07:53:51 -04:00
[//]: # "PLEASE KEEP THE LIST SORTED ALPHABETICALLY"
2024-06-20 09:30:11 -04:00
- AVOID_COLORS_COLLISION
2024-01-17 11:01:27 -05:00
- DASHBOARD_CROSS_FILTERS
2024-01-17 09:39:57 -05:00
- ENABLE_JAVASCRIPT_CONTROLS
2024-01-16 08:49:14 -05:00
- KV_STORE