Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add clickhouse-connect as recommended ClickHouse SQLAlchemy provider #1312

Merged
merged 1 commit into from
Aug 23, 2023
Merged

Add clickhouse-connect as recommended ClickHouse SQLAlchemy provider #1312

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions docs_website/docs/setup_guide/query_engines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,35 +36,35 @@ Querybook only supports a few of the Tier 1 & 2 databases by default. When Query

**Note**: If the query engine is not included below, but it does have a Sqlalchemy integration, you can still use it in Querybook. Follow the [Connect to a Query Engine](./connect_to_a_query_engine) with 1 additional step before step 4. Visit `<project_root>/querybook/server/lib/query_executor/sqlalchemy.py` and add the query engine to the list variable `SQLALCHEMY_SUPPORTED_DIALECTS`, and continue to step 4. If it works, please contribute to Querybook by submitting a PR of your changes.

| Query Engine | Tier | Package |
| -------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Apache Drill | 3 | [sqlalchemy-drill](https://pypi.org/project/sqlalchemy-drill/) |
| Apache Hive | 1 | [pyhive](https://pypi.org/project/PyHive/) OR `-r engines/hive.txt` |
| Apache Kylin | 3 | [kylinpy](https://pypi.org/project/kylinpy/) |
| Apache Solr | 3 | [sqlalchemy-solr](https://pypi.org/project/sqlalchemy-solr/) |
| Amazon Athena | 3 | [pyathena](https://pypi.org/project/pyathena/) |
| Amazon Redshift | 2 | [sqlalchemy-redshift](https://pypi.org/project/sqlalchemy-redshift/)<br/>[redshift_connector](https://pypi.org/project/redshift-connector/) OR `-r engines/redshift.txt` |
| BigQuery | 2 | [google-cloud-bigquery](https://pypi.org/project/google-cloud-bigquery/)<br/> OR `-r engines/bigquery.txt` |
| ClickHouse | 3 | [clickhouse-sqlalchemy](https://pypi.org/project/clickhouse-sqlalchemy/)<br/>[clickhouse-driver](https://pypi.org/project/clickhouse-driver/) |
| CockroachDB | 3 | [sqlalchemy-cockroachdb](https://pypi.org/project/sqlalchemy-cockroachdb/)<br/>[psycopg2](https://pypi.org/project/psycopg2/) |
| CrateDB | 3 | [crate](https://pypi.org/project/crate/) |
| Dremio | 3 | [sqlalchemy-dremio](https://pypi.org/project/sqlalchemy-dremio/) |
| Druid | 2 | [pydruid](https://pypi.org/project/pydruid/) OR `-r engines/druid.txt` |
| ElasticSearch | 3 | [elasticsearch-dbapi](https://pypi.org/project/elasticsearch-dbapi/0.2.1/) |
| EXASolution | 3 | [sqlalchemy-exasol](https://pypi.org/project/sqlalchemy-exasol/) |
| Firebird | 3 | [sqlalchemy-firebird](https://pypi.org/project/sqlalchemy-firebird/) |
| Google Spreasheets | 3 | [gsheetsdb](https://pypi.org/project/gsheetsdb/) |
| IBM DB2 | 3 | [ibm-db-sa](https://pypi.org/project/ibm-db-sa/) |
| Microsoft Access | 3 | [sqlalchemy-access](https://pypi.org/project/sqlalchemy-access/) |
| Microsoft SQL Server | 3 | Included by default |
| MySQL | 1 | Included by default |
| MonetDB | 3 | [sqlalchemy_monetdb](https://pypi.org/project/sqlalchemy_monetdb/) |
| Oracle | 3 | Included by default |
| PostgreSQL | 2 | Included by default |
| Presto | 1 | [pyhive](https://pypi.org/project/PyHive/) OR `-r engines/presto.txt` |
| SAP Hana | 3 | [sqlalchemy-hana](https://pypi.org/project/sqlalchemy-hana/0.2.2/) |
| Snowflake | 2 | [snowflake-sqlalchemy](https://pypi.org/project/snowflake-sqlalchemy/) OR `-r engines/snowflake.txt` |
| SQLite | 2 | Included by default |
| Teradata Vantage | 3 | [teradatasqlalchemy](https://pypi.org/project/teradatasqlalchemy/) |
| Trino | 2 | [trino](https://github.com/trinodb/trino-python-client) OR `-r engines/trino.txt` |
| Vertica | 3 | [sqlalchemy-vertica-python](https://pypi.org/project/sqlalchemy-vertica-python/) |
| Query Engine | Tier | Package |
| -------------------- | ---- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Apache Drill | 3 | [sqlalchemy-drill](https://pypi.org/project/sqlalchemy-drill/) |
| Apache Hive | 1 | [pyhive](https://pypi.org/project/PyHive/) OR `-r engines/hive.txt` |
| Apache Kylin | 3 | [kylinpy](https://pypi.org/project/kylinpy/) |
| Apache Solr | 3 | [sqlalchemy-solr](https://pypi.org/project/sqlalchemy-solr/) |
| Amazon Athena | 3 | [pyathena](https://pypi.org/project/pyathena/) |
| Amazon Redshift | 2 | [sqlalchemy-redshift](https://pypi.org/project/sqlalchemy-redshift/)<br/>[redshift_connector](https://pypi.org/project/redshift-connector/) OR `-r engines/redshift.txt` |
| BigQuery | 2 | [google-cloud-bigquery](https://pypi.org/project/google-cloud-bigquery/)<br/> OR `-r engines/bigquery.txt` |
| ClickHouse | 3 | [clickhouse-connect](https://pypi.org/project/clickhouse-connect) (recommended) OR<br/>[clickhouse-sqlalchemy](https://pypi.org/project/clickhouse-sqlalchemy/) plus [clickhouse-driver](https://pypi.org/project/clickhouse-driver/) |
| CockroachDB | 3 | [sqlalchemy-cockroachdb](https://pypi.org/project/sqlalchemy-cockroachdb/)<br/>[psycopg2](https://pypi.org/project/psycopg2/) |
| CrateDB | 3 | [crate](https://pypi.org/project/crate/) |
| Dremio | 3 | [sqlalchemy-dremio](https://pypi.org/project/sqlalchemy-dremio/) |
| Druid | 2 | [pydruid](https://pypi.org/project/pydruid/) OR `-r engines/druid.txt` |
| ElasticSearch | 3 | [elasticsearch-dbapi](https://pypi.org/project/elasticsearch-dbapi/0.2.1/) |
| EXASolution | 3 | [sqlalchemy-exasol](https://pypi.org/project/sqlalchemy-exasol/) |
| Firebird | 3 | [sqlalchemy-firebird](https://pypi.org/project/sqlalchemy-firebird/) |
| Google Spreasheets | 3 | [gsheetsdb](https://pypi.org/project/gsheetsdb/) |
| IBM DB2 | 3 | [ibm-db-sa](https://pypi.org/project/ibm-db-sa/) |
| Microsoft Access | 3 | [sqlalchemy-access](https://pypi.org/project/sqlalchemy-access/) |
| Microsoft SQL Server | 3 | Included by default |
| MySQL | 1 | Included by default |
| MonetDB | 3 | [sqlalchemy_monetdb](https://pypi.org/project/sqlalchemy_monetdb/) |
| Oracle | 3 | Included by default |
| PostgreSQL | 2 | Included by default |
| Presto | 1 | [pyhive](https://pypi.org/project/PyHive/) OR `-r engines/presto.txt` |
| SAP Hana | 3 | [sqlalchemy-hana](https://pypi.org/project/sqlalchemy-hana/0.2.2/) |
| Snowflake | 2 | [snowflake-sqlalchemy](https://pypi.org/project/snowflake-sqlalchemy/) OR `-r engines/snowflake.txt` |
| SQLite | 2 | Included by default |
| Teradata Vantage | 3 | [teradatasqlalchemy](https://pypi.org/project/teradatasqlalchemy/) |
| Trino | 2 | [trino](https://github.com/trinodb/trino-python-client) OR `-r engines/trino.txt` |
| Vertica | 3 | [sqlalchemy-vertica-python](https://pypi.org/project/sqlalchemy-vertica-python/) |
Loading