12 KiB
Updating Superset
This file documents any backwards-incompatible changes in Superset and assists people when migrating to a new version.
Next
-
9109: Expire
filter_immune_slices
andfilter_immune_filter_fields
to favor dashboard scoped filter metadatafilter_scopes
. -
9046: Replaces
can_only_access_owned_queries
byall_query_access
favoring a white list approach. Since a new permission is introduced usesuperset init
to create and associate it by default to theAdmin
role. Note that, by default, all nonAdmin
users will not be able to access queries they do not own. -
8901: The datasource's update timestamp has been added to the query object's cache key to ensure updates to datasources are always reflected in associated query results. As a consequence all previously cached results will be invalidated when updating to the next version.
-
8732: Swagger user interface is now enabled by default. A new permission
show on SwaggerView
is created bysuperset init
and given to theAdmin
Role. To disable the UI, setFAB_API_SWAGGER_UI = False
on config. -
8721: When using the cache warmup Celery task you should now specify the
SUPERSET_WEBSERVER_PROTOCOL
variable in your configuration (probably either "http" or "https"). This defaults to "http". -
8512:
DRUID_IS_ACTIVE
now defaults to False. To enable Druid-API-based functionality, override theDRUID_IS_ACTIVE
configuration variable by setting it toTrue
for your deployment. -
8450: The time range picker now uses UTC for the tooltips and default placeholder timestamps (sans timezone).
-
8418: FLASK_APP / Worker App have changed. FLASK_APP should be updated to
superset.app:create_app()
and Celery Workers should be started with--app=superset.tasks.celery_app:app
-
9017:
SIP_15_ENABLED
now defaults to True which ensures that for all new SQL charts the time filter will behave like [start, end). Existing deployments should either disable this feature to keep the status quo or inform their users of this change prior to enabling the flag. TheSIP_15_GRACE_PERIOD_END
option provides a mechanism for specifying how long chart owners have to migrate their charts (the default is indefinite).
0.35.0
-
8370: Deprecates the
HTTP_HEADERS
variable in favor ofDEFAULT_HTTP_HEADERS
andOVERRIDE_HTTP_HEADERS
. To retain the same behavior you should useOVERRIDE_HTTP_HEADERS
instead ofHTTP_HEADERS
.HTTP_HEADERS
will still work but may be removed in a future update. -
We're deprecating the concept of "restricted metric", this feature was not fully working anyhow.
-
8117: If you are using
ENABLE_PROXY_FIX = True
, review the newly-introducted variable,PROXY_FIX_CONFIG
, which changes the proxy behavior in accordance with Werkzeug -
8069: introduces MessagePack and PyArrow for async query results backend serialization. To disable set
RESULTS_BACKEND_USE_MSGPACK = False
in your configuration. -
8371: makes
tables.table_name
,dbs.database_name
,datasources.cluster_name
, andclusters.cluster_name
non-nullable. Depending on the integrity of the data, manual intervention may be required.
0.34.0
-
7848: If you are running redis with celery, celery bump to 4.3.0 requires redis-py upgrade to 3.2.0 or later.
-
7667: a change to make all Unix timestamp (which by definition are in UTC) comparisons refer to a timestamp in UTC as opposed to local time.
-
7653: a change which deprecates the table_columns.database_expression column. Expressions should be handled by the DB engine spec conversion, Python date format, or custom column expression/type.
-
The repo no longer contains translation binaries (
.mo
) files. If you want translations in your build, you now have to run the commandbabel-compile --target superset/translations
as part of your builds -
5451: a change which adds missing non-nullable fields to the
datasources
table. Depending on the integrity of the data, manual intervention may be required. -
5452: a change which adds missing non-nullable fields and uniqueness constraints (which may be case insensitive depending on your database configuration) to the
columns
andtable_columns
tables. Depending on the integrity of the data, manual intervention may be required. -
fabmanager
command line is deprecated since Flask-AppBuilder 2.0.0, use the newflask fab <command>
integrated with Flask cli. -
SUPERSET_UPDATE_PERMS
environment variable was replaced byFAB_UPDATE_PERMS
config boolean key. To disable automatic creation of permissions setFAB_UPDATE_PERMS = False
on config. -
5453: a change which adds missing non-nullable fields and uniqueness constraints (which may be case insensitive depending on your database configuration) to the metrics and sql_metrics tables. Depending on the integrity of the data, manual intervention may be required.
-
7616: this bug fix changes time_compare deltas to correctly evaluate to the number of days prior instead of number of days in the future. It will change the data for advanced analytics time_compare so
1 year
from 5/1/2019 will be calculated as 365 days instead of 366 days.
Superset 0.32.0
npm run backend-sync
is deprecated and no longer needed, will fail if called- 5445: a change which prevents encoding of empty string from form data in the database. This involves a non-schema changing migration which does potentially impact a large number of records. Scheduled downtime may be advised.
Superset 0.31.0
-
If you use
Hive
orPresto
, we've moved some dependencies that were in the main package as optional now. To get these packages, runpip install superset[presto]
and/orpip install superset[hive]
as required. -
Similarly, if you use Celery's
flower
,gsheetsdb
,thrift
orthrift-sasl
, those dependencies have now been made optional in our package, meaning you may have to install them in your environment post 0.31.0 -
boto3 / botocore was removed from the dependency list. If you use s3 as a place to store your SQL Lab result set or Hive uploads, you may have to rely on an alternate requirements.txt file to install those dependencies.
-
From 0.31.0 onwards, we recommend not using the npm package
yarn
in favor of good oldnpm install
. While yarn should still work just fine, you should probably align to guarantee builds similar to the ones we use in testing and across the community in general.
Superset 0.30.0
- 0.30.0 includes a db_migration that removes allow_run_sync. This may require downtime because during the migration if the db is migrated first, superset will get 500 errors when the code can't find the field (until the deploy finishes).
Superset 0.29.0
-
India was removed from the "Country Map" visualization as the geojson file included in the package was very large
-
5933/6078: changes which add schema and table metadata cache timeout logic at the database level. If left undefined caching of metadata is disabled.
Superset 0.28.0
-
Support for Python 2 is deprecated, we only support >=3.6 from
0.28.0
onwards -
Superset 0.28 deprecates the previous dashboard layout. While 0.27 offered a migration workflow to users and allowed them to validate and publish their migrated dashboards individually, 0.28 forces the migration of all dashboards through an automated db migration script. We do recommend that you take a backup prior to this migration.
-
Superset 0.28 deprecates the
median
cluster label aggregator for mapbox visualizations. This particular aggregation is not supported on mapbox visualizations going forward. -
Superset 0.28 upgrades
flask-login
to>=0.3
, which includes a backwards-incompatible change:g.user.is_authenticated
,g.user.is_anonymous
, andg.user.is_active
are now properties instead of methods.
Superset 0.27.0
- Superset 0.27 start to use nested layout for dashboard builder, which is not backward-compatible with earlier dashboard grid data. We provide migration script to automatically convert dashboard grid to nested layout data. To be safe, please take a database backup prior to this upgrade. It's the only way people could go back to a previous state.
Superset 0.26.0
- Superset 0.26.0 deprecates the
superset worker
CLI, which is a simple wrapper around thecelery worker
command, forcing you into crafting your own nativecelery worker
command. Your command should look something likecelery worker --app=superset.sql_lab:celery_app --pool=gevent -Ofair
Superset 0.25.0
Superset 0.25.0 contains a backwards incompatible changes. If you run a production system you should schedule downtime for this upgrade.
The PRs bellow have more information around the breaking changes:
- 4587 : a backward incompatible database migration that requires downtime. Once the db migration succeeds, the web server needs to be restarted with the new version. The previous version will fail
- 4565 : we've
changed the security model a bit where in the past you would have to
define your authentication scheme by inheriting from Flask
App Builder's
from flask_appbuilder.security.sqla.manager import SecurityManager
, you now have to derive Superset's own derivativesuperset.security.SupersetSecurityManager
. This can provide you with more hooks to define your own logic and/or defer permissions to another system as needed. For all implementation, you simply have to import and deriveSupersetSecurityManager
in place of theSecurityManager
- 4835 :
our
setup.py
now only pins versions where required, giving you more latitude in using versions of libraries as needed. We do now provide arequirements.txt
with pinned versions if you want to run the suggested versions thatSuperset
builds and runs tests against. Simplypip install -r requirements.txt
in your build pipeline, likely prior topip install superset==0.25.0