mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
8a68e24e69
* Add README.md to tests/ to describe test structure and pytest customizations * Add package-level docstrings to backends * Add README.md explaining the backend architecture * Small improvements to docstrings in backend modules * Restructure the backend automodule docs * Add more docstrings to backend connections * Add init to base backend Connection class to document expected interface * Reword the backend/README.md docs
62 lines
1.5 KiB
ReStructuredText
62 lines
1.5 KiB
ReStructuredText
###########################
|
|
Database Backend Interfaces
|
|
###########################
|
|
|
|
.. automodule:: bigchaindb.backend
|
|
:special-members: __init__
|
|
|
|
|
|
Generic Interfaces
|
|
==================
|
|
|
|
:mod:`bigchaindb.backend.connection`
|
|
------------------------------------
|
|
|
|
.. automodule:: bigchaindb.backend.connection
|
|
:special-members: __init__
|
|
|
|
:mod:`bigchaindb.backend.changefeed`
|
|
------------------------------------
|
|
.. automodule:: bigchaindb.backend.changefeed
|
|
|
|
:mod:`bigchaindb.backend.query`
|
|
-------------------------------
|
|
.. automodule:: bigchaindb.backend.query
|
|
|
|
:mod:`bigchaindb.backend.schema`
|
|
--------------------------------
|
|
.. automodule:: bigchaindb.backend.schema
|
|
|
|
:mod:`bigchaindb.backend.utils`
|
|
-------------------------------
|
|
.. automodule:: bigchaindb.backend.utils
|
|
|
|
|
|
RethinkDB Backend
|
|
=================
|
|
|
|
.. automodule:: bigchaindb.backend.rethinkdb
|
|
|
|
:mod:`bigchaindb.backend.rethinkdb.connection`
|
|
----------------------------------------------
|
|
|
|
.. automodule:: bigchaindb.backend.rethinkdb.connection
|
|
:special-members: __init__
|
|
|
|
:mod:`bigchaindb.backend.rethinkdb.schema`
|
|
------------------------------------------
|
|
.. automodule:: bigchaindb.backend.rethinkdb.schema
|
|
|
|
:mod:`bigchaindb.backend.rethinkdb.query`
|
|
-----------------------------------------
|
|
.. automodule:: bigchaindb.backend.rethinkdb.query
|
|
|
|
:mod:`bigchaindb.backend.rethinkdb.changefeed`
|
|
----------------------------------------------
|
|
.. automodule:: bigchaindb.backend.rethinkdb.changefeed
|
|
|
|
|
|
MongoDB Backend
|
|
===============
|
|
Stay tuned!
|