Author: plavin
Date: 2007-12-12 00:05:58 +0100 (Wed, 12 Dec 2007)
New Revision: 9254
Log:
Add section on routines and routine groups
Modified:
trunk/workbench/Makefile.depends
trunk/workbench/reference.xml
trunk/workbench/stored-procedures.xml
trunk/workbench/tables.xml
trunk/workbench/views.xml
Modified: trunk/workbench/Makefile.depends
===================================================================
--- trunk/workbench/Makefile.depends 2007-12-11 21:59:46 UTC (rev 9253)
+++ trunk/workbench/Makefile.depends 2007-12-11 23:05:58 UTC (rev 9254)
Changed blocks: 2, Lines Added: 4, Lines Deleted: 2; 930 bytes
@@ -280,7 +280,6 @@
metadata/plugins.idmap \
metadata/printing.idmap \
metadata/reference.idmap \
- metadata/stored-procedures.idmap \
metadata/tables.idmap \
metadata/views.idmap
reference.validpure: $(reference_SOURCES)
@@ -324,7 +323,10 @@
workbench.ent
stored_procedures_IMAGES =
stored_procedures_SOURCES = stored-procedures.xml $(stored_procedures_INCLUDES)
-stored_procedures_IDMAPS =
+stored_procedures_IDMAPS = \
+ metadata/reference.idmap \
+ metadata/stored-procedures.idmap \
+ metadata/tables.idmap
stored-procedures.validpure: $(stored_procedures_SOURCES)
stored-procedures.titles: $(stored_procedures_SOURCES)
stored-procedures.useless: $(stored_procedures_SOURCES)
Modified: trunk/workbench/reference.xml
===================================================================
--- trunk/workbench/reference.xml 2007-12-11 21:59:46 UTC (rev 9253)
+++ trunk/workbench/reference.xml 2007-12-11 23:05:58 UTC (rev 9254)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 496 bytes
@@ -864,7 +864,7 @@
<para>
For more information about creating and editing views see
- <xref linkend="wb-stored-procedures-tools" />.
+ <xref linkend="wb-creating-views" />.
</para>
</section>
Modified: trunk/workbench/stored-procedures.xml
===================================================================
--- trunk/workbench/stored-procedures.xml 2007-12-11 21:59:46 UTC (rev 9253)
+++ trunk/workbench/stored-procedures.xml 2007-12-11 23:05:58 UTC (rev 9254)
Changed blocks: 1, Lines Added: 514, Lines Deleted: 30; 16343 bytes
@@ -5,39 +5,523 @@
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
-<chapter id="wb-stored-procedures">
+<chapter id="wb-routines-routine-groups">
- <title>Creating Stored Procedures and Functions</title>
-
+ <title>Creating Routines and Routine Groups</title>
+
<para>
-
+ You can add routine groups to a database either from the
+ <literal>Physical Schemata</literal> section of the
+ <literal>Overview</literal> page or from the EER Diagram. Routines
+ may only be added from the <literal>Physical Schemata</literal>
+ section of the <literal>Overview</literal> page
</para>
-
- <section id="wb-stored-procedures-overview">
- <title>Overview </title>
-
- <para>
-
- </para>
-
+
+<!--start routines here-->
+
+ <section id="wb-routines">
+
+ <title>Routines</title>
+
+ <section id="wb-add-routines">
+
+ <title>Adding Routines to the Physical Schemata</title>
+
+ <para>
+ Double clicking the <literal>Add Routine</literal> icon in the
+ <literal>Physical Schemata</literal> section of the
+ <literal>Overview</literal> page adds a routine with the default
+ name of <literal>routine1</literal>. If a routine with this name
+ already exists, the new routine is named
+ <literal>routine2</literal>.
+ </para>
+
+ <para>
+ Adding a new routine automatically opens the routine editor
+ docked at the bottom of the application. Using the routine
+ editor is described in <xref linkend="wb-routine-editor"/>.
+ </para>
+
+ <para>
+ Right clicking a routine opens a pop-up menu with the following
+ options:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <guimenu>Edit Routine ...</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Rename</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Cut</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Copy</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Delete</guimenu>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ The <guimenu>Edit Routine ...</guimenu> option opens the routine
+ editor. Using the routine editor is described in
+ <xref linkend="wb-routine-editor"/>.
+ </para>
+
+ <para>
+ The <guimenu>Cut</guimenu> and <guimenu>Paste</guimenu> options
+ are useful for copying routines between different schemata.
+ </para>
+
+ <para>
+ The action of the <guimenu>Delete</guimenu> option varies
+ depending upon the way you have configured &workbench;. For more
+ information see <xref linkend="wb-options-advanced"/>.
+ </para>
+
+ </section>
+
+<!-- routine editor-->
+
+ <section id="wb-routine-editor">
+
+ <title>The Routine Editor</title>
+
+ <para>
+ You can invoke the routine editor by double clicking a routine
+ in the <literal>Physical Schemata</literal> section on the
+ <literal>MySQL Model</literal> page. Doing this opens the
+ routine editor docked at the bottom of the application. Double
+ clicking the title bar undocks the editor. Do the same to redock
+ it. Any number of routines may be open at the same time. Each
+ additional routine appears as a tab at the top of the routine
+ editor,
+ </para>
+
+ <para>
+ There ar two tabs at the bottom of the routine editor, the
+ <guilabel>View</guilabel> and the
+ <guilabel>Privileges</guilabel> tabs. Navigate between different
+ tabs using the mouse or from the keyboard by pressing
+ <keycap>Ctrl</keycap> + <keycap>Alt</keycap> +
+ <keycap>Tab</keycap>.
+ </para>
+
+ <section id="wb-routines-routine-tab">
+
+ <title>The <literal>Routine </literal>Tab</title>
+
+ <para>
+ From the <literal>Routine</literal> tab of the routine editor you
+ can perform the following tasks:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Rename the routine using the <guilabel>Name</guilabel>
+ text box.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Enter the SQL to create a routine using the
+ <guilabel>SQL</guilabel> text area.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ <section id="wb-routine-editor-privileges">
+
+ <title>The <literal>Privileges</literal> Tab</title>
+
+ <para>
+ The <literal>Privileges</literal> tab of the routine editor
+ functions in exactly the same way as the
+ <literal>Privileges</literal> tab of the table editor. For
+ more information see
+ <xref linkend="wb-table-editor-privileges"/>.
+ </para>
+
+ </section>
+
+ </section>
+
</section>
-
- <section id="wb-stored-procedures-tools">
- <title> The Routine Group Tool</title>
-
- <para>
-
- </para>
-
+
+<!--start routine groups here-->
+
+ <section id="wb-routine-groups">
+
+ <title>Routine Groups</title>
+
+ <section id="wb-routine-groups-physical-schemata">
+
+ <title>Adding Routine Groups to the Physical Schemata</title>
+
+ <para>
+ Double clicking the <literal>Add Routine Group</literal> icon in
+ the <literal>Physical Schemata</literal> section of the
+ <literal>Overview</literal> page adds a routine with the default
+ name of <literal>routines1</literal>. If a routine group with this name
+ already exists, the new routine group is named
+ <literal>routines2</literal>.
+ </para>
+
+ <para>
+ Adding a new routine group automatically opens the routine groups editor
+ docked at the bottom of the application. Using the routine groups
+ editor is described in <xref linkend="wb-routine-groups-editor"/>.
+ </para>
+
+ <para>
+ Right clicking a routine group opens a pop-up menu with the
+ following options:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <guimenu>Edit Routine Group...</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Rename</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Cut</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Copy</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Delete</guimenu>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ The <guimenu>Edit Routine Group...</guimenu> option opens the
+ routine group editor. Using the routine group editor is described in
+ <xref linkend="wb-routine-groups-editor"/>.
+ </para>
+
+ <para>
+ The <guimenu>Cut</guimenu> and <guimenu>Paste</guimenu> options
+ are useful for copying routine groups between different schemata.
+ </para>
+
+ <para>
+ The action of the <guimenu>Delete</guimenu> option varies
+ depending upon the way you have configured &workbench;. For more
+ information see <xref linkend="wb-options-advanced"/>.
+ </para>
+
+ <para>
+ Any routine groups added to the <literal>Physical
+ Schemata</literal> also show up in the
+ <literal>Catalog</literal> palette on the right side of the
+ application. They may be added to an EER Digram by dragging and
+ dropping them from this palette.
+ </para>
+
+ </section>
+
+ <section id="wb-using-routine-groups-tool">
+
+ <title>Adding Routine Groups to an EER Diagram</title>
+
+ <para>
+ Routine groups can also be added to an EER Diagram using the
+ <literal>Routine Groups</literal> tool on the vertical toolbar.
+ To do this make sure that the <literal>EER Diagram</literal> tab
+ is selected, and right click the routine groups icon on the
+ vertical toolbar. The routine groups icon is immediately above
+ the lowest toolbar divider.
+ </para>
+
+ <para>
+ Clicking the mouse on this icon changes the mouse pointer to a
+ routine group pointer. You can also change the mouse pointer to
+ a routine pointer by pressing the <keycap>G</keycap> key.
+ </para>
+
+ <para>
+ Choosing the <literal>Routine Group</literal> tool changes the
+ contents of the toolbar that appears immediately below the menu
+ bar. When the <literal>Routine Groups</literal> pointer is active,
+ this toolbar contains a drop down list box of schemata and a drop
+ down color chart. Use these list boxes to select the appropriate
+ schema and color accent for the new routine group. Make sure
+ that you associate the new routine group with a database. The
+ color of your routine group can easily be changed later using
+ the <literal>Properties</literal> palette.
+ </para>
+
+ <para>
+ Create a routine group by clicking anywhere on the EER Diagram
+ canvas. This creates a new routine group with the default name
+ <literal>routines1</literal>. To revert to the default mouse
+ pointer, click the arrow icon at the top of the vertical
+ toolbar.
+ </para>
+
+ <para>
+ Left clicking a routine groups object opens a pop-up menu with the following
+ options:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <guimenu>Cut</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Copy</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Edit Routine Group ...</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Edit in New Window ...</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Delete
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ These menu options function in exactly the same way as the
+ options described in
+ <xref linkend="wb-add-routines"/>.
+ </para>
+
+ </section>
+
+ <section id="wb-routine-groups-editor">
+
+ <title>The Routine Group Editor</title>
+
+ <para>
+ You can invoke the routine group editor by double clicking a
+ routine group object on the EER Diagram canvas or by double
+ clicking a routine group in the <literal>Physical
+ Schemata</literal> section on the <literal>MySQL Model</literal>
+ page. Doing this opens the routine group editor docked at the
+ bottom of the application. Double clicking the title bar undocks
+ the editor. Do the same to redock it. Any number of routine
+ groups may be open at the same time. Each additional routine
+ group appears as a tab at the top of the routine editor,
+ </para>
+
+ <para>
+ There are two tabs at the bottom of the routine editor, the
+ <guilabel>Routine group</guilabel> and the
+ <guilabel>Privileges</guilabel> tabs. Navigate between different
+ tabs using the mouse or from the keyboard by pressing
+ <keycap>Ctrl</keycap> + <keycap>Alt</keycap> +
+ <keycap>Tab</keycap>.
+ </para>
+
+ <section id="wb-routine-groups-tab">
+
+ <title>The <literal>Routine Groups</literal>Tab</title>
+
+ <para>
+ From the <literal>Routine Groups</literal> tab of the routine
+ groups editor you can perform the following tasks:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Rename the routine group using the
+ <guilabel>Name</guilabel> text box.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Add routines to the group by dragging and dropping them.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Add comments to the routine group.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ <section id="wb-routine-groups-editor-privileges">
+
+ <title>The <literal>Privileges</literal> Tab</title>
+
+ <para>
+ The <literal>Privileges</literal> tab of the routine group
+ editor functions in exactly the same way as the
+ <literal>Privileges</literal> tab of the table editor. For
+ more information see
+ <xref linkend="wb-table-editor-privileges"/>.
+ </para>
+
+ </section>
+
+ <section id="wb-modifying-routine">
+
+ <title>Modifying a Routine Group Using the Properties Palette</title>
+
+ <para>
+ When you select a routine group on the EER Diagram canvas, its
+ properties are displayed in the <literal>Properties</literal>
+ palette. Most of the properties accessible from the
+ <literal>Properties</literal> palette apply to the appearance
+ of a routine group on the EER Diagram canvas.
+ </para>
+
+ <para>
+ The properties are as follows:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>color</literal> – The color accent of the
+ object.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enabled</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>expanded</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>height</literal> – The height of the
+ object.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>left</literal> – The number of pixels
+ from the object to the left side of the canvas.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>locked</literal> – Whether the object is
+ locked or not. Use <literal>‘1’</literal>
+ for true and <literal>‘0’</literal> for
+ false.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>name</literal> – The name of the object.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>top</literal> – The number of pixels from
+ the object to the top of the canvas.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>visible</literal> – This property
+ controls whether an object shows up on the canvas or
+ not. Use <literal>‘1’</literal> for true and
+ <literal>‘0’</literal> for false.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>width</literal> – The width of the
+ object.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ <remark>
+ Update when app updated, F5 is used for refresh.
+ </remark>
+ </para>
+
+ </section>
+
+ </section>
+
</section>
-
- <section id="wb-stored-procedures-editor">
- <title>The Routine Groups Editor</title>
-
- <para>
-
- </para>
-
- </section>
-
+
</chapter>
Modified: trunk/workbench/tables.xml
===================================================================
--- trunk/workbench/tables.xml 2007-12-11 21:59:46 UTC (rev 9253)
+++ trunk/workbench/tables.xml 2007-12-11 23:05:58 UTC (rev 9254)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 1; 786 bytes
@@ -112,7 +112,8 @@
<para>
Choosing the <literal>table</literal> tool changes the contents of
- the toolbar that appears immediately below the menu bar. It now
+ the toolbar that appears immediately below the menu bar.
+ When the <literal>Tables</literal> pointer is active, this toolbar
contains a drop down list box of schemata, a drop down list box
of engines, a drop down list box of collations, and a drop down color
chart. Use these list boxes to select the appropriate schema, engine, collation, and
Modified: trunk/workbench/views.xml
===================================================================
--- trunk/workbench/views.xml 2007-12-11 21:59:46 UTC (rev 9253)
+++ trunk/workbench/views.xml 2007-12-11 23:05:58 UTC (rev 9254)
Changed blocks: 3, Lines Added: 7, Lines Deleted: 4; 1641 bytes
@@ -118,7 +118,8 @@
<para>
Choosing the <literal>View</literal> tool changes the contents of
- the toolbar that appears immediately below the menu bar. It now
+ the toolbar that appears immediately below the menu bar.
+ When the <literal>Views</literal> pointer is active, this toolbar
contains a drop down list box of schemata and a drop down color
chart. Use these list boxes to select the appropriate schema and
color accent for the new view. Make sure that you associate the
@@ -193,14 +194,14 @@
</para>
<para>
- There ar two tabs at the bottom of the view editor, the
+ There are two tabs at the bottom of the view editor, the
<guilabel>View</guilabel> and the <guilabel>Privileges</guilabel>
tabs. Navigate between different tabs using the mouse or from the
keyboard by pressing <keycap>Ctrl</keycap> + <keycap>Alt</keycap>
+ <keycap>Tab</keycap>.
</para>
- <section>
+ <section id="wb-views-view-tab">
<title>The <literal>View </literal>Tab</title>
@@ -302,7 +303,9 @@
<listitem>
<para>
<literal>locked</literal> – Whether the object is
- locked or not.
+ locked or not. Use
+ <literal>‘1’</literal> for true and
+ <literal>‘0’</literal> for false.
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r9254 - trunk/workbench | plavin | 12 Dec |
