From dec45a0436d9c0d8aba5ab381a9235e7ca752faf Mon Sep 17 00:00:00 2001 From: Itai Shirav Date: Tue, 7 Feb 2017 17:24:54 +0200 Subject: [PATCH] Document the Database.readonly option --- README.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 891fc3f..7dba0f9 100644 --- a/README.rst +++ b/README.rst @@ -31,8 +31,8 @@ Models are defined in a way reminiscent of Django's ORM:: 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 always possible to pass alias or materialized parameters. See below for usage examples. -Only one of default, alias and materialized parameters can be provided +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. 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. +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 -------------------------