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.
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 79 databases with varying levels of feature support. Click on any database name to see detailed documentation including connection strings, authentication methods, and configuration options.
Database | Categories | Score | Time Grains | Features | Documentation |
|---|---|---|---|---|---|
Presto Presto is a distributed SQL query engine for big data. | Query EnginesOpen Source | 159/201 | 19 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/201 | 19 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/201 | 19 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
Starburst EnterpriseTrino compatible Starburst Enterprise is a self-managed Trino distribution with enterprise featur... | Query EnginesHosted Open Source | 149/201 | 19 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
Apache Hive Apache Hive is a data warehouse infrastructure built on Hadoop. | Apache ProjectsQuery EnginesOpen Source | 140/201 | 10 grains | JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.Impersonation | Connection |
Apache Spark SQL Apache Spark SQL is a module for structured data processing. | Apache ProjectsQuery EnginesOpen Source | 140/201 | 10 grains | JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.Impersonation | Connection |
Databricks Interactive Cluster Apache Hive is a data warehouse infrastructure built on Hadoop. | Apache ProjectsQuery EnginesOpen Source | 140/201 | 10 grains | JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.Impersonation | Connection |
Other Databases | 109/201 | 19 grains | JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadCost Est. | ConnectionErrors | |
Aurora PostgreSQL PostgreSQL is an advanced open-source relational database. | Traditional RDBMSOpen Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.SQL Validation | Connection |
SupabaseAurora PostgreSQL compatible Open-source Firebase alternative built on top of PostgreSQL, providing a full ba... | Hosted Open Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
Google AlloyDBAurora PostgreSQL compatible Google Cloud's PostgreSQL-compatible database service for demanding transactiona... | Cloud - GoogleHosted Open Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
NeonAurora PostgreSQL compatible Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage. | Hosted Open Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
Amazon Aurora PostgreSQLAurora PostgreSQL compatible Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational da... | Cloud - AWSHosted Open Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
Aurora PostgreSQL (Data API) PostgreSQL is an advanced open-source relational database. | Traditional RDBMSOpen Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est.SQL Validation | Connection |
SupabaseAurora PostgreSQL (Data API) compatible Open-source Firebase alternative built on top of PostgreSQL, providing a full ba... | Hosted Open Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
Google AlloyDBAurora PostgreSQL (Data API) compatible Google Cloud's PostgreSQL-compatible database service for demanding transactiona... | Cloud - GoogleHosted Open Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
NeonAurora PostgreSQL (Data API) compatible Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage. | Hosted Open Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
Amazon Aurora PostgreSQLAurora PostgreSQL (Data API) compatible Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational da... | Cloud - AWSHosted Open Source | 104/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSH | Connection |
CockroachDB CockroachDB is a distributed SQL database built for cloud applications. | Traditional RDBMSOpen Source | 94/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est. | Connection |
Greenplum VMware Greenplum is a massively parallel processing (MPP) database built on Post... | Traditional RDBMSOpen Source | 94/201 | 14 grains | JOINsSubqueriesDynamic SchemaCatalogSSHFile UploadQuery CancelCost Est. | Connection |
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
- Go to Settings → Data: Database Connections
- Click + DATABASE
- Select your database type or enter a SQLAlchemy URI
- Click Test Connection to verify
- 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.