diff --git a/docs/installation.rst b/docs/installation.rst index 623c4ef168..4c2d74a8bd 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -482,73 +482,67 @@ connect to the databases you want to access through Superset. Here's a list of some of the recommended packages. -+------------------+---------------------------------------+-------------------------------------------------+ -| database | pypi package | SQLAlchemy URI prefix | -+==================+=======================================+=================================================+ -| Amazon Athena | ``pip install "PyAthenaJDBC>1.0.9"`` | ``awsathena+jdbc://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Amazon Athena | ``pip install "PyAthena>1.2.0"`` | ``awsathena+rest://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Amazon Redshift | ``pip install sqlalchemy-redshift`` | ``redshift+psycopg2://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Apache Drill | ``pip install sqlalchemy-drill`` | For the REST API:`` | -| | | ``drill+sadrill://`` | -| | | For JDBC | -| | | ``drill+jdbc://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Apache Druid | ``pip install pydruid`` | ``druid://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Apache Hive | ``pip install pyhive`` | ``hive://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Apache Impala | ``pip install impyla`` | ``impala://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Apache Kylin | ``pip install kylinpy`` | ``kylin://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Apache Pinot | ``pip install pinotdb`` | ``pinot+http://CONTROLLER:5436/`` | -| | | ``query?server=http://CONTROLLER:5983/`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Apache Spark SQL | ``pip install pyhive`` | ``jdbc+hive://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| BigQuery | ``pip install pybigquery`` | ``bigquery://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| ClickHouse | ``pip install sqlalchemy-clickhouse`` | | -+------------------+---------------------------------------+-------------------------------------------------+ -| CockroachDB | ``pip install cockroachdb`` | ``cockroachdb://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Dremio | ``pip install sqlalchemy_dremio`` | ``dremio://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Elasticsearch | ``pip install elasticsearch-dbapi`` | ``elasticsearch+http://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Exasol | ``pip install sqlalchemy-exasol`` | ``exa+pyodbc://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Google Sheets | ``pip install gsheetsdb`` | ``gsheets://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| IBM Db2 | ``pip install ibm_db_sa`` | ``db2+ibm_db://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| MySQL | ``pip install mysqlclient`` | ``mysql://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Oracle | ``pip install cx_Oracle`` | ``oracle://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| PostgreSQL | ``pip install psycopg2`` | ``postgresql+psycopg2://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Presto | ``pip install pyhive`` | ``presto://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Snowflake | ``pip install snowflake-sqlalchemy`` | ``snowflake://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| SQLite | | ``sqlite://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| SQL Server | ``pip install pymssql`` | ``mssql://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Teradata | ``pip install sqlalchemy-teradata`` | ``teradata://`` | -+------------------+---------------------------------------+-------------------------------------------------+ -| Vertica | ``pip install | ``vertica+vertica_python://`` | -| | sqlalchemy-vertica-python`` | | -+------------------+---------------------------------------+-------------------------------------------------+ -| Hana | ``pip install hdbcli sqlalchemy-hana``| ``hana://`` | -| | or | | -| | ``pip install apache-superset[hana]`` | | -+------------------+---------------------------------------+-------------------------------------------------+ - ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Database | PyPI package | SQLAlchemy URI prefix | ++==================+===================================================================+=================================================+ +| Amazon Athena | ``"apache-superset[athena]"`` | ``awsathena+jdbc://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Amazon Redshift | ``"apache-superset[redshift]"`` | ``redshift+psycopg2://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Apache Drill | ``"apache-superset[drill]"`` | For the REST API:`` | +| | | ``drill+sadrill://`` | +| | | For JDBC | +| | | ``drill+jdbc://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Apache Druid | ``"git+https://github.com/JohnOmernik/sqlalchemy-drill"`` | ``druid://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Apache Hive | ``"apache-superset[hive]"`` | ``hive://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Apache Impala | ``"apache-superset[impala]"`` | ``impala://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Apache Kylin | ``"apache-superset[kylin]"`` | ``kylin://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Apache Pinot | ``"apache-superset[pinot]"`` | ``pinot+http://CONTROLLER:5436/`` | +| | | ``query?server=http://CONTROLLER:5983/`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Apache Spark SQL | ``"apache-superset[hive]"`` | ``jdbc+hive://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| BigQuery | ``"apache-superset[bigquery]"`` | ``bigquery://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| ClickHouse | ``"apache-superset[clickhouse]"`` | | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| CockroachDB | ``"apache-superset[cockroachdb]"`` | ``cockroachdb://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Dremio | ``"apache-superset[dremio]"`` | ``dremio://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Elasticsearch | ``"apache-superset[elasticsearch]"`` | ``elasticsearch+http://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Exasol | ``"apache-superset[exasol]"`` | ``exa+pyodbc://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Google Sheets | ``"apache-superset[gsheets]"`` | ``gsheets://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Hana | ``"apache-superset[hana]"`` | ``hana://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| IBM Db2 | ``"apache-superset[db2]"`` | ``db2+ibm_db://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| MySQL | ``"apache-superset[mysql]"`` | ``mysql://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Oracle | ``"apache-superset[oracle]"`` | ``oracle://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| PostgreSQL | ``"apache-superset[postgres]"`` | ``postgresql+psycopg2://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Presto | ``"apache-superset[presto]"`` | ``presto://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Snowflake | ``"apache-superset[snowflake]"`` | ``snowflake://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| SQLite | | ``sqlite://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| SQL Server | ``"apache-superset[mssql]"`` | ``mssql://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Teradata | ``"apache-superset[teradata]"`` | ``teradata://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ +| Vertica | ``"apache-superset[vertical]"`` | ``vertica+vertica_python://`` | ++------------------+-------------------------------------------------------------------+-------------------------------------------------+ Note that many other databases are supported, the main criteria being the existence of a functional SqlAlchemy dialect and Python driver. Googling diff --git a/setup.py b/setup.py index 03e86d26f9..339d34fcd5 100644 --- a/setup.py +++ b/setup.py @@ -110,21 +110,33 @@ setup( ], extras_require={ "athena": ["pyathena>=1.10.8,<1.11"], - "bigquery": ["pybigquery>=0.4.10", "pandas_gbq>=0.10.0"], + "bigquery": ["pandas_gbq>=0.10.0", "pybigquery>=0.4.10"], + "clickhouse": ["clickhouse-sqlalchemy>= 0.1.4, <0.2"], + "cockroachdb": ["cockroachdb>=0.3.5, <0.4"], "cors": ["flask-cors>=2.0.0"], + "db2": ["ibm-db-sa>=0.3.5, <0.4"], + "dremio": ["sqlalchemy-dremio>=1.1.5, <1.2"], + "druid": ["pydruid>=0.6.1,<0.7"], + "elasticsearch": ["elasticsearch-dbapi>=0.1.0, <0.2.0"], + "exasol": ["sqlalchemy-exasol>=2.1.0, <2.2"], + "excel": ["xlrd>=1.2.0, <1.3"], "gsheets": ["gsheetsdb>=0.1.9"], + "hana": ["hdbcli==2.4.162", "sqlalchemy_hana==0.4.0"], "hive": ["pyhive[hive]>=0.6.1", "tableschema", "thrift>=0.11.0, <1.0.0"], + "impala": ["impyla>0.16.2, <0.17"], + "kylin": ["kylinpy>=2.8.1, <2.9"], + "mmsql": ["pymssql>=2.1.4, <2.2"], "mysql": ["mysqlclient==1.4.2.post1"], + "oracle": ["cx-Oracle>8.0.0, <8.1"], + "pinot": ["pinotdb>=0.3.3, <0.4"], "postgres": ["psycopg2-binary==2.8.5"], "presto": ["pyhive[presto]>=0.4.0"], - "elasticsearch": ["elasticsearch-dbapi>=0.1.0, <0.2.0"], - "druid": ["pydruid>=0.6.1,<0.7"], - "hana": ["hdbcli==2.4.162", "sqlalchemy_hana==0.4.0"], - "dremio": ["sqlalchemy_dremio>=1.1.0"], - "cockroachdb": ["cockroachdb==0.3.3"], - "thumbnails": ["Pillow>=7.0.0, <8.0.0"], - "excel": ["xlrd>=1.2.0, <1.3"], "prophet": ["fbprophet>=0.6, <0.7"], + "redshift": ["sqlalchemy-redshift>=0.8.1, < 0.9"], + "snowflake": ["snowflake-sqlalchemy>=1.2.3, <1.3"], + "teradata": ["sqlalchemy-teradata==0.9.0.dev0"], + "thumbnails": ["Pillow>=7.0.0, <8.0.0"], + "vertica": ["sqlalchemy-vertica-python>=0.5.9, < 0.6"], }, python_requires="~=3.6", author="Apache Software Foundation",