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

Document the Database.readonly option

Browse Source
This commit is contained in:
Itai Shirav 2017-02-07 17:24:54 +02:00
parent b95046893b
commit dec45a0436
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.rst
View File

@ -31,8 +31,8 @@ Models are defined in a way reminiscent of Django's ORM::
engine = engines.MergeTree('birthday', ('first_name', 'last_name', 'birthday')) engine = engines.MergeTree('birthday', ('first_name', 'last_name', 'birthday'))
It is possible to provide a default value for a field, instead of its "natural" default (empty string for string fields, zero for numeric fields etc.). It is possible to provide a default value for a field, instead of its "natural" default (empty string for string fields, zero for numeric fields etc.).
It is always possible to pass alias or materialized parameters. See below for usage examples. Alternatively it is possible to pass alias or materialized parameters (see below for usage examples).
Only one of default, alias and materialized parameters can be provided Only one of ``default``, ``alias`` and ``materialized`` parameters can be provided.
See below for the supported field types and table engines. See below for the supported field types and table engines.
@ -92,6 +92,11 @@ Using the ``Database`` instance you can create a table for your model, and inser
The ``insert`` method can take any iterable of model instances, but they all must belong to the same model class. The ``insert`` method can take any iterable of model instances, but they all must belong to the same model class.
Creating a read-only database is also supported. Such a ``Database`` instance can only read data, and cannot
modify data or schemas::
db = Database('my_test_db', readonly=True)
Reading from the Database Reading from the Database
------------------------- -------------------------