From 243c739d2b7d6eacd37aa1cdb3457da44a2e24eb Mon Sep 17 00:00:00 2001 From: ryan Date: Thu, 15 Dec 2016 15:06:07 +0100 Subject: [PATCH] config changes --- bigchaindb/backend/connection.py | 2 +- bigchaindb/backend/mongodb/__init__.py | 22 +++++++++++++++++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/bigchaindb/backend/connection.py b/bigchaindb/backend/connection.py index 4ba611d5..2d4f9bac 100644 --- a/bigchaindb/backend/connection.py +++ b/bigchaindb/backend/connection.py @@ -6,8 +6,8 @@ from bigchaindb.common.exceptions import ConfigurationError BACKENDS = { - 'rethinkdb': 'bigchaindb.backend.rethinkdb.connection.RethinkDBConnection', 'mongodb': 'bigchaindb.backend.mongodb.connection.MongoDBConnection', + 'rethinkdb': 'bigchaindb.backend.rethinkdb.connection.RethinkDBConnection' } logger = logging.getLogger(__name__) diff --git a/bigchaindb/backend/mongodb/__init__.py b/bigchaindb/backend/mongodb/__init__.py index b49bf6e6..2bc65591 100644 --- a/bigchaindb/backend/mongodb/__init__.py +++ b/bigchaindb/backend/mongodb/__init__.py @@ -1,2 +1,22 @@ +"""MongoDB backend implementation. + +Contains a MongoDB-specific implementation of the +:mod:`~bigchaindb.backend.changefeed`, :mod:`~bigchaindb.backend.query`, and +:mod:`~bigchaindb.backend.schema` interfaces. + +You can specify BigchainDB to use MongoDB as its database backend by either +setting ``database.backend`` to ``'rethinkdb'`` in your configuration file, or +setting the ``BIGCHAINDB_DATABASE_BACKEND`` environment variable to +``'rethinkdb'``. + +If configured to use MongoDB, BigchainDB will automatically return instances +of :class:`~bigchaindb.backend.rethinkdb.MongoDBConnection` for +:func:`~bigchaindb.backend.connection.connect` and dispatch calls of the +generic backend interfaces to the implementations in this module. +""" + # Register the single dispatched modules on import. -from bigchaindb.backend.mongodb import schema, query # noqa +from bigchaindb.backend.mongodb import changefeed, schema, query # noqa + +# MongoDBConnection should always be accessed via +# ``bigchaindb.backend.connect()``.