Merge pull request #458 from owncloud/db_converter

Docs for db:convert

admin_manual/maintenance/convert_db.rst

@@ -0,0 +1,63 @@
+Converting Database Type
+========================
+
+You can convert a sqlite database to a more performing MySQL, MariaDB or PostgreSQL database with the ownCloud command line tool.
+Available since ownCloud version 7.0.0. To convert former ownCloud installations, first update to at least version 7.0.0.
+
+
+Run the conversion
+------------------
+
+First setup the new database, here called "new_db_name".
+In ownCloud root folder call
+
+.. code-block:: bash
+
+  php occ db:convert-type [options] type username hostname database
+
+The Options
+
+* ``--port="3306"``                       the database port (optional)
+* ``--password="mysql_user_password"``    password for the new database. If omitted the tool will ask you (optional)
+* ``--clear-schema``                      clear schema (optional)
+* ``--all-apps``                          by default, tables for enabled apps are converted, use to convert also tables of deactivated apps (optional)
+
+*Note:* The converter searches for apps in your configured app folders and uses the schema definitions in the apps to create the new table. So tables of removed apps will not be converted even with option ``--all-apps``
+
+For example
+
+.. code-block:: bash
+
+  php occ db:convert-type --all-apps mysql oc_mysql_user 127.0.0.1 new_db_name
+
+
+On success the converter will automatically configure the new database in your ownCloud config ``config.php``
+
+Unconvertible Tables
+--------------------
+
+If you updated your ownCloud installation there might exist old tables, which are not used anymore. The converter will tell you
+
+.. code-block:: bash
+
+  The following tables will not be converted:
+  oc_permissions
+  ...
+
+You can ignore these tables.
+Here is a list of known old tables:
+
+* oc_calendar_calendars
+* oc_calendar_objects
+* oc_calendar_share_calendar
+* oc_calendar_share_event
+* oc_fscache
+* oc_log
+* oc_media_albums
+* oc_media_artists
+* oc_media_sessions
+* oc_media_songs
+* oc_media_users
+* oc_permissions
+* oc_queuedtasks
+* oc_sharing

admin_manual/maintenance/index.rst

@@ -11,4 +11,5 @@ Maintenance
    upgrade
    restore
    migrating
+   convert_db