mirror of
https://github.com/apache/superset.git
synced 2026-05-24 09:15:19 +00:00
4266d36cf4
Snapshots all four versioned Docusaurus sections at v6.1.0, cut from master after the version-cutting tooling (#39837) and broken-internal- links fixes (#40102) landed. Captures fresh auto-generated content and freezes data dependencies so the historical snapshot stays correct. Versioning behavior: lastVersion stays at current for every section, so the canonical URLs (/docs/..., /admin-docs/..., /developer-docs/..., /components/...) continue to render content from master. The current version is consistently labeled "Next" with an unreleased banner, and 6.1.0 is a historical pin accessible only via its explicit version segment. Component playground: previously disabled: true in versions-config.json, now enabled and versioned. The plugin block in docusaurus.config.ts was already gated only by the disabled flag, so no other code changes were needed to bring it back online. Snapshot includes: - All MDX content for the four sections. - Auto-gen captured fresh: 74 database pages (engine spec metadata), ~1,800 API reference files (openapi.json), 59 component pages (Storybook stories). - Data imports frozen at cut time into snapshot-local _versioned_data/ dirs: versioned_docs/version-6.1.0/_versioned_data/src/data/databases.json (canonical 80-database diagnostics from master, preserved by the generator's input-hash cache) admin_docs_versioned_docs/version-6.1.0/_versioned_data/data/countries.json admin_docs_versioned_docs/version-6.1.0/_versioned_data/static/feature-flags.json developer_docs_versioned_docs/version-6.1.0/_versioned_data/static/data/components.json - Import paths in deeply-nested files rewritten so they still resolve from one directory deeper inside the snapshot. Verified via full yarn build: exit 0, no broken links surfaced by onBrokenLinks: throw. Anchor warnings present are pre-existing on master (community#superset-community-calendar) and unrelated.
105 lines
3.7 KiB
Plaintext
105 lines
3.7 KiB
Plaintext
---
|
|
title: Connecting to Databases
|
|
sidebar_label: Overview
|
|
sidebar_position: 1
|
|
---
|
|
|
|
{/*
|
|
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.
|
|
*/}
|
|
|
|
import { DatabaseIndex } from '@site/src/components/databases';
|
|
import databaseData from '../_versioned_data/src/data/databases.json';
|
|
|
|
# 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](/admin-docs/installation/docker-compose), [Kubernetes](/admin-docs/installation/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.
|
|
|
|
<DatabaseIndex data={databaseData} />
|
|
|
|
## Installing Database Drivers
|
|
|
|
Superset requires a Python [DB-API database driver](https://peps.python.org/pep-0249/)
|
|
and a [SQLAlchemy dialect](https://docs.sqlalchemy.org/en/20/dialects/) 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:
|
|
|
|
```bash
|
|
# 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:
|
|
|
|
```bash
|
|
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](https://github.com/apache/superset/blob/master/superset/db_engine_specs/METADATA_STATUS.md)
|
|
for the current status of database documentation and the [README](https://github.com/apache/superset/blob/master/superset/db_engine_specs/README.md) for the metadata schema.
|
|
|
|
:::info 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:
|
|
|
|
```bash
|
|
cd docs && npm run gen-db-docs
|
|
```
|
|
|
|
This requires a working Superset development environment.
|
|
:::
|