Author: tbedford
Date: 2009-11-20 16:15:52 +0100 (Fri, 20 Nov 2009)
New Revision: 17742
Log:
Updates and restucturing for 5.2.8
Modified:
trunk/workbench/home.xml
trunk/workbench/reference.xml
trunk/workbench/sql-query.xml
Modified: trunk/workbench/home.xml
===================================================================
--- trunk/workbench/home.xml 2009-11-20 13:27:47 UTC (rev 17741)
+++ trunk/workbench/home.xml 2009-11-20 15:15:52 UTC (rev 17742)
Changed blocks: 4, Lines Added: 5, Lines Deleted: 4; 958 bytes
@@ -92,7 +92,7 @@
</orderedlist>
- <section id="wb-sql-development">
+ <section id="wb-workspace-sql-development">
<title>SQL Development</title>
@@ -152,7 +152,8 @@
</para>
<para>
- To read about the SQL Editor see <xref linkend="wb-sql-query"/>.
+ To read about the SQL Editor see
+ <xref linkend="wb-sql-editor"/>.
</para>
<para>
@@ -231,7 +232,7 @@
</section>
- <section id="wb-data-modelling">
+ <section id="wb-workspace-data-modelling">
<title>Data Modeling</title>
@@ -352,7 +353,7 @@
</section>
- <section id="wb-server-administration">
+ <section id="wb-workspace-server-administration">
<title>Server Administration</title>
Modified: trunk/workbench/reference.xml
===================================================================
--- trunk/workbench/reference.xml 2009-11-20 13:27:47 UTC (rev 17741)
+++ trunk/workbench/reference.xml 2009-11-20 15:15:52 UTC (rev 17742)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 573 bytes
@@ -103,7 +103,7 @@
This tab allows you to create and execute SQL queries. This tab
provides the functionality that was previously in the stand-alone
application MySQL Query Browser. For further information see
- <xref linkend="wb-sql-query"/>.
+ <xref linkend="wb-sql-editor"/>.
</para>
<para>
Modified: trunk/workbench/sql-query.xml
===================================================================
--- trunk/workbench/sql-query.xml 2009-11-20 13:27:47 UTC (rev 17741)
+++ trunk/workbench/sql-query.xml 2009-11-20 15:15:52 UTC (rev 17742)
Changed blocks: 1, Lines Added: 383, Lines Deleted: 279; 22255 bytes
@@ -5,353 +5,457 @@
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
-<chapter id="wb-sql-query">
+<chapter id="wb-sql-development">
- <title>SQL Editor</title>
+ <title>SQL Development</title>
<para>
- &workbench; 5.2 introduced the SQL Editor facility. This can be
- launched by selecting <guimenu>Database</guimenu>, <guimenu>Query
- Database</guimenu> from the main menu, or by using the keyboard
- shortcut <keycap>Ctrl</keycap>+<keycap>U</keycap> on Windows, or
- <keycap>Cmd</keycap>+<keycap>U</keycap> on Mac OS X. At this point
- you will be asked to select either a stored connection or enter the
- details for a new connection. Once a connection has been made to the
- server a new tab called <guilabel>SQL Editor <replaceable>(schema)</replaceable></guilabel> is
- displayed:
+ &workbench; provides extensive facilities for working directly with
+ SQL code.
</para>
- <figure id="wb-sql-query-ide">
+ <section id="wb-sql-editor">
+
<title>SQL Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="1440" contentdepth="858" fileref="../workbench/images/published/wb-sql-query-ide.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">SQL Editor</phrase>
- </textobject>
- </mediaobject>
- </figure>
- <para>
- The main areas of the SQL Editor are:
- </para>
+ <para>
+ &workbench; 5.2 introduced the SQL Editor facility. The SQL Editor
+ can be launched via various Action Items on the Home screen. It
+ can also be launched by selecting <guimenu>Database</guimenu>,
+ <guimenu>Query Database</guimenu> from the main menu, or by using
+ the keyboard shortcut <keycap>Ctrl</keycap>+<keycap>U</keycap> on
+ Windows, or <keycap>Cmd</keycap>+<keycap>U</keycap> on Mac OS X.
+ At this point you will be asked to select either a stored
+ connection or enter the details for a new connection. Once a
+ connection has been made to the server a new tab called
+ <guilabel>SQL Editor
+ <replaceable>(schema)</replaceable></guilabel> is displayed:
+ </para>
- <itemizedlist>
+ <figure id="wb-sql-query-ide">
+ <title>SQL Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="1440" contentdepth="858" fileref="../workbench/images/published/wb-sql-query-ide.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">SQL Editor</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
- <listitem>
- <para>
- Toolbar
- </para>
- </listitem>
+ <para>
+ The main elements of the SQL Editor user interface are:
+ </para>
- <listitem>
- <para>
- SQL Statements
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- Results
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The Main Menu
+ </para>
+ </listitem>
- <listitem>
- <para>
- Tab area
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Toolbar
+ </para>
+ </listitem>
- <listitem>
- <para>
- Connection details
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Statements Panel
+ </para>
+ </listitem>
- <listitem>
- <para>
- Default schema selection
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Main Tabsheets
+ </para>
+ </listitem>
- <listitem>
- <para>
- Schema explorer
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Sidebar
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- <para>
- Each of these are described in more detail in the following
- sections.
- </para>
+ <para>
+ Each of these are described in more detail in the following
+ sections.
+ </para>
- <para>
- <emphasis role="bold">Toolbar</emphasis>
- </para>
+ <section id="wb-sql-editor-main-menu">
- <para>
- The toolbar features six buttons, as shown in the folllowing
- screenshot:
- </para>
+ <title>Main Menu</title>
- <figure id="wb-sql-query-ide-toolbar">
- <title>Database Query - Toolbar</title>
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="168" contentdepth="33" fileref="../workbench/images/published/wb-sql-query-ide-toolbar.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Database Query - Toolbar</phrase>
- </textobject>
- </mediaobject>
- </figure>
+ <para></para>
- <para>
- From left to right these are:
- </para>
+ </section>
- <orderedlist>
+ <section id="wb-sql-editor-toolbar">
- <listitem>
+ <title>Toolbar</title>
+
<para>
- <emphasis role="bold">Open SQL Script</emphasis> - Cicking this
- button allows any saved SQL script to be loaded ready for
- execution. The script will be displayed in the <guilabel>SQL
- Statements</guilabel> area.
+ The toolbar features six buttons, as shown in the folllowing
+ screenshot:
</para>
- </listitem>
- <listitem>
+ <figure id="wb-sql-query-ide-toolbar">
+ <title>Database Query - Toolbar</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="168" contentdepth="33" fileref="../workbench/images/published/wb-sql-query-ide-toolbar.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Database Query - Toolbar</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
<para>
- <emphasis role="bold">Save SQL Script</emphasis> - Clicking this
- button allows the currently loaded SQL script to be saved to a
- file specified by the user.
+ From left to right these are:
</para>
- </listitem>
- <listitem>
+ <orderedlist>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Open SQL Script</emphasis> - Cicking
+ this button allows any saved SQL script to be loaded ready
+ for execution. The script will be displayed in the
+ <guilabel>SQL Statements</guilabel> area.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Save SQL Script</emphasis> - Clicking
+ this button allows the currently loaded SQL script to be
+ saved to a file specified by the user.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Execute SQL Script</emphasis> -
+ Executes the currently loaded SQL script. Results are
+ displayed in one or more tabs.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Stop execution</emphasis> - halts
+ execution of the currently executing SQL script.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Commit</emphasis> - commits a
+ transaction.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Rollback</emphasis> - rolls back a
+ transaction.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ </section>
+
+ <section id="wb-sql-editor-statements-panel">
+
+ <title>SQL Statements Panel</title>
+
<para>
- <emphasis role="bold">Execute SQL Script</emphasis> - Executes
- the currently loaded SQL script. Results are displayed in one or
- more tabs.
+ In this area you can enter SQL Statements directly.
</para>
- </listitem>
- <listitem>
+ <figure id="wb-sql-query-ide-statements">
+ <title>Database Query - SQL Statements</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="1202" contentdepth="213" fileref="../workbench/images/published/wb-sql-query-ide-statements.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Database Query - SQL Statements</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
<para>
- <emphasis role="bold">Stop execution</emphasis> - halts
- execution of the currently executing SQL script.
+ The statements entered can be saved to a file for later use. At
+ any point you can also execute the statements you have entered.
</para>
- </listitem>
- <listitem>
+ </section>
+
+ <section id="wb-sql-editor-main-tabsheets">
+
+ <title>Main Tabsheets</title>
+
<para>
- <emphasis role="bold">Commit</emphasis> - commits a transaction.
+ The main tabsheets area contains several tabs:
</para>
- </listitem>
- <listitem>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Live Schema Overview Tabsheet
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Output Tabsheet
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ History Tabsheet
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Results Tabsheets
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <figure id="wb-sql-query-ide-tab">
+ <title>Database Query - Tab Area</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="252" contentdepth="28" fileref="../workbench/images/published/wb-sql-query-ide-tab.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Database Query - Tab Area</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
<para>
- <emphasis role="bold">Rollback</emphasis> - rolls back a
- transaction.
+ Each of these is described in more detail in the following
+ sections.
</para>
- </listitem>
- </orderedlist>
+ <section id="wb-sql-editor-live-schema-tabsheet">
- <para>
- <emphasis role="bold">SQL Statements</emphasis>
- </para>
+ <title>Live Schema Tabsheet</title>
- <para>
- In this area you can enter SQL Statements directly.
- </para>
+ <para></para>
- <figure id="wb-sql-query-ide-statements">
- <title>Database Query - SQL Statements</title>
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="1202" contentdepth="213" fileref="../workbench/images/published/wb-sql-query-ide-statements.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Database Query - SQL Statements</phrase>
- </textobject>
- </mediaobject>
- </figure>
+ </section>
- <para>
- The statements entered can be saved to a file for later use. At any
- point you can also execute the statements you have entered.
- </para>
+ <section id="wb-sql-editor-output-tabsheet">
- <para>
- <emphasis role="bold">Results</emphasis>
- </para>
+ <title>Output Tabsheet</title>
- <para>
- The results area of the screen shows the results from any queries
- that have been executed. If the script contains multiple queries
- then multiple result tabs will be generated, one for each query that
- returns results.
- </para>
+ <para></para>
- <figure id="wb-sql-query-ide-results">
- <title>Database Query - Results</title>
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="1202" contentdepth="251" fileref="../workbench/images/published/wb-sql-query-ide-results.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Database Query - Results</phrase>
- </textobject>
- </mediaobject>
- </figure>
+ </section>
- <para>
- Controls are provided to allow you to easily move over the results.
- These are shown in the following screenshot:
- </para>
+ <section id="wb-sql-editor-history-tabsheet">
- <figure id="wb-sql-query-ide-results-controls">
- <title>Database Query - Results Controls</title>
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="137" contentdepth="34" fileref="../workbench/images/published/wb-sql-query-ide-results-controls.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Database Query - Results Controls</phrase>
- </textobject>
- </mediaobject>
- </figure>
+ <title>History Tabsheet</title>
- <para>
- There are four controls available. The controls from left to right
- are:
- </para>
+ <para></para>
- <orderedlist>
+ </section>
- <listitem>
- <para>
- <emphasis role="bold">Refresh Data from Data Source</emphasis> -
- Refreshes the current result set from the data source.
- </para>
- </listitem>
+ <section id="wb-sql-editor-results-tabsheets">
- <listitem>
- <para>
- <emphasis role="bold">Go to first record</emphasis> - Highlights
- the first record in the current result set.
- </para>
- </listitem>
+ <title>Results Tabsheets</title>
- <listitem>
- <para>
- <emphasis role="bold">Go to last record</emphasis> - Highlights
- the last record in the current result set.
- </para>
- </listitem>
+ <para>
+ The results area of the screen shows the results from any
+ queries that have been executed. If the script contains
+ multiple queries then multiple result tabs will be generated,
+ one for each query that returns results.
+ </para>
- <listitem>
- <para>
- <emphasis role="bold">Toggle wrapping of cell
- contents</emphasis> - The data in the cell can either be
- truncated or wrapped. This button allows you to toggles between
- these options.
- </para>
- </listitem>
+ <figure id="wb-sql-query-ide-results">
+ <title>Database Query - Results</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="1202" contentdepth="251" fileref="../workbench/images/published/wb-sql-query-ide-results.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Database Query - Results</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
- </orderedlist>
+ <para>
+ Controls are provided to allow you to easily move over the
+ results. These are shown in the following screenshot:
+ </para>
- <para>
- <emphasis role="bold">Tab Area</emphasis>
- </para>
+ <figure id="wb-sql-query-ide-results-controls">
+ <title>Database Query - Results Controls</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="137" contentdepth="34" fileref="../workbench/images/published/wb-sql-query-ide-results-controls.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Database Query - Results
+ Controls</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
- <para>
- The tab area contains tabs for any result sets generated by
- executing the SQL script. There is also an Output tab and a History
- tab. The Output tab contains a log of actions carried out, and the
- corresponding response. The History tab contains (not sure what!).
- </para>
+ <para>
+ There are four controls available. The controls from left to
+ right are:
+ </para>
- <figure id="wb-sql-query-ide-tab">
- <title>Database Query - Tab Area</title>
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="252" contentdepth="28" fileref="../workbench/images/published/wb-sql-query-ide-tab.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Database Query - Tab Area</phrase>
- </textobject>
- </mediaobject>
- </figure>
+ <orderedlist>
- <para>
- <emphasis role="bold">Connection Details</emphasis>
- </para>
+ <listitem>
+ <para>
+ <emphasis role="bold">Refresh Data from Data
+ Source</emphasis> - Refreshes the current result set from
+ the data source.
+ </para>
+ </listitem>
- <para>
- This section provides a summary of the current connection to the
- server.
- </para>
+ <listitem>
+ <para>
+ <emphasis role="bold">Go to first record</emphasis> -
+ Highlights the first record in the current result set.
+ </para>
+ </listitem>
- <figure id="wb-sql-query-ide-connection">
- <title>Database Query - Connection Details</title>
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="207" contentdepth="157" fileref="../workbench/images/published/wb-sql-query-ide-connection.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Database Query - Connection Details</phrase>
- </textobject>
- </mediaobject>
- </figure>
+ <listitem>
+ <para>
+ <emphasis role="bold">Go to last record</emphasis> -
+ Highlights the last record in the current result set.
+ </para>
+ </listitem>
- <para>
- <emphasis role="bold">Default Schema Selection</emphasis>
- </para>
+ <listitem>
+ <para>
+ <emphasis role="bold">Toggle wrapping of cell
+ contents</emphasis> - The data in the cell can either be
+ truncated or wrapped. This button allows you to toggles
+ between these options.
+ </para>
+ </listitem>
- <para>
- This drop down list box lists the schema that are available on the
- currently connected server. It is possible to select a schema to
- become the currently active schema using this facility.
- </para>
+ </orderedlist>
- <figure id="wb-sql-query-ide-schema">
- <title>Database Query - Default Schema Selection</title>
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="206" contentdepth="28" fileref="../workbench/images/published/wb-sql-query-ide-default.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Database Query - Default Schema
- Selection</phrase>
- </textobject>
- </mediaobject>
- </figure>
+ </section>
- <para>
- <emphasis role="bold">Schema Explorer</emphasis>
- </para>
+ </section>
- <para>
- This area allows you to explore the schema available on the
- currently connected server.
- </para>
+ <section id="wb-sql-editor-sidebar">
- <figure id="wb-sql-query-ide-explorer">
- <title>Database Query - Schema Explorer</title>
- <mediaobject>
- <imageobject>
- <imagedata contentwidth="200" contentdepth="198" fileref="../workbench/images/published/wb-sql-query-ide-explorer.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Database Query - Schema Explorer</phrase>
- </textobject>
- </mediaobject>
- </figure>
+ <title>Sidebar</title>
+ <section id="wb-sql-editor-connection-information-palette">
+
+ <title>Connection Information Palette</title>
+
+ <para>
+ This section provides a summary of the current connection to
+ the server.
+ </para>
+
+ <figure id="wb-sql-query-ide-connection">
+ <title>Database Query - Connection Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="207" contentdepth="157" fileref="../workbench/images/published/wb-sql-query-ide-connection.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Database Query - Connection
+ Details</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="wb-sql-editor-schematapalette">
+
+ <title>Schemata Palette</title>
+
+ <para>
+ The Schemata Palette contains a drop down listbox and a
+ schemata explorer control.
+ </para>
+
+ <para>
+ <emphasis role="bold">Default Schema Listbox</emphasis>
+ </para>
+
+ <para>
+ The drop down listbox lists the schema that are available on
+ the currently connected server. It is possible to select a
+ schema to become the currently active schema using this
+ facility.
+ </para>
+
+ <figure id="wb-sql-query-ide-schema">
+ <title>Database Query - Default Schema Selection</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="206" contentdepth="28" fileref="../workbench/images/published/wb-sql-query-ide-default.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Database Query - Default Schema
+ Selection</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ <emphasis role="bold">Schema Explorer</emphasis>
+ </para>
+
+ <para>
+ This area allows you to explore the schema available on the
+ currently connected server.
+ </para>
+
+ <figure id="wb-sql-query-ide-explorer">
+ <title>Database Query - Schema Explorer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="200" contentdepth="198" fileref="../workbench/images/published/wb-sql-query-ide-explorer.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Database Query - Schema
+ Explorer</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="wb-sql-editor-snippets-palette">
+
+ <title>Snippets Palette</title>
+
+ <para></para>
+
+ </section>
+
+ </section>
+
+ </section>
+
</chapter>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r17742 - trunk/workbench | anthony.bedford | 20 Nov |
