You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by vi...@apache.org on 2022/04/08 13:48:06 UTC
[superset] 09/09: docs: release notes for 1.5 (#19530)
This is an automated email from the ASF dual-hosted git repository.
villebro pushed a commit to branch 1.5
in repository https://gitbox.apache.org/repos/asf/superset.git
commit 77d6207bed81e8bca7e3caaf342eacf10c09eff2
Author: Ville Brofeldt <33...@users.noreply.github.com>
AuthorDate: Thu Apr 7 12:52:20 2022 +0300
docs: release notes for 1.5 (#19530)
* docs: release notes for 1.5
* rephrase and remove secret key from 1.4
* address review comments
(cherry picked from commit 1c1beb653a52c1fcc67a97e539314f138117c6ba)
---
RELEASING/README.md | 1 +
RELEASING/release-notes-1-5/README.md | 142 +++++++++++++++++++++
.../release-notes-1-5/media/adhoc_columns.png | Bin 0 -> 206451 bytes
.../release-notes-1-5/media/categorical_line.png | Bin 0 -> 308426 bytes
.../release-notes-1-5/media/dependent_filters.png | Bin 0 -> 437988 bytes
RELEASING/release-notes-1-5/media/filter_bar.png | Bin 0 -> 367513 bytes
RELEASING/release-notes-1-5/media/permalink.png | Bin 0 -> 187932 bytes
7 files changed, 143 insertions(+)
diff --git a/RELEASING/README.md b/RELEASING/README.md
index 8724cd1642..32fb1aef34 100644
--- a/RELEASING/README.md
+++ b/RELEASING/README.md
@@ -30,6 +30,7 @@ partaking in the process should join the channel.
## Release notes for recent releases
+- [1.5](release-notes-1-5/README.md)
- [1.4](release-notes-1-4/README.md)
- [1.3](release-notes-1-3/README.md)
- [1.2](release-notes-1-2/README.md)
diff --git a/RELEASING/release-notes-1-5/README.md b/RELEASING/release-notes-1-5/README.md
new file mode 100644
index 0000000000..7444fa4d7c
--- /dev/null
+++ b/RELEASING/release-notes-1-5/README.md
@@ -0,0 +1,142 @@
+<!--
+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.
+-->
+
+# Release Notes for Superset 1.5
+
+Superset 1.5 focuses on polishing the dashboard native filters experience, while
+improving performance and stability. Superset 1.5 is likely the last minor release of
+version 1 of Superset, and will be succeeded by Superset 2.0. The 1.5 branch
+introduces the notion of a Long Term Support (LTS) version of Superset, and will
+receive security and other critical fixes even after Superset 2.x is released.
+Therefore, users will have the choice of staying on the 1.5 branch or upgrading to 2.x
+when available.
+
+- [**User Experience**](#user-facing-features)
+- [**Feature flags**](#feature-flags)
+- [**Database Experience**](#database-experience)
+- [**Breaking Changes and Full Changelog**](#breaking-changes-and-full-changelog)
+
+## User Facing Features
+
+- Complex dashboards with lots of native filters and charts will render considerably
+ faster. See the videos that shows the rendering time of a complex dashboard go from
+ 11 to 3 seconds: [#19064](https://github.com/apache/superset/pull/19064). In
+ addition, applying filters and switching tabs is also much smoother.
+- The Native Filter Bar has been redesigned, along with moving the "Apply" and
+ "Clear all" buttons to the bottom:
+
+
+
+- Native filters can now be made dependent on multiple filters. This makes it possible
+ to restrict the available values in a filter based on the selection of other filters.
+
+
+
+- In addition to being able to write Custom SQL for adhoc metrics and filters, the
+ column control now also features a Custom SQL tab. This makes it possible to write
+ custom expressions directly in charts without adding them to the dataset as saved
+ expressions.
+
+
+
+- A new `SupersetMetastoreCache` has been added which makes it possible to cache data
+ in the Superset Metastore without the need for running a dedicated cache like Redis
+ or Memcached. The new cache will be used by default for required caches, but can also
+ be used for caching chart or other data. See the
+ [documentation](https://superset.apache.org/docs/installation/cache#caching) for
+ details on using the new cache.
+- Previously it was possible for Dashboards with lots of filters to cause an error.
+ A similar issue existed on Explore. Now Superset stores Dashboard and Explore state
+ in the cache (as opposed to the URL), eliminating the infamous
+ [Long URL Problem](https://github.com/apache/superset/issues/17086).
+- Previously permanent links to Dashboard and Explore pages were in fact shortened URLS
+ that relied on state being stored in the URL (see Long URL Problem above). In
+ addition, the links used numerical ids and didn't check user permissions making it
+ easy to iterate through links that were stored in the metastore. Now permanent links
+ state is stored as JSON objects in the metastore, making it possible to store
+ arbitrarily large Dashboard and Explore state in permalinks. In addition, the ids
+ are encoded using [`hashids`](https://hashids.org/) and check permissions, making
+ permalink state more secure.
+
+
+
+## Feature flags
+
+- A new feature flag `GENERIC_CHART_AXES` has been added that makes it possible to
+ use a non-temporal x-axis on the ECharts Timeseries chart
+ ([#17917](https://github.com/apache/superset/pull/17917)). When enabled, a new
+ control "X Axis" is added to the control panel of ECharts line, area, bar, step and
+ scatter charts, which makes it possible to use categorical or numerical x-axes on
+ those charts.
+
+
+
+## Database Experience
+
+- DuckDB: Add support for database:
+ [#19317](https://github.com/apache/superset/pull/19317)
+
+- Kusto: Add support for Azure Data Explorer (Kusto):
+ [#17898](https://github.com/apache/superset/pull/17898)
+
+- Trino: Add server cert support and new auth methods:
+ [#17593](https://github.com/apache/superset/pull/17593) and
+ [#16346](https://github.com/apache/superset/pull/16346)
+
+- Microsoft SQL Server (MSSQL): support using CTEs in virtual tables:
+ [#18567](https://github.com/apache/superset/pull/18567)
+
+- Teradata and MSSQL: add support for TOP limit syntax:
+ [#18746](https://github.com/apache/superset/pull/18746) and
+ [#18240](https://github.com/apache/superset/pull/18240)
+
+- Apache Drill: User impersonation using `drill+sadrill`:
+ [#19252](https://github.com/apache/superset/pull/19252)
+
+## Developer Experience
+
+- `superset-ui` has now been integrated into the Superset codebase as per
+ [SIP-58](https://github.com/apache/superset/issues/13013) dubbed "Monorepo". This
+ makes development of plugins that ship with Superset considerably simpler. In
+ addition, it makes it possible to align `superset-ui` releases with official Superset
+ releases.
+
+## Breaking Changes and Full Changelog
+
+**Breaking Changes**
+
+- Bump `mysqlclient` from v1 to v2:
+ [#17556](https://github.com/apache/superset/pull/17556)
+- Single and double quotes will no longer be removed from filter values:
+ [#17881](https://github.com/apache/superset/pull/17881)
+- Previously `QUERY_COST_FORMATTERS_BY_ENGINE`, `SQL_VALIDATORS_BY_ENGINE` and
+ `SCHEDULED_QUERIES` were expected to be defined in the feature flag dictionary in
+ the `config.py` file. These should now be defined as a top-level config, with the
+ feature flag dictionary being reserved for boolean only values:
+ [#15254](https://github.com/apache/superset/pull/15254)
+- All Superset CLI commands (init, load_examples and etc) require setting the
+ `FLASK_APP` environment variable (which is set by default when `.flaskenv` is loaded):
+ [#17539](https://github.com/apache/superset/pull/17539)
+
+**Changelog**
+
+To see the complete changelog in this release, head to
+[CHANGELOG.MD](https://github.com/apache/superset/blob/1.5/CHANGELOG.md).
+As mentioned earlier, this release has a MASSIVE amount of bug fixes. The full
+changelog lists all of them!
diff --git a/RELEASING/release-notes-1-5/media/adhoc_columns.png b/RELEASING/release-notes-1-5/media/adhoc_columns.png
new file mode 100644
index 0000000000..6c73693625
Binary files /dev/null and b/RELEASING/release-notes-1-5/media/adhoc_columns.png differ
diff --git a/RELEASING/release-notes-1-5/media/categorical_line.png b/RELEASING/release-notes-1-5/media/categorical_line.png
new file mode 100644
index 0000000000..8d88aee15b
Binary files /dev/null and b/RELEASING/release-notes-1-5/media/categorical_line.png differ
diff --git a/RELEASING/release-notes-1-5/media/dependent_filters.png b/RELEASING/release-notes-1-5/media/dependent_filters.png
new file mode 100644
index 0000000000..a92afcf32c
Binary files /dev/null and b/RELEASING/release-notes-1-5/media/dependent_filters.png differ
diff --git a/RELEASING/release-notes-1-5/media/filter_bar.png b/RELEASING/release-notes-1-5/media/filter_bar.png
new file mode 100644
index 0000000000..61170fea6d
Binary files /dev/null and b/RELEASING/release-notes-1-5/media/filter_bar.png differ
diff --git a/RELEASING/release-notes-1-5/media/permalink.png b/RELEASING/release-notes-1-5/media/permalink.png
new file mode 100644
index 0000000000..8edebd4c45
Binary files /dev/null and b/RELEASING/release-notes-1-5/media/permalink.png differ