Overview

This project is simple ORM for working with the [ClickHouse database](https://clickhouse.tech/). It allows you to define model classes whose instances can be written to the database and read from it.

This repository is expected to use more type hints and only supports Python 3.7+.

Supports both synchronous and asynchronous ways to interact with the clickhouse server. Means you can use asyncio to perform asynchronous queries.

To install ch-orm:

pip install ch-orm

Contents:

• Models and Databases
  • Defining Models
  • Using Models
  • Inserting to the Database
  • Reading from the Database
  • Reading without a Model
  • SQL Placeholders
  • Counting
  • Pagination
• Async Databases
  • Insert from the AioDatabase
  • Reading from the AioDatabase
• Expressions
  • Using Expressions
• Querysets
  • Filtering
  • Counting and Checking Existence
  • Ordering
  • Omitting Fields
  • Distinct
  • Final
  • Slicing
  • Pagination
  • Mutations
  • Aggregation
• Field Options
  • default
  • db_column
  • alias / materialized
  • codec
  • readonly
• Field Types
  • DateTimeField and Time Zones
  • Working with enum fields
  • Working with array fields
  • Working with tuple fields
  • Working with nullable fields
  • Working with LowCardinality fields
  • Working with geo fields
  • Creating custom field types
• Table Engines
  • Simple Engines
  • Engines in the MergeTree Family
  • Buffer Engine
  • Merge Engine
• Schema Migrations
  • Writing Migrations
  • Running Migrations
• System Models
  • Partitions and Parts
• Contributing
  • Building
  • Tests
• Class Reference
  • clickhouse_orm.database
  • clickhouse_orm.aio.database
  • clickhouse_orm.models
  • clickhouse_orm.fields
  • clickhouse_orm.engines
  • clickhouse_orm.engines
  • clickhouse_orm.query
  • clickhouse_orm.funcs
  • clickhouse_orm.system_models

Indices and tables

• Index

• Search Page