clickhouse-sqlalchemy

ClickHouse SQLAlchemy

ClickHouse dialect for SQLAlchemy to ClickHouse database.

https://coveralls.io/repos/github/xzkostyan/clickhouse-sqlalchemy/badge.svg?branch=master

https://img.shields.io/pypi/l/clickhouse-sqlalchemy.svg

https://img.shields.io/pypi/pyversions/clickhouse-sqlalchemy.svg

https://img.shields.io/pypi/dm/clickhouse-sqlalchemy.svg

https://github.com/xzkostyan/clickhouse-sqlalchemy/actions/workflows/actions.yml/badge.svg

Documentation

Documentation is available at https://clickhouse-sqlalchemy.readthedocs.io.

Usage

Supported interfaces:

native [recommended] (TCP) via clickhouse-driver <https://github.com/mymarilyn/clickhouse-driver>
async native (TCP) via asynch <https://github.com/long2ice/asynch>
http via requests

Define table

from sqlalchemy import create_engine, Column, MetaData

from clickhouse_sqlalchemy import (
    Table, make_session, get_declarative_base, types, engines
)

uri = 'clickhouse+native://localhost/default'

engine = create_engine(uri)
session = make_session(engine)
metadata = MetaData(bind=engine)

Base = get_declarative_base(metadata=metadata)

class Rate(Base):
    day = Column(types.Date, primary_key=True)
    value = Column(types.Int32)

    __table_args__ = (
        engines.Memory(),
    )

Rate.__table__.create()

Insert some data

from datetime import date, timedelta

from sqlalchemy import func

today = date.today()
rates = [
    {'day': today - timedelta(i), 'value': 200 - i}
    for i in range(100)
]

And query inserted data

session.execute(Rate.__table__.insert(), rates)

session.query(func.count(Rate.day)) \
    .filter(Rate.day > today - timedelta(20)) \
    .scalar()

License

ClickHouse SQLAlchemy is distributed under the MIT license.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clickhouse-sqlalchemy-0.3.2.tar.gz (45.2 kB view details)

Uploaded Jun 12, 2024 Source

File details

Details for the file clickhouse-sqlalchemy-0.3.2.tar.gz.

File metadata

Download URL: clickhouse-sqlalchemy-0.3.2.tar.gz
Upload date: Jun 12, 2024
Size: 45.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/56.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.12

File hashes

Hashes for clickhouse-sqlalchemy-0.3.2.tar.gz
Algorithm	Hash digest
SHA256	`267f3a9a1d0d186eb99a41895a684922d31125cea21702cd7dc73af1ccdd10e7`
MD5	`19681a648f78c6a94372978a171f32b1`
BLAKE2b-256	`2db9801073bb20edd4efc5e7240ea318b755867fb0d62acb374daafc35419b39`