2017-05-02 17:46:47 +03:00
|
|
|
# Table of Contents
|
2017-04-26 15:47:02 +03:00
|
|
|
|
|
|
|
|
* [Overview](index.md#overview)
|
|
|
|
|
* [Installation](index.md#installation)
|
|
|
|
|
|
|
|
|
|
* [Models and Databases](models_and_databases.md#models-and-databases)
|
|
|
|
|
* [Defining Models](models_and_databases.md#defining-models)
|
2018-04-21 15:23:00 +03:00
|
|
|
* [Default values](models_and_databases.md#default-values)
|
|
|
|
|
* [Null values](models_and_databases.md#null-values)
|
|
|
|
|
* [Materialized fields](models_and_databases.md#materialized-fields)
|
|
|
|
|
* [Alias fields](models_and_databases.md#alias-fields)
|
2017-04-26 15:47:02 +03:00
|
|
|
* [Table Names](models_and_databases.md#table-names)
|
2020-06-06 11:07:01 +03:00
|
|
|
* [Model Constraints](models_and_databases.md#model-constraints)
|
2020-06-06 20:56:32 +03:00
|
|
|
* [Data Skipping Indexes](models_and_databases.md#data-skipping-indexes)
|
2017-04-26 15:47:02 +03:00
|
|
|
* [Using Models](models_and_databases.md#using-models)
|
|
|
|
|
* [Inserting to the Database](models_and_databases.md#inserting-to-the-database)
|
|
|
|
|
* [Reading from the Database](models_and_databases.md#reading-from-the-database)
|
|
|
|
|
* [Reading without a Model](models_and_databases.md#reading-without-a-model)
|
|
|
|
|
* [SQL Placeholders](models_and_databases.md#sql-placeholders)
|
|
|
|
|
* [Counting](models_and_databases.md#counting)
|
|
|
|
|
* [Pagination](models_and_databases.md#pagination)
|
|
|
|
|
|
2017-04-28 13:44:45 +03:00
|
|
|
* [Querysets](querysets.md#querysets)
|
|
|
|
|
* [Filtering](querysets.md#filtering)
|
2020-05-28 19:18:10 +03:00
|
|
|
* [Using IN and NOT IN](querysets.md#using-in-and-not-in)
|
|
|
|
|
* [Specifying PREWHERE conditions](querysets.md#specifying-prewhere-conditions)
|
|
|
|
|
* [Old-style filter conditions](querysets.md#old-style-filter-conditions)
|
2017-04-28 13:44:45 +03:00
|
|
|
* [Counting and Checking Existence](querysets.md#counting-and-checking-existence)
|
|
|
|
|
* [Ordering](querysets.md#ordering)
|
|
|
|
|
* [Omitting Fields](querysets.md#omitting-fields)
|
2017-09-10 17:17:04 +03:00
|
|
|
* [Distinct](querysets.md#distinct)
|
2018-12-14 09:34:40 +03:00
|
|
|
* [Final](querysets.md#final)
|
2017-06-24 12:28:42 +03:00
|
|
|
* [Slicing](querysets.md#slicing)
|
2017-08-11 17:26:46 +03:00
|
|
|
* [Pagination](querysets.md#pagination)
|
|
|
|
|
* [Aggregation](querysets.md#aggregation)
|
2020-05-28 19:18:10 +03:00
|
|
|
* [Adding totals](querysets.md#adding-totals)
|
2017-04-28 13:44:45 +03:00
|
|
|
|
2020-02-08 13:38:23 +03:00
|
|
|
* [Field Options](field_options.md#field-options)
|
|
|
|
|
* [default](field_options.md#default)
|
|
|
|
|
* [alias / materialized](field_options.md#alias-/-materialized)
|
|
|
|
|
* [codec](field_options.md#codec)
|
|
|
|
|
* [readonly](field_options.md#readonly)
|
|
|
|
|
|
2017-04-26 15:47:02 +03:00
|
|
|
* [Field Types](field_types.md#field-types)
|
|
|
|
|
* [DateTimeField and Time Zones](field_types.md#datetimefield-and-time-zones)
|
|
|
|
|
* [Working with enum fields](field_types.md#working-with-enum-fields)
|
|
|
|
|
* [Working with array fields](field_types.md#working-with-array-fields)
|
2017-06-23 11:56:05 +03:00
|
|
|
* [Working with nullable fields](field_types.md#working-with-nullable-fields)
|
2019-06-25 13:24:06 +03:00
|
|
|
* [Working with LowCardinality fields](field_types.md#working-with-lowcardinality-fields)
|
|
|
|
|
* [Creating custom field types](field_types.md#creating-custom-field-types)
|
2017-04-26 15:47:02 +03:00
|
|
|
|
|
|
|
|
* [Table Engines](table_engines.md#table-engines)
|
2017-05-02 17:46:47 +03:00
|
|
|
* [Simple Engines](table_engines.md#simple-engines)
|
|
|
|
|
* [Engines in the MergeTree Family](table_engines.md#engines-in-the-mergetree-family)
|
2018-04-21 13:48:00 +03:00
|
|
|
* [Custom partitioning](table_engines.md#custom-partitioning)
|
2020-05-01 20:11:40 +03:00
|
|
|
* [Primary key](table_engines.md#primary-key)
|
2017-05-02 17:46:47 +03:00
|
|
|
* [Data Replication](table_engines.md#data-replication)
|
|
|
|
|
* [Buffer Engine](table_engines.md#buffer-engine)
|
2017-09-07 15:44:27 +03:00
|
|
|
* [Merge Engine](table_engines.md#merge-engine)
|
2017-04-26 15:47:02 +03:00
|
|
|
|
|
|
|
|
* [Schema Migrations](schema_migrations.md#schema-migrations)
|
|
|
|
|
* [Writing Migrations](schema_migrations.md#writing-migrations)
|
2020-06-06 11:07:01 +03:00
|
|
|
* [CreateTable](schema_migrations.md#createtable)
|
|
|
|
|
* [DropTable](schema_migrations.md#droptable)
|
|
|
|
|
* [AlterTable](schema_migrations.md#altertable)
|
|
|
|
|
* [AlterTableWithBuffer](schema_migrations.md#altertablewithbuffer)
|
|
|
|
|
* [AlterConstraints](schema_migrations.md#alterconstraints)
|
|
|
|
|
* [RunPython](schema_migrations.md#runpython)
|
|
|
|
|
* [RunSQL](schema_migrations.md#runsql)
|
2017-04-26 15:47:02 +03:00
|
|
|
* [Running Migrations](schema_migrations.md#running-migrations)
|
|
|
|
|
|
2017-04-28 13:44:45 +03:00
|
|
|
* [System Models](system_models.md#system-models)
|
|
|
|
|
* [Partitions and Parts](system_models.md#partitions-and-parts)
|
2017-04-26 15:47:02 +03:00
|
|
|
|
|
|
|
|
* [Contributing](contributing.md#contributing)
|
2017-05-11 05:30:17 +03:00
|
|
|
* [Building](contributing.md#building)
|
|
|
|
|
* [Tests](contributing.md#tests)
|
2017-05-02 17:46:47 +03:00
|
|
|
|
2017-05-05 15:31:08 +03:00
|
|
|
* [Class Reference](class_reference.md#class-reference)
|
2020-05-28 23:02:34 +03:00
|
|
|
* [infi.clickhouse_orm.database](class_reference.md#inficlickhouse_ormdatabase)
|
2017-05-05 15:31:08 +03:00
|
|
|
* [Database](class_reference.md#database)
|
|
|
|
|
* [DatabaseException](class_reference.md#databaseexception)
|
2020-05-28 23:02:34 +03:00
|
|
|
* [infi.clickhouse_orm.models](class_reference.md#inficlickhouse_ormmodels)
|
2017-05-05 15:31:08 +03:00
|
|
|
* [Model](class_reference.md#model)
|
|
|
|
|
* [BufferModel](class_reference.md#buffermodel)
|
2020-06-06 11:07:01 +03:00
|
|
|
* [MergeModel](class_reference.md#mergemodel)
|
2018-04-21 12:10:30 +03:00
|
|
|
* [DistributedModel](class_reference.md#distributedmodel)
|
2020-06-06 11:07:01 +03:00
|
|
|
* [Constraint](class_reference.md#constraint)
|
2020-06-06 20:56:32 +03:00
|
|
|
* [Index](class_reference.md#index)
|
2020-05-28 23:02:34 +03:00
|
|
|
* [infi.clickhouse_orm.fields](class_reference.md#inficlickhouse_ormfields)
|
2018-10-13 23:19:43 +03:00
|
|
|
* [ArrayField](class_reference.md#arrayfield)
|
|
|
|
|
* [BaseEnumField](class_reference.md#baseenumfield)
|
|
|
|
|
* [BaseFloatField](class_reference.md#basefloatfield)
|
|
|
|
|
* [BaseIntField](class_reference.md#baseintfield)
|
2017-05-05 15:31:08 +03:00
|
|
|
* [DateField](class_reference.md#datefield)
|
|
|
|
|
* [DateTimeField](class_reference.md#datetimefield)
|
2020-06-07 12:50:45 +03:00
|
|
|
* [DateTime64Field](class_reference.md#datetime64field)
|
2018-10-13 23:19:43 +03:00
|
|
|
* [Decimal128Field](class_reference.md#decimal128field)
|
|
|
|
|
* [Decimal32Field](class_reference.md#decimal32field)
|
|
|
|
|
* [Decimal64Field](class_reference.md#decimal64field)
|
|
|
|
|
* [DecimalField](class_reference.md#decimalfield)
|
|
|
|
|
* [Enum16Field](class_reference.md#enum16field)
|
|
|
|
|
* [Enum8Field](class_reference.md#enum8field)
|
|
|
|
|
* [Field](class_reference.md#field)
|
2017-05-05 15:31:08 +03:00
|
|
|
* [FixedStringField](class_reference.md#fixedstringfield)
|
2018-10-13 23:19:43 +03:00
|
|
|
* [Float32Field](class_reference.md#float32field)
|
|
|
|
|
* [Float64Field](class_reference.md#float64field)
|
2020-02-08 13:38:23 +03:00
|
|
|
* [IPv4Field](class_reference.md#ipv4field)
|
|
|
|
|
* [IPv6Field](class_reference.md#ipv6field)
|
2017-05-05 15:31:08 +03:00
|
|
|
* [Int16Field](class_reference.md#int16field)
|
|
|
|
|
* [Int32Field](class_reference.md#int32field)
|
|
|
|
|
* [Int64Field](class_reference.md#int64field)
|
2018-10-13 23:19:43 +03:00
|
|
|
* [Int8Field](class_reference.md#int8field)
|
2019-06-25 07:46:37 +03:00
|
|
|
* [LowCardinalityField](class_reference.md#lowcardinalityfield)
|
2018-10-13 23:19:43 +03:00
|
|
|
* [NullableField](class_reference.md#nullablefield)
|
|
|
|
|
* [StringField](class_reference.md#stringfield)
|
|
|
|
|
* [UInt16Field](class_reference.md#uint16field)
|
|
|
|
|
* [UInt32Field](class_reference.md#uint32field)
|
|
|
|
|
* [UInt64Field](class_reference.md#uint64field)
|
|
|
|
|
* [UInt8Field](class_reference.md#uint8field)
|
2019-06-13 05:19:16 +03:00
|
|
|
* [UUIDField](class_reference.md#uuidfield)
|
2020-05-28 23:02:34 +03:00
|
|
|
* [infi.clickhouse_orm.engines](class_reference.md#inficlickhouse_ormengines)
|
2017-05-05 15:31:08 +03:00
|
|
|
* [Engine](class_reference.md#engine)
|
|
|
|
|
* [TinyLog](class_reference.md#tinylog)
|
|
|
|
|
* [Log](class_reference.md#log)
|
|
|
|
|
* [Memory](class_reference.md#memory)
|
|
|
|
|
* [MergeTree](class_reference.md#mergetree)
|
|
|
|
|
* [Buffer](class_reference.md#buffer)
|
2017-09-13 12:15:44 +03:00
|
|
|
* [Merge](class_reference.md#merge)
|
2018-04-21 12:10:30 +03:00
|
|
|
* [Distributed](class_reference.md#distributed)
|
2017-05-05 15:31:08 +03:00
|
|
|
* [CollapsingMergeTree](class_reference.md#collapsingmergetree)
|
|
|
|
|
* [SummingMergeTree](class_reference.md#summingmergetree)
|
|
|
|
|
* [ReplacingMergeTree](class_reference.md#replacingmergetree)
|
2020-05-28 23:02:34 +03:00
|
|
|
* [infi.clickhouse_orm.query](class_reference.md#inficlickhouse_ormquery)
|
2017-05-05 15:31:08 +03:00
|
|
|
* [QuerySet](class_reference.md#queryset)
|
2017-08-11 17:26:46 +03:00
|
|
|
* [AggregateQuerySet](class_reference.md#aggregatequeryset)
|
2020-05-01 20:11:40 +03:00
|
|
|
* [Q](class_reference.md#q)
|
2020-05-28 23:02:34 +03:00
|
|
|
* [infi.clickhouse_orm.funcs](class_reference.md#inficlickhouse_ormfuncs)
|
2020-02-08 13:38:23 +03:00
|
|
|
* [F](class_reference.md#f)
|
2017-05-03 08:36:47 +03:00
|
|
|
|
