Added indexes on is_archived and is_starred

[github/wallabag/wallabag.git] / docs / en / user / upgrade.rst

diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst
index 5d8641398ebd988e7a8dbd4988087eaa9ed53672..889b530054e9f06834793bebd034663e682977e2 100644 (file)
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade.rst
@@ -1,3 +1,4 @@
+==================================
 Upgrade your wallabag installation
 ==================================
 
@@ -7,26 +8,30 @@ You will find here different ways to upgrade your wallabag:
 - `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
 - `from 1.x to 2.x <#from-wallabag-1-x>`_
 
+*****************************
 Upgrading from 2.1.x to 2.2.x
------------------------------
+*****************************
 
 Upgrade on a dedicated web server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+=================================
 
 ::
 
     make update
 
 Explanations about database migrations
-""""""""""""""""""""""""""""""""""""""
+--------------------------------------
+
+During the update, we execute database migrations.
 
 All the database migrations are stored in ``app/DoctrineMigrations``. You can execute each migration individually:
-``bin/console doctrine:migrations:migrate 20161001072726 --env=prod``.
+``bin/console doctrine:migrations:execute 20161001072726 --env=prod``.
 
+You can also cancel each migration individually: ``bin/console doctrine:migrations:execute 20161001072726 --down --env=prod``.
 
-Here are the migrations for 2.1.x to 2.2.0 release:
+Here is the migrations list for 2.1.x to 2.2.0 release:
 
-* ``20161001072726``: added foreign keys for for account resetting
+* ``20161001072726``: added foreign keys for account resetting
 * ``20161022134138``: converted database to ``utf8mb4`` encoding (for MySQL only)
 * ``20161024212538``: added ``user_id`` column on ``oauth2_clients`` to prevent users to delete API clients from other users
 * ``20161031132655``: added the internal setting to enable/disable downloading pictures
@@ -36,9 +41,14 @@ Here are the migrations for 2.1.x to 2.2.0 release:
 * ``20161118134328``: added ``http_status`` field on ``entry`` table
 * ``20161122144743``: added the internal setting to enable/disable fetching articles with paywall
 * ``20161122203647``: dropped ``expired`` and ``credentials_expired`` fields on ``user`` table
+* ``20161128084725``: added ``list_mode`` field on ``config`` table
+* ``20161128131503``: dropped ``locked``, ``credentials_expire_at`` and ``expires_at`` fields on ``user`` table
+* ``20161214094402``: renamed ``uuid`` to ``uid`` on ``entry`` table
+* ``20161214094403``: added ``uid`` index on ``entry`` table
+* ``20170127093841``: added ``is_starred`` and ``is_archived`` indexes on ``entry`` table
 
 Upgrade on a shared hosting
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+===========================
 
 Backup your ``app/config/parameters.yml`` file.
 
@@ -58,27 +68,22 @@ If you use SQLite, you must also copy your ``data/`` folder inside the new insta
 
 Empty ``var/cache`` folder.
 
-You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one:
+You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_``. Don't forgete to backup your database before migrating.
 
-.. code-block:: sql
+You may encounter issues with indexes names: if so, please change queries with the correct index name.
 
-    ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
-    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
-    ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
-    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
-    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
-    ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
-    DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
+`You can find all the queries here <http://doc.wallabag.org/en/master/user/query-upgrade-21-22.html>`_.
 
+***************************
 Upgrade from 2.0.x to 2.1.1
----------------------------
+***************************
 
 .. warning::
 
     Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade.
 
 Upgrade on a dedicated web server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+=================================
 
 ::
 
@@ -91,7 +96,7 @@ Upgrade on a dedicated web server
     php bin/console cache:clear --env=prod
 
 Upgrade on a shared hosting
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+===========================
 
 Backup your ``app/config/parameters.yml`` file.
 
@@ -123,8 +128,9 @@ You must run some SQL queries to upgrade your database. We assume that the table
     ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
     DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
 
+*****************
 From wallabag 1.x
------------------
+*****************
 
 There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to: