Document ensure_schema behaviour, fixes #225.

Browse Source
This commit is contained in:
Friedrich Lindenberg 2020-01-11 14:38:21 +01:00
parent 39385b7e0a
commit 71b9421d60
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
dataset/__init__.py
View File

@ -24,13 +24,18 @@ def connect(url=None, schema=None, reflect_metadata=True, engine_kwargs=None,
to False if you don't want the entire database schema to be pre-loaded.
This significantly speeds up connecting to large databases with lots of
tables. *reflect_views* can be set to False if you don't want views to be
loaded. Additionally, *engine_kwargs* will be directly passed to
loaded. Additionally, *engine_kwargs* will be directly passed to
SQLAlchemy, e.g. set *engine_kwargs={'pool_recycle': 3600}* will avoid `DB
connection timeout`_. Set *row_type* to an alternate dict-like class to
change the type of container rows are stored in.::
db = dataset.connect('sqlite:///factbook.db')
One of the main features of `dataset` is to automatically create tables and
columns as data is inserted. This behaviour can optionally be disabled via
the `ensure_schema` argument. It can also be overridden in a lot of the
data manipulation methods using the `ensure` flag.
.. _SQLAlchemy Engine URL: http://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine
.. _DB connection timeout: http://docs.sqlalchemy.org/en/latest/core/pooling.html#setting-pool-recycle
"""