svn commit - mysqldoc@docsrva: r23215 - trunk/workbench

[tony.bedford]

Author: tbedford
Date: 2010-10-19 15:08:48 +0200 (Tue, 19 Oct 2010)
New Revision: 23215

Log:
Updated SQL Editor preferences.

Modified:
   trunk/workbench/preferences.xml


Modified: trunk/workbench/preferences.xml
===================================================================
--- trunk/workbench/preferences.xml	2010-10-19 13:02:47 UTC (rev 23214)
+++ trunk/workbench/preferences.xml	2010-10-19 13:08:48 UTC (rev 23215)
Changed blocks: 2, Lines Added: 40, Lines Deleted: 9; 4133 bytes

@@ -356,21 +356,27 @@
         <para>
           <guilabel>Max syntax error count</guilabel> - large complex
           scripts can contain many errors. Further, a syntax error early
-          on can lead to many following syntax errors. For these reasons
-          it is possible to limit the number of errors displayed, the
-          default being 100 error messages.
+          on can lead to many subsequent syntax errors. For these
+          reasons it is possible to limit the number of errors displayed
+          using this option, the default being 100 error messages.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          <guilabel>Progress status update interval</guilabel> -
+          <guilabel>Progress status update interval</guilabel> - When
+          executing long running queries over a slow connection you
+          would need to increase this value, to prevent excess load on
+          the connection.
         </para>
       </listitem>
 
       <listitem>
         <para>
           <guilabel>DBMS connection keep-alive interval</guilabel> -
+          When executing long running queries over a slow connection you
+          would need to increase this value to prevent the connection
+          being lost.
         </para>
       </listitem>
 

@@ -386,32 +392,57 @@
 
       <listitem>
         <para>
-          <guilabel>Limit Rows</guilabel> -
+          <guilabel>Limit Rows</guilabel> - queries can sometimes result
+          in an excessive number of rows being returned as a result.
+          This can heavily load the connection, and take time to display
+          in &workbench;. To prevent this you can set a more moderate
+          value here.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          <guilabel>Limit Rows Count</guilabel> -
+          <guilabel>Limit Rows Count</guilabel> - specify the maximum
+          number of result rows to return.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          <guilabel>Max. Field Value Length to Display</guilabel> -
+          <guilabel>Max. Field Value Length to Display</guilabel> - to
+          avoid display problems due to excessive field length, it is
+          possible to set the maximum field length to display (in
+          bytes).
         </para>
       </listitem>
 
       <listitem>
         <para>
           <guilabel>Treat BINARY/VARBINARY as non-binary character
-          string </guilabel> -
+          string </guilabel> - Binary byte string values are not
+          displayed by default in the results grid, but are instead
+          marked as BLOB values. These can then be viewed or edited with
+          the BLOB editor. Non-binary character string values are
+          displayed in the results grid, and can be edited in the grid
+          cell or using the BLOB editor. Note that if this option is
+          turned on, data truncation may result. This is because binary
+          byte string values may contain null bytes as part of their
+          valid data. For non-binary character strings a null byte
+          terminates the string.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          <guilabel>Enable Data Changes Commit Wizard</guilabel> -
+          <guilabel>Enable Data Changes Commit Wizard</guilabel> - In
+          the SQL Editor, when editing table data and then clicking the
+          <guibutton>Applying changes to data</guibutton> button, a
+          wizard is launched to step you through applying you changes.
+          This gives you a chance to review the SQL that will be applied
+          to the live server to make the requested changes. If the
+          option is deselected, then the changes will simply be applied
+          to the server, without the wizard being displayed, and without
+          a chance to review the changes that will be made.
         </para>
       </listitem>