安装数据库驱动

Superset要求为每个要连接的数据存储安装Python DB-API数据库驱动程序和SQLAlchemy方言。

• 支持的数据库和依赖关系

Superset不附带与数据库的连接，除了SQLite，它是Python标准库的一部分。将需要为您想要用作元数据数据库安装所需的包，以及通过Superset连接到您想要访问的数据库对应所需的包。

下面一些推荐包的列表：

Amazon Athena

PyPI包：pip install "PyAthenaJDBC>1.0.9 , pip install "PyAthena>1.2.0

连接字符串：awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{

Amazon Athena

PyPI包：pip install "PyAthenaJDBC>1.0.9 , pip install "PyAthena>1.2.0

连接字符串：awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{

Amazon Redshift

PyPI包：pip install sqlalchemy-redshift

连接字符串：redshift+psycopg2://<userName>:<DBPassword>@<AWS End Point>:5439/<Database Name>

Apache Drill

PyPI包：pip install sqlalchemy-drill

连接字符串：drill+sadrill:// For JDBC drill+jdbc://

Apache Druid

PyPI包：pip install pydruid

连接字符串：druid://<User>:<password>@<Host>:<Port-default-9088>/druid/v2/sql

Apache Hive

PyPI包：pip install pyhive

连接字符串：hive://hive@{hostname}:{port}/{database}

Apache Impala

PyPI包：pip install impala

连接字符串：impala://{hostname}:{port}/{database}

Apache Kylin

PyPI包：pip install kylinpy

连接字符串：kylin://<username>:<password>@<hostname>:<port>/<project>?<param1>=<value1>&<param2>=<value2>

Apache Pinot

PyPI包：pip install pinotdb

连接字符串：pinot://BROKER:5436/query?server=http://CONTROLLER:5983/

Apache Solr

PyPI包：pip install sqlalchemy-solr

连接字符串：solr://{username}:{password}@{hostname}:{port}/{server_path}/{collection}

Apache Spark SQL

PyPI包：pip install pyhive

连接字符串：hive://hive@{hostname}:{port}/{database}

Azure MS SQL

PyPI包：pip install pymssql

连接字符串：mssql+pymssql://UserName@presetSQL:TestPassword@presetSQL.database.windows.net:1433/TestSchema

Big Query

PyPI包：pip install pybigquery

连接字符串：bigquery://{project_id}

ClickHouse

PyPI包：pip install sqlalchemy-clickhouse

连接字符串：clickhouse://{username}:{password}@{hostname}:{port}/{database}

CockroachDB

PyPI包：pip install cockroachdb

连接字符串：cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable

Dremio

PyPI包：pip install sqlalchemy_dremio

连接字符串：dremio://user:pwd@host:31010/

Elasticsearch

PyPI包：pip install elasticsearch-dbapi

连接字符串：elasticsearch+http://{user}:{password}@{host}:9200/

Exasol

PyPI包：pip install sqlalchemy-exasol

连接字符串：exa+pyodbc://{username}:{password}@{hostname}:{port}/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC

Google Sheets

PyPI包：pip install gsheetsdb

连接字符串：gsheets://

Hologres

PyPI包：pip install psycopg2

连接字符串：postgresql+psycopg2://<UserName>:<DBPassword>@<Database Host>/<Database Name>

IBM Db2

PyPI包：pip install ibm_db_sa

连接字符串：db2+ibm_db://

MySQL

PyPI包：pip install mysqlclient

连接字符串：mysql://<UserName>:<DBPassword>@<Database Host>/<Database Name>

Oracle

PyPI包：pip install cx_Oracle

连接字符串：oracle://

PostgreSQL

PyPI包：pip install psycopg2

连接字符串：postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>

Trino

PyPI包：pip install sqlalchemy-trino

连接字符串：trino://{username}:{password}@{hostname}:{port}/{catalog}

Presto

PyPI包：pip install pyhive

连接字符串：presto://

SAP Hana

PyPI包：pip install hdbcli sqlalchemy-hana or pip install apache-superset[hana]

连接字符串：hana://{username}:{password}@{host}:{port}

Snowflake

PyPI包：pip install snowflake-sqlalchemy

连接字符串：snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}

SQLite

PyPI包：默认已安装

连接字符串：sqlite://

SQL Server

PyPI包：pip install pymssql

连接字符串：mssql://

Teradata

PyPI包：pip install sqlalchemy-teradata

连接字符串：teradata://{user}:{password}@{host}

Vertica

PyPI包：pip install sqlalchemy-vertica-python

连接字符串：vertica+vertica_python://<UserName>:<DBPassword>@<Database Host>/<Database Name>

请注意，还支持许多其他数据库，主要条件是是否存在一个功能性的SQLAlchemy方言和Python驱动程序。搜索关键字“sqlalchemy +(数据库名称)”应该可以帮助您找到对应的驱动。

额外的数据库设置

• 更深层次的SQLAlchemy集成

可以使用SQLAlchemy公开的参数来调整数据库连接信息。在数据库编辑视图中，您可以将额外的字段编辑为JSON blob。

• 对象集合

像Postgres和Redshift这样的数据库使用对象集合作为数据库之上的逻辑实体。为了让超集连接到特定的模式，您可以在Edit Tables表单(source > Tables > Edit record)中设置模式参数。

SQLAlchemy连接的外部密码存储

可以将Superset配置为使用数据库密码的外部存储。如果你正在运行一个自定义的秘钥分发框架，并且不希望将秘密存储在Superset的元数据库中，这是非常有用的。

示例：编写一个函数，该函数接受一个sqla.engine类型的参数。url，并返回给定连接字符串的密码。然后在配置文件中设置SQLALCHEMY_CUSTOM_PASSWORD_STORE以指向该函数。

def example_lookup_password(url):
secret = <<get password from external framework>>
return 'secret'
SQLALCHEMY_CUSTOM_PASSWORD_STORE = example_lookup_password

一种常见的模式是使用环境变量来提供机密信息。SQLALCHEMY_CUSTOM_PASSWORD_STORE也可以用于此目的。

def example_password_as_env_var(url):
# assuming the uri looks like
# mysql://localhost?superset_user:{SUPERSET_PASSWORD}
return url.password.format(os.environ)

SQLALCHEMY_CUSTOM_PASSWORD_STORE = example_password_as_env_var

对数据库的SSL访问

你可以使用Edit Databases表单中的额外字段来配置SSL:

{
    "metadata_params": {},
    "engine_params": {
          "connect_args":{
              "sslmode":"require",
              "sslrootcert": "/path/to/my/pem"
        }
     }
}