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"
2021-03-16 17:11:17 -04:00
- CLIENT_CACHE
2022-10-06 07:53:51 -04:00
- CROSS_REFERENCES
2021-03-16 17:11:17 -04:00
- DASHBOARD_CACHE
- DASHBOARD_NATIVE_FILTERS_SET
- DISABLE_DATASET_SOURCE_EDIT
2022-10-06 07:53:51 -04:00
- DRILL_TO_DETAIL
- ENABLE_ADVANCED_DATA_TYPES
2021-03-16 17:11:17 -04:00
- ENABLE_EXPLORE_JSON_CSRF_PROTECTION
2022-10-06 07:53:51 -04:00
- ENABLE_TEMPLATE_REMOVE_FILTERS
2021-03-16 17:11:17 -04:00
- KV_STORE
- PRESTO_EXPAND_DATA
- REMOVE_SLICE_LEVEL_LABEL_COLORS
- SHARE_QUERIES_VIA_KV_STORE
- TAGGING_SYSTEM
## 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"
2021-03-16 17:11:17 -04:00
- ALERT_REPORTS: [(docs) ](https://superset.apache.org/docs/installation/alerts-reports )
2022-10-06 07:53:51 -04:00
- ALLOW_FULL_CSV_EXPORT
- CACHE_IMPERSONATION
- DASHBOARD_EDIT_CHART_IN_NEW_TAB
- DASHBOARD_FILTERS_EXPERIMENTAL
2021-03-16 17:11:17 -04:00
- DASHBOARD_NATIVE_FILTERS
2022-10-06 07:53:51 -04:00
- DYNAMIC_PLUGINS: [(docs) ](https://superset.apache.org/docs/installation/running-on-kubernetes )
- ENABLE_FILTER_BOX_MIGRATION
2022-03-14 10:54:02 -04:00
- ENABLE_JAVASCRIPT_CONTROLS
2022-06-22 09:14:24 -04:00
- GENERIC_CHART_AXES
2022-10-06 07:53:51 -04:00
- GLOBAL_ASYNC_QUERIES [(docs) ](https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries )
2022-10-04 13:44:57 -04:00
- RLS_IN_SQLLAB
2022-10-06 07:53:51 -04:00
- USE_ANALAGOUS_COLORS
- UX_BETA
- VERSIONED_EXPORT
2021-03-16 17:11:17 -04:00
## Stable
2022-10-06 07:53:51 -04:00
2021-03-16 17:11:17 -04:00
These features flags are **safe for production** and have been tested.
2022-10-06 07:53:51 -04:00
[//]: # "PLEASE KEEP THE LIST SORTED ALPHABETICALLY"
- ALERTS_ATTACH_REPORTS
- ALLOW_ADHOC_SUBQUERY
2021-03-16 17:11:17 -04:00
- DASHBOARD_CROSS_FILTERS
2021-07-02 11:32:45 -04:00
- DASHBOARD_RBAC [(docs) ](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard#manage-access-to-dashboards )
2022-10-06 07:53:51 -04:00
- DISABLE_LEGACY_DATASOURCE_EDITOR
- DRUID_JOINS
- EMBEDDABLE_CHARTS
- EMBEDDED_SUPERSET
- ENABLE_DND_WITH_CLICK_UX
- ENABLE_EXPLORE_DRAG_AND_DROP
2021-03-16 17:11:17 -04:00
- ENABLE_TEMPLATE_PROCESSING
2022-10-06 07:53:51 -04:00
- ENFORCE_DB_ENCRYPTION_UI
- ESCAPE_MARKDOWN_HTML
2021-03-16 17:11:17 -04:00
- LISTVIEWS_DEFAULT_CARD_VIEW
- SCHEDULED_QUERIES [(docs) ](https://superset.apache.org/docs/installation/alerts-reports )
- SQLLAB_BACKEND_PERSISTENCE
2022-10-06 07:53:51 -04:00
- SQL_VALIDATORS_BY_ENGINE [(docs) ](https://superset.apache.org/docs/installation/sql-templating )
2021-03-16 17:11:17 -04:00
- THUMBNAILS [(docs) ](https://superset.apache.org/docs/installation/cache )
## 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"
2021-03-16 17:11:17 -04:00
- ALLOW_DASHBOARD_DOMAIN_SHARDING
- DISPLAY_MARKDOWN_HTML
2022-10-04 13:44:57 -04:00
- FORCE_DATABASE_CONNECTIONS_SSL