Author: tbedford
Date: 2009-07-29 16:47:27 +0200 (Wed, 29 Jul 2009)
New Revision: 15854
Log:
Further updates.
Modified:
trunk/workbench/sql-query.xml
Modified: trunk/workbench/sql-query.xml
===================================================================
--- trunk/workbench/sql-query.xml 2009-07-29 13:21:22 UTC (rev 15853)
+++ trunk/workbench/sql-query.xml 2009-07-29 14:47:27 UTC (rev 15854)
Changed blocks: 8, Lines Added: 130, Lines Deleted: 7; 5343 bytes
@@ -92,7 +92,10 @@
<emphasis role="bold">Toolbar</emphasis>
</para>
- <para></para>
+ <para>
+ The toolbar features six buttons, as shown in the folllowing
+ screenshot:
+ </para>
<figure id="wb-sql-query-ide-toolbar">
<title>SQL Query IDE - Toolbar</title>
@@ -107,6 +110,59 @@
</figure>
<para>
+ From left to right these are:
+ </para>
+
+ <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">Kill connection</emphasis> - this kills
+ the connection to the server.
+ </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>
+
+ <para>
<emphasis role="bold">SQL Statements</emphasis>
</para>
@@ -127,10 +183,20 @@
</figure>
<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>
+
+ <para>
<emphasis role="bold">Results</emphasis>
</para>
- <para></para>
+ <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>
<figure id="wb-sql-query-ide-results">
<title>SQL Query IDE - Results</title>
@@ -144,7 +210,10 @@
</mediaobject>
</figure>
- <para></para>
+ <para>
+ Controls are provided to allow you to easily move over the results.
+ These are shown in the following screenshot:
+ </para>
<figure id="wb-sql-query-ide-results-controls">
<title>SQL Query IDE - Results Controls</title>
@@ -159,10 +228,54 @@
</figure>
<para>
+ There are four controls available. The controls from left to right
+ are:
+ </para>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Refresh Data from Data Source</emphasis> -
+ Refreshes the current result set from the data source.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Go to first record</emphasis> - Highlights
+ the first record in the current result set.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Go to last record</emphasis> - Highlights
+ the last record in the current result set.
+ </para>
+ </listitem>
+
+ <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>
+
+ </orderedlist>
+
+ <para>
<emphasis role="bold">Tab Area</emphasis>
</para>
- <para></para>
+ <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>
<figure id="wb-sql-query-ide-tab">
<title>SQL Query IDE - Tab Area</title>
@@ -180,7 +293,10 @@
<emphasis role="bold">Connection Details</emphasis>
</para>
- <para></para>
+ <para>
+ This section provides a summary of the current connection to the
+ server.
+ </para>
<figure id="wb-sql-query-ide-connection">
<title>SQL Query IDE - Connection Details</title>
@@ -198,7 +314,11 @@
<emphasis role="bold">Default Schema Selection</emphasis>
</para>
- <para></para>
+ <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>
<figure id="wb-sql-query-ide-schema">
<title>SQL Query IDE - Default Schema Selection</title>
@@ -217,7 +337,10 @@
<emphasis role="bold">Schema Explorer</emphasis>
</para>
- <para></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>SQL Query IDE - Schema Explorer</title>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r15854 - trunk/workbench | anthony.bedford | 29 Jul |
