svn commit - mysqldoc@docsrva: r15571 - in trunk: refman-5.4 workbench

[anthony.bedford]

Author: tbedford
Date: 2009-07-03 16:07:35 +0200 (Fri, 03 Jul 2009)
New Revision: 15571

Log:
Extended database synchronization section. Added screenshots. Updated dependencies.

Modified:
   trunk/refman-5.4/Makefile.depends
   trunk/workbench/Makefile.depends
   trunk/workbench/forward-engineering.xml


Modified: trunk/refman-5.4/Makefile.depends
===================================================================
--- trunk/refman-5.4/Makefile.depends	2009-07-03 13:20:00 UTC (rev 15570)
+++ trunk/refman-5.4/Makefile.depends	2009-07-03 14:07:35 UTC (rev 15571)
Changed blocks: 3, Lines Added: 5, Lines Deleted: 1; 1301 bytes

@@ -1229,6 +1229,7 @@
 	metadata/dba.idmap \
 	metadata/errors-problems-core.idmap \
 	metadata/extending-mysql.idmap \
+	metadata/functions-core.idmap \
 	metadata/installing-core.idmap \
 	metadata/internationalization.idmap \
 	metadata/programs-admin-util-core.idmap \

@@ -1756,8 +1757,10 @@
 dynxml_local_news_5_4_IDMAPS = \
 	metadata/installing-core.idmap \
 	metadata/introduction.idmap \
+	metadata/optimization.idmap \
 	metadata/programs-using.idmap \
-	metadata/sql-syntax-compound-statements.idmap
+	metadata/sql-syntax-compound-statements.idmap \
+	metadata/sql-syntax-data-manipulation.idmap
 dynxml-local-news-5.4.validpure: $(dynxml_local_news_5_4_SOURCES)
 dynxml-local-news-5.4.titles: $(dynxml_local_news_5_4_SOURCES)
 dynxml-local-news-5.4.useless: $(dynxml_local_news_5_4_SOURCES)

@@ -3953,6 +3956,7 @@
 optimization_IMAGES =
 optimization_SOURCES = optimization.xml $(optimization_INCLUDES)
 optimization_IDMAPS = \
+	../refman-5.1/metadata/mysql-cluster.idmap \
 	metadata/apis-c.idmap \
 	metadata/backup.idmap \
 	metadata/connectors-apis.idmap \


Modified: trunk/workbench/Makefile.depends
===================================================================
--- trunk/workbench/Makefile.depends	2009-07-03 13:20:00 UTC (rev 15570)
+++ trunk/workbench/Makefile.depends	2009-07-03 14:07:35 UTC (rev 15571)
Changed blocks: 4, Lines Added: 24, Lines Deleted: 0; 3191 bytes

@@ -126,6 +126,12 @@
 	../common/fixedchars.ent \
 	../refman-common/urls.ent \
 	all-entities.ent \
+	images/published/wb-database-synchronize-wizard-diff-direction-arrow.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-ignore.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-model.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-source.png \
+	images/published/wb-database-synchronize-wizard-diff-direction.png \
+	images/published/wb-database-synchronize-wizard-diff.png \
 	images/published/wb-diff-sources.png \
 	images/published/wb-forward-engineer-sql-alter-script-wizard-options.png \
 	images/published/wb-forward-engineer-sql-alter-script-wizard-script.png \

@@ -139,6 +145,12 @@
 	version.ent \
 	workbench.ent
 forward_engineering_IMAGES = \
+	images/published/wb-database-synchronize-wizard-diff-direction-arrow.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-ignore.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-model.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-source.png \
+	images/published/wb-database-synchronize-wizard-diff-direction.png \
+	images/published/wb-database-synchronize-wizard-diff.png \
 	images/published/wb-diff-sources.png \
 	images/published/wb-forward-engineer-sql-alter-script-wizard-options.png \
 	images/published/wb-forward-engineer-sql-alter-script-wizard-script.png \

@@ -639,6 +651,12 @@
 	images/published/wb-application-layout.png \
 	images/published/wb-connection-wizard1.png \
 	images/published/wb-connection-wizard2.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-arrow.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-ignore.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-model.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-source.png \
+	images/published/wb-database-synchronize-wizard-diff-direction.png \
+	images/published/wb-database-synchronize-wizard-diff.png \
 	images/published/wb-dbdoc-detailed-report-schema.png \
 	images/published/wb-dbdoc-wizard-main-detailed-frames.png \
 	images/published/wb-default-schema.png \

@@ -706,6 +724,12 @@
 	images/published/wb-application-layout.png \
 	images/published/wb-connection-wizard1.png \
 	images/published/wb-connection-wizard2.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-arrow.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-ignore.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-model.png \
+	images/published/wb-database-synchronize-wizard-diff-direction-source.png \
+	images/published/wb-database-synchronize-wizard-diff-direction.png \
+	images/published/wb-database-synchronize-wizard-diff.png \
 	images/published/wb-dbdoc-detailed-report-schema.png \
 	images/published/wb-dbdoc-wizard-main-detailed-frames.png \
 	images/published/wb-default-schema.png \


Modified: trunk/workbench/forward-engineering.xml
===================================================================
--- trunk/workbench/forward-engineering.xml	2009-07-03 13:20:00 UTC (rev 15570)
+++ trunk/workbench/forward-engineering.xml	2009-07-03 14:07:35 UTC (rev 15571)
Changed blocks: 1, Lines Added: 164, Lines Deleted: 3; 6822 bytes

@@ -389,11 +389,172 @@
     <title>Database Synchronization</title>
 
     <para>
-      The <guimenu>Synchronize ...</guimenu> menu item under the
-      <guimenu>Database</guimenu> menu option synchronizes your database
-      model with an existing database.
+      It is possible to synchronize a model in &workbench; with a live
+      database. By default, the synchronization process will change the
+      live database to be the same as the model, but this is
+      configurable during the synchronization process.
     </para>
 
+    <para>
+      &workbench; allows you control over the direction of
+      synchronization, and the objects synchronized, in a completely
+      flexible way. You can choose to synchronize only certain tables,
+      allow synchronization to the live database only, or allow
+      synchronization from the live database to the model only, or a
+      combination of directions. In effect you have complete control as
+      to whether the synchronization is unidirectional or bidirectional,
+      and which objects exactly are subject to synchronization. This is
+      all controlled in the <guilabel>Model and Database
+      Differences</guilabel> page of the synchronization wizard:
+    </para>
+
+    <figure id="wb-database-synchronize-wizard-diff">
+      <title>Model and Database Differences</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata
fileref="images/published/wb-database-synchronize-wizard-diff.png" lang="en"
format="PNG"/>
+        </imageobject>
+        <textobject>
+          <phrase lang="en">Model and Database Differences</phrase>
+        </textobject>
+      </mediaobject>
+    </figure>
+
+    <para>
+      In the above example the live database consists of
+      <literal>table1</literal>, <literal>table2</literal> and
+      <literal>table3</literal>. In &workbench;
+      <literal>table4</literal> has been created, along with a
+      relationship between it and <literal>table3</literal>. Further,
+      <literal>table5</literal> exists in the live database, but not in
+      the model. The actions that are configured to occur would result
+      in <literal>table3</literal> being altered (to include the
+      relationship with <literal>table4</literal>),
+      <literal>table4</literal> being created and
+      <literal>table5</literal> being dropped, in the live database. It
+      is possible to reconfigure this though.
+    </para>
+
+    <para>
+      The next example shows how direction of synchronization can be
+      changed:
+    </para>
+
+    <figure id="wb-database-synchronize-wizard-diff-direction">
+      <title>Controlling Synchronization Direction</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata
fileref="images/published/wb-database-synchronize-wizard-diff-direction.png" lang="en"
format="PNG"/>
+        </imageobject>
+        <textobject>
+          <phrase lang="en">Controlling Synchronization
+          Direction</phrase>
+        </textobject>
+      </mediaobject>
+    </figure>
+
+    <para>
+      In this case the synchronization direction has been changed so
+      that rather than the default action of <literal>table5</literal>
+      being dropped from the live database, it will be incorporated into
+      the &workbench; model.
+    </para>
+
+    <para>
+      For convenience the wizard provides three additional buttons to
+      allows synchronization directions to be applied to a group of
+      selected changes. The <guibutton>Update Model</guibutton> button
+      causes the selected changes to only be applied to the model
+      itself:
+    </para>
+
+    <figure id="wb-database-synchronize-wizard-diff-direction-model">
+      <title>Update Model Button</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata
fileref="images/published/wb-database-synchronize-wizard-diff-direction-model.png"
lang="en" format="PNG"/>
+        </imageobject>
+        <textobject>
+          <phrase lang="en">Update Model Button</phrase>
+        </textobject>
+      </mediaobject>
+    </figure>
+
+    <para>
+      In the above example <literal>table7</literal> would be added to
+      the model.
+    </para>
+
+    <para>
+      The <guibutton>Ignore</guibutton> button causes the selected
+      changes to be ignored, no synchronization will take place for
+      those changes:
+    </para>
+
+    <figure id="wb-database-synchronize-wizard-diff-direction-ignore">
+      <title>Ignore Button</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata
fileref="images/published/wb-database-synchronize-wizard-diff-direction-ignore.png"
lang="en" format="PNG"/>
+        </imageobject>
+        <textobject>
+          <phrase lang="en">Ignore Button</phrase>
+        </textobject>
+      </mediaobject>
+    </figure>
+
+    <para>
+      In the above example no changes would take place.
+    </para>
+
+    <para>
+      The <guibutton>Update Source</guibutton> button causes the
+      selected changes to only update the live database:
+    </para>
+
+    <figure id="wb-database-synchronize-wizard-diff-direction-source">
+      <title>Update Source Button</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata
fileref="images/published/wb-database-synchronize-wizard-diff-direction-source.png"
lang="en" format="PNG"/>
+        </imageobject>
+        <textobject>
+          <phrase lang="en">Update Source Button</phrase>
+        </textobject>
+      </mediaobject>
+    </figure>
+
+    <para>
+      In this example <literal>table6</literal> would be added to the
+      live database and <literal>table7</literal> would be dropped from
+      the live database.
+    </para>
+
+    <para>
+      It is also possible to control individual changes by clicking on
+      the arrows. Clicking an arrow causes it to change between the
+      three available synchronization directions:
+    </para>
+
+    <figure id="wb-database-synchronize-wizard-diff-direction-arrow">
+      <title>Click arrows to change direction of changes</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata
fileref="images/published/wb-database-synchronize-wizard-diff-direction-arrow.png"
lang="en" format="PNG"/>
+        </imageobject>
+        <textobject>
+          <phrase lang="en">Click arrows to change direction of
+          changes</phrase>
+        </textobject>
+      </mediaobject>
+    </figure>
+
+    <para>
+      In the above example <literal>table6</literal> will be created in
+      the live database, and <literal>table7</literal> will be created
+      in the model.
+    </para>
+
   </section>
 
   <section id="wb-database-diff-report">