You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-7Lines changed: 20 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,7 @@
15
15
16
16
## Table of Contents
17
17
*[Features](#features)
18
+
*[Arch](#arch)
18
19
*[Installation](#installation)
19
20
*[Usage](#usage)
20
21
*[Documentation](#documentation)
@@ -27,9 +28,14 @@
27
28
28
29
* In-process SQL OLAP Engine, powered by ClickHouse
29
30
* No need to install ClickHouse
30
-
*Minimal data copy from C++ to Python
31
+
*Minimized data copy from C++ to Python with [python memoryview](https://docs.python.org/3/c-api/memoryview.html)
31
32
* Input&Output support Parquet, CSV, JSON, Arrow, ORC and [more](https://clickhouse.com/docs/en/interfaces/formats)
32
33
34
+
## Arch
35
+
<divalign="center">
36
+
<imgsrc="docs/_static/arch-chdb.png"height="300">
37
+
</div>
38
+
33
39
## Installation
34
40
Currently, chDB only supports Python 3.7+ on macOS and Linux.
35
41
```bash
@@ -47,19 +53,26 @@ res = chdb.query('select version()', 'CSV'); print(str(res.get_memview().tobytes
47
53
48
54
### work with Parquet or CSV
49
55
```python
50
-
chdb.query('select * from file("data.parquet", Parquet)', 'Pretty')
51
-
chdb.query('select * from file("data.csv", CSV)', 'Pretty')
56
+
chdb.query('select * from file("data.parquet", Parquet)', 'CSV')
57
+
chdb.query('select * from file("data.csv", CSV)', 'CSV')
52
58
```
53
59
60
+
### pandas dataframe output
61
+
```python
62
+
chdb.query('select * from file("data.parquet", Parquet)', 'Dataframe')
63
+
```
64
+
65
+
more examples, please refer to [examples](examples)
66
+
54
67
## Documentation
55
68
- For SQL syntax, please refer to [ClickHouse SQL Reference](https://clickhouse.com/docs/en/sql-reference/syntax)
56
69
57
70
## Contributing
58
71
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
59
72
There are something you can help:
60
-
* Report bugs on [GitHub Issues](https://github.com/auxten/chdb/issues).
61
-
* Help me with Windows support, I don't know much about Windows toolchain.
62
-
* The Python Wrapper just have a `query` function. I want to add more functions to make it more convenient to use. like `toPandas`, `toNumpy` and so on.
73
+
- Report bugs on [GitHub Issues](https://github.com/auxten/chdb/issues).
74
+
-[ ] Help me with Windows support, I don't know much about Windows toolchain.
75
+
-[x] The Python Wrapper just have a `query` function. I want to add more functions to make it more convenient to use. like `toPandas`, `toNumpy` and so on.
63
76
64
77
## License
65
78
AGPL-v3.0 or Commercial License, see [LICENSE](LICENSE.txt) for more information.
@@ -69,5 +82,5 @@ chDB is mainly based on [ClickHouse](https://github.com/ClickHouse/ClickHouse)
69
82
for trade mark and other reasons, I named it chDB.
0 commit comments