https://github.com/ClickHouse/clickhouse-connect

Python driver/sqlalchemy/superset connectors
https://github.com/ClickHouse/clickhouse-connect

clickhouse python

Last synced: about 2 months ago
JSON representation

Python driver/sqlalchemy/superset connectors

• Host: GitHub
• URL: https://github.com/ClickHouse/clickhouse-connect
• Owner: ClickHouse
• License: apache-2.0
• Created: 2022-02-24T20:15:16.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T15:22:57.000Z (5 months ago)
• Last Synced: 2024-04-14T12:28:29.790Z (5 months ago)
• Topics: clickhouse, python
• Language: Python
• Homepage:
• Size: 1.49 MB
• Stars: 257
• Watchers: 9
• Forks: 54
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-clickhouse - ClickHouse/clickhouse-connect - Python package for connecting Python to ClickHouse, supporting various data structures including Pandas DataFrames, Numpy Arrays, PyArrow Tables, SQLAlchemy 1.3 and 1.4, and Apache Superset 1.4+ (Language bindings / Python)

README

        
## ClickHouse Connect

A high performance core database driver for connecting ClickHouse to Python, Pandas, and Superset

* Pandas DataFrames

* Numpy Arrays

* PyArrow Tables

* Superset Connector

* SQLAlchemy 1.3 and 1.4 (limited feature set)

ClickHouse Connect currently uses the ClickHouse HTTP interface for maximum compatibility.

### Installation

```

pip install clickhouse-connect

```

ClickHouse Connect requires Python 3.8 or higher.

### Superset Connectivity

ClickHouse Connect is fully integrated with Apache Superset. Previous versions of ClickHouse Connect utilized a

dynamically loaded Superset Engine Spec, but as of Superset v2.1.0 the engine spec was incorporated into the main

Apache Superset project and removed from clickhouse-connect in v0.6.0. If you have issues connecting to earlier

versions of Superset, please use clickhouse-connect v0.5.25.

When creating a Superset Data Source, either use the provided connection dialog, or a SqlAlchemy DSN in the form

`clickhousedb://{username}:{password}@{host}:{port}`.

### SQLAlchemy Implementation

ClickHouse Connect incorporates a minimal SQLAlchemy implementation (without any ORM features) for compatibility with

Superset. It has only been tested against SQLAlchemy versions 1.3.x and 1.4.x, and is unlikely to work with more

complex SQLAlchemy applications.

### Asyncio Support

ClickHouse Connect provides an async wrapper, so that it is possible to use the client in an `asyncio` environment.

See the [run_async example](./examples/run_async.py) for more details.

### Complete Documentation

The documentation for ClickHouse Connect has moved to

[ClickHouse Docs](https://clickhouse.com/docs/en/integrations/language-clients/python/intro)