Spaces:
Paused
Paused
| { | |
| "generated": true, | |
| "source": "superset/config.py", | |
| "flags": { | |
| "development": [ | |
| { | |
| "name": "AG_GRID_TABLE_ENABLED", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enables Table V2 (AG Grid) viz plugin" | |
| }, | |
| { | |
| "name": "ALERT_REPORT_TABS", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enables experimental tabs UI for Alerts and Reports" | |
| }, | |
| { | |
| "name": "CHART_PLUGINS_EXPERIMENTAL", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enables experimental chart plugins" | |
| }, | |
| { | |
| "name": "CSV_UPLOAD_PYARROW_ENGINE", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Experimental PyArrow engine for CSV parsing (may have issues with dates/nulls)" | |
| }, | |
| { | |
| "name": "DATASET_FOLDERS", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Allow metrics and columns to be grouped into folders in the chart builder" | |
| }, | |
| { | |
| "name": "DATE_RANGE_TIMESHIFTS_ENABLED", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enable support for date range timeshifts (e.g., \"2015-01-03 : 2015-01-04\") in addition to relative timeshifts (e.g., \"1 day ago\")" | |
| }, | |
| { | |
| "name": "ENABLE_ADVANCED_DATA_TYPES", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enables advanced data type support" | |
| }, | |
| { | |
| "name": "ENABLE_EXTENSIONS", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enable Superset extensions for custom functionality without modifying core" | |
| }, | |
| { | |
| "name": "FAB_API_KEY_ENABLED", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enable API key authentication via FAB SecurityManager When enabled, users can create/manage API keys in the User Info page" | |
| }, | |
| { | |
| "name": "GRANULAR_EXPORT_CONTROLS", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enable granular export controls (can_export_data, can_export_image, can_copy_clipboard) instead of the single can_csv permission" | |
| }, | |
| { | |
| "name": "MATRIXIFY", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enable Matrixify feature for matrix-style chart layouts" | |
| }, | |
| { | |
| "name": "MOBILE_CONSUMPTION_MODE", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Serve a consumption-only mobile experience (dashboards, dashboard list, and home page) on small screens; other views show a \"not supported on mobile\" screen. Authoring features are hidden on mobile when enabled." | |
| }, | |
| { | |
| "name": "OPTIMIZE_SQL", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Try to optimize SQL queries \u2014 for now only predicate pushdown is supported" | |
| }, | |
| { | |
| "name": "PRESTO_EXPAND_DATA", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Expand nested types in Presto into extra columns/arrays. Experimental, doesn't work with all nested types." | |
| }, | |
| { | |
| "name": "SEMANTIC_LAYERS", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enable semantic layers and show semantic views alongside datasets" | |
| }, | |
| { | |
| "name": "SOFT_DELETE", | |
| "default": true, | |
| "lifecycle": "development", | |
| "description": "Temporary rollout / kill-switch gate for soft delete (off = legacy hard delete). An emergency stop, not a clean rollback: flipping ON->OFF resurrects already-soft-deleted rows. Retained through this release as the move-back lever; removed (along with its two gate points \u2014 BaseDAO.delete routing and the do_orm_execute visibility listener) once post-flip confidence is established." | |
| }, | |
| { | |
| "name": "TABLE_V2_TIME_COMPARISON_ENABLED", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enable Table V2 time comparison feature" | |
| }, | |
| { | |
| "name": "TAGGING_SYSTEM", | |
| "default": false, | |
| "lifecycle": "development", | |
| "description": "Enables the tagging system for organizing assets" | |
| }, | |
| { | |
| "name": "VERSION_HISTORY", | |
| "default": true, | |
| "lifecycle": "development", | |
| "description": "Enables the version history panel on Explore and Dashboard pages. History only accrues while ``ENABLE_VERSIONING_CAPTURE`` is also on; with capture off the panel renders but stays empty, so the two ship with matching defaults and should be changed together." | |
| } | |
| ], | |
| "testing": [ | |
| { | |
| "name": "ALERT_REPORTS", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Enables Alerts and Reports functionality", | |
| "docs": "https://superset.apache.org/docs/configuration/alerts-reports" | |
| }, | |
| { | |
| "name": "ALERT_REPORTS_FILTER", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Enables filter functionality in Alerts and Reports" | |
| }, | |
| { | |
| "name": "ALERT_REPORT_SLACK_V2", | |
| "default": true, | |
| "lifecycle": "testing", | |
| "description": "Enables Slack V2 integration for Alerts and Reports. Defaults to True; the legacy Slack v1 path is deprecated and will be removed in the next major release. Operators must grant the Slack bot both the `channels:read` and `groups:read` scopes so existing v1 recipients can be auto-upgraded on their next send. Without those scopes, file uploads fail (Slack retired the `files.upload` endpoint in 2025) and only text-only `chat_postMessage` sends will continue to work via the legacy path." | |
| }, | |
| { | |
| "name": "ALERT_REPORT_WEBHOOK", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Enables webhook integration for Alerts and Reports" | |
| }, | |
| { | |
| "name": "ALLOW_FULL_CSV_EXPORT", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Allow users to export full CSV of table viz type. Warning: Could cause server memory/compute issues with large datasets." | |
| }, | |
| { | |
| "name": "ASSIGN_CREATOR_GROUPS_AS_VIEWERS", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Share a newly created dashboard or chart read-only with every group its creator belongs to, unless the create payload names viewers explicitly. Requires ENABLE_VIEWERS. Narrows access: an asset with no viewers falls back to datasource permissions; one with viewers is limited to its editors and viewers, and dashboards must also be published before those viewers gain access.", | |
| "category": "security" | |
| }, | |
| { | |
| "name": "AWS_DATABASE_IAM_AUTH", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Enable AWS IAM authentication for database connections (Aurora, Redshift). Allows cross-account role assumption via STS AssumeRole. Security note: When enabled, ensure Superset's IAM role has restricted sts:AssumeRole permissions to prevent unauthorized access." | |
| }, | |
| { | |
| "name": "CACHE_IMPERSONATION", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Enable caching per impersonation key in datasources with user impersonation" | |
| }, | |
| { | |
| "name": "DATE_FORMAT_IN_EMAIL_SUBJECT", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Allow users to optionally specify date formats in email subjects", | |
| "docs": "https://superset.apache.org/docs/configuration/alerts-reports" | |
| }, | |
| { | |
| "name": "DYNAMIC_PLUGINS", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Enable dynamic plugin loading" | |
| }, | |
| { | |
| "name": "ENABLE_DASHBOARD_DOWNLOAD_WEBDRIVER_SCREENSHOT", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Generate screenshots (PDF/JPG) of dashboards using web driver. Depends on ENABLE_DASHBOARD_SCREENSHOT_ENDPOINTS." | |
| }, | |
| { | |
| "name": "ENABLE_DASHBOARD_SCREENSHOT_ENDPOINTS", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Enables endpoints to cache and retrieve dashboard screenshots via webdriver. Requires Celery and THUMBNAIL_CACHE_CONFIG." | |
| }, | |
| { | |
| "name": "ENABLE_SUPERSET_META_DB", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Allows users to add a superset:// DB that can query across databases. Experimental with potential security/performance risks. See SUPERSET_META_DB_LIMIT.", | |
| "docs": "https://superset.apache.org/user-docs/databases/supported/superset-meta-database" | |
| }, | |
| { | |
| "name": "ENABLE_VIEWERS", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Subject-based viewer access control for dashboards and charts. When enabled, resources can have explicit viewer Subject assignments.", | |
| "category": "security" | |
| }, | |
| { | |
| "name": "ESTIMATE_QUERY_COST", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Enable query cost estimation. Supported in Presto, Postgres, and BigQuery. Requires `cost_estimate_enabled: true` in database `extra` attribute." | |
| }, | |
| { | |
| "name": "GLOBAL_ASYNC_QUERIES", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Enable async queries for dashboards and Explore via WebSocket. Requires Redis 5.0+ and Celery workers.", | |
| "docs": "https://superset.apache.org/docs/contributing/misc#async-chart-queries" | |
| }, | |
| { | |
| "name": "IMPERSONATE_WITH_EMAIL_PREFIX", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "When impersonating a user, use the email prefix instead of username" | |
| }, | |
| { | |
| "name": "RLS_IN_SQLLAB", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Apply RLS rules to SQL Lab queries. Requires query parsing/manipulation. May break queries or allow RLS bypass. Use with care!" | |
| }, | |
| { | |
| "name": "SSH_TUNNELING", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Allow users to enable SSH tunneling when creating a DB connection. DB engine must support SSH Tunnels.", | |
| "docs": "https://superset.apache.org/docs/configuration/setup-ssh-tunneling" | |
| }, | |
| { | |
| "name": "USE_ANALOGOUS_COLORS", | |
| "default": false, | |
| "lifecycle": "testing", | |
| "description": "Use analogous colors in charts" | |
| } | |
| ], | |
| "stable": [ | |
| { | |
| "name": "ALERTS_ATTACH_REPORTS", | |
| "default": true, | |
| "lifecycle": "stable", | |
| "description": "When enabled, alerts send email/slack with screenshot AND link. When disabled, alerts send only link; reports still send screenshot.", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "ALLOW_ADHOC_SUBQUERY", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Allow ad-hoc subqueries in SQL Lab", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "CACHE_QUERY_BY_USER", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Enable caching per user key for Superset cache", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "CSS_TEMPLATES", | |
| "default": true, | |
| "lifecycle": "stable", | |
| "description": "Enables CSS Templates in Settings menu and dashboard forms", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "DASHBOARD_VIRTUALIZATION", | |
| "default": true, | |
| "lifecycle": "stable", | |
| "description": "Enables dashboard virtualization for improved performance", | |
| "category": "path_to_deprecation" | |
| }, | |
| { | |
| "name": "DASHBOARD_VIRTUALIZATION_DEFER_DATA", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Supports simultaneous data and dashboard virtualization for backend performance", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "DATAPANEL_CLOSED_BY_DEFAULT", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Data panel closed by default in chart builder", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "DISABLE_EMBEDDED_SUPERSET_LOGOUT", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Hide the logout button in embedded contexts (e.g., when using SSO in iframes)", | |
| "docs": "https://superset.apache.org/docs/configuration/networking-settings#hiding-the-logout-button-in-embedded-contexts", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "DRILL_BY", | |
| "default": true, | |
| "lifecycle": "stable", | |
| "description": "Enable drill-by functionality in charts", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "DRUID_JOINS", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Enable Druid JOINs (requires Druid version with JOIN support)", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "EMBEDDABLE_CHARTS", | |
| "default": true, | |
| "lifecycle": "stable", | |
| "description": "Enable sharing charts with embedding", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "EMBEDDED_SUPERSET", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Enable embedded Superset functionality", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "ENABLE_FACTORY_RESET_COMMAND", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Enable factory reset CLI command", | |
| "category": "internal" | |
| }, | |
| { | |
| "name": "ENABLE_TEMPLATE_PROCESSING", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Enable Jinja templating in SQL queries", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "ESCAPE_MARKDOWN_HTML", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Escape HTML in Markdown components (rather than rendering it)", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "FILTERBAR_CLOSED_BY_DEFAULT", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Filter bar closed by default when opening dashboard", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "FORCE_GARBAGE_COLLECTION_AFTER_EVERY_REQUEST", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Force garbage collection after every request", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "LISTVIEWS_DEFAULT_CARD_VIEW", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Use card view as default in list views", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "MENU_HIDE_USER_INFO", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Hide user info in the navigation menu", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "SLACK_ENABLE_AVATARS", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Use Slack avatars for users. Requires adding slack-edge.com to TALISMAN_CONFIG.", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "SQLLAB_BACKEND_PERSISTENCE", | |
| "default": true, | |
| "lifecycle": "stable", | |
| "description": "Enable SQL Lab backend persistence for query state", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "SQLLAB_FORCE_RUN_ASYNC", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Force SQL Lab to run async via Celery regardless of database settings", | |
| "category": "runtime_config" | |
| }, | |
| { | |
| "name": "THUMBNAILS", | |
| "default": false, | |
| "lifecycle": "stable", | |
| "description": "Exposes API endpoint to compute thumbnails", | |
| "docs": "https://superset.apache.org/docs/configuration/cache", | |
| "category": "runtime_config" | |
| } | |
| ], | |
| "deprecated": [ | |
| { | |
| "name": "DRILL_TO_DETAIL", | |
| "default": true, | |
| "lifecycle": "deprecated", | |
| "description": "Enable drill-to-detail functionality in charts" | |
| } | |
| ] | |
| } | |
| } | |