Skip to main content

ClickHouse SQLAlchemy

ClickHouse dialect for SQLAlchemy to ClickHouse database.

https://img.shields.io/pypi/v/clickhouse-sqlalchemy.svg 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.

Metadata

Release files for clickhouse-sqlalchemy 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for clickhouse-sqlalchemy 0.3.2
File Size Uploaded
clickhouse-sqlalchemy-0.3.2.tar.gz 45.2 kB Details

Release files / clickhouse-sqlalchemy-0.3.2.tar.gz

Download URL clickhouse-sqlalchemy-0.3.2.tar.gz
Size 45.2 kB
Tags Source
SHA-256 checksum
How to use checksums
267f3a9a1d0d186eb99a41895a684922d31125cea21702cd7dc73af1ccdd10e7
BLAKE2b-256 checksum
How to use checksums
2db9801073bb20edd4efc5e7240ea318b755867fb0d62acb374daafc35419b39
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release
Image

0.3.2 This release

1 release file

Image

0.3.1

1 release file

Image

0.3.0

1 release file

Image

0.2.9

1 release file

Image

0.2.8

1 release file

Image

0.2.7

1 release file

Image

0.2.6

1 release file

Image

0.2.5

1 release file

Image

0.2.4

1 release file

Image

0.2.3

1 release file

Image

0.2.2

1 release file

Image

0.2.1

1 release file

Image

0.2.0

1 release file

Image

0.1.12

1 release file

Image

0.1.11

1 release file

Image

0.1.10

1 release file

Image

0.1.9

1 release file

Image

0.1.8

1 release file

Image

0.1.7

1 release file

Image

0.1.6

1 release file

Image

0.1.5

1 release file

Image

0.1.4

1 release file

Image

0.1.3

1 release file

Image

0.1.2

1 release file

Image

0.1.1

1 release file

Image

0.1.0

1 release file

Image

0.0.10

1 release file

Image

0.0.9

1 release file

Image

0.0.8

1 release file

Image

0.0.7

1 release file

Image

0.0.6

1 release file

Image

0.0.5

1 release file

Image

0.0.4

1 release file

Image

0.0.3

1 release file

Image

0.0.2

1 release file

Image

0.0.1

1 release file

Image Anthropic, PBC Visionary sponsor Image Bloomberg Visionary sponsor Image Hudson River Trading Visionary sponsor Image Meta Visionary sponsor Image NVIDIA Visionary sponsor Image Microsoft Sustainability sponsor Image Depot Continuous Integration Image AWS Cloud computing and Security Sponsor Image Datadog Monitoring Image Fastly CDN Image Google Download Analytics Image Sentry Error logging Image StatusPage Status page