Skip to content

Commit

Permalink
docs: merge database config under Configuration section (#28281)
Browse files Browse the repository at this point in the history
  • Loading branch information
mistercrunch authored May 1, 2024
1 parent 3ac387b commit 538d1bb
Show file tree
Hide file tree
Showing 63 changed files with 1,728 additions and 1,901 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ https://user-images.githubusercontent.com/64562059/234390129-321d4f35-cb4b-45e8-

## Supported Databases

Superset can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, [and more](https://superset.apache.org/docs/databases/installing-database-drivers/)) that has a Python DB-API driver and a SQLAlchemy dialect.
Superset can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, [and more](https://superset.apache.org/docs/configuration/databases)) that has a Python DB-API driver and a SQLAlchemy dialect.

Here are some of the major database solutions that are supported:

Expand Down Expand Up @@ -133,7 +133,7 @@ Here are some of the major database solutions that are supported:
<img src="superset-frontend/src/assets/images/doris.png" alt="doris" border="0" width="200" height="80"/>
</p>

**A more comprehensive list of supported databases** along with the configuration instructions can be found [here](https://superset.apache.org/docs/databases/installing-database-drivers).
**A more comprehensive list of supported databases** along with the configuration instructions can be found [here](https://superset.apache.org/docs/configuration/databases).

Want to add support for your datastore or data engine? Read more [here](https://superset.apache.org/docs/frequently-asked-questions#does-superset-work-with-insert-database-engine-here) about the technical requirements.

Expand Down Expand Up @@ -172,7 +172,7 @@ Understanding the Superset Points of View

- Getting Started with Superset
- [Superset in 2 Minutes using Docker Compose](https://superset.apache.org/docs/installation/docker-compose#installing-superset-locally-using-docker-compose)
- [Installing Database Drivers](https://superset.apache.org/docs/databases/docker-add-drivers/)
- [Installing Database Drivers](https://superset.apache.org/docs/configuration/databases#installing-database-drivers)
- [Building New Database Connectors](https://preset.io/blog/building-database-connector/)
- [Create Your First Dashboard](https://superset.apache.org/docs/using-superset/creating-your-first-dashboard/)
- [Comprehensive Tutorial for Contributing Code to Apache Superset
Expand Down
2 changes: 1 addition & 1 deletion RESOURCES/FEATURE_FLAGS.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ These features are **finished** but currently being tested. They are usable, but
- CONFIRM_DASHBOARD_DIFF
- DRILL_TO_DETAIL
- DYNAMIC_PLUGINS: [(docs)](https://superset.apache.org/docs/configuration/running-on-kubernetes)
- ENABLE_SUPERSET_META_DB: [(docs)](https://superset.apache.org/docs/databases/meta-database/)
- ENABLE_SUPERSET_META_DB: [(docs)]()
- ESTIMATE_QUERY_COST
- GLOBAL_ASYNC_QUERIES [(docs)](https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries)
- HORIZONTAL_FILTER_BAR
Expand Down
1,673 changes: 1,673 additions & 0 deletions docs/docs/configuration/databases.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/docs/configuration/timezones.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To help make the problem somewhat tractable—given that Apache Superset has no

To strive for data consistency (regardless of the timezone of the client) the Apache Superset backend tries to ensure that any timestamp sent to the client has an explicit (or semi-explicit as in the case with [Epoch time](https://en.wikipedia.org/wiki/Unix_time) which is always in reference to UTC) timezone encoded within.

The challenge however lies with the slew of [database engines](/docs/databases/installing-database-drivers#install-database-drivers) which Apache Superset supports and various inconsistencies between their [Python Database API (DB-API)](https://www.python.org/dev/peps/pep-0249/) implementations combined with the fact that we use [Pandas](https://pandas.pydata.org/) to read SQL into a DataFrame prior to serializing to JSON. Regrettably Pandas ignores the DB-API [type_code](https://www.python.org/dev/peps/pep-0249/#type-objects) relying by default on the underlying Python type returned by the DB-API. Currently only a subset of the supported database engines work correctly with Pandas, i.e., ensuring timestamps without an explicit timestamp are serializd to JSON with the server timezone, thus guaranteeing the client will display timestamps in a consistent manner irrespective of the client's timezone.
The challenge however lies with the slew of [database engines](/docs/configuration/databases#installing-drivers-in-docker-images) which Apache Superset supports and various inconsistencies between their [Python Database API (DB-API)](https://www.python.org/dev/peps/pep-0249/) implementations combined with the fact that we use [Pandas](https://pandas.pydata.org/) to read SQL into a DataFrame prior to serializing to JSON. Regrettably Pandas ignores the DB-API [type_code](https://www.python.org/dev/peps/pep-0249/#type-objects) relying by default on the underlying Python type returned by the DB-API. Currently only a subset of the supported database engines work correctly with Pandas, i.e., ensuring timestamps without an explicit timestamp are serializd to JSON with the server timezone, thus guaranteeing the client will display timestamps in a consistent manner irrespective of the client's timezone.

For example the following is a comparison of MySQL and Presto,

Expand Down
16 changes: 0 additions & 16 deletions docs/docs/databases/ascend.mdx

This file was deleted.

39 changes: 0 additions & 39 deletions docs/docs/databases/athena.mdx

This file was deleted.

92 changes: 0 additions & 92 deletions docs/docs/databases/bigquery.mdx

This file was deleted.

42 changes: 0 additions & 42 deletions docs/docs/databases/clickhouse.mdx

This file was deleted.

17 changes: 0 additions & 17 deletions docs/docs/databases/cockroachdb.mdx

This file was deleted.

24 changes: 0 additions & 24 deletions docs/docs/databases/cratedb.mdx

This file was deleted.

23 changes: 0 additions & 23 deletions docs/docs/databases/databend.mdx

This file was deleted.

89 changes: 0 additions & 89 deletions docs/docs/databases/databricks.mdx

This file was deleted.

Loading

0 comments on commit 538d1bb

Please sign in to comment.