Update docs

This commit is contained in:
Itai Shirav 2017-09-13 12:15:44 +03:00
parent 59564f8c70
commit 8304ddca5c
3 changed files with 36 additions and 22 deletions

View File

@ -317,28 +317,28 @@ infi.clickhouse_orm.fields
Abstract base class for all field types. Abstract base class for all field types.
#### Field(default=None, alias=None, materialized=None) #### Field(default=None, alias=None, materialized=None, readonly=None)
### StringField ### StringField
Extends Field Extends Field
#### StringField(default=None, alias=None, materialized=None) #### StringField(default=None, alias=None, materialized=None, readonly=None)
### DateField ### DateField
Extends Field Extends Field
#### DateField(default=None, alias=None, materialized=None) #### DateField(default=None, alias=None, materialized=None, readonly=None)
### DateTimeField ### DateTimeField
Extends Field Extends Field
#### DateTimeField(default=None, alias=None, materialized=None) #### DateTimeField(default=None, alias=None, materialized=None, readonly=None)
### BaseIntField ### BaseIntField
@ -348,7 +348,7 @@ 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) #### BaseIntField(default=None, alias=None, materialized=None, readonly=None)
### BaseFloatField ### BaseFloatField
@ -358,7 +358,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) #### BaseFloatField(default=None, alias=None, materialized=None, readonly=None)
### BaseEnumField ### BaseEnumField
@ -368,14 +368,14 @@ 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) #### BaseEnumField(enum_cls, default=None, alias=None, materialized=None, readonly=None)
### ArrayField ### ArrayField
Extends Field Extends Field
#### ArrayField(inner_field, default=None, alias=None, materialized=None) #### ArrayField(inner_field, default=None, alias=None, materialized=None, readonly=None)
### NullableField ### NullableField
@ -389,91 +389,91 @@ Extends Field
Extends StringField Extends StringField
#### FixedStringField(length, default=None, alias=None, materialized=None) #### FixedStringField(length, default=None, alias=None, materialized=None, readonly=None)
### UInt8Field ### UInt8Field
Extends BaseIntField Extends BaseIntField
#### UInt8Field(default=None, alias=None, materialized=None) #### UInt8Field(default=None, alias=None, materialized=None, readonly=None)
### UInt16Field ### UInt16Field
Extends BaseIntField Extends BaseIntField
#### UInt16Field(default=None, alias=None, materialized=None) #### UInt16Field(default=None, alias=None, materialized=None, readonly=None)
### UInt32Field ### UInt32Field
Extends BaseIntField Extends BaseIntField
#### UInt32Field(default=None, alias=None, materialized=None) #### UInt32Field(default=None, alias=None, materialized=None, readonly=None)
### UInt64Field ### UInt64Field
Extends BaseIntField Extends BaseIntField
#### UInt64Field(default=None, alias=None, materialized=None) #### UInt64Field(default=None, alias=None, materialized=None, readonly=None)
### Int8Field ### Int8Field
Extends BaseIntField Extends BaseIntField
#### Int8Field(default=None, alias=None, materialized=None) #### Int8Field(default=None, alias=None, materialized=None, readonly=None)
### Int16Field ### Int16Field
Extends BaseIntField Extends BaseIntField
#### Int16Field(default=None, alias=None, materialized=None) #### Int16Field(default=None, alias=None, materialized=None, readonly=None)
### Int32Field ### Int32Field
Extends BaseIntField Extends BaseIntField
#### Int32Field(default=None, alias=None, materialized=None) #### Int32Field(default=None, alias=None, materialized=None, readonly=None)
### Int64Field ### Int64Field
Extends BaseIntField Extends BaseIntField
#### Int64Field(default=None, alias=None, materialized=None) #### Int64Field(default=None, alias=None, materialized=None, readonly=None)
### Float32Field ### Float32Field
Extends BaseFloatField Extends BaseFloatField
#### Float32Field(default=None, alias=None, materialized=None) #### Float32Field(default=None, alias=None, materialized=None, readonly=None)
### Float64Field ### Float64Field
Extends BaseFloatField Extends BaseFloatField
#### Float64Field(default=None, alias=None, materialized=None) #### Float64Field(default=None, alias=None, materialized=None, readonly=None)
### Enum8Field ### Enum8Field
Extends BaseEnumField Extends BaseEnumField
#### Enum8Field(enum_cls, default=None, alias=None, materialized=None) #### Enum8Field(enum_cls, default=None, alias=None, materialized=None, readonly=None)
### Enum16Field ### Enum16Field
Extends BaseEnumField Extends BaseEnumField
#### Enum16Field(enum_cls, default=None, alias=None, materialized=None) #### Enum16Field(enum_cls, default=None, alias=None, materialized=None, readonly=None)
infi.clickhouse_orm.engines infi.clickhouse_orm.engines
@ -512,6 +512,19 @@ Read more [here](https://clickhouse.yandex/reference_en.html#Buffer).
#### Buffer(main_model, num_layers=16, min_time=10, max_time=100, min_rows=10000, max_rows=1000000, min_bytes=10000000, max_bytes=100000000) #### Buffer(main_model, num_layers=16, min_time=10, max_time=100, min_rows=10000, max_rows=1000000, min_bytes=10000000, max_bytes=100000000)
### Merge
Extends Engine
The Merge engine (not to be confused with MergeTree) does not store data itself,
but allows reading from any number of other tables simultaneously.
Writing to a table is not supported
https://clickhouse.yandex/docs/en/single/index.html#document-table_engines/merge
#### Merge(table_regex)
### CollapsingMergeTree ### CollapsingMergeTree
Extends MergeTree Extends MergeTree

View File

@ -87,6 +87,7 @@
* [Memory](class_reference.md#memory) * [Memory](class_reference.md#memory)
* [MergeTree](class_reference.md#mergetree) * [MergeTree](class_reference.md#mergetree)
* [Buffer](class_reference.md#buffer) * [Buffer](class_reference.md#buffer)
* [Merge](class_reference.md#merge)
* [CollapsingMergeTree](class_reference.md#collapsingmergetree) * [CollapsingMergeTree](class_reference.md#collapsingmergetree)
* [SummingMergeTree](class_reference.md#summingmergetree) * [SummingMergeTree](class_reference.md#summingmergetree)
* [ReplacingMergeTree](class_reference.md#replacingmergetree) * [ReplacingMergeTree](class_reference.md#replacingmergetree)

View File

@ -96,7 +96,7 @@ class FixedStringField(StringField):
def __init__(self, length, default=None, alias=None, materialized=None, readonly=None): def __init__(self, length, default=None, alias=None, materialized=None, readonly=None):
self._length = length self._length = length
self.db_type = 'FixedString(%d)' % length self.db_type = 'FixedString(%d)' % length
super(FixedStringField, self).__init__(default, alias, materialized,readonly) super(FixedStringField, self).__init__(default, alias, materialized, readonly)
def to_python(self, value, timezone_in_use): def to_python(self, value, timezone_in_use):
value = super(FixedStringField, self).to_python(value, timezone_in_use) value = super(FixedStringField, self).to_python(value, timezone_in_use)