List:Commits« Previous MessageNext Message »
From:plavin Date:December 8 2007 7:03pm
Subject:svn commit - mysqldoc@docsrva: r9213 - trunk/workbench
View as plain text  
Author: plavin
Date: 2007-12-08 20:03:18 +0100 (Sat, 08 Dec 2007)
New Revision: 9213

Log:
Add to forward engineering


Modified:
   trunk/workbench/Makefile.depends
   trunk/workbench/forward-engineering.xml
   trunk/workbench/options-connections.xml
   trunk/workbench/reference.xml
   trunk/workbench/reverse-engineering.xml


Modified: trunk/workbench/Makefile.depends
===================================================================
--- trunk/workbench/Makefile.depends	2007-12-08 09:11:49 UTC (rev 9212)
+++ trunk/workbench/Makefile.depends	2007-12-08 19:03:18 UTC (rev 9213)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 1; 675 bytes

@@ -78,7 +78,8 @@
 	workbench.ent
 forward_engineering_IMAGES =
 forward_engineering_SOURCES = forward-engineering.xml $(forward_engineering_INCLUDES)
-forward_engineering_IDMAPS =
+forward_engineering_IDMAPS = \
+	metadata/options-connections.idmap
 forward-engineering.validpure: $(forward_engineering_SOURCES)
 forward-engineering.titles: $(forward_engineering_SOURCES)
 forward-engineering.useless: $(forward_engineering_SOURCES)


Modified: trunk/workbench/forward-engineering.xml
===================================================================
--- trunk/workbench/forward-engineering.xml	2007-12-08 09:11:49 UTC (rev 9212)
+++ trunk/workbench/forward-engineering.xml	2007-12-08 19:03:18 UTC (rev 9213)
Changed blocks: 1, Lines Added: 112, Lines Deleted: 92; 5684 bytes

@@ -8,105 +8,125 @@
 <chapter id="wb-forward-engineering">
 
   <title>Forward Engineering</title>
-  
-  <!--para>
-    Use forward engineering to export your schema design
-    to a MySQL server.   
-  </para>
-  
-  <para>
-    Select the schena that you wish to forward engineer
-    and then choose the <guimenu>Forward Engineer ...</guimenu>
-    option under the <guimenu>Database</guimenu> menu option.
-  </para>
-  
-  <para>
-    The first 
-  </para>
-  
-  <para>
-    The SQL options are as follows:
-    
-    <itemizedlist>
-      
-      <listitem>
-        <para>
-          Generate DROP statements (except DROP DATABASE)
-        </para>
-      </listitem>
-      
-      <listitem>
-        <para>
-          Generate separate CREATE INDEX statements
-        </para>
-      </listitem>
-      
-      <listitem>
-        <para>
-          Generate SHOW WARNINGS after every DDL statement
-        </para>
-      </listitem>
-      
-      <listitem>
-        <para>
-          Do not creatre users, just export privileges
-        </para>
-      </listitem>
-      
-      <listitem>
-        <para>
-          Generate INSERT statements for tables
-        </para>
-      </listitem>
-      
-    </itemizedlist>
-    
-    
-  </para>
-  
-  <para>
-    On the <literal>Review Script</literal> page you may
-    review and edit the SQL script that will be executed.
-  </para-->
-  
- <section id="wb-exporting-sql-scripts">
-   
-   <title>Exporting SQL Scripts</title>
-   
-   <para>
-     <remark>Create</remark>
-   </para>
-   <para>
-     <remark> ALTER is for comparing with another CREATE script and generating an
-       ALTER script so that a live db that was created with the former is updated
-       the png option will export an image of the current canvas
-       same for pdf and ps (alfredo)</remark>
-   </para>
- </section>
-  
+
+  <section id="wb-forward-engineering-sql-scripts">
+
+    <title>Forward Engineering using SQL Scripts</title>
+
+    <para>
+      To forward engineer a database use the <guimenu>Export</guimenu>
+      option found under the <guimenu>File</guimenu> menu. You may
+      export a script to alter an existing database or create a new
+      database.
+    </para>
+
+    <para>
+      <remark>
+        Create
+      </remark>
+    </para>
+
+    <para>
+      <remark>
+        ALTER is for comparing with another CREATE script and generating
+        an ALTER script so that a live db that was created with the
+        former is updated the png option will export an image of the
+        current canvas same for pdf and ps (alfredo)
+      </remark>
+    </para>
+
+  </section>
+
+  <section id="forward-engineering-live-server">
+
+    <title>Forward Engineering to a Live Server (Commercial Version)</title>
+
+    <para>
+      Use forward engineering to export your schema design to a MySQL
+      server.
+    </para>
+
+    <para>
+      Select the schema that you wish to forward engineer and then
+      choose the <guimenu>Forward Engineer ...</guimenu> option under
+      the <guimenu>Database</guimenu> menu option.
+    </para>
+
+    <para>
+      On the first screen select the objects that you wish to export.
+    </para>
+
+    <para>
+      The next screen offers SQL export options. These are as follows:
+
+      <itemizedlist>
+
+        <listitem>
+          <para>
+            Generate DROP statements (except DROP DATABASE)
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            Generate separate CREATE INDEX statements
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            Generate SHOW WARNINGS after every DDL statement
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            Do not creatre users, just export privileges
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            Generate INSERT statements for tables
+          </para>
+        </listitem>
+
+      </itemizedlist>
+    </para>
+
+    <para>
+      On the <literal>Review Script</literal> page you may review and
+      edit the SQL script that will be executed. You next connect to a
+      MySQL server; this process is described in
+      <xref linkend="wb-options-connections"/>.
+    </para>
+
+    <para>
+      Confirm the creation of a schema by connecting to the target MySQL
+      server and issuing the <userinput>SHOW DATABASES;</userinput>
+      command.
+    </para>
+
+  </section>
+
   <section id="wb-database-synchronization">
-    
+
     <title>Database Synchronization (Commercial Version)</title>
-    
+
     <para>
-      The <guimenuitem>Synchronize ...</guimenuitem> menu item under the 
-      <guimenu>Database</guimenu> menu option synchronizes your
-      database model with an existing database.
+      The <guimenuitem>Synchronize ...</guimenuitem> menu item under the
+      <guimenu>Database</guimenu> menu option synchronizes your database
+      model with an existing database.
     </para>
-    
+
     <note>
-      
       <para>
-        New tables or views can be synchronized with an
-        existing database.
-        Currently, changes to an existing table, such as the addition 
-        of a column, cannot be synchronized using &workbench;.        
+        New tables or views can be synchronized with an existing
+        database. Currently, changes to an existing table, such as the
+        addition of a column, cannot be synchronized using &workbench;.
       </para>
-        
     </note>
-    
-    
+
   </section>
-  
-    
+
 </chapter>


Modified: trunk/workbench/options-connections.xml
===================================================================
--- trunk/workbench/options-connections.xml	2007-12-08 09:11:49 UTC (rev 9212)
+++ trunk/workbench/options-connections.xml	2007-12-08 19:03:18 UTC (rev 9213)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 751 bytes

@@ -14,7 +14,7 @@
     with all  the menu options found under the <guimenu>Database</guimenu>
     main menu option. These options are <guimenu>Reverse Engineer ...</guimenu>,
     <guimenu>Forward Engineer ...</guimenu>, and <guimenu>Synchronize ...</guimenu>.
-    Use this dialog window to open existing stored connections or to create new 
+    Use this dialog window to open an ad hoc connection, to open an existing stored connections, or create new 
     connections.
   </para>
 


Modified: trunk/workbench/reference.xml
===================================================================
--- trunk/workbench/reference.xml	2007-12-08 09:11:49 UTC (rev 9212)
+++ trunk/workbench/reference.xml	2007-12-08 19:03:18 UTC (rev 9213)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 605 bytes

@@ -69,7 +69,7 @@
         <guilabel>Export</guilabel> menu item. You may generate the SQL
         statements necessary to create a new database or alter an
         existing one. These menu items are discussed in detail in
-        <xref linkend="wb-exporting-sql-scripts"/>.
+        <xref linkend="wb-forward-engineering-sql-scripts"/>.
       </para>
 
       <para>


Modified: trunk/workbench/reverse-engineering.xml
===================================================================
--- trunk/workbench/reverse-engineering.xml	2007-12-08 09:11:49 UTC (rev 9212)
+++ trunk/workbench/reverse-engineering.xml	2007-12-08 19:03:18 UTC (rev 9213)
Changed blocks: 4, Lines Added: 13, Lines Deleted: 6; 2059 bytes

@@ -48,7 +48,7 @@
       <literal>CREATE DATABASE
       <replaceable>db_name</replaceable></literal> statement in your
       script file, you must import the database objects into an existing
-      schema or, if there is no schema, into a new unnamed schema is
+      schema or, if there is no schema, a new unnamed schema is
       created.
     </para>
 

@@ -66,7 +66,7 @@
     </para>
 
     <para>
-      Before exiting be sure to save the schema. Choose the
+      Before exiting, be sure to save the schema. Choose the
       <guimenu>File</guimenu>, <guimenu>Save</guimenu> menu item and the
       reverse-engineered database will be saved as a MySQL Workbench
       file with the extension <literal>mwb</literal>.

@@ -91,9 +91,10 @@
 
     <para>
       Choose the <guimenu>Reverse Engineer ...</guimenu> menu item found
-      under the <guimenu>Database</guimenu> main menu. Doing this opens
-      the connection dialog window. Choose to create a new connection.
-      Instructions for doing this are described in detail in
+      under the  main menu, <guimenu>Database</guimenu>. Doing this opens
+      the connection dialog window. You may choose to create a new connection
+      or simply locate the server you wish to connect to and enter your credentials.
+      Instructions for connecting to a server are described in detail in
       <xref linkend="wb-options-connections"/>.
     </para>
 

@@ -202,7 +203,13 @@
       </figure>
       
       <para>
-        If you wish to do this, rename
+        The message log is displayed by clicking the
+        <guibutton>Advanced</guibutton> button.
+      </para>
+      
+      <para>  
+        If you wish to import an object with the same name as an
+        existing object, rename
         the existing object before reverse engineering.
       </para>
 


Thread
svn commit - mysqldoc@docsrva: r9213 - trunk/workbenchplavin8 Dec