Skip to content

[docs] Add Superset documentation to /clients/ #23188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
steveburnett wants to merge 2 commits into from
Closed

[docs] Add Superset documentation to /clients/ #23188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5b6cbb
Add Superset documentation to /clients/
steveburnett Jul 11, 2024
41bc1ac
Merge branch 'master' into steveburnett-superset
steveburnett Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions presto-docs/src/main/sphinx/clients.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ Presto Clients

clients/presto-cli
clients/presto-console
clients/superset
clients/dbeaver
37 changes: 37 additions & 0 deletions presto-docs/src/main/sphinx/clients/superset.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
===============
Apache Superset
===============

`Apache Superset <https://superset.apache.org/>`_ is an open source data exploration tool that is part of the Apache Project.
Follow these steps to configure Superset to query Presto.

1. Install or deploy Superset from the `Superset documentation <https://superset.apache.org/docs/intro>`_.

Note: When running Superset for the first time, an error may be displayed similar to the following:

`validating superset/docker-compose-image-tag.yml: services.db.env_file.0 must be a string`

See `Superset discussion 28184 <https://github.com/apache/superset/discussions/28184>`_ for more information.

2. You may need `pyhive` to configure Superset to connect to Presto. See `Presto <https://superset.apache.org/docs/configuration/databases#presto>`_.

3. Log into Superset as described in `Log into Superset <https://superset.apache.org/docs/quickstart#3-log-into-superset>`_.

4. In the Superset UI, select `+` in the upper right to display the drop-down menu, then select `Data`, then `Connect database`.

5. In the `Connect a database` window, select `Presto`.

6. In `SLQAlchemy URI`, enter a connection string using the following format:

`presto://{hostname}:{port}/{database}`

For example, `presto://<Presto-IP-address>:8080/system`

For more information, see the Superset documentation for connecting to `Presto <https://superset.apache.org/docs/configuration/databases#presto>`_.

7. Select `Test Connection`. If the message `Connection looks good!` is displayed, continue.

Note: If your Presto server is running locally, `localhost` may not resolve DNS successfully from the Superset docker-compose launched instance to the local Presto server. Replace `<Presto-IP-address>` with your system's actual IP address.

8. Select `Connect`.