Changeset 5895

Timestamp:

Nov 30, 2011, 2:46:07 PM (11 years ago)

Author:

Nicklas Nordborg

Message:

References #1630: Migrate from MySQL to PostgreSQL

Documentation configuration options for the migration program.

Location:

trunk

Files:

• config/dist/base.config (modified) (1 diff)
• doc/src/docbook/admin/installation.xml (modified) (5 diffs)
• doc/src/docbook/appendix/base.config.xml (modified) (1 diff)

trunk/config/dist/base.config

@@ -271 +271 @@
 # ssl.truststore.provider = 
 
+# ===================
+# Migration section
+# ===================
+# Configuration settings that are related to migrating a BASE
+# installation on a MySQL database to a PostgreSQL database.
+# See documentation for more information.
+
+# Enable this flag to compress the exported data. This may increase
+# performance if disks are slow.
+# migrate.export.compress = 0 
+
+# The number of rows that should be fetched at the same time from
+# the database. Increasing this value may give better performance
+# but requires more memory.
+# migrate.export.fetch-size = 20000
+
+# Enable this flag to issue an SQL statment for statistical
+# analysis of the imported data before continuing with the next table.
+# Disabling this may result in very poor performance.
+# migrate.import.analyze = 1
+
+# Enable this flag to drop the primary key of a table before importing
+# data to it. This may increase the performance. The primary key is
+# re-created after the data has been imported.
+# migrate.import.drop-primary-key = 1
+
+# Enable this flag to drop unique constraints and indexes before importing
+# data. This may increase the performance. The constraints and indexes
+# are re-created after the data has been imported. NOTE! Foreign key
+# constraints are not affected by this flag, since they must always be dropped.
+# migrate.import.drop-constraints = 1
+
+

trunk/doc/src/docbook/admin/installation.xml

@@ -1556 +1556 @@
             </listitem>
 
+            <listitem>
+              <para>
+              Make sure that you have configured migration-specific settings
+              in the <filename>base.config</filename> file. In most cases the
+              default settings should be good, but if you are experiencing
+              performance problems it may be necessary to change some settings.
+              See <xref linkend="appendix.base.config.migrate" /> for more 
+              information.
+              </para>
+            </listitem>
+
             <listitem>            
               <para>
@@ -1568 +1579 @@
                 where <replaceable>/path/to/migration/dir</replaceable>
                 is replaced with the path to the working directory created above.
-                Make sure that the directory is empty since existing files will
-                cause the corresponding table to be skipped (useful when debugging). 
                 Depending on the size of the BASE installation the export may 
                 take a long time.
@@ -1576 +1585 @@
           </orderedlist>
           
+          <note>
+            <para>
+              Make sure that the migration working directory is empty to perform
+              a full export. Existing files in the directory causes the corresponding
+              tables to be skipped. This can be useful when debugging and after a
+              server crash, since the export will resume where it stopped. Just make
+              sure that the database hasn't been modified in the meantime.
+            </para>
+          </note>
           <warning>
             <para>
@@ -1584 +1602 @@
             </para>
           </warning>
-
         </listitem>
       </varlistentry>
@@ -1667 +1684 @@
               Make the corresponding changes in <filename>base.config</filename>
               so that the BASE installation points to the new database.
+              Also, make sure that you have configured migration-specific settings
+              in the <filename>base.config</filename> file. In most cases the
+              default settings should be good, but if you are experiencing
+              performance problems it may be necessary to change some settings.
+              See <xref linkend="appendix.base.config.migrate" /> for more 
+              information.
               </para>
             </listitem>

trunk/doc/src/docbook/appendix/base.config.xml

@@ -1064 +1064 @@
     
   </simplesect>
+  
+  <simplesect id="appendix.base.config.migrate">
+    <title>Migration section</title>
+    
+    <para>
+      The settings in this section only affect the migration program that can
+      be used to move a BASE installation from a MySQL database to PostgreSQL.
+      For more information about this see <xref linkend="installation.migrate" />.
+    </para>
+    
+    <variablelist>
+      <varlistentry>
+        <term><property>migrate.export.compress</property></term>
+        <listitem>
+          <para>
+            Enable this option
+            to compress the data files generated by the export. This may
+            improve performance in case disk speed is a limiting factor.
+            Default is to not compress.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><property>migrate.export.fetch-size</property></term>
+        <listitem>
+          <para>
+            The number
+            of rows that should be fetch at the same time from the database.
+            A higher value may increase the performance but uses more
+            memory. The default value is 20000.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><property>migrate.import.analyze</property></term>
+        <listitem>
+          <para>
+            Enable this flag to issue an SQL statment for statistical
+            analysis of the imported data before continuing with the next
+            table. Disabling this may result in very poor performance. This
+            option is enabled by default.
+          </para>
+        </listitem>
+      </varlistentry>
+  
+      <varlistentry>
+        <term><property>migrate.import.drop-primary-key</property></term>
+        <listitem>
+          <para>
+            Enable this flag to drop the primary key of a table before 
+            importing data to it. This may increase the performance. The 
+            primary key is re-created after the data has been imported.
+            This option is enabled by default.
+          </para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term><property>migrate.import.drop-constraints</property></term>
+        <listitem>
+          <para>
+            Enable this flag to drop unique constraints and indexes before 
+            importing data to a table. This may increase the performance. 
+            The constraints and indexes are re-created after the data has been 
+            imported. NOTE! Foreign key constraints are not affected by this flag, 
+            since they must always be dropped. This option is enabled by
+            default.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+    
+  </simplesect>
 
 </appendix>