Skip to main content
Version: Next

Connecting to Databases

Superset does not ship bundled with connectivity to databases. The main step in connecting Superset to a database is to install the proper database driver(s) in your environment.

note

You'll need to install the required packages for the database you want to use as your metadata database as well as the packages needed to connect to the databases you want to access through Superset. For information about setting up Superset's metadata database, please refer to installation documentations (Docker Compose, Kubernetes)

Supported Databases​

Superset supports 73 databases with varying levels of feature support. Click on any database name to see detailed documentation including connection strings, authentication methods, and configuration options.

Total Databases
73
With Documentation
73/ 73
Multiple Drivers
36
Auth Methods
5
Filter by category
Database
Categories
Score
Time Grains
Features
Documentation
Presto
Presto is a distributed SQL query engine for big data.
Query EnginesOpen Source
159/20119 grains
JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.ImpersonationSQL Validation
ConnectionDriversErrors
Trino
Trino is a distributed SQL query engine for big data analytics.
Query EnginesOpen Source
149/20119 grains
JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.Impersonation
ConnectionDrivers
Starburst GalaxyTrino compatible
Starburst Galaxy is a fully-managed cloud analytics platform built on Trino. It ...
Query EnginesCloud Data WarehousesHosted Open Source
149/20119 grains
JOINsSubqueriesDynamic SchemaCatalogSSH
Connection
Starburst EnterpriseTrino compatible
Starburst Enterprise is a self-managed Trino distribution with enterprise featur...
Query EnginesHosted Open Source
149/20119 grains
JOINsSubqueriesDynamic SchemaCatalogSSH
Connection
Apache Hive
Apache Hive is a data warehouse infrastructure built on Hadoop.
Apache ProjectsQuery EnginesOpen Source
140/20110 grains
JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.Impersonation
ConnectionDrivers
Apache Spark SQL
Apache Spark SQL is a module for structured data processing.
Apache ProjectsQuery EnginesOpen Source
140/20110 grains
JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.Impersonation
ConnectionDrivers
PostgreSQL
PostgreSQL is an advanced open-source relational database.
Traditional RDBMSOpen Source
104/20114 grains
JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.SQL Validation
ConnectionErrors
SupabasePostgreSQL compatible
Open-source Firebase alternative built on top of PostgreSQL, providing a full ba...
Hosted Open Source
104/20114 grains
JOINsSubqueriesDynamic SchemaCatalogSSH
Connection
Google AlloyDBPostgreSQL compatible
Google Cloud's PostgreSQL-compatible database service for demanding transactiona...
Cloud - GoogleHosted Open Source
104/20114 grains
JOINsSubqueriesDynamic SchemaCatalogSSH
Connection
NeonPostgreSQL compatible
Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage.
Hosted Open Source
104/20114 grains
JOINsSubqueriesDynamic SchemaCatalogSSH
Connection
Amazon Aurora PostgreSQLPostgreSQL compatible
Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational da...
Cloud - AWSHosted Open Source
104/20114 grains
JOINsSubqueriesDynamic SchemaCatalogSSH
Connection
CockroachDB
CockroachDB is a distributed SQL database built for cloud applications.
Traditional RDBMSOpen Source
94/20114 grains
JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.
Connection
RisingWave
RisingWave is a distributed streaming database.
Analytical DatabasesOpen Source
94/20114 grains
JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.
Connection
Apache Doris
Apache Doris is a high-performance real-time analytical database.
Apache ProjectsAnalytical DatabasesOpen Source
79/2019 grains
JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery Cancel
ConnectionDriversErrors
Snowflake
Snowflake is a cloud-native data warehouse.
Cloud Data WarehousesAnalytical DatabasesProprietary
72/20112 grains
JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery Cancel
ConnectionAuthErrors
StarRocks
StarRocks is a high-performance analytical database for real-time analytics.
Analytical DatabasesOpen Source
69/2019 grains
JOINsSubqueriesDynamic SchemaSSHFile UploadQuery CancelImpersonation
ConnectionDriversErrors
CelerDataStarRocks compatible
CelerData is a fully-managed cloud analytics service built on StarRocks. It prov...
Analytical DatabasesCloud Data WarehousesHosted Open Source
69/2019 grains
JOINsSubqueriesDynamic SchemaSSH
Connection
SingleStore
SingleStore is a distributed SQL database for real-time analytics and transactio...
Analytical DatabasesProprietary
68/2018 grains
JOINsSubqueriesDynamic SchemaSSHFile UploadQuery Cancel
ConnectionDrivers
Google Sheets
Google Sheets allows querying spreadsheets as SQL tables via shillelagh.
Cloud - GoogleHosted Open Source
61/20121 grains
JOINsSubqueriesFile UploadImpersonation
ConnectionErrors
MariaDB
MariaDB is a community-developed fork of MySQL.
Traditional RDBMSOpen Source
59/2019 grains
JOINsSubqueriesDynamic SchemaSSHFile UploadQuery Cancel
ConnectionDrivers
  • 87 databases
  • 1
  • 2
  • 3
  • 4
  • 5
  • 20 / page

Installing Database Drivers​

Superset requires a Python DB-API database driver and a SQLAlchemy dialect to be installed for each database engine you want to connect to.

Installing Drivers in Docker​

For Docker deployments, create a requirements-local.txt file in the docker directory:

# Create the requirements file
touch ./docker/requirements-local.txt

# Add your driver (e.g., for PostgreSQL)
echo "psycopg2-binary" >> ./docker/requirements-local.txt

Then restart your containers. The drivers will be installed automatically.

Installing Drivers with pip​

For non-Docker installations:

pip install <driver-package>

See individual database pages for the specific driver packages needed.

Connecting Through the UI​

  1. Go to Settings → Data: Database Connections
  2. Click + DATABASE
  3. Select your database type or enter a SQLAlchemy URI
  4. Click Test Connection to verify
  5. Click Connect to save

Contributing​

To add or update database documentation, add a metadata attribute to your engine spec class in superset/db_engine_specs/. Documentation is auto-generated from these metadata attributes.

See METADATA_STATUS.md for the current status of database documentation and the README for the metadata schema.

Developer Note

This documentation was built without Flask context, so feature diagnostics (scores, time grain support, etc.) may not reflect actual database capabilities. For full diagnostics, build docs locally with:

cd docs && npm run gen-db-docs

This requires a working Superset development environment.