Skip to content

Commit efeeea9

Browse files
committed
Add arch chart
1 parent bfea587 commit efeeea9

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
## Table of Contents
1717
* [Features](#features)
18+
* [Arch](#arch)
1819
* [Installation](#installation)
1920
* [Usage](#usage)
2021
* [Documentation](#documentation)
@@ -27,9 +28,14 @@
2728
2829
* In-process SQL OLAP Engine, powered by ClickHouse
2930
* 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)
3132
* Input&Output support Parquet, CSV, JSON, Arrow, ORC and [more](https://clickhouse.com/docs/en/interfaces/formats)
3233

34+
## Arch
35+
<div align="center">
36+
<img src="docs/_static/arch-chdb.png" height="300">
37+
</div>
38+
3339
## Installation
3440
Currently, chDB only supports Python 3.7+ on macOS and Linux.
3541
```bash
@@ -47,19 +53,26 @@ res = chdb.query('select version()', 'CSV'); print(str(res.get_memview().tobytes
4753

4854
### work with Parquet or CSV
4955
```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')
5258
```
5359

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+
5467
## Documentation
5568
- For SQL syntax, please refer to [ClickHouse SQL Reference](https://clickhouse.com/docs/en/sql-reference/syntax)
5669

5770
## Contributing
5871
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**.
5972
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.
6376

6477
## License
6578
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)
6982
for trade mark and other reasons, I named it chDB.
7083

7184
## Contact
72-
- Email: `echo "YXV4dGVud3BjQGdtYWlsLmNvbQ==" | base64 -d`
85+
7386
- Twitter: [@auxten](https://twitter.com/auxten)

docs/_static/arch-chdb.png

34 KB
Loading

0 commit comments

Comments
 (0)