Table of Contents

• Overview
  • Installation
• Models and Databases
  • Defining Models
    • Default values
    • Null values
    • Materialized fields
    • Alias fields
    • Table Names
    • Model Constraints
    • Data Skipping Indexes
  • 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
• Querysets
  • Filtering
  • Using IN and NOT IN
    • Specifying PREWHERE conditions
    • Old-style filter conditions
  • Counting and Checking Existence
  • Ordering
  • Omitting Fields
  • Distinct
  • Final
  • Slicing
  • Pagination
  • Mutations
  • Aggregation
    • Adding totals
• 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
  • Creating custom field types
• Table Engines
  • Simple Engines
  • Engines in the MergeTree Family
    • Custom partitioning
    • Primary key
    • Data Replication
  • Buffer Engine
  • Merge Engine
• Schema Migrations
  • Writing Migrations
    • CreateTable
    • DropTable
    • AlterTable
    • AlterTableWithBuffer
    • AlterConstraints
    • RunPython
    • RunSQL
  • Running Migrations
• System Models
  • Partitions and Parts
• Contributing
  • Building
  • Tests
• Class Reference
  • clickhouse_orm.database
    • Database
    • DatabaseException
  • clickhouse_orm.models
    • Model
    • BufferModel
    • MergeModel
    • DistributedModel
    • Constraint
    • Index
  • clickhouse_orm.fields
    • ArrayField
    • BaseEnumField
    • BaseFloatField
    • BaseIntField
    • DateField
    • DateTime64Field
    • DateTimeField
    • Decimal128Field
    • Decimal32Field
    • Decimal64Field
    • DecimalField
    • Enum16Field
    • Enum8Field
    • Field
    • FixedStringField
    • Float32Field
    • Float64Field
    • IPv4Field
    • IPv6Field
    • Int16Field
    • Int32Field
    • Int64Field
    • Int8Field
    • LowCardinalityField
    • NullableField
    • StringField
    • UInt16Field
    • UInt32Field
    • UInt64Field
    • UInt8Field
    • UUIDField
  • clickhouse_orm.engines
    • Engine
    • TinyLog
    • Log
    • Memory
    • MergeTree
    • Buffer
    • Merge
    • Distributed
    • CollapsingMergeTree
    • SummingMergeTree
    • ReplacingMergeTree
  • clickhouse_orm.query
    • QuerySet
    • AggregateQuerySet
    • Q
  • clickhouse_orm.funcs
    • F