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

Update docs

Browse Source
This commit is contained in:
Itai Shirav 2019-06-25 07:46:37 +03:00
parent bcc4c29d10
commit 38bb4981b8
3 changed files with 38 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGELOG.md
View File

@ -1,6 +1,11 @@
Change Log Change Log
========== ==========
Unreleased
----------
- Add support for per-field compression codecs (rbelio, Chocorean)
- Add support for low cardinality fields (rbelio)
v1.1.0 v1.1.0
------ ------
- Add PREWHERE support to querysets (M1hacka) - Add PREWHERE support to querysets (M1hacka)

54
docs/class_reference.md
View File

@ -10,7 +10,7 @@ infi.clickhouse_orm.database
Database instances connect to a specific ClickHouse database for running queries, Database instances connect to a specific ClickHouse database for running queries,
inserting data and other operations. inserting data and other operations.
#### Database(db_name, db_url="http://localhost:8123/", username=None, password=None, readonly=False, autocreate=True, timeout=60, verify_ssl_cert=True) #### Database(db_name, db_url="http://localhost:8123/", username=None, password=None, readonly=False, autocreate=True, timeout=60, verify_ssl_cert=True, log_statements=False)
Initializes a database instance. Unless it's readonly, the database will be Initializes a database instance. Unless it's readonly, the database will be
@ -24,6 +24,7 @@ created on the ClickHouse server if it does not already exist.
- `autocreate`: automatically create the database if it does not exist (unless in readonly mode). - `autocreate`: automatically create the database if it does not exist (unless in readonly mode).
- `timeout`: the connection timeout in seconds. - `timeout`: the connection timeout in seconds.
- `verify_ssl_cert`: whether to verify the server's certificate when connecting via HTTPS. - `verify_ssl_cert`: whether to verify the server's certificate when connecting via HTTPS.
- `log_statements`: when True, all database statements are logged.
#### add_setting(name, value) #### add_setting(name, value)
@ -510,7 +511,7 @@ infi.clickhouse_orm.fields
Extends Field Extends Field
#### ArrayField(inner_field, default=None, alias=None, materialized=None, readonly=None) #### ArrayField(inner_field, default=None, alias=None, materialized=None, readonly=None, codec=None)
### BaseEnumField ### BaseEnumField
@ -520,7 +521,7 @@ Extends Field
Abstract base class for all enum-type fields. Abstract base class for all enum-type fields.
#### BaseEnumField(enum_cls, default=None, alias=None, materialized=None, readonly=None) #### BaseEnumField(enum_cls, default=None, alias=None, materialized=None, readonly=None, codec=None)
### BaseFloatField ### BaseFloatField
@ -530,7 +531,7 @@ Extends Field
Abstract base class for all float-type fields. Abstract base class for all float-type fields.
#### BaseFloatField(default=None, alias=None, materialized=None, readonly=None) #### BaseFloatField(default=None, alias=None, materialized=None, readonly=None, codec=None)
### BaseIntField ### BaseIntField
@ -540,21 +541,21 @@ Extends Field
Abstract base class for all integer-type fields. Abstract base class for all integer-type fields.
#### BaseIntField(default=None, alias=None, materialized=None, readonly=None) #### BaseIntField(default=None, alias=None, materialized=None, readonly=None, codec=None)
### DateField ### DateField
Extends Field Extends Field
#### DateField(default=None, alias=None, materialized=None, readonly=None) #### DateField(default=None, alias=None, materialized=None, readonly=None, codec=None)
### DateTimeField ### DateTimeField
Extends Field Extends Field
#### DateTimeField(default=None, alias=None, materialized=None, readonly=None) #### DateTimeField(default=None, alias=None, materialized=None, readonly=None, codec=None)
### Decimal128Field ### Decimal128Field
@ -592,14 +593,14 @@ Base class for all decimal fields. Can also be used directly.
Extends BaseEnumField Extends BaseEnumField
#### Enum16Field(enum_cls, default=None, alias=None, materialized=None, readonly=None) #### Enum16Field(enum_cls, default=None, alias=None, materialized=None, readonly=None, codec=None)
### Enum8Field ### Enum8Field
Extends BaseEnumField Extends BaseEnumField
#### Enum8Field(enum_cls, default=None, alias=None, materialized=None, readonly=None) #### Enum8Field(enum_cls, default=None, alias=None, materialized=None, readonly=None, codec=None)
### Field ### Field
@ -607,7 +608,7 @@ Extends BaseEnumField
Abstract base class for all field types. Abstract base class for all field types.
#### Field(default=None, alias=None, materialized=None, readonly=None) #### Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### FixedStringField ### FixedStringField
@ -621,91 +622,98 @@ Extends StringField
Extends BaseFloatField Extends BaseFloatField
#### Float32Field(default=None, alias=None, materialized=None, readonly=None) #### Float32Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### Float64Field ### Float64Field
Extends BaseFloatField Extends BaseFloatField
#### Float64Field(default=None, alias=None, materialized=None, readonly=None) #### Float64Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### Int16Field ### Int16Field
Extends BaseIntField Extends BaseIntField
#### Int16Field(default=None, alias=None, materialized=None, readonly=None) #### Int16Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### Int32Field ### Int32Field
Extends BaseIntField Extends BaseIntField
#### Int32Field(default=None, alias=None, materialized=None, readonly=None) #### Int32Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### Int64Field ### Int64Field
Extends BaseIntField Extends BaseIntField
#### Int64Field(default=None, alias=None, materialized=None, readonly=None) #### Int64Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### Int8Field ### Int8Field
Extends BaseIntField Extends BaseIntField
#### Int8Field(default=None, alias=None, materialized=None, readonly=None) #### Int8Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### LowCardinalityField
Extends Field
#### LowCardinalityField(inner_field, default=None, alias=None, materialized=None, readonly=None, codec=None)
### NullableField ### NullableField
Extends Field Extends Field
#### NullableField(inner_field, default=None, alias=None, materialized=None, extra_null_values=None) #### NullableField(inner_field, default=None, alias=None, materialized=None, extra_null_values=None, codec=None)
### StringField ### StringField
Extends Field Extends Field
#### StringField(default=None, alias=None, materialized=None, readonly=None) #### StringField(default=None, alias=None, materialized=None, readonly=None, codec=None)
### UInt16Field ### UInt16Field
Extends BaseIntField Extends BaseIntField
#### UInt16Field(default=None, alias=None, materialized=None, readonly=None) #### UInt16Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### UInt32Field ### UInt32Field
Extends BaseIntField Extends BaseIntField
#### UInt32Field(default=None, alias=None, materialized=None, readonly=None) #### UInt32Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### UInt64Field ### UInt64Field
Extends BaseIntField Extends BaseIntField
#### UInt64Field(default=None, alias=None, materialized=None, readonly=None) #### UInt64Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### UInt8Field ### UInt8Field
Extends BaseIntField Extends BaseIntField
#### UInt8Field(default=None, alias=None, materialized=None, readonly=None) #### UInt8Field(default=None, alias=None, materialized=None, readonly=None, codec=None)
### UUIDField ### UUIDField
Extends Field Extends Field
#### UUIDField(default=None, alias=None, materialized=None, readonly=None) #### UUIDField(default=None, alias=None, materialized=None, readonly=None, codec=None)
infi.clickhouse_orm.engines infi.clickhouse_orm.engines

3
docs/toc.md
View File

@ -36,7 +36,7 @@
* [Working with array fields](field_types.md#working-with-array-fields) * [Working with array fields](field_types.md#working-with-array-fields)
* [Working with materialized and alias fields](field_types.md#working-with-materialized-and-alias-fields) * [Working with materialized and alias fields](field_types.md#working-with-materialized-and-alias-fields)
* [Working with nullable fields](field_types.md#working-with-nullable-fields) * [Working with nullable fields](field_types.md#working-with-nullable-fields)
* [Creating custom field types](field_types.md#creating-custom-field-types) * [Working with field compression codecs](field_types.md#working-with-field-compression-codecs)
* [Table Engines](table_engines.md#table-engines) * [Table Engines](table_engines.md#table-engines)
* [Simple Engines](table_engines.md#simple-engines) * [Simple Engines](table_engines.md#simple-engines)
@ -86,6 +86,7 @@
* [Int32Field](class_reference.md#int32field) * [Int32Field](class_reference.md#int32field)
* [Int64Field](class_reference.md#int64field) * [Int64Field](class_reference.md#int64field)
* [Int8Field](class_reference.md#int8field) * [Int8Field](class_reference.md#int8field)
* [LowCardinalityField](class_reference.md#lowcardinalityfield)
* [NullableField](class_reference.md#nullablefield) * [NullableField](class_reference.md#nullablefield)
* [StringField](class_reference.md#stringfield) * [StringField](class_reference.md#stringfield)
* [UInt16Field](class_reference.md#uint16field) * [UInt16Field](class_reference.md#uint16field)