|
1 |
| -## ClickHouse Connect |
| 1 | +## Timeplus Connect |
2 | 2 |
|
3 |
| -A high performance core database driver for connecting ClickHouse to Python, Pandas, and Superset |
| 3 | +This project provides Python connector to interact with Proton, the code is based on [clickhouse-connect](https://github.com/ClickHouse/clickhouse-connect) |
| 4 | + |
| 5 | +A high performance core database driver for connecting Timeplus to Python, Pandas, and Superset |
4 | 6 |
|
5 | 7 | * Pandas DataFrames
|
6 | 8 | * Numpy Arrays
|
7 | 9 | * PyArrow Tables
|
8 | 10 | * Superset Connector
|
9 | 11 | * SQLAlchemy 1.3 and 1.4 (limited feature set)
|
10 | 12 |
|
11 |
| -ClickHouse Connect currently uses the ClickHouse HTTP interface for maximum compatibility. |
| 13 | +Timeplus Connect currently uses the Timeplus HTTP interface for maximum compatibility. |
12 | 14 |
|
13 | 15 | ### Installation
|
14 | 16 |
|
15 | 17 | ```
|
16 |
| -pip install clickhouse-connect |
| 18 | +pip install timeplus-connect |
17 | 19 | ```
|
18 | 20 |
|
19 |
| -ClickHouse Connect requires Python 3.8 or higher. |
| 21 | +Timeplus Connect requires Python 3.8 or higher. |
20 | 22 |
|
21 | 23 | ### Superset Connectivity
|
22 | 24 |
|
23 |
| -ClickHouse Connect is fully integrated with Apache Superset. Previous versions of ClickHouse Connect utilized a |
| 25 | +Timeplus Connect is fully integrated with Apache Superset. Previous versions of Timeplus Connect utilized a |
24 | 26 | dynamically loaded Superset Engine Spec, but as of Superset v2.1.0 the engine spec was incorporated into the main
|
25 | 27 | Apache Superset project and removed from clickhouse-connect in v0.6.0. If you have issues connecting to earlier
|
26 | 28 | versions of Superset, please use clickhouse-connect v0.5.25.
|
27 | 29 |
|
28 | 30 | When creating a Superset Data Source, either use the provided connection dialog, or a SqlAlchemy DSN in the form
|
29 |
| -`clickhousedb://{username}:{password}@{host}:{port}`. |
| 31 | +`timeplusdb://{username}:{password}@{host}:{port}`. |
30 | 32 |
|
31 | 33 | ### SQLAlchemy Implementation
|
32 | 34 |
|
33 |
| -ClickHouse Connect incorporates a minimal SQLAlchemy implementation (without any ORM features) for compatibility with |
| 35 | +Timeplus Connect incorporates a minimal SQLAlchemy implementation (without any ORM features) for compatibility with |
34 | 36 | Superset. It has only been tested against SQLAlchemy versions 1.3.x and 1.4.x, and is unlikely to work with more
|
35 | 37 | complex SQLAlchemy applications.
|
36 | 38 |
|
37 | 39 | ### Asyncio Support
|
38 | 40 |
|
39 |
| -ClickHouse Connect provides an async wrapper, so that it is possible to use the client in an `asyncio` environment. |
| 41 | +Timeplus Connect provides an async wrapper, so that it is possible to use the client in an `asyncio` environment. |
40 | 42 | See the [run_async example](./examples/run_async.py) for more details.
|
41 |
| - |
42 |
| -### Complete Documentation |
43 |
| - |
44 |
| -The documentation for ClickHouse Connect has moved to |
45 |
| -[ClickHouse Docs](https://clickhouse.com/docs/en/integrations/language-clients/python/intro) |
0 commit comments