From 096aa12db862cba46eb94c2c1fb8bded2fa09865 Mon Sep 17 00:00:00 2001 From: Gunther Cox Date: Sun, 13 Jan 2019 19:17:51 -0500 Subject: [PATCH] Describe migration process for each ORM --- docs/storage/index.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/storage/index.rst b/docs/storage/index.rst index 80a5a9113..69d334d28 100644 --- a/docs/storage/index.rst +++ b/docs/storage/index.rst @@ -43,3 +43,24 @@ MongoDB Storage Adapter .. autoclass:: chatterbot.storage.MongoDatabaseAdapter :members: + +Database Migrations +=================== + +Various frameworks such as Django and SQL Alchemy support +functionality that allows revisions to be made to databases +programmatically. This makes it possible for updates and +revisions to structures in the database to be be applied +in consecutive version releases. + +The following explains the included migration process for +each of the databases that ChatterBot comes with support for. + +* Django: Full schema migrations and data migrations will + be included with each release. +* SQL Alchemy: No migrations are currently provided in + releases. If you require migrations between versions + `Alembic`_ is the recommended solution for generating them. +* MongoDB: No migrations are provided. + +.. _Alembic: https://alembic.sqlalchemy.org