Infinidat/infi.clickhouse_orm
1
1
Fork 0
mirror of https://github.com/Infinidat/infi.clickhouse_orm.git synced 2025-08-02 11:10:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
sw 2022-06-04 21:29:49 +08:00
parent d22683f28c
commit d4d92118bf
5 changed files with 146 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.git-blame-ignore-revs Normal file
View File

@ -0,0 +1 @@
d22683f28c7c59053bd009cedfe35e54e6b3aead

9
README.md
View File

@ -6,9 +6,10 @@ Supports both synchronous and asynchronous ways to interact with the clickhouse
| Build | [![Python 3.7 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.7%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.7+Tests)[![Python 3.8 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.8%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.8+Tests)[![Python 3.9 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.9%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.9+Tests)[![Python 3.10 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.10%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.10+Tests) | | Build | [![Python 3.7 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.7%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.7+Tests)[![Python 3.8 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.8%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.8+Tests)[![Python 3.9 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.9%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.9+Tests)[![Python 3.10 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.10%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.10+Tests) |
| ----------- | ------------------------------------------------------------ | | ----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Package** | [![PyPI](https://img.shields.io/pypi/v/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![PyPI version](https://img.shields.io/pypi/pyversions/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![PyPI Wheel](https://img.shields.io/pypi/wheel/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![Coverage Status](https://coveralls.io/repos/github/sswest/ch-orm/badge.svg?branch=master)](https://coveralls.io/github/sswest/ch-orm?branch=master) | | **Package** | [![PyPI](https://img.shields.io/pypi/v/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![PyPI version](https://img.shields.io/pypi/pyversions/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![PyPI Wheel](https://img.shields.io/pypi/wheel/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![Coverage Status](https://coveralls.io/repos/github/sswest/ch-orm/badge.svg?branch=master)](https://coveralls.io/github/sswest/ch-orm?branch=master)[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
| **Docs** | [![Documentation](https://camo.githubusercontent.com/bbb44987324f9324879ccae8ff5ad5c30b7e8b37ccee7235841a9628772595fe/68747470733a2f2f72656164746865646f63732e6f72672f70726f6a656374732f73616e69632f62616467652f3f76657273696f6e3d6c6174657374)](http://sswest.github.io/ch-orm) | |
| **Docs** | [![Documentation](https://camo.githubusercontent.com/bbb44987324f9324879ccae8ff5ad5c30b7e8b37ccee7235841a9628772595fe/68747470733a2f2f72656164746865646f63732e6f72672f70726f6a656374732f73616e69632f62616467652f3f76657273696f6e3d6c6174657374)](https://sswest.github.io/ch-orm) |
Introduction Introduction
============ ============
@ -19,4 +20,4 @@ It allows you to define model classes whose instances can be written to the data
This and other examples can be found in the `examples` folder. This and other examples can be found in the `examples` folder.
To learn more please visit the [documentation](docs/toc.md). To learn more please visit the [documentation](https://sswest.github.io/ch-orm/).

268
docs/toc.md
View File

@ -1,147 +1,147 @@
# Table of Contents # Table of Contents
* [Overview](index.md#overview) * [Overview](/sswest/ch-orm/blob/master/docs/index.md#overviewindex.md#overview)
* [Installation](index.md#installation) * [Installation](/sswest/ch-orm/blob/master/docs/index.md#installation)
* [Models and Databases](models_and_databases.md#models-and-databases) * [Models and Databases](/sswest/ch-orm/blob/master/docs/models_and_databases.md#models-and-databases)
* [Defining Models](models_and_databases.md#defining-models) * [Defining Models](/sswest/ch-orm/blob/master/docs/models_and_databases.md#defining-models)
* [Default values](models_and_databases.md#default-values) * [Default values](/sswest/ch-orm/blob/master/docs/models_and_databases.md#default-values)
* [Null values](models_and_databases.md#null-values) * [Null values](/sswest/ch-orm/blob/master/docs/models_and_databases.md#null-values)
* [Materialized fields](models_and_databases.md#materialized-fields) * [Materialized fields](/sswest/ch-orm/blob/master/docs/models_and_databases.md#materialized-fields)
* [Alias fields](models_and_databases.md#alias-fields) * [Alias fields](/sswest/ch-orm/blob/master/docs/models_and_databases.md#alias-fields)
* [Table Names](models_and_databases.md#table-names) * [Table Names](/sswest/ch-orm/blob/master/docs/models_and_databases.md#table-names)
* [Model Constraints](models_and_databases.md#model-constraints) * [Model Constraints](/sswest/ch-orm/blob/master/docs/models_and_databases.md#model-constraints)
* [Data Skipping Indexes](models_and_databases.md#data-skipping-indexes) * [Data Skipping Indexes](/sswest/ch-orm/blob/master/docs/models_and_databases.md#data-skipping-indexes)
* [Using Models](models_and_databases.md#using-models) * [Using Models](/sswest/ch-orm/blob/master/docs/models_and_databases.md#using-models)
* [Inserting to the Database](models_and_databases.md#inserting-to-the-database) * [Inserting to the Database](/sswest/ch-orm/blob/master/docs/models_and_databases.md#inserting-to-the-database)
* [Reading from the Database](models_and_databases.md#reading-from-the-database) * [Reading from the Database](/sswest/ch-orm/blob/master/docs/models_and_databases.md#reading-from-the-database)
* [Reading without a Model](models_and_databases.md#reading-without-a-model) * [Reading without a Model](/sswest/ch-orm/blob/master/docs/models_and_databases.md#reading-without-a-model)
* [SQL Placeholders](models_and_databases.md#sql-placeholders) * [SQL Placeholders](/sswest/ch-orm/blob/master/docs/models_and_databases.md#sql-placeholders)
* [Counting](models_and_databases.md#counting) * [Counting](/sswest/ch-orm/blob/master/docs/models_and_databases.md#counting)
* [Pagination](models_and_databases.md#pagination) * [Pagination](/sswest/ch-orm/blob/master/docs/models_and_databases.md#pagination)
* [Async Databases](async_databases.md#async-databases) * [Async Databases](/sswest/ch-orm/blob/master/docs/async_databases.md#async-databases)
* [Insert from the AioDatabase](async_databases.md#insert-from-the-aiodatabase) * [Insert from the AioDatabase](/sswest/ch-orm/blob/master/docs/async_databases.md#insert-from-the-aiodatabase)
* [Reading from the AioDatabase](async_databases.md#reading-from-the-aiodatabase) * [Reading from the AioDatabase](/sswest/ch-orm/blob/master/docs/async_databases.md#reading-from-the-aiodatabase)
* [Querysets](querysets.md#querysets) * [Querysets](/sswest/ch-orm/blob/master/docs/querysets.md#querysets)
* [Filtering](querysets.md#filtering) * [Filtering](/sswest/ch-orm/blob/master/docs/querysets.md#filtering)
* [Using IN and NOT IN](querysets.md#using-in-and not-in) * [Using IN and NOT IN](/sswest/ch-orm/blob/master/docs/querysets.md#using-in-and-not-in)
* [Specifying PREWHERE conditions](querysets.md#specifying-prewhere conditions) * [Specifying PREWHERE conditions](/sswest/ch-orm/blob/master/docs/querysets.md#specifying-prewhere-conditions)
* [Old-style filter conditions](querysets.md#old-style-filter-conditions) * [Old-style filter conditions](/sswest/ch-orm/blob/master/docs/querysets.md#old-style-filter-conditions)
* [Counting and Checking Existence](querysets.md#counting-and-checking existence) * [Counting and Checking Existence](/sswest/ch-orm/blob/master/docs/querysets.md#counting-and-checking-existence)
* [Ordering](querysets.md#ordering) * [Ordering](/sswest/ch-orm/blob/master/docs/querysets.md#ordering)
* [Omitting Fields](querysets.md#omitting-fields) * [Omitting Fields](/sswest/ch-orm/blob/master/docs/querysets.md#omitting-fields)
* [Distinct](querysets.md#distinct) * [Distinct](/sswest/ch-orm/blob/master/docs/querysets.md#distinct)
* [Final](querysets.md#final) * [Final](/sswest/ch-orm/blob/master/docs/querysets.md#final)
* [Slicing](querysets.md#slicing) * [Slicing](/sswest/ch-orm/blob/master/docs/querysets.md#slicing)
* [Pagination](querysets.md#pagination) * [Pagination](/sswest/ch-orm/blob/master/docs/querysets.md#pagination)
* [Mutations](querysets.md#mutations) * [Mutations](/sswest/ch-orm/blob/master/docs/querysets.md#mutations)
* [Aggregation](querysets.md#aggregation) * [Aggregation](/sswest/ch-orm/blob/master/docs/querysets.md#aggregation)
* [Adding totals](querysets.md#adding-totals) * [Adding totals](/sswest/ch-orm/blob/master/docs/querysets.md#adding-totals)
* [Field Options](field_options.md#field-options) * [Field Options](/sswest/ch-orm/blob/master/docs/field_options.md#field-options)
* [default](field_options.md#default) * [default](/sswest/ch-orm/blob/master/docs/field_options.md#default)
* [db_column](field_options.md#db_column) * [db_column](/sswest/ch-orm/blob/master/docs/field_options.md#db_column)
* [alias / materialized](field_options.md#alias-/-materialized) * [alias / materialized](/sswest/ch-orm/blob/master/docs/field_options.md#alias-/-materialized)
* [codec](field_options.md#codec) * [codec](/sswest/ch-orm/blob/master/docs/field_options.md#codec)
* [readonly](field_options.md#readonly) * [readonly](/sswest/ch-orm/blob/master/docs/field_options.md#readonly)
* [Field Types](field_types.md#field-types) * [Field Types](/sswest/ch-orm/blob/master/docs/field_types.md#field-types)
* [DateTimeField and Time Zones](field_types.md#datetimefield-and-time-zones) * [DateTimeField and Time Zones](/sswest/ch-orm/blob/master/docs/field_types.md#datetimefield-and-time-zones)
* [Working with enum fields](field_types.md#working-with-enum-fields) * [Working with enum fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-enum-fields)
* [Working with array fields](field_types.md#working-with-array-fields) * [Working with array fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-array-fields)
* [Working with tuple fields](field_types.md#working-with-tuple-fields) * [Working with tuple fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-tuple-fields)
* [Working with nullable fields](field_types.md#working-with-nullable-fields) * [Working with nullable fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-nullable-fields)
* [Working with LowCardinality fields](field_types.md#working-with-lowcardinality fields) * [Working with LowCardinality fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-lowcardinality-fields)
* [Creating custom field types](field_types.md#creating-custom-field-types) * [Creating custom field types](/sswest/ch-orm/blob/master/docs/field_types.md#creating-custom-field-types)
* [Table Engines](table_engines.md#table-engines) * [Table Engines](/sswest/ch-orm/blob/master/docs/table_engines.md#table-engines)
* [Simple Engines](table_engines.md#simple-engines) * [Simple Engines](/sswest/ch-orm/blob/master/docs/table_engines.md#simple-engines)
* [Engines in the MergeTree Family](table_engines.md#engines-in-the-mergetree family) * [Engines in the MergeTree Family](/sswest/ch-orm/blob/master/docs/table_engines.md#engines-in-the-mergetree-family)
* [Custom partitioning](table_engines.md#custom-partitioning) * [Custom partitioning](/sswest/ch-orm/blob/master/docs/table_engines.md#custom-partitioning)
* [Primary key](table_engines.md#primary-key) * [Primary key](/sswest/ch-orm/blob/master/docs/table_engines.md#primary-key)
* [Data Replication](table_engines.md#data-replication) * [Data Replication](/sswest/ch-orm/blob/master/docs/table_engines.md#data-replication)
* [Buffer Engine](table_engines.md#buffer-engine) * [Buffer Engine](/sswest/ch-orm/blob/master/docs/table_engines.md#buffer-engine)
* [Merge Engine](table_engines.md#merge-engine) * [Merge Engine](/sswest/ch-orm/blob/master/docs/table_engines.md#merge-engine)
* [Schema Migrations](schema_migrations.md#schema-migrations) * [Schema Migrations](/sswest/ch-orm/blob/master/docs/schema_migrations.md#schema-migrations)
* [Writing Migrations](schema_migrations.md#writing-migrations) * [Writing Migrations](/sswest/ch-orm/blob/master/docs/schema_migrations.md#writing-migrations)
* [CreateTable](schema_migrations.md#createtable) * [CreateTable](/sswest/ch-orm/blob/master/docs/schema_migrations.md#createtable)
* [DropTable](schema_migrations.md#droptable) * [DropTable](/sswest/ch-orm/blob/master/docs/schema_migrations.md#droptable)
* [AlterTable](schema_migrations.md#altertable) * [AlterTable](/sswest/ch-orm/blob/master/docs/schema_migrations.md#altertable)
* [AlterTableWithBuffer](schema_migrations.md#altertablewithbuffer) * [AlterTableWithBuffer](/sswest/ch-orm/blob/master/docs/schema_migrations.md#altertablewithbuffer)
* [AlterConstraints](schema_migrations.md#alterconstraints) * [AlterConstraints](/sswest/ch-orm/blob/master/docs/schema_migrations.md#alterconstraints)
* [RunPython](schema_migrations.md#runpython) * [RunPython](/sswest/ch-orm/blob/master/docs/schema_migrations.md#runpython)
* [RunSQL](schema_migrations.md#runsql) * [RunSQL](/sswest/ch-orm/blob/master/docs/schema_migrations.md#runsql)
* [Running Migrations](schema_migrations.md#running-migrations) * [Running Migrations](/sswest/ch-orm/blob/master/docs/schema_migrations.md#running-migrations)
* [System Models](system_models.md#system-models) * [System Models](/sswest/ch-orm/blob/master/docs/system_models.md#system-models)
* [Partitions and Parts](system_models.md#partitions-and-parts) * [Partitions and Parts](/sswest/ch-orm/blob/master/docs/system_models.md#partitions-and-parts)
* [Contributing](contributing.md#contributing) * [Contributing](/sswest/ch-orm/blob/master/docs/contributing.md#contributing)
* [Building](contributing.md#building) * [Building](/sswest/ch-orm/blob/master/docs/contributing.md#building)
* [Tests](contributing.md#tests) * [Tests](/sswest/ch-orm/blob/master/docs/contributing.md#tests)
* [Class Reference](class_reference.md#class-reference) * [Class Reference](/sswest/ch-orm/blob/master/docs/class_reference.md#class-reference)
* [infi.clickhouse_orm.database](class_reference.md#inficlickhouse_ormdatabase) * [clickhouse_orm.database](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormdatabase)
* [Database](class_reference.md#database) * [Database](/sswest/ch-orm/blob/master/docs/class_reference.md#database)
* [DatabaseException](class_reference.md#databaseexception) * [DatabaseException](/sswest/ch-orm/blob/master/docs/class_reference.md#databaseexception)
* [infi.clickhouse_orm.models](class_reference.md#inficlickhouse_ormmodels) * [clickhouse_orm.models](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormmodels)
* [Model](class_reference.md#model) * [Model](/sswest/ch-orm/blob/master/docs/class_reference.md#model)
* [BufferModel](class_reference.md#buffermodel) * [BufferModel](/sswest/ch-orm/blob/master/docs/class_reference.md#buffermodel)
* [MergeModel](class_reference.md#mergemodel) * [MergeModel](/sswest/ch-orm/blob/master/docs/class_reference.md#mergemodel)
* [DistributedModel](class_reference.md#distributedmodel) * [DistributedModel](/sswest/ch-orm/blob/master/docs/class_reference.md#distributedmodel)
* [Constraint](class_reference.md#constraint) * [Constraint](/sswest/ch-orm/blob/master/docs/class_reference.md#constraint)
* [Index](class_reference.md#index) * [Index](/sswest/ch-orm/blob/master/docs/class_reference.md#index)
* [infi.clickhouse_orm.fields](class_reference.md#inficlickhouse_ormfields) * [clickhouse_orm.fields](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormfields)
* [ArrayField](class_reference.md#arrayfield) * [ArrayField](/sswest/ch-orm/blob/master/docs/class_reference.md#arrayfield)
* [BaseEnumField](class_reference.md#baseenumfield) * [BaseEnumField](/sswest/ch-orm/blob/master/docs/class_reference.md#baseenumfield)
* [BaseFloatField](class_reference.md#basefloatfield) * [BaseFloatField](/sswest/ch-orm/blob/master/docs/class_reference.md#basefloatfield)
* [BaseIntField](class_reference.md#baseintfield) * [BaseIntField](/sswest/ch-orm/blob/master/docs/class_reference.md#baseintfield)
* [DateField](class_reference.md#datefield) * [DateField](/sswest/ch-orm/blob/master/docs/class_reference.md#datefield)
* [DateTime64Field](class_reference.md#datetime64field) * [DateTime64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#datetime64field)
* [DateTimeField](class_reference.md#datetimefield) * [DateTimeField](/sswest/ch-orm/blob/master/docs/class_reference.md#datetimefield)
* [Decimal128Field](class_reference.md#decimal128field) * [Decimal128Field](/sswest/ch-orm/blob/master/docs/class_reference.md#decimal128field)
* [Decimal32Field](class_reference.md#decimal32field) * [Decimal32Field](/sswest/ch-orm/blob/master/docs/class_reference.md#decimal32field)
* [Decimal64Field](class_reference.md#decimal64field) * [Decimal64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#decimal64field)
* [DecimalField](class_reference.md#decimalfield) * [DecimalField](/sswest/ch-orm/blob/master/docs/class_reference.md#decimalfield)
* [Enum16Field](class_reference.md#enum16field) * [Enum16Field](/sswest/ch-orm/blob/master/docs/class_reference.md#enum16field)
* [Enum8Field](class_reference.md#enum8field) * [Enum8Field](/sswest/ch-orm/blob/master/docs/class_reference.md#enum8field)
* [Field](class_reference.md#field) * [Field](/sswest/ch-orm/blob/master/docs/class_reference.md#field)
* [FixedStringField](class_reference.md#fixedstringfield) * [FixedStringField](/sswest/ch-orm/blob/master/docs/class_reference.md#fixedstringfield)
* [Float32Field](class_reference.md#float32field) * [Float32Field](/sswest/ch-orm/blob/master/docs/class_reference.md#float32field)
* [Float64Field](class_reference.md#float64field) * [Float64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#float64field)
* [IPv4Field](class_reference.md#ipv4field) * [IPv4Field](/sswest/ch-orm/blob/master/docs/class_reference.md#ipv4field)
* [IPv6Field](class_reference.md#ipv6field) * [IPv6Field](/sswest/ch-orm/blob/master/docs/class_reference.md#ipv6field)
* [Int16Field](class_reference.md#int16field) * [Int16Field](/sswest/ch-orm/blob/master/docs/class_reference.md#int16field)
* [Int32Field](class_reference.md#int32field) * [Int32Field](/sswest/ch-orm/blob/master/docs/class_reference.md#int32field)
* [Int64Field](class_reference.md#int64field) * [Int64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#int64field)
* [Int8Field](class_reference.md#int8field) * [Int8Field](/sswest/ch-orm/blob/master/docs/class_reference.md#int8field)
* [LowCardinalityField](class_reference.md#lowcardinalityfield) * [LowCardinalityField](/sswest/ch-orm/blob/master/docs/class_reference.md#lowcardinalityfield)
* [NullableField](class_reference.md#nullablefield) * [NullableField](/sswest/ch-orm/blob/master/docs/class_reference.md#nullablefield)
* [StringField](class_reference.md#stringfield) * [StringField](/sswest/ch-orm/blob/master/docs/class_reference.md#stringfield)
* [UInt16Field](class_reference.md#uint16field) * [UInt16Field](/sswest/ch-orm/blob/master/docs/class_reference.md#uint16field)
* [UInt32Field](class_reference.md#uint32field) * [UInt32Field](/sswest/ch-orm/blob/master/docs/class_reference.md#uint32field)
* [UInt64Field](class_reference.md#uint64field) * [UInt64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#uint64field)
* [UInt8Field](class_reference.md#uint8field) * [UInt8Field](/sswest/ch-orm/blob/master/docs/class_reference.md#uint8field)
* [UUIDField](class_reference.md#uuidfield) * [UUIDField](/sswest/ch-orm/blob/master/docs/class_reference.md#uuidfield)
* [infi.clickhouse_orm.engines](class_reference.md#inficlickhouse_ormengines) * [clickhouse_orm.engines](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormengines)
* [Engine](class_reference.md#engine) * [Engine](/sswest/ch-orm/blob/master/docs/class_reference.md#engine)
* [TinyLog](class_reference.md#tinylog) * [TinyLog](/sswest/ch-orm/blob/master/docs/class_reference.md#tinylog)
* [Log](class_reference.md#log) * [Log](/sswest/ch-orm/blob/master/docs/class_reference.md#log)
* [Memory](class_reference.md#memory) * [Memory](/sswest/ch-orm/blob/master/docs/class_reference.md#memory)
* [MergeTree](class_reference.md#mergetree) * [MergeTree](/sswest/ch-orm/blob/master/docs/class_reference.md#mergetree)
* [Buffer](class_reference.md#buffer) * [Buffer](/sswest/ch-orm/blob/master/docs/class_reference.md#buffer)
* [Merge](class_reference.md#merge) * [Merge](/sswest/ch-orm/blob/master/docs/class_reference.md#merge)
* [Distributed](class_reference.md#distributed) * [Distributed](/sswest/ch-orm/blob/master/docs/class_reference.md#distributed)
* [CollapsingMergeTree](class_reference.md#collapsingmergetree) * [CollapsingMergeTree](/sswest/ch-orm/blob/master/docs/class_reference.md#collapsingmergetree)
* [SummingMergeTree](class_reference.md#summingmergetree) * [SummingMergeTree](/sswest/ch-orm/blob/master/docs/class_reference.md#summingmergetree)
* [ReplacingMergeTree](class_reference.md#replacingmergetree) * [ReplacingMergeTree](/sswest/ch-orm/blob/master/docs/class_reference.md#replacingmergetree)
* [infi.clickhouse_orm.query](class_reference.md#inficlickhouse_ormquery) * [clickhouse_orm.query](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormquery)
* [QuerySet](class_reference.md#queryset) * [QuerySet](/sswest/ch-orm/blob/master/docs/class_reference.md#queryset)
* [AggregateQuerySet](class_reference.md#aggregatequeryset) * [AggregateQuerySet](/sswest/ch-orm/blob/master/docs/class_reference.md#aggregatequeryset)
* [Q](class_reference.md#q) * [Q](/sswest/ch-orm/blob/master/docs/class_reference.md#q)
* [infi.clickhouse_orm.funcs](class_reference.md#inficlickhouse_ormfuncs) * [clickhouse_orm.funcs](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormfuncs)
* [F](class_reference.md#f) * [F](/sswest/ch-orm/blob/master/docs/class_reference.md#f)

6
pyproject.toml
View File

@ -8,8 +8,8 @@ description = "A Python library for working with the ClickHouse database"
readme = "README.md" readme = "README.md"
keywords = ["ClickHouse", "ORM", 'DB', 'DATABASE', 'OLAP'] keywords = ["ClickHouse", "ORM", 'DB', 'DATABASE', 'OLAP']
license = {text = "BSD License"} license = {text = "BSD License"}
urls = {Homepage = "https://github.com/sswest/ch-orm", Documentation = "https://sswest.github.io/ch-orm/"}
classifiers = [ classifiers = [
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.9",
@ -28,3 +28,7 @@ version = "0.2.0"
[tool.setuptools.packages.find] [tool.setuptools.packages.find]
where = ["src"] where = ["src"]
[tool.black]
line-length = 100
target-version = ['py39', 'py37', 'py38']

1
scripts/generate_ref.py
View File

@ -4,6 +4,7 @@ from collections import namedtuple
DefaultArgSpec = namedtuple('DefaultArgSpec', 'has_default default_value') DefaultArgSpec = namedtuple('DefaultArgSpec', 'has_default default_value')
def _get_default_arg(args, defaults, arg_index): def _get_default_arg(args, defaults, arg_index):
""" Method that determines if an argument has default value or not, """ Method that determines if an argument has default value or not,
and if yes what is the default value for the argument and if yes what is the default value for the argument