chDB

中文

chDB is an embedded SQL OLAP Engine powered by ClickHouse

Features

In-process SQL OLAP Engine, powered by ClickHouse
No need to install ClickHouse
Minimized data copy from C++ to Python with python memoryview
Input&Output support Parquet, CSV, JSON, Arrow, ORC and 60+more formats, samples

Arch

Installation

Currently, chDB only supports Python 3.7+ on macOS(x86_64 and ARM64) and Linux.

pip install chdb

Usage

Run in command line

python3 -m chdb SQL [OutputFormat]

python3 -m chdb "SELECT 1,'abc'" Pretty

Currently, chDB only supports query function, which is used to execute SQL and return desired format data.

import chdb
res = chdb.query('select version()', 'Pretty'); print(res.data())

Work with Parquet or CSV

# See more data type format in tests/format_output.py
res = chdb.query('select * from file("data.parquet", Parquet)', 'JSON'); print(res.data())
# With large data result, get_memview() is more quickly cos it does not do an extra data copy.
res = chdb.query('select * from file("data.csv", CSV)', 'CSV');  print(str(res.get_memview().tobytes()))

Pandas dataframe output

# See more in https://clickhouse.com/docs/en/interfaces/formats
chdb.query('select * from file("data.parquet", Parquet)', 'Dataframe')

Demos and Examples

Benchmark

ClickBench of embedded engines

Documentation

For SQL syntax, please refer to ClickHouse SQL Reference

Contributing

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. There are something you can help:

Help me with Windows support, I don't know much about Windows toolchain.
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.

License

AGPL-v3.0 or Commercial License, see LICENSE for more information.

Acknowledgments

chDB is mainly based on ClickHouse for trade mark and other reasons, I named it chDB.

hay-man / chdb Goto Github PK

chdb's Introduction