From 1a94e7d50d071406bee8b08dc0f41243f17c5ff0 Mon Sep 17 00:00:00 2001 From: Elizabeth Thompson Date: Wed, 27 Jan 2021 11:18:41 -0800 Subject: [PATCH] docs:add deprecations to updating.md --- UPDATING.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/UPDATING.md b/UPDATING.md index 9240ee7fc2da9..6126c98be283c 100644 --- a/UPDATING.md +++ b/UPDATING.md @@ -22,8 +22,14 @@ under the License. This file documents any backwards-incompatible changes in Superset and assists people when migrating to a new version. +## Next +# Breaking Changes +# Potential Downtime +# Deprecations + ## 1.0.0 +# Breaking Changes - [11509](https://github.com/apache/superset/pull/12491): Dataset metadata updates check user ownership, only owners or an Admin are allowed. - Security simplification (SIP-19), the following permission domains were simplified: - [12072](https://github.com/apache/superset/pull/12072): `Query` with `can_read`, `can_write` @@ -37,13 +43,10 @@ assists people when migrating to a new version. - [11856](https://github.com/apache/superset/pull/11856): `CssTemplate` with `can_read`, `can_write`. - [11764](https://github.com/apache/superset/pull/11764): `SavedQuery` with `can_read`, `can_write`. Old permissions will be automatically migrated to these new permissions and applied to all existing security Roles. + - [11499](https://github.com/apache/superset/pull/11499): Breaking change: `STORE_CACHE_KEYS_IN_METADATA_DB` config flag added (default=`False`) to write `CacheKey` records to the metadata DB. `CacheKey` recording was enabled by default previously. -- [11920](https://github.com/apache/superset/pull/11920): Undos the DB migration from [11714](https://github.com/apache/superset/pull/11714) to prevent adding new columns to the logs table. Deploying a sha between these two PRs may result in locking your DB. + - [11704](https://github.com/apache/superset/pull/11704) Breaking change: Jinja templating for SQL queries has been updated, removing default modules such as `datetime` and `random` and enforcing static template values. To restore or extend functionality, use `JINJA_CONTEXT_ADDONS` and `CUSTOM_TEMPLATE_PROCESSORS` in `superset_config.py`. -- [11714](https://github.com/apache/superset/pull/11714): Logs - significantly more analytics events (roughly double?), and when - using DBEventLogger (default) could result in stressing the metadata - database more. - [11509](https://github.com/apache/superset/pull/11509): Config value `TABLE_NAMES_CACHE_CONFIG` has been renamed to `DATA_CACHE_CONFIG`, which will now also hold query results cache from connected datasources (previously held in `CACHE_CONFIG`), in addition to the table names. If you will set `DATA_CACHE_CONFIG` to a new cache backend different than your previous `CACHE_CONFIG`, plan for additional cache warmup to avoid degrading charting performance for the end users. @@ -53,14 +56,24 @@ assists people when migrating to a new version. - [11244](https://github.com/apache/superset/pull/11244): The `REDUCE_DASHBOARD_BOOTSTRAP_PAYLOAD` feature flag has been removed after being set to True for multiple months. -- [11098](https://github.com/apache/superset/pull/11098): includes a database migration that adds a `uuid` column to most models, and updates `Dashboard.position_json` to include chart UUIDs. Depending on number of objects, the migration may take up to 5 minutes, requiring planning for downtime. - [11172](https://github.com/apache/superset/pull/11172): Turning - off language selectors by default as i18n is incomplete in most languages - and requires more work. You can easily turn on the languages you want - to expose in your environment in superset_config.py +off language selectors by default as i18n is incomplete in most languages +and requires more work. You can easily turn on the languages you want +to expose in your environment in superset_config.py - [11172](https://github.com/apache/superset/pull/11172): Breaking change: SQL templating is turned off by default. To turn it on set `ENABLE_TEMPLATE_PROCESSING` to True on `FEATURE_FLAGS` +# Potential Downtime +- [11920](https://github.com/apache/superset/pull/11920): Undos the DB migration from [11714](https://github.com/apache/superset/pull/11714) to prevent adding new columns to the logs table. Deploying a sha between these two PRs may result in locking your DB. + +- [11714](https://github.com/apache/superset/pull/11714): Logs +significantly more analytics events (roughly double?), and when +using DBEventLogger (default) could result in stressing the metadata +database more. + +- [11098](https://github.com/apache/superset/pull/11098): includes a database migration that adds a `uuid` column to most models, and updates `Dashboard.position_json` to include chart UUIDs. Depending on number of objects, the migration may take up to 5 minutes, requiring planning for downtime. + +# Deprecations - [11155](https://github.com/apache/superset/pull/11155): The `FAB_UPDATE_PERMS` config parameter is no longer required as the Superset application correctly informs FAB under which context permissions should be updated. ## 0.38.0