Below is the list of changes that have just been committed into a local
mysqldoc repository of MHillyer. When MHillyer does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://www.mysql.com/doc/I/n/Installing_source_tree.html
ChangeSet
1.1921 04/08/05 13:53:56 MHillyer@doomhammer. +10 -0
Changes to the document, restored images to the BK tree.
BitKeeper/etc/logging_ok
1.57 04/08/05 13:53:51 MHillyer@doomhammer. +1 -0
Logging to logging@stripped accepted
Docs/mysql-query-browser-images/twosakilas.png
1.1 04/08/05 13:53:33 MHillyer@doomhammer. +164 -0
Docs/mysql-query-browser-images/tabletool.png
1.1 04/08/05 13:53:33 MHillyer@doomhammer. +87 -0
Docs/mysql-query-browser-images/schematabrowser.png
1.1 04/08/05 13:53:33 MHillyer@doomhammer. +170 -0
Docs/mysql-query-browser-images/twosakilas.png
1.0 04/08/05 13:53:33 MHillyer@doomhammer. +0 -0
BitKeeper file C:/cygwin/home/MHillyer/mysqldoc/Docs/mysql-query-browser-images/twosakilas.png
Docs/mysql-query-browser-images/tabletool.png
1.0 04/08/05 13:53:33 MHillyer@doomhammer. +0 -0
BitKeeper file C:/cygwin/home/MHillyer/mysqldoc/Docs/mysql-query-browser-images/tabletool.png
Docs/mysql-query-browser-images/schematabrowser.png
1.0 04/08/05 13:53:33 MHillyer@doomhammer. +0 -0
BitKeeper file C:/cygwin/home/MHillyer/mysqldoc/Docs/mysql-query-browser-images/schematabrowser.png
Docs/mysql-query-browser-images/querybar.png
1.1 04/08/05 13:53:32 MHillyer@doomhammer. +374 -0
Docs/mysql-query-browser-images/mainscreen.png
1.1 04/08/05 13:53:32 MHillyer@doomhammer. +1231 -0
Docs/mysql-query-browser-images/connection.png
1.1 04/08/05 13:53:32 MHillyer@doomhammer. +407 -0
Docs/mysql-query-browser-images/buttonbar.png
1.1 04/08/05 13:53:32 MHillyer@doomhammer. +232 -0
Docs/mysql-query-browser-images/Thumbs.db
1.1 04/08/05 13:53:32 MHillyer@doomhammer. +513 -0
Docs/query-browser-en.xml
1.7 04/08/05 13:53:32 MHillyer@doomhammer. +1056 -612
Changes to some tag usage, addition of content to using section, reformatted with Stefan's .m script.
Docs/mysql-query-browser-images/querybar.png
1.0 04/08/05 13:53:32 MHillyer@doomhammer. +0 -0
BitKeeper file C:/cygwin/home/MHillyer/mysqldoc/Docs/mysql-query-browser-images/querybar.png
Docs/mysql-query-browser-images/mainscreen.png
1.0 04/08/05 13:53:32 MHillyer@doomhammer. +0 -0
BitKeeper file C:/cygwin/home/MHillyer/mysqldoc/Docs/mysql-query-browser-images/mainscreen.png
Docs/mysql-query-browser-images/connection.png
1.0 04/08/05 13:53:32 MHillyer@doomhammer. +0 -0
BitKeeper file C:/cygwin/home/MHillyer/mysqldoc/Docs/mysql-query-browser-images/connection.png
Docs/mysql-query-browser-images/buttonbar.png
1.0 04/08/05 13:53:32 MHillyer@doomhammer. +0 -0
BitKeeper file C:/cygwin/home/MHillyer/mysqldoc/Docs/mysql-query-browser-images/buttonbar.png
Docs/mysql-query-browser-images/Thumbs.db
1.0 04/08/05 13:53:32 MHillyer@doomhammer. +0 -0
BitKeeper file C:/cygwin/home/MHillyer/mysqldoc/Docs/mysql-query-browser-images/Thumbs.db
# This is a BitKeeper patch. What follows are the unified diffs for the
# set of deltas contained in the patch. The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User: MHillyer
# Host: doomhammer.
# Root: C:/cygwin/home/MHillyer/mysqldoc
--- 1.6/Docs/query-browser-en.xml 2004-07-29 12:31:14 -06:00
+++ 1.7/Docs/query-browser-en.xml 2004-08-05 13:53:32 -06:00
@@ -2,639 +2,1083 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<book id="mysql-query-browser" lang="en">
- <title>MySQL Query Browser</title>
- <chapter id="mysql-query-browser-introduction">
- <title>Introduction to the MySQL Query Browser</title>
- <para>The MySQL Query Browser is a graphical tool provided by MySQL
-AB for creating, executing, and optimizing queries in a graphical
-environment. Where the <ulink
-url="http://www.mysql.com/products/administrator/">MySQL
-Administrator</ulink> is designed with database administration in
-mind, the MySQL Query Browser is designed to help you query the data
-stored within MySQL.</para>
-
- <para>While all queries executed in the MySQL Query Browser could
-also be performed in the <command>mysql</command> command-line
-utility, the MySQL Query Browser allows for the querying and editing
-of data in a more intuitive, graphical manner.</para>
-
- <para>MySQL Query Browser is designed to work with MySQL versions
-4.0 and higher. <remark>[MH] VERIFY THIS FOR QB</remark></para>
-
- <para><remark>[MH] REMOVE PARA WHEN QB GOES BETA.</remark>
-<emphasis>MySQL Query Browser is Alpha software. As such, you should
-be wary of using it in production environment as it has only been
-tested on a limited number of systems to date. You should backup all
-important data before using the MySQL Query Browser. If you find
-it's lacking some feature important to you, or if you discover a
-bug, please use our <ulink url="http://bugs.mysql.com">MySQL Bug
-System</ulink> to request features or report
-problems.</emphasis></para>
- </chapter> <!-- END INTRODUCTION -->
-
- <chapter id="mysql-query-browser-installation">
- <title>Installing MySQL Query Browser</title>
- <sect1 id="mysql-query-browser-installation-introduction">
- <title>Introduction</title>
- <para>The MySQL Query Browser is available for both Windows and
-Linux, in source and binary forms. MySQL Query Browser can be
-downloaded from <ulink
-url="http://dev.mysql.com/downloads/query-browser/">The MySQL web
-site.</ulink></para>
- </sect1> <!-- END INSTALLATION INTRODUCTION -->
- </chapter> <!-- END INSTALLATION CHAPTER -->
- <chapter id="mysql-query-browser-starting">
- <!-- I AM LIFTING THIS SECTION FROM THE ADMINISTRATOR MANUAL AND
+ <title>
+ MySQL Query Browser
+ </title>
+
+ <bookinfo>
+
+ <title>
+ MySQL Query Browser
+ </title>
+
+ <copyright>
+
+ <year>2004</year>
+
+ <holder>MySQL AB</holder>
+
+ </copyright>
+
+ <legalnotice>
+
+ <para>
+ This manual is NOT distributed under a GPL style license. Use of the
+ manual is subject to the following terms:
+
+ <itemizedlist>
+
+ <listitem><para>
+ Conversion to other formats is allowed, but the actual content may
+ not be altered or edited in any way.
+ </para></listitem>
+
+ <listitem><para>
+ You may create a printed copy for your own personal use.
+ </para></listitem>
+
+ <listitem><para>
+ For all other uses, such as selling printed copies or using (parts
+ of) the manual in another publication, prior written agreement
+ from MySQL AB is required.
+ </para></listitem>
+
+ </itemizedlist>
+
+ Please email docs@stripped for more information or if you are
+ interested in doing a translation.
+ </para>
+
+ </legalnotice>
+
+ </bookinfo>
+
+ <chapter id="mysql-query-browser-introduction">
+
+ <title>
+ Introduction to the MySQL Query Browser
+ </title>
+
+ <para>
+ The MySQL Query Browser is a graphical tool provided by MySQL AB for
+ creating, executing, and optimizing queries in a graphical
+ environment. Where the
+ <ulink
+url="http://www.mysql.com/products/administrator/">MySQL
+ Administrator</ulink> is designed with database administration in
+ mind, the MySQL Query Browser is designed to help you query the data
+ stored within MySQL.
+ </para>
+
+ <para>
+ While all queries executed in the MySQL Query Browser could also be
+ performed in the <command>mysql</command> command-line utility, the
+ MySQL Query Browser allows for the querying and editing of data in a
+ more intuitive, graphical manner.
+ </para>
+
+ <para>
+ MySQL Query Browser is designed to work with MySQL versions 4.0 and
+ higher.
+
+ <remark>
+ [MH] VERIFY THIS FOR QB
+ </remark>
+ </para>
+
+ <para>
+ <remark>
+ [MH] REMOVE PARA WHEN QB GOES BETA.
+ </remark>
+
+ <emphasis>MySQL Query Browser is Alpha software. As such, you should
+ be wary of using it in production environment as it has only been
+ tested on a limited number of systems to date. You should backup all
+ important data before using the MySQL Query Browser. If you find it's
+ lacking some feature important to you, or if you discover a bug,
+ please use our <ulink url="http://bugs.mysql.com">MySQL Bug
+ System</ulink> to request features or report problems.</emphasis>
+ </para>
+
+ </chapter>
+
+<!-- END INTRODUCTION -->
+
+ <chapter id="mysql-query-browser-installation">
+
+ <title>
+ Installing MySQL Query Browser
+ </title>
+
+ <sect1 id="mysql-query-browser-installation-introduction">
+
+ <title>
+ Introduction
+ </title>
+
+ <para>
+ The MySQL Query Browser is available for both Windows and Linux, in
+ source and binary forms. MySQL Query Browser can be downloaded from
+ <ulink
+url="http://dev.mysql.com/downloads/query-browser/">The
+ MySQL web site.</ulink>
+ </para>
+
+ </sect1>
+
+<!-- END INSTALLATION INTRODUCTION -->
+
+ </chapter>
+
+<!-- END INSTALLATION CHAPTER -->
+
+ <chapter id="mysql-query-browser-starting">
+
+<!-- I AM LIFTING THIS SECTION FROM THE ADMINISTRATOR MANUAL AND
MODIFYING IT TO APPLY TO THE QB -->
- <title>Starting MySQL Query Browser</title>
- <sect1 id="mysql-query-browser-starting-introduction">
- <title>Introduction</title>
- <para>The way you start MySQL Query Browser depends on the
-operating system you are using:
- <itemizedlist>
- <listitem>
- <para>On Windows, start MySQL Query Browser by
-double-clicking its desktop icon, or by selecting its item
-from the <literal>Start</literal> menu. Alternatively, you
-can open a DOS window and start it from the command line:
+
+ <title>
+ Starting MySQL Query Browser
+ </title>
+
+ <sect1 id="mysql-query-browser-starting-introduction">
+
+ <title>
+ Introduction
+ </title>
+
+ <para>
+ The way you start MySQL Query Browser depends on the operating
+ system you are using:
+
+ <itemizedlist>
+
+ <listitem><para>
+ On Windows, start MySQL Query Browser by double-clicking its
+ desktop icon, or by selecting its item from the
+ <literal>Start</literal> menu. Alternatively, you can open a DOS
+ window and start it from the command line:
+
<programlisting>
c:\>
c:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\GUITools\MySQLQuery
Browser.exe
- </programlisting> The
-<replaceable>%PROGRAMFILES%</replaceable> is the default
- directory for programs on your machine, for example
-<literal>c:\program files</literal> or
-<literal>c:\programme</literal>. If your path contains
-spaces, you should enclose the command within quote
-characters. For example:
-
- <programlisting>
+ </programlisting>
+
+ The <replaceable>%PROGRAMFILES%</replaceable> is the default
+ directory for programs on your machine, for example
+ <literal>c:\program files</literal> or
+ <literal>c:\programme</literal>. If your path contains spaces, you
+ should enclose the command within quote characters. For example:
+
+<programlisting>
c:\> "c:\program
files\MySQL\GUITools\MySQLQueryBrowser.exe"
- </programlisting></para>
- </listitem>
+ </programlisting>
+ </para></listitem>
- <listitem>
- <para>On Linux desktops, start MySQL Query Browser by
-changing directory into
-<literal>/opt/mysql-query-browser/bin</literal>, and then
-running <literal>mysql-query-browser</literal>.</para>
- </listitem>
-
- <!-- ADD STARTING PROCEDURE FOR MAC OS -->
- </itemizedlist></para>
- </sect1>
-
- <!-- END INTRODUCTION -->
- <sect1 id="mysql-query-browser-starting-connection">
- <title>Connection Dialog</title>
-
- <para>Once MySQL Query Browser has been started, it displays a
-connection dialog. You have to specify the MySQL server to which
-you would like to connect, the credentials needed for
-authorization on that server, which machine that server runs on
-(and which port it listens to), and the default schema you will be
-querying from. You may also specify a number of other options, if
-required.</para>
-
- <para><emphasis>You must choose a default schema in order to issue
-queries.</emphasis> It is possible to choose a schema after
-connecting to the server, but setting the default from the
-connection dialog can save time on subsequent connections.</para>
-
- <figure>
- <title>Connection dialog</title>
- <graphic fileref="mysql-query-browser-images/connection.png"
+ <listitem><para>
+ On Linux desktops, start MySQL Query Browser by changing directory
+ into <literal>/opt/mysql-query-browser/bin</literal>, and then
+ running <literal>mysql-query-browser</literal>.
+ </para></listitem>
+
+<!-- ADD STARTING PROCEDURE FOR MAC OS -->
+
+ </itemizedlist>
+ </para>
+
+ </sect1>
+
+<!-- END INTRODUCTION -->
+
+ <sect1 id="mysql-query-browser-starting-connection">
+
+ <title>
+ Connection Dialog
+ </title>
+
+ <para>
+ Once MySQL Query Browser has been started, it displays a connection
+ dialog. You have to specify the MySQL server to which you would like
+ to connect, the credentials needed for authorization on that server,
+ which machine that server runs on (and which port it listens to),
+ and the default schema you will be querying from. You may also
+ specify a number of other options, if required.
+ </para>
+
+ <para>
+ <emphasis>You must choose a default schema in order to issue
+ queries.</emphasis> It is possible to choose a schema after
+ connecting to the server, but setting the default from the
+ connection dialog can save time on subsequent connections.
+ </para>
+
+ <figure>
+ <title>
+ Connection dialog
+ </title>
+ <graphic fileref="mysql-query-browser-images/connection.png"
format="PNG" lang="en" />
- </figure>
+ </figure>
- <para>If the server connection is successfully established, all of
-the values filled in the fields of the connection dialog will be
-saved for future connections (see the section that describes <link
-linkend="mysql-query-browser-appendix-store-connections">how MySQL
-Query Browser stores connection information</link>). The
-<literal>Password</literal> field, however, will always be empty:
-For security reasons, the password is not stored along with the
-other options, unless you explicitly specify otherwise in the
-<link
-linkend="mysql-query-browser-starting-options-general-options">Gen
-eral Options section of the Options dialog</link>.</para>
-
- <para>You can change any of the values in the connection profiles
-just by overwriting the existing values with new ones. Similarly,
-if you select another connection profile, you can change any of
-its values. When you click the <guibutton>OK</guibutton> button
-after changing a profile's values, the changes are stored
-permanently if a successful connection to the MySQL server is
-established. However, the preferred method for changing a profile
-is to click the <guibutton>...</guibutton> button next to the
-<guilabel>Connection</guilabel> drop-down box. This brings up an
-<literal>Options</literal> dialog window that has a
-<literal>Connections</literal> section for modifying connection
-profiles. You can find the values you can set in the Connection
-dialog window in the description of the
-<literal>Connections</literal> section of the
-<literal>Options</literal> dialog (see <link
-linkend="mysql-query-browser-starting-options-connections">Options
-dialog</link>).</para>
- </sect1> <!-- END CONNECTION DIALOG -->
- </chapter>
-
- <chapter id="mysql-query-browser-tour">
- <title>A Tour of the MySQL Query Browser</title>
- <sect1 id="mysql-query-browser-tour-mainwindow">
- <title>The Main Query Window</title>
- <para>Once you successfully connect to a MySQL server you will be
-presented with the main window of the MySQL Query Browser. Most of
-your time spent using the MySQL Query Browser will be spent in
-this main window as almost all of the application's functionality
-is accessed in this window.</para>
-
- <figure>
- <title>The MySQL Query Browser Main Window</title>
- <graphic fileref="mysql-query-browser-images/mainscreen.png"
+ <para>
+ If the server connection is successfully established, all of the
+ values filled in the fields of the connection dialog will be saved
+ for future connections (see the section that describes
+ <link
+linkend="">how MySQL Query Browser stores connection
+ information</link>). The <literal>Password</literal> field, however,
+ will always be empty: For security reasons, the password is not
+ stored along with the other options, unless you explicitly specify
+ otherwise in the <link
+linkend="">Gen eral Options section of the
+ Options dialog</link>.
+ </para>
+
+ <para>
+ You can change any of the values in the connection profiles just by
+ overwriting the existing values with new ones. Similarly, if you
+ select another connection profile, you can change any of its values.
+ When you click the <guibutton>OK</guibutton> button after changing a
+ profile's values, the changes are stored permanently if a successful
+ connection to the MySQL server is established. However, the
+ preferred method for changing a profile is to click the
+ <guibutton>...</guibutton> button next to the
+ <guilabel>Connection</guilabel> drop-down box. This brings up an
+ <literal>Options</literal> dialog window that has a
+ <literal>Connections</literal> section for modifying connection
+ profiles. You can find the values you can set in the Connection
+ dialog window in the description of the
+ <literal>Connections</literal> section of the
+ <literal>Options</literal> dialog (see <link
+linkend="">Options
+ dialog</link>).
+ </para>
+
+ </sect1>
+
+<!-- END CONNECTION DIALOG -->
+
+ </chapter>
+
+ <chapter id="mysql-query-browser-tour">
+
+ <title>
+ A Tour of the MySQL Query Browser
+ </title>
+
+ <sect1 id="mysql-query-browser-tour-mainwindow">
+
+ <title>
+ The Main Query Window
+ </title>
+
+ <para>
+ Once you successfully connect to a MySQL server you will be
+ presented with the main window of the MySQL Query Browser. Most of
+ your time spent using the MySQL Query Browser will be spent in this
+ main window as almost all of the application's functionality is
+ accessed in this window.
+ </para>
+
+ <figure>
+ <title>
+ The MySQL Query Browser Main Window
+ </title>
+ <graphic fileref="mysql-query-browser-images/mainscreen.png"
lang="en" format="PNG"/>
- </figure>
+ </figure>
- <para>The main query window is divided up into several sections:
- <itemizedlist>
- <listitem><para><emphasis>Query Bar:</emphasis> The query bar
-is where you create and execute your queries. It is composed
-of three navigation buttons (Go Back, Next, Refresh), the
-query area, two action buttons (Execute and Stop), and a
-status indicator.</para></listitem>
-
- <listitem><para><emphasis>Button Bar:</emphasis> The button
-bar contains three sets of buttons: the Transaction Buttons
-(Start, Commit, Rollback), the query management buttons
-(Explain, Compare), and the query building buttons (Select,
-From, Where, etc.)</para></listitem>
-
- <listitem><para><emphasis>Tabsheets:</emphasis> All query
-results will be displayed in the tabsheets. You can have
-multiple tabsheets active at one time, allowing you to work on
-multiple queries. Tabsheets can be split vertically and
-horizontally for performing comparisons, and queries in
-different parts of a split tabsheet can be joined together for
-master-detail analysis.</para></listitem>
-
- <listitem><para><emphasis>Object Browser:</emphasis> The
-object browser allows you to manage your schema, bookmarks,
-and history. You can choose which database and tables to
-query, add commonly-used queries to a collection of bookmarks,
-and browse through previously issued queries to use them
-again.</para></listitem>
-
- <listitem><para><emphasis>Parameter and Function
-Browser:</emphasis> The parameter and function browser is used
-to quickly add built-in functions to your query, and to manage
-queries that depend on external variables. One example of this
-is when establishing a master-detail pair of queries. The data
-in the master query is available as parameters to the detail
-query.</para></listitem>
- </itemizedlist></para>
-
- <para>Each of these sections will be covered in more detail in the
-sections that follow.</para>
- </sect1> <!-- END MAIN QUERY WINDOW SECTION -->
-
- <sect1 id="mysql-query-browser-tour-querybar">
- <title>The Query Bar</title>
- <para>All queries, whether generated automatically, graphically,
-or by hand, will appear in the query bar. The simplest way to use
-the MySQL Query Browser is to type a query into the query area and
-click the execute button.</para>
-
- <sect2 id="mysql-query-browser-tour-querybar-navigation">
- <title>The Navigation Buttons</title>
- <para>To the left of the query area are the navigation buttons.
-The navigation buttons allow you to browse through your query
-history so that you can review and re-execute a previously
-executed query. The query history is available through the
-object browser. <remark>[MH] LINK TO IT WHEN SECTION IS
-COMPLETE!</remark></para>
-
- <para>Clicking the <guibutton>Go Back</guibutton> button will
-move you to the previous query in your history, while the
-<guibutton>Next</guibutton> button will move you to the
-following query. <emphasis>Note:</emphasis> Only queries that
-execute without errors are added to your history.</para>
-
- <para>As you navigate with the <guibutton>Next</guibutton> and
-<guibutton>Go Back</guibutton> buttons the queries you navigate
-through will not be executed unless you explicitly execute them
-by clicking the <guibutton>Execute</guibutton> button. The
-<guibutton>Refresh</guibutton> button will re-execute the last
-executed query, which may or may not be the current query in the
-query area.</para>
- </sect2> <!-- END NAVIGATION BUTTONS -->
-
- <sect2 id="mysql-query-browser-tour-querybar-queryarea">
- <title>The Query Area</title>
- <para>The query area is where the text of all queries and
-statements will be displayed. The query is three lines tall by
-default and will automatically expand to a maximum of ten lines
-in height, after which it will be scrollable for longer queries
-(See figure below).</para>
-
- <figure>
- <title>The query area expanded to ten lines</title>
- <graphic fileref="mysql-query-browser-images/querybar.png"
+ <para>
+ The main query window is divided up into several sections:
+
+ <itemizedlist>
+
+ <listitem><para>
+ <emphasis>Query Bar:</emphasis> The query bar is where you create
+ and execute your queries. It is composed of three navigation
+ buttons (Go Back, Next, Refresh), the query area, two action
+ buttons (Execute and Stop), and a status indicator.
+ </para></listitem>
+
+ <listitem><para>
+ <emphasis>Button Bar:</emphasis> The button bar contains three
+ sets of buttons: the Transaction Buttons (Start, Commit,
+ Rollback), the query management buttons (Explain, Compare), and
+ the query building buttons (Select, From, Where, etc.)
+ </para></listitem>
+
+ <listitem><para>
+ <emphasis>Tabsheets:</emphasis> All query results will be
+ displayed in the tabsheets. You can have multiple tabsheets active
+ at one time, allowing you to work on multiple queries. Tabsheets
+ can be split vertically and horizontally for performing
+ comparisons, and queries in different parts of a split tabsheet
+ can be joined together for master-detail analysis.
+ </para></listitem>
+
+ <listitem><para>
+ <emphasis>Object Browser:</emphasis> The object browser allows you
+ to manage your schema, bookmarks, and history. You can choose
+ which database and tables to query, add commonly-used queries to a
+ collection of bookmarks, and browse through previously issued
+ queries to use them again.
+ </para></listitem>
+
+ <listitem><para>
+ <emphasis>Parameter and Function Browser:</emphasis> The parameter
+ and function browser is used to quickly add built-in functions to
+ your query, and to manage queries that depend on external
+ variables. One example of this is when establishing a
+ master-detail pair of queries. The data in the master query is
+ available as parameters to the detail query.
+ </para></listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ Each of these sections will be covered in more detail in the
+ sections that follow.
+ </para>
+
+ </sect1>
+
+<!-- END MAIN QUERY WINDOW SECTION -->
+
+ <sect1 id="mysql-query-browser-tour-querybar">
+
+ <title>
+ The Query Bar
+ </title>
+
+ <para>
+ All queries, whether generated automatically, graphically, or by
+ hand, will appear in the query bar. The simplest way to use the
+ MySQL Query Browser is to type a query into the query area and click
+ the execute button.
+ </para>
+
+ <sect2 id="mysql-query-browser-tour-querybar-navigation">
+
+ <title>
+ The Navigation Buttons
+ </title>
+
+ <para>
+ To the left of the query area are the navigation buttons. The
+ navigation buttons allow you to browse through your query history
+ so that you can review and re-execute a previously executed query.
+ The query history is available through the object browser.
+
+ <remark>
+ [MH] LINK TO IT WHEN SECTION IS COMPLETE!
+ </remark>
+ </para>
+
+ <para>
+ Clicking the <guibutton>Go Back</guibutton> button will move you to
+ the previous query in your history, while the
+ <guibutton>Next</guibutton> button will move you to the following
+ query. <emphasis>Note:</emphasis> Only queries that execute without
+ errors are added to your history.
+ </para>
+
+ <para>
+ As you navigate with the <guibutton>Next</guibutton> and
+ <guibutton>Go Back</guibutton> buttons the queries you navigate
+ through will not be executed unless you explicitly execute them by
+ clicking the <guibutton>Execute</guibutton> button. The
+ <guibutton>Refresh</guibutton> button will re-execute the last
+ executed query, which may or may not be the current query in the
+ query area.
+ </para>
+
+ </sect2>
+
+<!-- END NAVIGATION BUTTONS -->
+
+ <sect2 id="mysql-query-browser-tour-querybar-queryarea">
+
+ <title>
+ The Query Area
+ </title>
+
+ <para>
+ The query area is where the text of all queries and statements will
+ be displayed. The query is three lines tall by default and will
+ automatically expand to a maximum of ten lines in height, after
+ which it will be scrollable for longer queries (See figure below).
+ </para>
+
+ <figure>
+ <title>
+ The query area expanded to ten lines
+ </title>
+ <graphic fileref="mysql-query-browser-images/querybar.png"
lang="en" format="PNG"/>
- </figure>
+ </figure>
- <para>The following commands are available by right-clicking the
-query area: <literal>Cut</literal>
-<keycap>Ctrl</keycap>+<keycap>X</keycap>),
-<literal>Copy</literal>
-(<keycap>Ctrl</keycap>+<keycap>C</keycap>),
-<literal>Paste</literal>
-(<keycap>Ctrl</keycap>+<keycap>V</keycap>),
-<literal>Clear</literal>
-(<keycap>Ctrl</keycap>+<keycap>N</keycap>), <literal>Open SQL
-From File</literal> (<keycap>Ctrl</keycap>+<keycap>O</keycap>),
-and <literal>Save SQL To File</literal>
-(<keycap>Ctrl</keycap>+<keycap>S</keycap>). The Open and Save
-commands will open a SQL file into the query area or save the
-contents of the query area into a text file.</para>
- </sect2> <!-- END QUERY AREA -->
-
- <sect2 id="mysql-query-browser-tour-querybar-actionbuttons">
- <title>The Action Buttons</title>
- <para>To the right of the query area are the action buttons. The
-<guibutton>Execute</guibutton> button will execute any queries
-in the query area, while the <guibutton>Stop</guibutton> button
-will cease execution.</para>
-
- <para>If you click the down-arrow below the
-<guibutton>Execute</guibutton> button, you will see that there
-are three potential execution options:</para>
-
- <itemizedlist>
- <listitem><para><literal>Execute</literal>
-(<keycap>Ctrl</keycap>+<keycap>Return</keycap>): This will
-execute the query and display the results in the currently
-active tabsheet.</para></listitem>
-
- <listitem><para><literal>Execute in new Tab</literal>
-(<keycap>Ctrl</keycap>+<keycap>Shift</keycap>+<keycap>Return
-</keycap>): This will execute the query and display the
-results in a newly created tabsheet.</para></listitem>
-
- <listitem><para><literal>Split Tab and Execute</literal>
-(<keycap>Ctrl</keycap>+<keycap>Alt</keycap>+<keycap>Return
-</keycap>): This will split the tabsheet horizontally and then
-display the query results in the lower half of the
-tabsheet.</para></listitem>
- </itemizedlist>
-
- <para>To the right of the action buttons is the status
-indicator. The status indicator will show the standard MySQL
-logo when the MySQL Query Browser is idle, and will display an
-animated MySQL logo when the MySQL Query Browser is busy
-processing a query. Both icons can be seen in the following
-illustration:</para>
-
- <figure>
- <title>The MySQL Query Browser Status Icons</title>
- <graphic fileref="mysql-query-browser-images/twosakilas.png"
+ <para>
+ The following commands are available by right-clicking the query
+ area: <literal>Cut</literal>
+ <keycap>Ctrl</keycap>+<keycap>X</keycap>), <literal>Copy</literal>
+ (<keycap>Ctrl</keycap>+<keycap>C</keycap>),
+ <literal>Paste</literal>
+ (<keycap>Ctrl</keycap>+<keycap>V</keycap>),
+ <literal>Clear</literal>
+ (<keycap>Ctrl</keycap>+<keycap>N</keycap>), <literal>Open SQL From
+ File</literal> (<keycap>Ctrl</keycap>+<keycap>O</keycap>), and
+ <literal>Save SQL To File</literal>
+ (<keycap>Ctrl</keycap>+<keycap>S</keycap>). The Open and Save
+ commands will open a SQL file into the query area or save the
+ contents of the query area into a text file.
+ </para>
+
+ </sect2>
+
+<!-- END QUERY AREA -->
+
+ <sect2 id="mysql-query-browser-tour-querybar-actionbuttons">
+
+ <title>
+ The Action Buttons
+ </title>
+
+ <para>
+ To the right of the query area are the action buttons. The
+ <guibutton>Execute</guibutton> button will execute any queries in
+ the query area, while the <guibutton>Stop</guibutton> button will
+ cease execution.
+ </para>
+
+ <para>
+ If you click the down-arrow below the
+ <guibutton>Execute</guibutton> button, you will see that there are
+ three potential execution options:
+ </para>
+
+ <itemizedlist>
+
+ <listitem><para>
+ <literal>Execute</literal>
+ (<keycap>Ctrl</keycap>+<keycap>Return</keycap>): This will execute
+ the query and display the results in the currently active
+ tabsheet.
+ </para></listitem>
+
+ <listitem><para>
+ <literal>Execute in new Tab</literal>
+ (<keycap>Ctrl</keycap>+<keycap>Shift</keycap>+<keycap>Return
+ </keycap>): This will execute the query and display the results in
+ a newly created tabsheet.
+ </para></listitem>
+
+ <listitem><para>
+ <literal>Split Tab and Execute</literal>
+ (<keycap>Ctrl</keycap>+<keycap>Alt</keycap>+<keycap>Return
+ </keycap>): This will split the tabsheet horizontally and then
+ display the query results in the lower half of the tabsheet.
+ </para></listitem>
+
+ </itemizedlist>
+
+ <para>
+ To the right of the action buttons is the status indicator. The
+ status indicator will show the standard MySQL logo when the MySQL
+ Query Browser is idle, and will display an animated MySQL logo when
+ the MySQL Query Browser is busy processing a query. Both icons can
+ be seen in the following illustration:
+ </para>
+
+ <figure>
+ <title>
+ The MySQL Query Browser Status Icons
+ </title>
+ <graphic fileref="mysql-query-browser-images/twosakilas.png"
lang="en" format="PNG"/>
- </figure>
- </sect2> <!-- END ACTION BUTTONS SECTION-->
- </sect1> <!-- END QUERY BAR SECTION -->
-
- <sect1 id="mysql-query-browser-tour-buttonbar">
- <title>The Button Bar</title>
- <para>Below the query bar is the button bar. The button bar
-contains a series of buttons for transaction control, query
-management, and query building.</para>
-
- <figure>
- <title>The Button Bar</title>
- <graphic fileref="mysql-query-browser-images/buttonbar.png"
+ </figure>
+
+ </sect2>
+
+<!-- END ACTION BUTTONS SECTION-->
+
+ </sect1>
+
+<!-- END QUERY BAR SECTION -->
+
+ <sect1 id="mysql-query-browser-tour-buttonbar">
+
+ <title>
+ The Button Bar
+ </title>
+
+ <para>
+ Below the query bar is the button bar. The button bar contains a
+ series of buttons for transaction control, query management, and
+ query building.
+ </para>
+
+ <figure>
+ <title>
+ The Button Bar
+ </title>
+ <graphic fileref="mysql-query-browser-images/buttonbar.png"
lang="en" format="PNG"/>
- </figure>
+ </figure>
- <para>The left panel of the button bar contains the transaction
-control buttons. From left to right, the buttons allow you to
-begin, commit, and rollback a transaction. As when using the
-command-line client, you can only use transactions with table
-handlers that support them (InnoDB for example).</para>
-<remark>[MH] ADD A LINK TO TRANSACTIONS IN THE REFERENCE
-MANUAL.</remark>
-
- <para>The center panel provides buttons for query management. The
-<guibutton>Explain</guibutton> button can be used to get the
-<literal>EXPLAIN</literal> output for the current query from the
-MySQL server, while the <literal>Compare</literal> button will
-allow you to compare the results of two queries
-graphically.</para>
-
- <para>The right panel contains the query building buttons. These
-buttons can be used to graphically build a query by clicking on
-the desired tables and fields that you wish to involve in your
-query, using specialized pointers to indicate which part of the
-query the different fields and tables will occupy.</para>
- </sect1> <!-- END BUTTON BAR SECTION -->
-
- <sect1 id="mysql-query-browser-tour-tabsheet">
- <title>The Tabsheet Area</title>
- <para>The tabsheet area is where all query results will be
-displayed. Within the tabsheet area you can have multiple
-tabsheets, and individual tabsheets can be split either vertically
-or horizontally. New tabs can be created by either choosing the
-<literal>Execute in new Tab</literal> option on the query bar, or
-by clicking the <guibutton>New Tab</guibutton> button at the top
-of the tabsheet area. In addition you can also right-click on the
-current tabsheet and choose the <literal>Add new Tabsheet
-(Ctrl+T)</literal> option.</para>
-
- <para>To split a tabsheet, right-click on the tabsheet and choose
-either the <literal>Split Tab vertically</literal> or the
-<literal>Split Tab horizontally</literal> option. After splitting
-the tabsheet you can then click one half of the tabsheet and
-execute queries within it. You can remove sections of the tabsheet
-by right-clicking on the section you wish to remove and clicking
-<literal>Remove Resultset</literal>.</para>
-
- <para>The tabsheet can be used to review and edit the results of a
-query, with editing permitted as long as the query is based on a
-single table and provides sufficient key information to uniquely
-identify rows. <remark>[MH] RESULTSETS BASED ON JOINS WILL
-EVENTUALLY BE EDITABLE, UPDATE THIS WHEN IT IS CHANGED!</remark>To
-edit the contents of the tabsheet you must enable edit mode
-through the use of the <guibutton>Edit</guibutton> button at the
-bottom of the tabsheet. Any edits you make are not immediately
-applied, but instead you will need to click the <guibutton>Apply
-Changes</guibutton> button next to the <guibutton>Edit</guibutton>
-button. The <guibutton>Discard Changes</guibutton> button will
-throw away any changes you have made to the data.</para>
- </sect1> <!-- END TABSHEET SECTION -->
-
- <sect1 id="mysql-query-browser-tour-objectbrowser">
- <title>The Object Browser</title>
- <para>The object browser allows you to browse your server's
-schemata, your bookmarks, and your query history.</para>
-
- <sect2 id="mysql-query-browser-tour-objectbrowser-schemata">
- <title>The Schemata Browser</title>
- <para>The schemata browser is where you will probably spend most
-of your time within the object browser. You can use the schema
-browser to not only select tables and fields to query, you can
-also edit tables, create new tables and schemas, and drop tables
-and schemas. The schema browser is also one of the places where
-you can set the default schema, which is a required action
-before you can start issuing queries.</para>
-
- <figure>
- <title>The Schemata Browser</title>
- <graphic
+ <para>
+ The left panel of the button bar contains the transaction control
+ buttons. From left to right, the buttons allow you to begin, commit,
+ and rollback a transaction. As when using the command-line client,
+ you can only use transactions with table handlers that support them
+ (InnoDB for example).
+ </para>
+
+ <remark>
+ [MH] ADD A LINK TO TRANSACTIONS IN THE REFERENCE MANUAL.
+ </remark>
+
+ <para>
+ The center panel provides buttons for query management. The
+ <guibutton>Explain</guibutton> button can be used to get the
+ <literal>EXPLAIN</literal> output for the current query from the
+ MySQL server, while the <literal>Compare</literal> button will allow
+ you to compare the results of two queries graphically.
+ </para>
+
+ <para>
+ The right panel contains the query building buttons. These buttons
+ can be used to graphically build a query by clicking on the desired
+ tables and fields that you wish to involve in your query, using
+ specialized pointers to indicate which part of the query the
+ different fields and tables will occupy.
+ </para>
+
+ </sect1>
+
+<!-- END BUTTON BAR SECTION -->
+
+ <sect1 id="mysql-query-browser-tour-tabsheet">
+
+ <title>
+ The Tabsheet Area
+ </title>
+
+ <para>
+ The tabsheet area is where all query results will be displayed.
+ Within the tabsheet area you can have multiple tabsheets, and
+ individual tabsheets can be split either vertically or horizontally.
+ New tabs can be created by either choosing the <literal>Execute in
+ new Tab</literal> option on the query bar, or by clicking the
+ <guibutton>New Tab</guibutton> button at the top of the tabsheet
+ area. In addition you can also right-click on the current tabsheet
+ and choose the <literal>Add new Tabsheet (Ctrl+T)</literal> option.
+ </para>
+
+ <para>
+ To split a tabsheet, right-click on the tabsheet and choose either
+ the <literal>Split Tab vertically</literal> or the <literal>Split
+ Tab horizontally</literal> option. After splitting the tabsheet you
+ can then click one half of the tabsheet and execute queries within
+ it. You can remove sections of the tabsheet by right-clicking on the
+ section you wish to remove and clicking <literal>Remove
+ Resultset</literal>.
+ </para>
+
+ <para>
+ The tabsheet can be used to review and edit the results of a query,
+ with editing permitted as long as the query is based on a single
+ table and provides sufficient key information to uniquely identify
+ rows.
+
+ <remark>
+ [MH] RESULTSETS BASED ON JOINS WILL EVENTUALLY BE EDITABLE, UPDATE
+ THIS WHEN IT IS CHANGED!
+ </remark>
+
+ To edit the contents of the tabsheet you must enable edit mode
+ through the use of the <guibutton>Edit</guibutton> button at the
+ bottom of the tabsheet. Any edits you make are not immediately
+ applied, but instead you will need to click the <guibutton>Apply
+ Changes</guibutton> button next to the <guibutton>Edit</guibutton>
+ button. The <guibutton>Discard Changes</guibutton> button will throw
+ away any changes you have made to the data.
+ </para>
+
+ </sect1>
+
+<!-- END TABSHEET SECTION -->
+
+ <sect1 id="mysql-query-browser-tour-objectbrowser">
+
+ <title>
+ The Object Browser
+ </title>
+
+ <para>
+ The object browser allows you to browse your server's schemata, your
+ bookmarks, and your query history.
+ </para>
+
+ <sect2 id="mysql-query-browser-tour-objectbrowser-schemata">
+
+ <title>
+ The Schemata Browser
+ </title>
+
+ <para>
+ The schemata browser is where you will probably spend most of your
+ time within the object browser. You can use the schema browser to
+ not only select tables and fields to query, you can also edit
+ tables, create new tables and schemas, and drop tables and schemas.
+ The schema browser is also one of the places where you can set the
+ default schema, which is a required action before you can start
+ issuing queries.
+ </para>
+
+ <figure>
+ <title>
+ The Schemata Browser
+ </title>
+ <graphic
fileref="mysql-query-browser-images/schematabrowser.png"
lang="en" format="PNG"/>
- </figure>
+ </figure>
- <para>You can filter the schemata shown by using the search bar
-at the top of the schemata browser. As you fill in the search
-bar schemata that do not match your search will be hidden from
-view. You can clear the search bar by clicking the
-<guibutton>X</guibutton> button on the right side of the search
-bar.</para>
-
- <para>To view a schema's tables click the black arrow on the
-left of the schema. You can view a table's fields by clicking on
-the black arrow to the left of the table name. Fields that form
-part of an index will have a small key icon to the left of their
-name, otherwise they will have a blue diamond icon. You can also
-double-click on a schema or table name to expand the schema or
-table contents.</para>
-
- <para>To create a new schema, right-click within the schemata
-browser and choose the <literal>Create new Schema</literal>
-option. You can create a new table by right-clicking the schema
-you wish to add a table to and choosing the <literal>Create new
-Table</literal> option. You can drop tables and schemata by
-right-clicking on the table or schema you wish to drop and
-choosing either the <literal>Drop Schema</literal> or
-<literal>Drop Table</literal> option.</para>
-
- <para>You can edit a table by right-clicking on it and choosing
-the <literal>Edit Table</literal> option. The table editor is
-identical to the one used in the MySQL Administrator
-application. For more information on editing tables, see
-<remark>[MH] FILL IN!</remark>.</para>
- </sect2> <!-- END SCHEMATA BROWSER -->
-
- <sect2 id="mysql-query-browser-tour-objectbrowser-bookmarks">
- <title>The Bookmark Browser</title>
- <para>You can place your more commonly used queries in bookmarks
-so that you can quickly retrieve them and re-use them later. To
-add a query to your bookmarks highlight and drag it from the
-query area into the bookmark browser.</para>
-
- <para>Your bookmarks can be organized into folders and
-subfolders to help with management of your queries. To add a new
-subfolder right-click on an existing folder and choose the
-<literal>Create Bookmark Folder</literal> option. You can remove
-bookmarks and folders by right-clicking on them and choosing the
-<literal>Delete Items</literal> option. <emphasis>If you delete
-a folder all items and subfolders within the folder will also be
-deleted.</emphasis></para>
- </sect2> <!-- END BOOKMARK BROWSER -->
-
- <sect2 id="mysql-query-browser-tour-objectbrowser-history">
- <title>The History Browser</title>
- <para>With the history browser you can look through all the
-prior queries you have issued. To expand a given day's queries,
-double-click on the day. To load a history item into the query
-area, double-click on it.</para>
- </sect2> <!-- END HISTORY BROWSER -->
- </sect1> <!-- END OBJECT BROWSER -->
-
- <sect1 id="mysql-query-browser-tour-pandf">
- <title>The Parameter and Function Browser</title>
- <para>Within the parameter and function browser are shortcuts to
-query elements that are not part of the tables themselves. The
-parameter browser provides different local, global, and dynamic
-variables that can help build your queries, while the function
-browser provides a convenient reference to the built-in functions
-of the MySQL server.</para>
-
- <sect2 id="mysql-query-browser-tour-pandf-parameterbrowser">
- <title>The Parameter Browser</title>
- <para>The parameter browser contains all the local, global, and
-dynamic variables that can be included in your query. At the
-moment only the dynamic parameters are active, which allow you
-to create master-detail queries.</para>
- </sect2> <!-- END PARAMETER BROWSER -->
-
- <sect2 id="mysql-query-browser-tour-pandf-functionbrowser">
- <title>The Function Browser</title>
- <para>The function browser provides a quick reference tool for
-determining syntax and usage of the built-in functions of the
-MySQL server. By double-clicking on the various functions you
-can bring up reference information in the in-line help
-system.</para>
- </sect2> <!-- END FUNCTION BROWSER -->
- </sect1> <!-- END PARAMETER AND FUNCTION BROWSER -->
-
- <para>In the next chapter we will put these tools to use with some
-practical examples.</para>
- </chapter> <!-- END TOUR CHAPTER -->
-
- <chapter id="mysql-query-browser-using">
- <title>Using The MySQL Query Browser</title>
- <para>In this chapter we will further describe the tools available
-in the MySQL Query Browser through practical examples of their
-use.</para>
-
- <sect1 id="mysql-query-browser-using-manualentry">
- <title>Entering and Editing Queries Manually</title>
- <para>The most common task performed with the query browser is
-that of performing queries and analyzing their results. The most
-direct way to create a query is to type it directly into the query
-area. As you type in your query, the SQL syntax portions of the
-query(SELECT, FROM, WHERE, etc.) will be highlighted in
-blue.</para>
-
- <para>Once you have entered your query, click on the
-<guibutton>Execute</guibutton> button and your query results will
-be displayed in the tabsheet. You can also press
-<keycap>Ctrl</keycap>+ <keycap>Enter</keycap> to execute the
-query. If there is an error with your query an error box will
-appear at the bottom of the tabsheet which will display the
-relevant error message and error number.</para>
-
- <para>In addition to loading the query results into the current
-active tabsheet, you can also create a new tabsheet for the
-results of your query or split your current tabsheet and load
-results into the new section.</para>
-
- <para>To execute the query and load the results into a new
-tabsheet click the down-arrow below the
-<guibutton>Execute</guibutton> button and choose the
-<literal>Execute in new Tab</literal> option or press
-<keycap>Ctrl</keycap>+<keycap>Shift</keycap>+<keycap>Return
-</keycap>.</para>
-
- <para>To split the active tabsheet and display the query results
-click the down-arrow below the <guibutton>Execute</guibutton>
-button and choose the <literal>Split Tab and Execute</literal>
-option or press
-<keycap>Ctrl</keycap>+<keycap>Alt</keycap>+<keycap>Return</keycap>
-.</para>
-
- <para>You must set a default schema before you will be able to
-query the database successfully. You can set the default schema at
-the connection screen, by right-clicking on a schema in the schema
-browser and choosing <literal>Make Default Schema</literal>, or by
-choosing the <literal>Change Default Schema</literal> option from
-the <menu>File</menu> menu.</para>
- </sect1> <!-- END ENTERING QUERIES MANUALLY -->
-
- <sect1 id="mysql-query-browser-using-graphicalbuilding">
- <title>Building Queries Graphically</title>
- <para>One feature of the MySQL Query Browser is the ability to
-build queries graphically. This allows you to select the columns
-and tables you wish to query from the schemata browser and have
-the query build automatically based on your choices.</para>
-
- <para>The first step to creating a query graphically is to choose
-a table to query. Click and drag the table you wish to query
-towards the query area and the following tool will appear:</para>
-
- <figure>
- <title>The Table Tool</title>
- <graphic fileref="mysql-query-browser-images/tabletool.png"
+ <para>
+ You can filter the schemata shown by using the search bar at the
+ top of the schemata browser. As you fill in the search bar schemata
+ that do not match your search will be hidden from view. You can
+ clear the search bar by clicking the <guibutton>X</guibutton>
+ button on the right side of the search bar.
+ </para>
+
+ <para>
+ To view a schema's tables click the black arrow on the left of the
+ schema. You can view a table's fields by clicking on the black
+ arrow to the left of the table name. Fields that form part of an
+ index will have a small key icon to the left of their name,
+ otherwise they will have a blue diamond icon. You can also
+ double-click on a schema or table name to expand the schema or
+ table contents.
+ </para>
+
+ <para>
+ To create a new schema, right-click within the schemata browser and
+ choose the <literal>Create new Schema</literal> option. You can
+ create a new table by right-clicking the schema you wish to add a
+ table to and choosing the <literal>Create new Table</literal>
+ option. You can drop tables and schemata by right-clicking on the
+ table or schema you wish to drop and choosing either the
+ <literal>Drop Schema</literal> or <literal>Drop Table</literal>
+ option.
+ </para>
+
+ <para>
+ You can edit a table by right-clicking on it and choosing the
+ <literal>Edit Table</literal> option. The table editor is identical
+ to the one used in the MySQL Administrator application. For more
+ information on editing tables, see
+
+ <remark>
+ [MH] FILL IN!
+ </remark>
+
+ .
+ </para>
+
+ </sect2>
+
+<!-- END SCHEMATA BROWSER -->
+
+ <sect2 id="mysql-query-browser-tour-objectbrowser-bookmarks">
+
+ <title>
+ The Bookmark Browser
+ </title>
+
+ <para>
+ You can place your more commonly used queries in bookmarks so that
+ you can quickly retrieve them and re-use them later. To add a query
+ to your bookmarks highlight and drag it from the query area into
+ the bookmark browser.
+ </para>
+
+ <para>
+ Your bookmarks can be organized into folders and subfolders to help
+ with management of your queries. To add a new subfolder right-click
+ on an existing folder and choose the <literal>Create Bookmark
+ Folder</literal> option. You can remove bookmarks and folders by
+ right-clicking on them and choosing the <literal>Delete
+ Items</literal> option. <emphasis>If you delete a folder all items
+ and subfolders within the folder will also be deleted.</emphasis>
+ </para>
+
+ </sect2>
+
+<!-- END BOOKMARK BROWSER -->
+
+ <sect2 id="mysql-query-browser-tour-objectbrowser-history">
+
+ <title>
+ The History Browser
+ </title>
+
+ <para>
+ With the history browser you can look through all the prior queries
+ you have issued. To expand a given day's queries, double-click on
+ the day. To load a history item into the query area, double-click
+ on it.
+ </para>
+
+ </sect2>
+
+<!-- END HISTORY BROWSER -->
+
+ </sect1>
+
+<!-- END OBJECT BROWSER -->
+
+ <sect1 id="mysql-query-browser-tour-pandf">
+
+ <title>
+ The Parameter and Function Browser
+ </title>
+
+ <para>
+ Within the parameter and function browser are shortcuts to query
+ elements that are not part of the tables themselves. The parameter
+ browser provides different local, global, and dynamic variables that
+ can help build your queries, while the function browser provides a
+ convenient reference to the built-in functions of the MySQL server.
+ </para>
+
+ <sect2 id="mysql-query-browser-tour-pandf-parameterbrowser">
+
+ <title>
+ The Parameter Browser
+ </title>
+
+ <para>
+ The parameter browser contains all the local, global, and dynamic
+ variables that can be included in your query. At the moment only
+ the dynamic parameters are active, which allow you to create
+ master-detail queries.
+ </para>
+
+ </sect2>
+
+<!-- END PARAMETER BROWSER -->
+
+ <sect2 id="mysql-query-browser-tour-pandf-functionbrowser">
+
+ <title>
+ The Function Browser
+ </title>
+
+ <para>
+ The function browser provides a quick reference tool for
+ determining syntax and usage of the built-in functions of the MySQL
+ server. By double-clicking on the various functions you can bring
+ up reference information in the in-line help system.
+ </para>
+
+ </sect2>
+
+<!-- END FUNCTION BROWSER -->
+
+ </sect1>
+
+<!-- END PARAMETER AND FUNCTION BROWSER -->
+
+ </chapter>
+
+<!-- END TOUR CHAPTER -->
+
+ <chapter id="mysql-query-browser-using">
+
+ <title>
+ Using The MySQL Query Browser
+ </title>
+
+ <para>
+ In this chapter we will further describe the tools available in the
+ MySQL Query Browser through practical examples of their use.
+ </para>
+
+ <sect1 id="mysql-query-browser-using-manualentry">
+
+ <title>
+ Entering and Editing Queries Manually
+ </title>
+
+ <para>
+ The most common task performed with the query browser is that of
+ performing queries and analyzing their results. The most direct way
+ to create a query is to type it directly into the query area. As you
+ type in your query, the SQL syntax portions of the query(SELECT,
+ FROM, WHERE, etc.) will be highlighted in blue.
+ </para>
+
+ <para>
+ Once you have entered your query, click on the
+ <guibutton>Execute</guibutton> button and your query results will be
+ displayed in the tabsheet. You can also press <keycap>Ctrl</keycap>+
+ <keycap>Enter</keycap> to execute the query. If there is an error
+ with your query an error box will appear at the bottom of the
+ tabsheet which will display the relevant error message and error
+ number.
+ </para>
+
+ <para>
+ In addition to loading the query results into the current active
+ tabsheet, you can also create a new tabsheet for the results of your
+ query or split your current tabsheet and load results into the new
+ section.
+ </para>
+
+ <para>
+ To execute the query and load the results into a new tabsheet click
+ the down-arrow below the <guibutton>Execute</guibutton> button and
+ choose the <literal>Execute in new Tab</literal> option or press
+ <keycap>Ctrl</keycap>+<keycap>Shift</keycap>+<keycap>Return
+ </keycap>.
+ </para>
+
+ <para>
+ To split the active tabsheet and display the query results click the
+ down-arrow below the <guibutton>Execute</guibutton> button and
+ choose the <literal>Split Tab and Execute</literal> option or press
+ <keycap>Ctrl</keycap>+<keycap>Alt</keycap>+<keycap>Return</keycap> .
+ </para>
+
+ <para>
+ You must set a default schema before you will be able to query the
+ database successfully. You can set the default schema at the
+ connection screen, by right-clicking on a schema in the schema
+ browser and choosing <literal>Make Default Schema</literal>, or by
+ choosing the <literal>Change Default Schema</literal> option from
+ the <guimenu>File</guimenu> menu.
+ </para>
+
+ </sect1>
+
+<!-- END ENTERING QUERIES MANUALLY -->
+
+ <sect1 id="mysql-query-browser-using-graphicalbuilding">
+
+ <title>
+ Building Queries Graphically
+ </title>
+
+ <para>
+ One feature of the MySQL Query Browser is the ability to build
+ queries graphically. This allows you to select the columns and
+ tables you wish to query from the schemata browser and have the
+ query build automatically based on your choices.
+ </para>
+
+ <para>
+ The first step to creating a query graphically is to choose a table
+ to query. Click and drag the table you wish to query towards the
+ query area and the following tool will appear:
+ </para>
+
+ <figure>
+ <title>
+ The Table Tool
+ </title>
+ <graphic fileref="mysql-query-browser-images/tabletool.png"
lang="en" format="PNG"/>
- </figure>
+ </figure>
+
+ <para>
+ You can then hover your mouse over the action you wish to take and
+ release the mouse button. For example, by releasing the mouse over
+ the <literal>Add Table(s)</literal> option, <literal>SELECT * FROM
+ City C</literal> is added to the query area.
+ </para>
+
+ <para>
+ Once a table is selected, you can choose specific columns to query;
+ click the <literal>Select</literal> button from the query building
+ buttons on the button bar. Your mouse pointer will now change to a
+ <literal>Select</literal> pointer, which you can use to choose
+ fields from the schema browser. For example, by clicking on the Id,
+ Name, and Country fields of the World sample database, the query
+ <literal>SELECT C.Id, C.Name, C.Country FROM City C</literal> will
+ be built in the query area.
+ </para>
+
+ <para>
+ Once you have chosen the fields you wish to query, you can use the
+ other query building icons to complete your query with
+ <literal>WHERE</literal>, <literal>GROUP BY</literal>, and
+ <literal>ORDER BY</literal> clauses. When a new section of the query
+ is added with the query building buttons, the cursor in the query
+ area will be placed in position for editing; if you click a field
+ with the WHERE pointer, the cursor will be in position for you to
+ type in the details of the <literal>WHERE</literal> clause.
+ </para>
+
+ <para>
+ You can change between the different query building pointers by
+ clicking on the query building buttons in the button bar, or by
+ using a combination of <literal>Ctrl+Alt</literal> and the first
+ letter of the pointer you wish to use (<literal>Ctrl+Alt+S</literal>
+ for SELECT, <literal>Ctrl+Alt+W</literal> for WHERE).
+ </para>
+
+ </sect1>
+
+<!-- END BUILDING GRAPHICALLY -->
+
+ <sect1 id="mysql-query-browser-using-navigatingtabsheet">
+
+ <title>
+ Navigating Resultsets With the Tabsheet
+ </title>
+
+ <para>
+ Once you have successfully executed a query you will then be able to
+ view and manipulate the result set within the tabsheet.
+ </para>
+
+ <para>
+ You can navigate the tabsheet using the arrow keys, tab key, and
+ PageUp/PageDown keys. The Home and End keys can be used to move to
+ the first and last column within a given row. The
+ <literal>First</literal> and <literal>Last</literal> buttons at the
+ bottom of the tabsheet can be used to move to the first and last
+ rows of the resultset. The <literal>Search</literal> button at the
+ bottom of the tabsheet can be used to find a specific value within
+ the tabsheet.
+ </para>
+
+ </sect1>
+
+<!-- END NAVIGATING TABSHEET -->
+
+ <sect1 id="mysql-query-browser-using-editingtabsheet">
+
+ <title>
+ Editing Resultsets With the Tabsheet
+ </title>
+
+ <para>
+ When a query is based on a single table the resultset can be edited
+ from within the tabsheet.
+
+ <remark>
+ [MH] THIS WILL CHANGE, UPDATE WHEN APPROPRIATE
+ </remark>
+
+ To edit a resultset click the <literal>Edit</literal> button. If the
+ <literal>Edit</literal> button is not active, your resultset is not
+ editable.
+ </para>
+
+ <para>
+ Once in edit mode you can add, edit, and delete rows from the
+ dataset graphically. You can navigate the fields with the tab and
+ arrow keys, and pressing <literal>Enter</literal> will allow you to
+ edit the content of a field. You can also double-click a field to
+ make it editable. When editing a field, the tab key will move you to
+ the next field in an editable state. All edited fields will be
+ highlighted in blue for easy identification.
+ </para>
+
+ <para>
+ To add rows to the dataset, scroll to the bottom of the tabsheet and
+ fill in the fields of the blank row found there. All new rows will
+ be highlighted in green.
+ </para>
+
+ <para>
+ To delete a row right-click on the row and choose the
+ <literal>Delete Row</literal> option. All deleted rows will be
+ highlighted in red on the tabsheet.
+ </para>
+
+ <para>
+ Changes made to the resultset are not applied immediately, but
+ instead are cached until the <guibutton>Apply Changes</guibutton>
+ button is pressed. You can abort your edits with the
+ <guibutton>Discard Changes</guibutton> button. Exiting edit mode
+ without choosing to apply or discard your changes will result in you
+ being prompted to apply or discard.
+ </para>
+
+ </sect1>
+
+<!-- END EDITING TABSHEET -->
+
+ <sect1 id="mysql-query-browser-using-compare">
+
+ <title>
+ Comparing Recordets
+ </title>
+
+ <para>
+ You can compare recordsets graphically with the MySQL Query Browser,
+ allowing you to easily determine where rows have been added,
+ removed, or changed.
+ </para>
+
+ <para>
+ To compare two recordsets, execute the first of the queries you wish
+ to compare. Once the resultset has loaded, right-click on the
+ resultset and choose the <guimenu>Split Tab Horizontally</guimenu>
+ option. Load your second query into the new section of the tabsheet
+ and click the <guibutton>Compare</guibutton> button to compare the
+ two resultsets.
+ </para>
+
+ <para>
+ When you have activated the compare mode, both resultsets will
+ scroll in sync, both vertically and horizontally. Rows are matched
+ for comparison, with blank rows added when one set has a row that
+ the other set lacks.
+ </para>
+
+ <para>
+ If one resultset has a row that the other resultset does not have,
+ that row will be highlighted in green. The other resultset will have
+ a blank row inserted that will be highlighted in red. If both
+ resultsets have a matching row, but individual fields are different,
+ those fields will be highlighted in blue.
+ </para>
+
+ <para>
+ In order to successfully compare two resultsets, you will need two
+ queries with matching column names. The tables which the data is
+ based on will need to have primary keys defined in order for the
+ MySQL Query Browser to match rows. Fields in your resultsets must
+ have the same names, and must be in the same order.
+ </para>
+
+ </sect1>
+
+ <sect1 id="mysql-query-browser-using-master_detail">
+
+ <title>
+ Creating Master-Detail Views
+ </title>
+
+ <para></para>
+
+ </sect1>
+
+<!-- END MASTER DETAIL -->
+
+<!-- END COMPARING RECORDSETS -->
+
+ </chapter>
+
+<!-- END USING CHAPTER -->
- <para>You can then hover your mouse over the action you wish to
-take and release the mouse button. For example, by releasing the
-mouse over the <literal>Add Table(s)</literal> option,
-<literal>SELECT * FROM City C</literal> is added to the query
-area.</para>
-
- <para>Once a table is selected, you can choose specific columns to
-query; click the <literal>Select</literal> button from the query
-building buttons on the button bar. Your mouse pointer will now
-change to a <literal>Select</literal> pointer, which you can use
-to choose fields from the schema browser. For example, by clicking
-on the Id, Name, and Country fields of the World sample database,
-the query <literal>SELECT C.Id, C.Name, C.Country FROM City
-C</literal> will be built in the query area.</para>
-
- <para>Once you have chosen the fields you wish to query, you can
-use the other query building icons to complete your query with
-<literal>WHERE</literal>, <literal>GROUP BY</literal>, and
-<literal>ORDER BY</literal> clauses. When a new section of the
-query is added with the query building buttons, the cursor in the
-query area will be placed in position for editing; if you click a
-field with the WHERE pointer, the cursor will be in position for
-you to type in the details of the <literal>WHERE</literal>
-clause.</para>
-
- <para>You can change between the different query building pointers
-by clicking on the query building buttons in the button bar, or by
-using a combination of <literal>Ctrl+Alt</literal> and the first
-letter of the pointer you wish to use
-(<literal>Ctrl+Alt+S</literal> for SELECT,
-<literal>Ctrl+Alt+W</literal> for WHERE).</para>
- </sect1> <!-- END BUILDING GRAPHICALLY -->
-
- <sect1 id="mysql-query-browser-using-navigatingtabsheet">
- <title>Navigating Resultsets With the Tabsheet</title>
- <para>Once you have successfully executed a query you will then be
-able to view and manipulate the result set within the
-tabsheet.</para>
-
- <para>You can navigate the tabsheet using the arrow keys, tab key,
-and PageUp/PageDown keys. The Home and End keys can be used to
-move to the first and last column within a given row. The
-<literal>First</literal> and <literal>Last</literal> buttons at
-the bottom of the tabsheet can be used to move to the first and
-last rows of the resultset. The <literal>Search</literal> button
-at the bottom of the tabsheet can be used to find a specific value
-within the tabsheet.</para>
- </sect1> <!-- END NAVIGATING TABSHEET -->
-
- <sect1 id="mysql-query-browser-using-editingtabsheet">
- <title>Editing Resultsets With the Tabsheet</title>
- <para>When a query is based on a single table the resultset can be
-edited from within the tabsheet. <remark>[MH] THIS WILL CHANGE,
-UPDATE WHEN APPROPRIATE</remark> To edit a resultset click the
-<literal>Edit</literal> button. If the <literal>Edit</literal>
-button is not active, your resultset is not editable.</para>
-
- <para>Once in edit mode you can add, edit, and delete rows from
-the dataset graphically. You can navigate the fields with the tab
-and arrow keys, and pressing <literal>Enter</literal> will allow
-you to edit the content of a field. You can also double-click a
-field to make it editable. When editing a field, the tab key will
-move you to the next field in an editable state. All edited fields
-will be highlighted in blue for easy identification.</para>
-
- <para>To add rows to the dataset, scroll to the bottom of the
-tabsheet and fill in the fields of the blank row found there. All
-new rows will be highlighted in green.</para>
-
- <para>To delete a row right-click on the row and choose the
-<literal>Delete Row</literal> option. All deleted rows will be
-highlighted in red on the tabsheet.</para>
-
- <para>Changes made to the resultset are not applied immediately,
-but instead are cached until the <guibutton>Apply
-Changes</guibutton> button is pressed. You can abort your edits
-with the <guibutton>Discard Changes</guibutton> button. Exiting
-edit mode without choosing to apply or discard your changes will
-result in you being prompted to apply or discard.</para>
- </sect1> <!-- END EDITING TABSHEET -->
-
- <sect1 id="mysql-query-browser-using-compare">
- <title>Comparing Recordets</title>
- <para>Test Line</para>
- </sect1> <!-- END COMPARING RECORDSETS -->
- </chapter> <!-- END USING CHAPTER -->
-</book>
\ No newline at end of file
+</book>
--- New file ---
+++ Docs/mysql-query-browser-images/Thumbs.db 04/08/05 13:53:32
--- New file ---
+++ Docs/mysql-query-browser-images/buttonbar.png 04/08/05 13:53:32
T
--- New file ---
+++ Docs/mysql-query-browser-images/connection.png 04/08/05 13:53:32
djŪ
Ѵ
$
--- New file ---
+++ Docs/mysql-query-browser-images/mainscreen.png 04/08/05 13:53:32
,
Z`
0X
--- New file ---
+++ Docs/mysql-query-browser-images/querybar.png 04/08/05 13:53:32
h
['
--- New file ---
+++ Docs/mysql-query-browser-images/schematabrowser.png 04/08/05 13:53:33
p
p
p
--- New file ---
+++ Docs/mysql-query-browser-images/tabletool.png 04/08/05 13:53:33
--- New file ---
+++ Docs/mysql-query-browser-images/twosakilas.png 04/08/05 13:53:33
--- 1.56/BitKeeper/etc/logging_ok 2004-08-03 00:14:30 -06:00
+++ 1.57/BitKeeper/etc/logging_ok 2004-08-05 13:53:51 -06:00
@@ -1,6 +1,7 @@
Administrator@athena.
Administrator@athene.
Administrator@mhlaptop.
+MHillyer@doomhammer.
Mike.Hillyer@doomhammer.
Sinisa@stripped
anjuta@stripped
| Thread |
|---|
| • bk commit - mysqldoc tree (MHillyer:1.1921) | mhillyer | 6 Aug |
