From 151b7e1ad4e6f64ec8214d3363f0a2560e29f1f9 Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Wed, 19 Dec 2018 12:20:25 +0100 Subject: [PATCH] Everybody should use migrations Signed-off-by: Roeland Jago Douma --- developer_manual/app/storage/migrations.rst | 19 +++++++++++++++++++ developer_manual/app/storage/schema.rst | 9 ++++++--- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/developer_manual/app/storage/migrations.rst b/developer_manual/app/storage/migrations.rst index 1ce8e432d..5db7567f9 100644 --- a/developer_manual/app/storage/migrations.rst +++ b/developer_manual/app/storage/migrations.rst @@ -2,6 +2,9 @@ Migrations ========== +.. app_db_migrations: + + In the past, apps had a `appinfo/database.xml`-file which holds their database schema for installation and update and was a functional method for installing apps which had some trouble with upgrading apps (e.g. apps were not able to rename columns @@ -116,6 +119,22 @@ With this the old column gets removed. return $schema; } +Migrate from database.xml +------------------------- + +To migrate your app from a `database.xml` file to migrations run: + +.. code-block:: bash + php ./occ migrations:generate-from-schema + +This will create a new file under `lib/Migration` with that results in the +same database table(s) as your database.xml file. + +For version you should use the your app versions. So if you app is at version +1.2.3 user 010203. + +Don't forget to remove your `database.xml` file. + Console commands ---------------- diff --git a/developer_manual/app/storage/schema.rst b/developer_manual/app/storage/schema.rst index 6a9e8efbd..15d0fd62a 100644 --- a/developer_manual/app/storage/schema.rst +++ b/developer_manual/app/storage/schema.rst @@ -1,6 +1,9 @@ -=============== -Database schema -=============== +============================ +Database schema (deprecated) +============================ + +.. note:: Using the database.xml schema file is deprecated. You should migrate +to using :ref:`Databse Migrations app_db_migrations`. .. sectionauthor:: Bernhard Posselt