Author: tbedford
Date: 2009-11-20 18:17:44 +0100 (Fri, 20 Nov 2009)
New Revision: 17750
Log:
Various updates, mostly regarding changes to the SQL Editor toolbar.
Modified:
trunk/workbench/sql-development.xml
Modified: trunk/workbench/sql-development.xml
===================================================================
--- trunk/workbench/sql-development.xml 2009-11-20 16:53:06 UTC (rev 17749)
+++ trunk/workbench/sql-development.xml 2009-11-20 17:17:44 UTC (rev 17750)
Changed blocks: 6, Lines Added: 81, Lines Deleted: 16; 6090 bytes
@@ -100,7 +100,7 @@
<title>Toolbar</title>
<para>
- The toolbar features six buttons, as shown in the folllowing
+ The toolbar features ten buttons, as shown in the following
screenshot:
</para>
@@ -124,38 +124,63 @@
<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
+ <emphasis role="bold">Open a SQL Script File</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.
+ <emphasis role="bold">Save SQL Script to File</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.
+ <emphasis role="bold">Save SQL to Snippets List</emphasis> -
+ SQL code snippets saved here can be given a name. They will
+ appear in the <guilabel>SQL Snippets</guilabel> palette in
+ the SQL Editor sidebar.
</para>
</listitem>
<listitem>
<para>
- <emphasis role="bold">Stop execution</emphasis> - halts
- execution of the currently executing SQL script.
+ <emphasis role="bold">Execute SQL Script in Connected
+ Server</emphasis> - Executes the currently loaded SQL
+ script. Results are displayed in one or more Results tabs.
</para>
</listitem>
<listitem>
<para>
+ <emphasis role="bold">Stop the query being
+ executed</emphasis> - halts execution of the currently
+ executing SQL script. This restarts the connection to the
+ database server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Toggle whether execution of SQL script
+ should continue after failed statements</emphasis> - If the
+ red 'breakpoint' circle is displayed the script will finish
+ on a statement that fails. If the button is depressed so
+ that the green arrow is displayed, then execution will
+ continue past the failed code, possibly generating
+ additional result sets. Any error generated from attempting
+ to execute the faulty statement will be recorded in either
+ case in the Output tabsheet.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
<emphasis role="bold">Commit</emphasis> - commits a
transaction.
</para>
@@ -168,6 +193,30 @@
</para>
</listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Refresh state of database
+ structures</emphasis> - refreshes the view of Schemata,
+ Tables, Views and Routines that appears in the Live Overview
+ Schema tabsheet. For example, if a SQL script creates a new
+ table, it will not appear in the Overview tab until the
+ refresh toolbar button is pressed.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Toggle whether query result tabs
+ should be kept between queries by default</emphasis> -
+ normally when a script is executed any results generated
+ from previous executions of the script are lost, and the new
+ results displayed in the results tab. If this toggle button
+ is pressed, so that the pin appears inserted, results will
+ be retained between executions. Each execution of the script
+ will create a new Results tab containing the result set.
+ </para>
+ </listitem>
+
</orderedlist>
</section>
@@ -254,9 +303,13 @@
<section id="wb-sql-editor-live-schema-tabsheet">
- <title>Live Schema Tabsheet</title>
+ <title>Live Schema Overview Tabsheet</title>
- <para></para>
+ <para>
+ This tabsheet provides an overview of the schema. The schema
+ objects Tables, Views and Routines are displayed for the
+ current schema.
+ </para>
</section>
@@ -264,7 +317,13 @@
<title>Output Tabsheet</title>
- <para></para>
+ <para>
+ The Output tabsheet displays a summary of the communication
+ between the script and the server. The messages displayed can
+ be information or errors. Each message displays the time, the
+ action that was carried out, and the response from the server.
+ This is useful for troubleshooting scripts.
+ </para>
</section>
@@ -272,7 +331,13 @@
<title>History Tabsheet</title>
- <para></para>
+ <para>
+ The History tabsheet provides a history of SQL operations
+ carried out. Both the time of the SQL operation and the SQL
+ code itself is recorded. To view the SQL executed clisk on the
+ time, and the SQL code executed will be displayed in the
+ <guilabel>SQL</guilabel> column.
+ </para>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r17750 - trunk/workbench | anthony.bedford | 20 Nov |
