Author: shinz
Date: 2007-04-03 08:31:39 +0200 (Tue, 03 Apr 2007)
New Revision: 5703
Log:
Add Query Browser (plus common) translation repositories for upcoming Welsh translation (if it will ever happen, that is)
Added:
trunk/gui-common-cy/Makefile
trunk/gui-common-cy/Makefile.ext
trunk/gui-common-cy/VERSION
trunk/gui-common-cy/appendix-common-files.xml
trunk/gui-common-cy/appendix-connection-storage.xml
trunk/gui-common-cy/appendix-source-install.xml
trunk/gui-common-cy/appendix-third-party.xml
trunk/gui-common-cy/appendix-translator-notes.xml
trunk/gui-common-cy/appendix-troubleshooting.xml
trunk/gui-common-cy/chapter-grt-shell.xml
trunk/gui-common-cy/chapter-options-connections.xml
trunk/gui-common-cy/chapter-options-editors.xml
trunk/gui-common-cy/chapter-options-general.xml
trunk/gui-common-cy/chapter-options-introduction.xml
trunk/gui-common-cy/chapter-table-editor.xml
trunk/gui-common-cy/chapter-uninstall-all.xml
trunk/gui-common-cy/chapter-upgrade-all.xml
trunk/gui-common-cy/gui-common.ent
trunk/gui-common-cy/images/columneditor.png
trunk/gui-common-cy/images/confirmchanges.png
trunk/gui-common-cy/images/connectionerror.png
trunk/gui-common-cy/images/grt-shell.png
trunk/gui-common-cy/images/indexeditor.png
trunk/gui-common-cy/images/options-connection.png
trunk/gui-common-cy/images/options.png
trunk/gui-common-cy/images/ssl-params.png
trunk/gui-common-cy/images/tableeditor.png
trunk/gui-common-cy/installation-all.xml
trunk/gui-common-cy/mysql-enterprise.xml
trunk/gui-common-cy/starting-all.xml
trunk/query-browser-cy/Makefile
trunk/query-browser-cy/Makefile.ext
trunk/query-browser-cy/VERSION
trunk/query-browser-cy/chapter-options-query-browser.xml
trunk/query-browser-cy/connection-dialog.xml
trunk/query-browser-cy/copyright.xml
trunk/query-browser-cy/images/blob-buttons.png
trunk/query-browser-cy/images/buttonbar.png
trunk/query-browser-cy/images/connection.png
trunk/query-browser-cy/images/dynamiclist.png
trunk/query-browser-cy/images/file-open-script.png
trunk/query-browser-cy/images/gui-command-line.png
trunk/query-browser-cy/images/mainscreen.png
trunk/query-browser-cy/images/qb-options.png
trunk/query-browser-cy/images/querybar.png
trunk/query-browser-cy/images/schematabrowser.png
trunk/query-browser-cy/images/script-editor.png
trunk/query-browser-cy/images/stored-procedure-database-browser.png
trunk/query-browser-cy/images/tabletool.png
trunk/query-browser-cy/images/twosakilas.png
trunk/query-browser-cy/introduction.xml
trunk/query-browser-cy/legalnotice.en.xml
trunk/query-browser-cy/options.xml
trunk/query-browser-cy/query-browser.xml
trunk/query-browser-cy/renamed-nodes.txt
trunk/query-browser-cy/tour.xml
trunk/query-browser-cy/using.xml
trunk/query-browser-cy/xml-files.xml
Property changes on: trunk/gui-common-cy/chapter-grt-shell.xml
___________________________________________________________________
Name: svn:executable
+ *
Property changes on: trunk/gui-common-cy/chapter-uninstall-all.xml
___________________________________________________________________
Name: svn:executable
+ *
Property changes on: trunk/gui-common-cy/images/columneditor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/gui-common-cy/images/confirmchanges.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/gui-common-cy/images/connectionerror.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/gui-common-cy/images/grt-shell.png
___________________________________________________________________
Name: svn:executable
+ *
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/gui-common-cy/images/indexeditor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/gui-common-cy/images/options-connection.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/gui-common-cy/images/options.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/gui-common-cy/images/ssl-params.png
___________________________________________________________________
Name: svn:executable
+ *
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/gui-common-cy/images/tableeditor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/gui-common-cy/installation-all.xml
___________________________________________________________________
Name: svn:executable
+ *
Property changes on: trunk/gui-common-cy/starting-all.xml
___________________________________________________________________
Name: svn:executable
+ *
Property changes on: trunk/query-browser-cy/connection-dialog.xml
___________________________________________________________________
Name: svn:executable
+ *
Property changes on: trunk/query-browser-cy/images/blob-buttons.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/buttonbar.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/connection.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/dynamiclist.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/file-open-script.png
___________________________________________________________________
Name: svn:executable
+ *
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/gui-command-line.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/mainscreen.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/qb-options.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/querybar.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/schematabrowser.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/script-editor.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/stored-procedure-database-browser.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/tabletool.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Property changes on: trunk/query-browser-cy/images/twosakilas.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/gui-common-cy/Makefile
===================================================================
--- trunk/gui-common-cy/Makefile (rev 0)
+++ trunk/gui-common-cy/Makefile 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 41, Lines Deleted: 0; 1271 bytes
@@ -0,0 +1,41 @@
+# Makefile for MySQL Reference Manual
+
+# Location of repository root relative to current directory
+REPO_ROOT = ..
+
+# Location of directory containing Makefile components
+MAKE_DIR = $(REPO_ROOT)/make.d
+
+# Set any variables here that should override imported standard variables
+
+DOC_LANG = en
+MAIN_DOC_BASENAME = guibook
+
+# Set IDMAP and remap variables
+
+IDMAP_LANG = $(DOC_LANG)
+IDMAP_MAIN = guibook
+
+IDMAP_URLBASE = $(IDMAP_MAIN)/$(IDMAP_LANG)
+IDMAP_REFS = . ../workbench ../query-browser ../administrator ../migration-toolkit ../refman-5.1 ../refman-common
+IDMAP_SRCS = $(wildcard *.xml)
+IDMAP_OBJS = $(call xmllist_to_idmaplist,$(IDMAP_SRCS))
+
+# Import standard variables
+
+include $(MAKE_DIR)/vars-layout
+include $(MAKE_DIR)/vars-shell
+include $(MAKE_DIR)/vars-docbook
+
+# Import default target rule (causes help message to print)
+
+include $(MAKE_DIR)/default-target
+
+clean::
+ $(RM) guibook.txt
+
+# Import standard target rules
+
+include $(MAKE_DIR)/xml-valid
+include $(MAKE_DIR)/xml-format
+include $(MAKE_DIR)/xml-useless
Added: trunk/gui-common-cy/Makefile.ext
===================================================================
--- trunk/gui-common-cy/Makefile.ext (rev 0)
+++ trunk/gui-common-cy/Makefile.ext 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 407 bytes
@@ -0,0 +1,5 @@
+# Makefile extensions for operations specific to this directory
+
+../gui-common/metadata/%.idmap: ../gui-common/%.xml
+ make -C ../gui-common idmap
+
Added: trunk/gui-common-cy/VERSION
===================================================================
--- trunk/gui-common-cy/VERSION (rev 0)
+++ trunk/gui-common-cy/VERSION 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 24, Lines Deleted: 0; 1194 bytes
@@ -0,0 +1,24 @@
+Pfad: query-browser
+URL: svn+ssh://shinz@stripped/svn/mysqldoc/trunk/query-browser
+Basis des Projektarchivs: svn+ssh://shinz@stripped/svn/mysqldoc
+UUID des Projektarchivs: c493bd56-8c02-0410-a43f-aded7e9288fb
+Revision: 5702
+Knotentyp: Verzeichnis
+Plan: normal
+Letzter Autor: mcbrown
+Letzte geänderte Rev: 5667
+Letztes Änderungsdatum: 2007-03-31 07:19:46 +0200 (Sa, 31 Mär 2007)
+Eigenschaften zuletzt geändert: 2006-11-10 23:46:15 +0100 (Fr, 10 Nov 2006)
+
+Pfad: gui-common
+URL: svn+ssh://shinz@stripped/svn/mysqldoc/trunk/gui-common
+Basis des Projektarchivs: svn+ssh://shinz@stripped/svn/mysqldoc
+UUID des Projektarchivs: c493bd56-8c02-0410-a43f-aded7e9288fb
+Revision: 5702
+Knotentyp: Verzeichnis
+Plan: normal
+Letzter Autor: mcbrown
+Letzte geänderte Rev: 5631
+Letztes Änderungsdatum: 2007-03-29 18:10:34 +0200 (Do, 29 Mär 2007)
+Eigenschaften zuletzt geändert: 2006-11-10 23:51:08 +0100 (Fr, 10 Nov 2006)
+
Added: trunk/gui-common-cy/appendix-common-files.xml
===================================================================
--- trunk/gui-common-cy/appendix-common-files.xml (rev 0)
+++ trunk/gui-common-cy/appendix-common-files.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 42, Lines Deleted: 0; 1536 bytes
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" >
+<appendix id="mysql-gui-appendix-xml-files">
+
+ <title>XML Files Common to the MySQL GUI Applications</title>
+
+ <para>
+ On Windows, XML files common to all MySQL GUI applications are
+ stored in the <literal>C:\Documents and
+ Settings\<replaceable>UserName</replaceable>\Application
+ Data\MySQL</literal> directory, where
+ <replaceable>UserName</replaceable> is the name of the current
+ Windows user. On Linux, the files are stored in the
+ <literal>~/.mysqlgui</literal> directory.
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>mysqlx_common_options.xml</literal>: Stores options
+ selected in the <link
+linkend="mysql-gui-options">Options
+ dialog</link>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>mysqlx_user_connections.xml</literal>: This file is
+ described in
+ <link
+ linkend="mysql-gui-appendix-store-connections">How
+ Connections are Stored</link>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+</appendix>
+<!-- END COMMON XML FILES -->
Added: trunk/gui-common-cy/appendix-connection-storage.xml
===================================================================
--- trunk/gui-common-cy/appendix-connection-storage.xml (rev 0)
+++ trunk/gui-common-cy/appendix-connection-storage.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 64, Lines Deleted: 0; 2712 bytes
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" >
+<appendix id="mysql-gui-appendix-store-connections">
+
+ <title>How Connections Are Stored</title>
+
+ <para>
+ On Windows, connection profiles are stored in <literal>C:\Documents
+ and Settings\<replaceable>UserName</replaceable>\Application
+ Data\MySQL</literal> directory, where
+ <replaceable>UserName</replaceable> is the name of the current
+ Windows user. On Linux, the files are stored in the
+ <literal>~/.mysqlgui</literal> directory. The settings are stored in
+ a file called <literal>mysqlx_user_connections.xml</literal>. The
+ contents of that file look like this:
+ </para>
+
+<programlisting>
+<?xml version="1.0"?>
+ <user_connections>
+ <last_connection>1</last_connection>
+ <password_storage_type>2</password_storage_type>
+ <user_connection>
+ <connection_name></connection_name>
+ <username>root</username>
+ <hostname>localhost</hostname>
+ <port>3306</port>
+ <schema></schema>
+ <advanced_options/>
+ <storage_path></storage_path>
+ <notes></notes>
+ <connection_type>0</connection_type>
+ <storage_type>2</storage_type>
+ <password></password>
+ </user_connection>
+ ...
+</programlisting>
+
+ <para>
+ You can edit the file manually, but take care not to invalidate the
+ XML. When applying changes by editing and saving the file, those
+ changes will show up the next time you open the
+ <link
+
+linkend="mysql-gui-options-connections">Connections</link>
+ section of the <link
+ linkend="mysql-gui-options">Options
+ Dialog</link>. You do not need to restart your application for the
+ changes to take effect.
+ </para>
+
+ <para>
+ Database administrators may want to edit the file and then copy it
+ to another machine running the MySQL GUI tools. This makes it easy
+ to have identical connection profiles on a number of machines,
+ without having to set up those profiles individually. All XML
+ configuration files for the MySQL GUI Tools are cross-platform
+ compatible and can be transferred between Windows and Linux
+ machines.
+ </para>
+
+</appendix>
+<!-- END CONNECTION STORAGE -->
Added: trunk/gui-common-cy/appendix-source-install.xml
===================================================================
--- trunk/gui-common-cy/appendix-source-install.xml (rev 0)
+++ trunk/gui-common-cy/appendix-source-install.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 815, Lines Deleted: 0; 22111 bytes
@@ -0,0 +1,815 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+
+ <!ENTITY % gui-common.entities SYSTEM "gui-common.ent">
+ %gui-common.entities;
+]>
+<appendix id="mysql-gui-install-source">
+
+ <title>Installing From Source</title>
+
+ <section id="mysql-gui-install-source-introduction">
+
+ <title>Introduction</title>
+
+ <para>
+ Normally, you will want to install the MySQL GUI tools from
+ binaries. We put a lot of effort into making sure that our
+ binaries are built with the best possible options. If, for
+ whatever reason, you wish to compile the tools yourself, follow
+ these instructions.
+ </para>
+
+ </section>
+
+<!-- END INTRODUCTION -->
+
+ <section id="mysql-gui-install-source-download">
+
+ <title>Downloading The Source Code</title>
+
+ <para>
+ The source code for the MySQL GUI tools is available from our
+ public Subversion trees at
+ <ulink url="http://dev.mysql.com/tech-resources/sources.html"/>.
+ </para>
+
+ <para>
+ You will need the <literal>mysql-gui-common</literal> tree
+ regardless of which GUI tools you intend to build. The
+ <literal>mysql-gui-common</literal> tree contains source and
+ graphics files used for all MySQL GUI tools.
+ </para>
+
+ <para>
+ To be able to access these trees, you must have Subversion
+ installed. Subversion is freely available from
+ <ulink url="http://subversion.tigris.org/"/>.
+ </para>
+
+ </section>
+
+<!-- END GET SOURCE -->
+
+ <section id="mysql-gui-install-source-windows">
+
+ <title>Building from Source under Windows</title>
+
+ <para>
+ Installing from source under Windows requires multiple commercial
+ compilers and because of this it is preferable to install from
+ binaries. If you meet the prerequisites needed you can build the
+ MySQL GUI tools from source under Windows.
+ </para>
+
+ <section
+id="mysql-gui-install-source-windows-prerequisites">
+
+ <title>Prerequisites</title>
+
+ <para>
+ To compile the MySQL GUI tools from source under Windows, you
+ need Borland Delphi 7, Microsoft Visual Studio.NET 2003, and
+ some libraries which are available on the internet as open
+ source software. Make sure the programs
+ <literal>DCC32.exe</literal> and <literal>DEVENV.exe
+ /?</literal> can be launched from the command line.
+ </para>
+
+ <para>
+ You will need the following libraries to build from source:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ glib-2.0
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ libxml-2
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ mysql client libraries (4.0 or newer, 5.0 prefered)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ pcre-1.4
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ MS Visual C runtime libraries 7.1
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Java include files 1.4.2_04
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Lua 5.0.2
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </section>
+
+<!-- Prerequisites -->
+
+ <section id="mysql-gui-install-source-windows-compiling">
+
+ <title>Compiling and Building</title>
+
+ <para>
+ Make sure you have cloned the
+ <literal>mysql-administrator</literal>,
+ <literal>mysql-gui-common</literal>, and
+ <literal>mysql-query-browser</literal> trees, and that their
+ local directories are located in the same directory, for example
+ in <literal>Personal Files\MySQLGUI\</literal>.
+ </para>
+
+ <para>
+ The source files and libraries should be placed into the
+ following tree structure:
+ </para>
+
+<programlisting>
+ Working Directory
+ |
+ |- mysql-administrator
+ |- mysql-gui-common
+ |- mysql-query-browser
+ |- mysql-gui-win-res
+ |
+ |-include
+ | |
+ | |-glib-2.0
+ | |-java
+ | | |
+ | | |-win32
+ | |
+ | |-libxml
+ | |-lua
+ | |-mysql
+ | |-pcre
+ | |-windows
+ |
+ |-lib
+ |
+ |-glib-2.0
+ |-java
+ |-libxml
+ |-lua
+ |-mysql
+ |-pcre
+ |-windows
+</programlisting>
+
+ <section id="mysql-gui-install-source-windows-compiling-command-line">
+
+ <title>Building from Command Line</title>
+
+ <para>
+ To build from the command line open a windows command line
+ prompt and change into the main repository of the tool (i.e.
+ for &administrator; this is
+ <literal>work\mysql-administrator</literal>). There are three
+ batch-files to start the build:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ build_debug.cmd
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ build_release.cmd
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ build_commercial.cmd
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Execute one of those to generate a runtime image of the
+ application. It will be generated in a
+ <literal>bin\windows</literal> directory.
+ </para>
+
+ <para>
+ Another method is to doubleclick on one of the
+ <literal>build_<replaceable>buildtype</replaceable>.cmd</literal>
+ files, where <replaceable>buildtype</replaceable> is one of
+ <literal>debug</literal>, <literal>release</literal>, and
+ <literal>commercial</literal>. The
+ <literal>commercial</literal> build script is for users with
+ commercial licenses, and makes use of the commercial version
+ of the MySQL client library.
+ </para>
+
+ </section>
+
+<!-- END COMMAND LINE -->
+
+ <section id="mysql-gui-install-source-windows-compiling-ide">
+
+ <title>Building from the IDE</title>
+
+ <para>
+ Before you can open any projects, you have to install these
+ components. Otherwise some of the forms will not open and you
+ will receive error messages.
+ </para>
+
+ <para>
+ To install the components, goto the
+ <literal>mysql-gui-common\source\windows\</literal> directory.
+ Copy the following directories to your Delphi source directory
+ (<literal>C:\Program Files\Borland\Delphi7\Source\</literal>).
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ png
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ SynEdit
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ TNT
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ UniCodeEditor
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ VirtualTreeview
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Then doubleclick each <literal>*.dpk</literal> file outlined
+ below. It will open Delphi. Press compile and install to
+ install the components. Repeat this for each
+ <literal>*.dpk</literal> file.
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ SynEdit\Packages\SynEdit_D7.dpk
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ TNT\Packages\TntUnicodeVcl_D70.dpk
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ VirtualTreeview\Packages\VirtualTreesD7D.dpk
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ UniCodeEditor\Packages\UniCodeEditorD7.dpk
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ These components have to be installed via the
+ <guimenu>Install</guimenu> option of the
+ <guimenu>Component</guimenu> menu. Click on the
+ <guibutton>Browse</guibutton> button and select the files
+ below. Press <guibutton>OK</guibutton> after each file.
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ png\PNGImage.pas
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ After installing the components you can open the projects as
+ outlined below.
+ </para>
+
+ <para>
+ To build the application from the Delphi 7 IDE simply
+ doubleclick the
+ <literal>edit_<replaceable>xxxx</replaceable>.cmd</literal>.
+ This will launch Delphi 7 and open the file. To generate the
+ complete runtime image select <guimenu>Build All
+ Projects</guimenu> option from the <guimenu>Project</guimenu>
+ menu.
+ </para>
+
+ <para>
+ Like for building from command line there are three different
+ files.
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ edit_debug.cmd
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ edit_release.cmd
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ edit_commercial.cmd
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ The runtime image will be generated in a
+ <literal>bin\windows</literal> directory.
+ </para>
+
+ <para>
+ <emphasis>Opening the Delphi project not using the
+ <literal>edit_*.cmd</literal> script will lead to incorrect
+ project settings and problems while building the
+ projects.</emphasis>
+ </para>
+
+ </section>
+
+<!-- END BUILDING IDE -->
+
+ </section>
+
+<!-- COMPILING AND BUILDING -->
+
+ </section>
+
+<!-- BUILDING FROM SOURCE UNDER WINDOWS -->
+
+ <section id="mysql-gui-install-source-linux">
+
+ <title>Building from Source under Linux</title>
+
+ <section
+id="mysql-gui-install-source-linux-prerequisites">
+
+ <title>Prerequisites</title>
+
+ <para>
+ The easiest way to install required packages is by using an
+ automatic dependency resolving package manager, such as
+ <literal>apt-get</literal> or <literal>yum</literal>. You can
+ install these dependencies by hand, but it will be a very
+ tedious process since some of them require other packages that
+ require other packages and so on.
+ </para>
+
+ <para>
+ Common requirements are listed below. For some distributions the
+ package name is also mentioned.
+ </para>
+
+ <table>
+ <title>Required Components</title>
+ <tgroup cols="4">
+ <colspec colwidth="1.5in"/>
+ <colspec colwidth="1in"/>
+ <colspec colwidth="1in"/>
+ <colspec colwidth="1in"/>
+ <thead>
+ <row>
+ <entry><emphasis role="bold">Software</emphasis></entry>
+ <entry><emphasis role="bold">Version</emphasis></entry>
+ <entry><emphasis role="bold">Ubuntu 6</emphasis></entry>
+ <entry><emphasis role="bold">SuSE 10.x</emphasis></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>gcc/g++</entry>
+ <entry>4</entry>
+ <entry>g++</entry>
+ <entry>gcc-c++</entry>
+ </row>
+ <row>
+ <entry>autoconf, automake libtool</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>x11-libs</entry>
+ <entry></entry>
+ <entry>libx11-dev</entry>
+ <entry>xorg-x11-devel</entry>
+ </row>
+ <row>
+ <entry>glibc</entry>
+ <entry></entry>
+ <entry>libc6-dev</entry>
+ <entry>xorg-xll-devel</entry>
+ </row>
+ <row>
+ <entry>libstdc++</entry>
+ <entry></entry>
+ <entry>libstdc++6-4.0-dev</entry>
+ <entry>libstdc++devel</entry>
+ </row>
+ <row>
+ <entry>glib</entry>
+ <entry>2.6+</entry>
+ <entry>libglib2.0-dev</entry>
+ <entry>glib2-devel</entry>
+ </row>
+ <row>
+ <entry>gtk+</entry>
+ <entry>2.6+</entry>
+ <entry>libgtk2.0-dev</entry>
+ <entry>gtk2-devel</entry>
+ </row>
+ <row>
+ <entry>libglade2</entry>
+ <entry>2.5+</entry>
+ <entry>libglade2-dev</entry>
+ <entry>libglade2-devel</entry>
+ </row>
+ <row>
+ <entry>libsigc++</entry>
+ <entry>2.0.x</entry>
+ <entry>libsigc++-2.0-dev</entry>
+ <entry>libsigc++2-devel</entry>
+ </row>
+ <row>
+ <entry>glibmm-2.4</entry>
+ <entry>2.4</entry>
+ <entry>libglibmm-2.4-dev</entry>
+ <entry>glibmm24-devel</entry>
+ </row>
+ <row>
+ <entry>gtkmm-2.4</entry>
+ <entry>2.4</entry>
+ <entry>libgtkmm-2.4-dev</entry>
+ <entry>gtkmm24-devel</entry>
+ </row>
+ <row>
+ <entry>pcre</entry>
+ <entry>4.x or newer</entry>
+ <entry>libpcre3-dev</entry>
+ <entry>pcre-devel</entry>
+ </row>
+ <row>
+ <entry>pkgconfig</entry>
+ <entry>0.15+</entry>
+ <entry>pkg-config</entry>
+ <entry>pkgconfig</entry>
+ </row>
+ <row>
+ <entry>libxml2</entry>
+ <entry>2.6.x</entry>
+ <entry>libxml2-dev</entry>
+ <entry>libxml2-devel</entry>
+ </row>
+ <row>
+ <entry>MySQL 5.0 or 5.1 client libs and headers</entry>
+ <entry></entry>
+ <entry>libmysqlclient15-dev</entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ Additional requirements for building &query_browser; are:
+ </para>
+
+ <table>
+ <title>Requirements for &query_browser;</title>
+ <tgroup cols="4">
+ <colspec colwidth="1.5in"/>
+ <colspec colwidth="1in"/>
+ <colspec colwidth="1in"/>
+ <colspec colwidth="1in"/>
+ <thead>
+ <row>
+ <entry><emphasis role="bold">Software</emphasis></entry>
+ <entry><emphasis role="bold">Version</emphasis></entry>
+ <entry><emphasis role="bold">Ubuntu 6</emphasis></entry>
+ <entry><emphasis role="bold">SuSE 10.x</emphasis></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>libgtkhtml</entry>
+ <entry>2.11 or 3.x</entry>
+ <entry>libgtkhtml2-dev</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>libgnomeprint</entry>
+ <entry>2.2</entry>
+ <entry>libgnomeprint2.2-dev</entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ </section>
+
+<!-- Prerequisites -->
+
+ <section id="mysql-gui-install-source-linux-compiling">
+
+ <title>Compiling and Building</title>
+
+ <para>
+ To build any of the tools, you need to have the source tree for
+ <literal>mysql-gui-common</literal> and the tree for the desired
+ app (i.e.: <literal>mysql-administrator</literal>,
+ <literal>mysql-query-browser</literal>) in the same top-level
+ directory.
+ </para>
+
+ <para>
+ First build <literal>mysql-gui-common</literal>:
+ </para>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ cd mysql-gui-common
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ sh ./autogen.sh
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ ./configure
+ --prefix=/opt/mysql-<replaceable>administrator</replaceable>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ make
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ make install
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ <para>
+ The <literal>--prefix</literal> option can have whatever value you
+ want, normally one would specify <literal>/usr/local</literal>
+ (the default) or <literal>/usr</literal>, but for making
+ precompiled binaries, something in <literal>/opt</literal> might
+ be more appropriate.
+ </para>
+
+ <para>
+ After you have successfully built
+ <literal>mysql-gui-common</literal>, you can build the individual
+ tools (in this example we will build mysql-administrator):
+ </para>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ cd mysql-administrator
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ sh ./autogen.sh
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ ./configure
+ --prefix=/opt/mysql-<replaceable>administrator</replaceable>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ make
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ make install
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ <para>
+ If everything went well, things should be properly built and
+ installed.
+ </para>
+
+ <section id="mysql-gui-install-source-linux-compiling-static">
+
+ <title>Building Static Binaries</title>
+
+ <para>
+ Building static binaries is non-trivial under Linux, due to the
+ enormous number of library dependencies that come from GNOME and
+ associated libraries. Additionally:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Many libraries do not come with their static (lib*.a)
+ versions shipped, so we need to build them ourselves.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Some libraries can't be linked statically, such as glibc,
+ because of libnss*.so.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Some libraries depend on data files and modules from the
+ original package, esp. in case of gtk/gnome. Problems don't
+ only appear when the user is missing these data files;
+ things may not work because different distributions put
+ files in different paths.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ The current solution is to build a partially static binary, with
+ the most common libraries left dynamically linked
+ (<literal>glibc</literal> and <literal>gtk</literal>).
+ <literal>gtkmm</literal>, <literal>gtksourceview</literal>,
+ <literal>gtkhtml</literal> and dependencies (like gnome) are
+ linked statically. The ideal solution would be to build custom
+ binaries for each major/chosen distribution, but we don't have
+ time/resources for that at the moment.
+ </para>
+
+ <para>
+ To build these binaries:
+ </para>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ Look at the <literal>source/linux/static_make</literal>
+ script for all the files that should be removed/moved out of
+ <literal>/usr/lib</literal>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Run the script.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ <para>
+ That's needed to force the linker to look for the static version
+ of each library and also to explicitly list the dependency libs
+ that were otherwise linked to the dynamic libs.
+ </para>
+
+ </section>
+
+<!-- END BUILDING STATIC -->
+
+ <section id="mysql-gui-install-source-linux-compiling-rpm">
+
+ <title>Building RPMs</title>
+
+ <para>
+ For building RPMs, a spec file is already supplied and will be
+ made automatically after <literal>./configure</literal> is ran.
+ The spec file expects a source tarball with the following
+ structure:
+ </para>
+
+<programlisting>mysql-administrator/ mysql-administrator/mysql-gui-common/* »
+mysql-administrator/mysql-administrator/*</programlisting>
+
+ <para>
+ The contents of each subdirectory is the entire source tree for each
+ tool (Windows specific files and source metadata are optional, of
+ course). You must make a <literal>tar.gz</literal> file and put
+ it in <literal>/usr/src/redhat/SOURCES</literal> (or whatever is
+ your rpm SOURCES directory).
+ </para>
+
+ <para>
+ Then, execute: <literal>rpmbuild -ba
+ mysql-administrator.spec</literal>
+ </para>
+
+ <para>
+ That should build the srpm and rpm files for the tool.
+ </para>
+
+ </section>
+
+<!-- END COMPILING RPMS -->
+
+ </section>
+
+<!-- Compiling and Building -->
+
+<!-- Building from Source under Linux -->
+
+</appendix>
+<!-- END SOURCE INSTALL -->
Added: trunk/gui-common-cy/appendix-third-party.xml
===================================================================
--- trunk/gui-common-cy/appendix-third-party.xml (rev 0)
+++ trunk/gui-common-cy/appendix-third-party.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 49, Lines Deleted: 0; 1792 bytes
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" >
+<appendix id="mysql-gui-appendix-third-party-software">
+
+ <title>Third-party Software Used by the MySQL GUI Tools</title>
+
+ <para>
+ The MySQL GUI tools incorporate PCRE and PNG support through the use
+ of third-party libraries.
+ </para>
+
+ <section id="mysql-gui-appendix-third-party-software-pcre">
+
+ <title>PCRE Library</title>
+
+ <para>
+ Regular expression support is provided by the PCRE library
+ package, which is open source software, written by Philip Hazel,
+ and copyright by the University of Cambridge, England. The source
+ for the PCRE library can be found at:
+ <ulink
+
+url="ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/">ftp:/
+ /ftp.csx.cam.ac.uk/pub/software/programming/pcre/</ulink>.
+ </para>
+
+ </section>
+
+<!-- PCRE LIBRARY -->
+
+ <section id="mysql-gui-appendix-third-party-software-png">
+
+ <title>PNG Support</title>
+
+ <para>
+ PNG support for the Windows version is provided by the TPNGImage
+ component which is open source software, written and copyright by
+ Gustavo Daud. The source for the TPNGImage can be found at:
+ <ulink url="http://pngdelphi.sourceforge.net">
+ http://pngdelphi.sourceforge.net </ulink>.
+ </para>
+
+ </section>
+
+<!-- PNG SUPPORT -->
+
+</appendix>
+<!-- THIRD-PARTY SOFTWARE USED BY GUI TOOLS -->
Added: trunk/gui-common-cy/appendix-translator-notes.xml
===================================================================
--- trunk/gui-common-cy/appendix-translator-notes.xml (rev 0)
+++ trunk/gui-common-cy/appendix-translator-notes.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 86, Lines Deleted: 0; 2669 bytes
@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" >
+<appendix id="mysql-gui-appendix-notes-for-translators">
+
+ <title>Notes for Translators</title>
+
+ <para>
+ You may find that the MySQL GUI tools and/or their documentation are
+ not available in your preferred language. If you would like to
+ translate the software, or its documentation, or participate in that
+ translation, <emphasis>please contact the MySQL documentation team
+ before starting your translation.</emphasis>
+ </para>
+
+ <para>
+ The MySQL documentation team's address is
+ <email>docs@stripped</email>. In your email, please state what you
+ would like to translate (the tools, their documentation, or even the
+ whole MySQL reference manual if you dare), and give some information
+ regarding your background:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ What is your name?
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Where do you live?
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ How long have you used MySQL?
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Have you done other translations?
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Will you work alone or with a group of translators?
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ What's your timetable regarding the translation?
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ What is your motivation for translating?
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ We will get back to you as soon as possible.
+ </para>
+
+ <para>
+ The format used for both software and documentation is
+ <emphasis role="bold">DocBook XML</emphasis>. From that base format,
+ all other available formats (HTML, CHM, PDF, etc.) are being
+ generated. It would be a pity if you started translating, say, the
+ HTML version of this documentation, because we will not be able to
+ use it in that format. Also, you might find that someone else has
+ already done (or is in the process of doing) that translation. So,
+ once again, please contact the MySQL documentation team first.
+ </para>
+
+</appendix>
+<!-- Notes for Translators -->
Added: trunk/gui-common-cy/appendix-troubleshooting.xml
===================================================================
--- trunk/gui-common-cy/appendix-troubleshooting.xml (rev 0)
+++ trunk/gui-common-cy/appendix-troubleshooting.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 94, Lines Deleted: 0; 3448 bytes
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" >
+<appendix id="mysql-gui-appendix-troubleshooting">
+
+ <title>Troubleshooting Application Errors</title>
+
+ <para></para>
+
+ <section
+id="mysql-gui-appendix-troubleshooting-connection-errors">
+
+ <title>Troubleshooting Connection Errors</title>
+
+ <para>
+ If an error occurs when you select a connection profile and
+ attempt to establish a connection to the MySQL server named in the
+ profile, a window containing error information will be displayed
+ (see figure).
+ </para>
+
+ <figure>
+ <title>Error message dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/connectionerror.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Error message dialog</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Normally, this means either that the credentials specified in the
+ profile are wrong (wrong username, wrong password), or that you do
+ not have privileges to connect to the MySQL server from the client
+ machine. See <xref linkend="access-denied"/>, for more
+ information.
+ </para>
+
+ <para>
+ However, another cause of connection failure is that there might
+ be a network problem that prevents you from reaching the machine
+ where the MySQL server is running. For this reason, the error
+ dialog provides a <guibutton>PING</guibutton> button. Clicking
+ this button will send an ICMP PING request to the MySQL server
+ host machine. If the host machine is available over the network,
+ you will see something like this:
+ </para>
+
+<programlisting>
+Reply from 127.0.0.1: Time=0ms TTL=128
+Reply from 127.0.0.1: Time=1ms TTL=128
+</programlisting>
+
+ <para>
+ This would indicate that the machine is reachable, and that the
+ cause of connection failure is not a network problem.
+ </para>
+
+ </section>
+
+<!-- TROUBLESHOOTING CONNECTION ERRORS -->
+
+ <section
+id="mysql-gui-appendix-troubleshooting-display-problems">
+
+ <title>Troubleshooting Display Problems</title>
+
+ <para>
+ If, under Windows, the controls in the windows look somehow
+ displaced, select <guimenu>Start</guimenu>, <guimenu>Control
+ Panel</guimenu>, <guimenu>Display</guimenu>. Select the
+ <guilabel>Settings</guilabel> tab and click the
+ <guibutton>Advanced...</guibutton> button. Change your DPI
+ settings to <literal>Normal (96 DPI)</literal>.
+ </para>
+
+ <para>
+ If, under Linux, messages and captions appear very big, your
+ display resolution is probably set too high. Use
+ <literal>gnome-font-properties</literal> to change your default
+ font to a smaller value or go to <literal>Details</literal> and
+ set your resolution to <literal>72</literal> or some other more
+ appropriate value.
+ </para>
+
+ </section>
+
+<!-- TROUBLESHOOTING DISPLAY PROBLEMS -->
+
+</appendix>
+<!-- END TROUBLESHOOTING APPENDIX -->
Added: trunk/gui-common-cy/chapter-grt-shell.xml
===================================================================
--- trunk/gui-common-cy/chapter-grt-shell.xml (rev 0)
+++ trunk/gui-common-cy/chapter-grt-shell.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 736, Lines Deleted: 0; 24920 bytes
@@ -0,0 +1,736 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ ]>
+<chapter id="grt-shell">
+
+ <title>The Generic Runtime Environment (GRT) Shell</title>
+
+ <section id="grt-introduction">
+
+ <title>Introduction</title>
+
+ <para>
+ The GRT is a thin C layer, inspired by Objective C, which allows
+ for dynamic typing and dynamic data objects. The GRT is used by
+ both &workbench; and the &migration_toolkit; and provides a means
+ for expanding these tools. Through the use of the GRT, these tools
+ can support new behavior and data sources using code written in
+ languages such as C, C++, Java, Python, and Lua with support for
+ Mono forthcoming.
+ </para>
+
+ <para>
+ The GRT is not only useful for expanding &gui_tools;. By using a
+ script file from within the GRT shell you can perform repetitive
+ tasks programatically from the command line. Suppose, for example,
+ that you have multiple schemata that you wish to migrate to MySQL.
+ You can do this once using the graphical interface, in the process
+ saving the procedure as a script file. You can then adapt this
+ script file and run it unattended from the GRT shell.
+ </para>
+
+ <para>
+ The preferred development language is <literal>Lua</literal>, a
+ light-weight scripting language expressly designed for extending
+ applications. For more information about this language see
+ <ulink url="http://www.lua.org/">lua.org</ulink>.
+ </para>
+
+ <note>
+ <para>
+ The GRT shell is used both in the &migration_toolkit; and the
+ &workbench;. However, the &migration_toolkit; is only available
+ for Windows. The implementation of the GRT Shell varies
+ depending upon the operating system (OS).
+ </para>
+ </note>
+
+ </section>
+
+<!-- End INTRODUCTION -->
+
+ <section id="exploring-grt-shell">
+
+ <title>Exploring the GRT Shell</title>
+
+ <para>
+ To open the GRT shell from within the &migration_toolkit; choose
+ the <guimenu>GRT Environment Shell</guimenu> option under the
+ <guimenu>Tools</guimenu> menu. In &workbench; under Windows,
+ choose <guimenu>View</guimenu>, <guimenu>Advanced</guimenu>,
+ <guimenu>Show GRT Shell</guimenu>. Under Linux simply choose
+ <guimenu>View</guimenu> and then <guimenu>GRT Console</guimenu>
+ and with Mac OS X choose the <guimenu>Window</guimenu> menu and
+ then <guimenu>GRT Shell</guimenu>. However, the simplest way to
+ open the GRT Shell in either application or under any OS is to use
+ the <keycap>F4</keycap> key. If you haven't docked the GRT shell
+ window you should see something similar to the following:
+ </para>
+
+ <figure>
+ <title>The GRT shell (Windows)</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/grt-shell.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The GRT shell (Windows)</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The GRT shell itself is the default tab on the left of the screen.
+ Beside it is the <literal>Snippets</literal> tab, used for saving
+ code snippets.
+ </para>
+
+ <para>
+ On the right, is the <literal>GRT Globals
+ Tree</literal>—showing the various objects, variables,
+ structures, and code modules used by the application. These
+ objects are all directly accessible from the shell.
+ </para>
+
+ <section id="grt-menu-items">
+
+ <title>Menu Items</title>
+
+ <para>
+ The menu runs across the top of the screen and varies
+ significantly depending upon which OS you are using. Since the
+ &migration_toolkit; is currently only implemented on Windows,
+ all references to invoking the GRT shell from this application
+ apply only to the Windows OS.
+ </para>
+
+ <section>
+
+ <title>The File or Shell Menu</title>
+
+ <section>
+
+ <title>Windows File Menu</title>
+
+ <para id="grt-file-menu">
+ Currently only two of the submenus under the
+ <guimenu>File</guimenu> menu are implemented;
+ <guimenu>Exit</guimenu>, which simply exits the GRT shell,
+ and <guimenu>Open Script</guimenu>. The <guimenu>Open
+ Script</guimenu> option is for opening existing
+ <literal>Lua</literal> scripts and is only implemented under
+ Windows.
+ </para>
+
+ <para>
+ Sample scripts are found in the <filename>Scripts</filename>
+ directory which is immediately below the installation
+ directory. Opening a script from this menu option will
+ create an additional tab labeled with the name of the
+ script. Click on this tab to see the file contents. You may
+ paste text between the <literal>GRT Shell</literal> tab and
+ any script tab.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>Linux Shell Menu</title>
+
+ <para>
+ Under Linux the <guimenu>Shell</guimenu> menu shows menu
+ items for closing the shell, refreshing the objects listed
+ in the Global tree or saving the object tree.
+ </para>
+
+ <para>
+ The <guimenu>Save Tree ...</guimenu> menu option saves an
+ XML file of all the data types and classes shown in the
+ three tabs of the <literal>Objects Tree</literal>.
+ </para>
+
+ <para>
+ Under Linux there is no menu option to open a script.
+ </para>
+
+ </section>
+
+ </section>
+
+ <section id="grt-view-menu">
+
+ <title>The View Menu</title>
+
+ <section>
+
+ <title>The View Menu: Windows</title>
+
+ <para>
+ The <guimenu>Refresh</guimenu> option of the
+ <guimenu>View</guimenu> menu refreshes the view of the
+ objects shown in the object tree tabs on the right.
+ </para>
+
+ <para>
+ The <guimenu>Display Type Info</guimenu> and
+ <guimenu>Display Object Values</guimenu> menu items toggle
+ the view of the objects in the <literal>Values</literal> tab
+ on the right. When checked, <guimenu>Display Type
+ Info</guimenu> shows the data type of objects and
+ <guimenu>Display Object Values</guimenu> shows their value.
+
+ <remark>
+ [PL]Same as panel below or not?
+ </remark>
+ </para>
+
+ <para>
+ The <guimenu>Display Object Refcount</guimenu> shows the
+ current number of references to specific objects.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>The View Menu: Linux</title>
+
+ <para>
+ The <guimenu>View</guimenu> menu has only one element,
+ <guimenu>Structure Only</guimenu> and it is not yet
+ activated.
+ </para>
+
+ </section>
+
+ </section>
+
+ <section>
+
+ <title>Mac OS X Menu</title>
+
+ <para>
+ Under Mac OS X there are only two menu options,
+ <guimenu>Reload</guimenu> and <guimenu>Reload
+ Selected</guimenu>. <guimenu>Reload</guimenu> reloads all the
+ objects in the Object Tree panel and is equivalent to the
+ Windows <guimenu>View</guimenu>, <guimenu>Refresh</guimenu>
+ option. The <guimenu>Reload Selected</guimenu> option only
+ reloads the selected object.
+ </para>
+
+ </section>
+
+ </section>
+
+ <section id="grt-shell-window">
+
+ <title>The Shell</title>
+
+ <para>
+ The GRT shell is principally used for running Lua scripts or
+ typing Lua commands directly. However, you can also access the
+ GRT Scripting Library functions and global functions and
+ objects. To see the available commands type
+ ‘<literal>?</literal>’.
+ </para>
+
+ <para>
+ Some OS-specific commands are also available. For instance,
+ under Windows you can clear the screen by typing
+ <command>cls</command>. Unlike most shells, you can cut and
+ paste text to and from the shell window.
+ </para>
+
+ <para>
+ Working from the command line is described in detail in
+ <xref linkend="using-grt-shell"/>.
+ </para>
+
+ <para>
+ The <literal>Snippets</literal> tab functions as a scratch pad
+ for saving code snippets. This makes it easy to reuse code and
+ does away with the need to retype it at the command line.
+ </para>
+
+ <para>
+ If you have opened script files as described in
+ <xref linkend="grt-file-menu"/>, there may be any number of tabs
+ to the right of the <literal>Snippets</literal> tab. These tabs
+ will be labeled with the names of the script files. As with the
+ <literal>Snippets</literal> tab you can cut and paste to or from
+ any of the tabs. This gives you the opportunity to test code
+ from the command line.
+ </para>
+
+ </section>
+
+ <section id="grt-globals-tree-panel">
+
+ <title>The Globals Tree Panel</title>
+
+ <para>
+ The <literal>Globals Tree</literal> is found on the right side
+ of the screen and is made up of three tabs,
+ <literal>Values</literal>, <literal>Structs</literal>, and
+ <literal>Modules</literal>.
+
+ <remark>
+ How are these different?
+ </remark>
+ </para>
+
+ <section>
+
+ <title>The <literal>Values</literal> Tab</title>
+
+ <para>
+ The objects shown in this tab differ depending upon which
+ &gui_tools; application you are running. For example, if you
+ are running &workbench; you should find a
+ <literal>workbench</literal> object beneath the
+ <literal>root</literal> object. If you currently have a schema
+ loaded you should be able to find it beneath the
+ <literal>workbench</literal> object. Clicking
+ <literal>workbench </literal> will expose the
+ <literal>catalog</literal> object and clicking this object in
+ turn will show <literal>charcterSets</literal>,
+ <literal>schemata</literal>, and
+ <literal>simpleDataTypes</literal>. Beneath
+ <literal>schemata</literal> you should see the default
+ <literal>New Schema</literal> plus any schemata you have
+ loaded. Detailed information about the currently selected
+ object appears in the window below the module tree.
+ </para>
+
+ <para>
+ If you are running &migration_toolkit;, the
+ <literal>workbench</literal> object is absent but you will
+ find a <literal>migration</literal> object beneath the
+ <literal>root</literal> object. Both applications show the
+ <literal>rdbmsMgmt</literal> object.
+ </para>
+
+ <para>
+ When the <literal>Values</literal> tab is selected right
+ clicking an object in the Globals Tree panel opens a pop-up
+ menu with the options:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Refresh
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Remove Object
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Display Type Info
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Display Object Values
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Display Object RefCount
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ With the exception of <guimenu>Remove Object</guimenu>, these
+ options are the same as those shown in
+ <xref linkend="grt-view-menu"/>. You may remove any object
+ except the <literal>root</literal> object.
+ </para>
+
+ <note>
+ <para>
+ Note this pop-up menu only shows under Windows.
+ </para>
+ </note>
+
+ </section>
+
+ <section>
+
+ <title>The <literal>Struct</literal> Tab</title>
+
+ <para>
+ A <literal>struct</literal> is a user-defined data type formed
+ by combining primitive data types. This tab shows the
+ definitions of the structs used by the objects in the
+ <literal>Values</literal> tab and the modules in the
+ <literal>Modules</literal> tab.
+ </para>
+
+ <para>
+ When the <literal>Structs</literal> tab is selected right
+ clicking a structure in the list opens a pop-up menu with the
+ options:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Order by Name
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Order by Hierarchy
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Order by Package
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <note>
+ <para>
+ Note this pop-up menu only shows under Windows.
+ </para>
+ </note>
+
+ <para>
+ The default view for this tab is by package, a grouping of
+ elements by functionality. Double-click a package to show
+ related structures. Under <literal>db.mgmt</literal>, for
+ example, you should see elements you are already familiar with
+ from the user interface, <literal>Connection</literal>,
+ <literal>Driver</literal>, and so forth. If an element can be
+ further decomposed, an arrow will show on it's left.
+ Double-click the item to reveal its constituent elements.
+ </para>
+
+ <para>
+ If you switch to the hierarchical view you'll find the
+ <literal>db.mgmt.driver</literal> object under the
+ <literal>GRT Object</literal> since this is the parent object
+ from which it is derived.
+ </para>
+
+ <para>
+ Ordering by name simply shows all the different objects
+ arranged alphabetically.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>The <literal>Modules</literal> Tab</title>
+
+ <para>
+ A module can be either a Python or Lua script or a Java class
+ file. Information about modules appears in the window below
+ the module tree. For example, go to the
+ <literal>Modules</literal> tab and click on the
+ <literal>ReverseEngineeringGeneric</literal> module. Double
+ click a module and you will see its methods.
+ </para>
+
+ <para>
+ Double clicking a method name will copy it into the GRT shell
+ window. You will see how useful this can be in
+ <xref linkend="using-grt-shell"/>.
+ </para>
+
+ </section>
+
+ </section>
+
+ </section>
+
+<!--End Exploring-->
+
+ <section id="using-grt-shell">
+
+ <title>Using the GRT Shell</title>
+
+ <para>
+ There are three built-in Lua modules that assist working from the
+ GRT shell:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>grtV</literal> – for accessing any
+ object/variable in the <literal>Values</literal> tab
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>grtS</literal> – for viewing the structs
+ defined in the <literal>Structures</literal> tab
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>grtM</literal> – for accessing any object in
+ the <literal>Modules</literal> tab
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ All items in all the tabs are accessible from the GRT shell.
+
+ <remark>
+ You can use the structs defined ...
+ </remark>
+ </para>
+
+ <para>
+ The script example below uses the <literal>getGlobal</literal>
+ method of the <literal>grtV</literal> object to return a list of
+ databases and then iterates through this list.
+ </para>
+
+<programlisting>
+dbs = grtV.getGlobal("/rdbmsMgmt/rdbms")
+for i = 1, grtV.getn(dbs) do
+ print(dbs[i].name)
+end
+</programlisting>
+
+ <para>
+ The <literal>getGlobal</literal> method returns the object found
+ at the path parameter passed to it. In this case, the object is a
+ list that is traversed using a <literal>for</literal> loop
+ controlled by the <literal>getn</literal> method which returns the
+ number of elements in the database list.
+ </para>
+
+ <para>
+ Running this <literal>for</literal> loop outputs the names of the
+ database formats supported by the &workbench; and the
+ &migration_toolkit;:
+ </para>
+
+<programlisting>
+"Oracle"
+"Mysql"
+"MaxDB"
+"GenericJdbc"
+"Mssql"
+"Access"
+</programlisting>
+
+ <para>
+ To discover all the methods available for a specific object, type
+ the object name preceded by a ‘<literal>?</literal>’.
+ For example typing <command>?grtV</command> shows:
+ </para>
+
+<programlisting>
+GRT Value Management Library - grtV
+-----------------------------------
+A library that contains functions to work with GRT values.
+
+clearList child diffMake
+diffApply duplicate fromXml
+getContentType getKey getListItemByObjName
+getListRefValueByObjName getn getGlobal
+insert load lookupAdd
+lookupId newDict newList
+newObj remove save
+setContentType setGlobal toLua
+toXml typeOf
+
+Type 'help grtV.<command>' to get help on a specific command.
+</programlisting>
+
+ <para>
+ <remark>
+ Add an object that will appear in the tab? i.e definition of an
+ different database struct?
+ </remark>
+ </para>
+
+ </section>
+
+ <section id="invoking-grt-from-command-line">
+
+ <title>Invoking the GRT Shell From the Command Line</title>
+
+ <note>
+ <para>
+ This capability is currently only available under Windows.
+ </para>
+ </note>
+
+ <para>
+ In addition to using the GRT shell from within the &workbench; or
+ the &migration_toolkit;, you can invoke it directly from the
+ command line. If the location of the &gui_tools; is not included
+ in the <literal>PATH</literal> variable, navigate to the
+ installation directory and find the <filename>grtsh.exe</filename>
+ file.
+ </para>
+
+ <para>
+ Execute this file by typing:
+ </para>
+
+<programlisting>
+C:\> <userinput>grtsh -?</userinput>
+</programlisting>
+
+ <para>
+ Do this and you should see the following listing:
+ </para>
+
+<programlisting>
+Usage: C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe [-classpath path] »
+ [-modulepath path] [-jvm library] [-d path] [-listen port] [-verbose] [-x] [luafile]
+ C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe -j structsfile outputdir
+ C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe -p structsfile outputdir
+
+ -lua ......... Use the Lua shell (default).
+ -py .......... Use the Python shell.
+ -classpath ... Sets the java classpath to the given value.
+ -modulepath .. Sets the location of the GRT module directory.
+ -jvm ......... The java virtual machine library to use (with absolute path).
+ -basedir ..... Path to the data files location.
+ -d path ...... Modules directory
+ -x ........... Exits the shell after running the specified file
+ luafile ...... File that is run at startup.
+
+ -listen port . Runs in 'remote agent' mode on the given port number.
+ -verbose ..... Prints detailed startup information.
+ -j ........... Generates Java classes from the given structs file.
+ -p ........... Generates PHP classes from the given structs file.
+ -D var=value . Sets a global shell variable to the given value.
+Environment variables:
+GRT_MODULE_PATH Equivalent to -modulepath, must point to the directory
+ where the grtsh binary resides
+</programlisting>
+
+ <para>
+ The default shell is the <literal>Lua</literal> shell and is
+ indicated by the <literal>/ ></literal> prompt. Using the
+ <option>-py</option> option opens a Python shell, indicated by the
+ <literal>/>>></literal> prompt.
+ </para>
+
+ <para>
+ If you wish to set the classpath for Java classes use the
+ <option>classpath</option> option. You may also change the Java
+ Virtual Machine (JVM) by using the <option>jvm</option> option
+ with the absolute path to the JVM you wish to use.
+ </para>
+
+ <para>
+ The <option>modulepath</option> option sets the location of the
+ <filename>dll</filename> files used with the GRT shell. These
+ files are located in the same directory as the
+ <filename>grtsh.exe</filename> file. You can also set this
+ directory by defining the environment variable,
+ <literal>GRT_MODULE_PATH</literal>.
+ </para>
+
+ <para>
+ The location of any data files you wish to use may be set using
+ the <option>basedir</option> option.
+
+ <remark>
+ [PL]What are data files?
+ </remark>
+ </para>
+
+ <para>
+ To see the various modules that are loaded at startup use the
+ <option>verbose</option> option. The java modules are stored in
+ the <filename>java\com\mysql\grt\modules</filename> directory
+ immediately below the installation directory and the
+ <literal>Lua</literal> modules in the <filename>lua</filename>
+ directory. Currently, importing Python modules is not
+ supported.
+ </para>
+
+ <para>
+ To include modules other than the default modules, use the
+ <option>d</option> option with a path.
+ </para>
+
+ <para>
+ It is also possible to use the GRT shell to convert XML files to
+ Java or PHP class files, by opening the shell using the
+ <option>j</option> or the <option>p</option> option and specifying
+ the XML source file and the destination directory.
+ </para>
+
+ <para>
+ Use the <option>listen</option> option with a port number to run
+ the GRT shell as a service that can be accessed from a remote
+ location.
+ </para>
+
+ <para>
+ Perhaps most importantly, you can pass a <literal>Lua</literal>
+ script to the shell on startup. This allows you to perform tasks
+ using a script file without even opening the &workbench; or the
+ &migration_toolkit;. This is an especially useful feature if you
+ need to migrate the same database a number of times or you want to
+ customize a migration. You can easily create a
+ <literal>Lua</literal> script by clicking the <guibutton>Generate
+ Migration Script</guibutton> when migrating using the graphical
+ interface. For information on creating a Lua script see,
+ <xref linkend="mysql-migration-toolkit-indepth-summary"/>.
+ A Lua migration script is examined in detail in
+ <xref linkend="scripted-migration" />.
+ </para>
+
+ <para>
+ Passing a <literal>Lua</literal> file to the shell is usually
+ invoked using the <option>x</option> option so that the shell
+ closes after the script has executed.
+ </para>
+
+ <para>
+ The appearance of the GRT shell run from the command line is
+ identical to its appearance when run from within the &workbench;
+ or the &migration_toolkit;. All the commands and options described
+ in <xref linkend="using-grt-shell"/> are available when the GRT
+ shell is invoked from the command line.
+ </para>
+
+ </section>
+
+<!--End Using -->
+
+
+
+</chapter>
+<!-- end GRT Shell -->
Property changes on: trunk/gui-common-cy/chapter-grt-shell.xml
___________________________________________________________________
Name: svn:executable
+ *
Added: trunk/gui-common-cy/chapter-options-connections.xml
===================================================================
--- trunk/gui-common-cy/chapter-options-connections.xml (rev 0)
+++ trunk/gui-common-cy/chapter-options-connections.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 303, Lines Deleted: 0; 10910 bytes
@@ -0,0 +1,303 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % urls.entities SYSTEM "../refman-common/urls.ent">
+ %urls.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ ]>
+<section id="mysql-gui-options-connections">
+
+ <title>Connections</title>
+
+ <para>
+ The <literal>Connections</literal> section allows you to create,
+ edit, and delete connection profiles. The center box displays a list
+ of currently available profiles, together with a history of
+ connections that were made without being stored in a profile. You
+ can collapse or expand both the <literal>Connections</literal> and
+ <literal>History</literal> trees by double clicking them.
+ </para>
+
+ <para>
+ Connections are automatically added to the
+ <literal>History</literal> tree whenever you establish a connection
+ to a MySQL server without using one of the profiles stored under the
+ <literal>Connections</literal> tree. They do not appear in the
+ drop-down box of the <literal>Connection</literal> dialog, but you
+ can use any of them by manually typing their name into the
+ <literal>Connection</literal> box of the
+ <literal>Connection</literal> dialog.
+ </para>
+
+ <figure>
+ <title>Options dialog: Connections</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/options-connection.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Options dialog: Connections</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ To edit an existing connection profile, click on its name and change
+ the values that appear in the <literal>Connection
+ Parameters</literal> and <literal>Advanced Parameters</literal>
+ tabs, then click on the <guibutton>Apply Changes</guibutton> button
+ to save your changes.
+ </para>
+
+ <para>
+ When you select a connection profile from either the
+ <literal>Connections</literal> or <literal>History</literal> trees,
+ the <literal>Connection Parameters</literal> tab displays the
+ following fields:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Connection</literal>: The connection profile label.
+ This is the name by which you refer to the profile and that
+ appears in the <literal>Connection</literal> drop-down box of
+ the Connection dialog. It may contain any characters, including
+ spaces. Choose distinctive names so that you can easily tell
+ which profiles they refer to. The names can help you distinguish
+ connections to different MySQL servers, or connections as
+ different MySQL users to a given server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Username</literal>: The username used to connect to the
+ MySQL server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Password</literal>: The password used to connect to the
+ MySQL server. Note that passwords are not stored in the
+ connection profile, unless you specify otherwise in the
+ <link
+linkend="mysql-gui-options-general-options">General
+ Options section</link>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Hostname</literal>: The name of the host machine where
+ the MySQL server runs, or its IP address.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Port</literal>: The TCP/IP port that the MySQL server
+ listens to on the host machine.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Type</literal>: Specifies the protocol used to connect
+ to the database server. The default protocol is
+ <literal>MySQL</literal> (which uses the native MySQL protocol).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Schema</literal>: The default database for a connection
+ when using the &query_browser;.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Notes</literal>: You can use this field to enter
+ comments or additional information describing the connection
+ profile.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <note>
+ <para>
+ The <literal>Advanced Parameters</literal> tab is not available on
+ all platforms. Advanced parameters can still be configured in the
+ Connection dialog. Use the <guibutton>Details ...</guibutton>
+ button to display the <literal>Advanced Connection
+ Options</literal>.
+ </para>
+ </note>
+
+ <para>
+ When you select a connection profile from either the
+ <literal>Connections</literal> or <literal>History</literal> list,
+ the <literal>Advanced Parameters</literal> tab displays the
+ following checkboxes:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Use compressed protocol</literal>: If checked, the
+ communication between the application and the MySQL server will
+ be compressed, which may increase transfer rates. This
+ corresponds to starting a MySQL command-line tool with the
+ <literal>--compress</literal> option.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Return number of found rows, not number of affected
+ rows</literal>: By default, MySQL returns the number of rows
+ changed by the last <literal>UPDATE</literal>, deleted by the
+ last <literal>DELETE</literal> or inserted by the last
+ <literal>INSERT</literal> statement. When this option is
+ checked, the server returns the number of rows matched by the
+ <literal>WHERE</literal> statement for <literal>UPDATE</literal>
+ statements.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Ignore spaces after function names, make them reserved
+ words</literal>: Normally, any reference to a function name in
+ an SQL statement must be followed immediately by an opening
+ parenthesis. If this option is checked, spaces may appear
+ between the function name and the parenthesis, like this:
+ </para>
+
+<programlisting>
+COUNT (*)
+</programlisting>
+
+ <para>
+ Enabling this option has the effect that function names become
+ reserved words. This option corresponds to starting a MySQL
+ command-line tool with the <literal>--ignore-spaces</literal>
+ option.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Allow interactive_timeout seconds of inactivity before
+ disconnect</literal>: Normally, the connection is closed by the
+ MySQL server after a certain period of inactivity on the client
+ side. This period can be set with the
+ <literal>interactive_timeout</literal> variable. If checked, the
+ server will not close the connection unless the period of
+ inactivity exceeds the value set by
+ <literal>interactive_timeout</literal>. This corresponds to
+ starting a MySQL command-line tool with the
+ <literal>--connect-timeout=<replaceable>seconds</replaceable>
+ </literal> option.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Enable LOAD DATA LOCAL handling</literal>: By default,
+ the <literal>LOCAL</literal> option of the <literal>LOAD
+ DATA</literal> statement is disabled for security reasons.
+ Enabling this option will allow you to load data from the local
+ machine (the machine where the client GUI application is
+ running). This option corresponds to starting a MySQL
+ command-line tool with the <literal>--local-infile=1</literal>
+ option. (Note that this option is ineffective unless the MySQL
+ server allows <literal>LOCAL</literal> handling.)
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <section id ="mysql-gui-options-ssl-connections">
+
+ <title>SSL Connections</title>
+
+ <para>
+ To set up an SSL connection under Windows,
+ open the <guilabel>Advanced Parameters</guilabel> tab
+ of the <literal>Options Dialog</literal> window. Select the connection
+ you wish to configure, or create a new connection.
+ Use the <literal>Advanced Parameters</literal> text boxes
+ to send options to the MySQL client library
+ in much the same way that you would pass parameters to
+ the command-line client.
+ </para>
+
+ <para>
+ The parameters are essentially the same as those you would use for the
+ command-line client, with underscores replacing ‘<literal>-</literal>’
+ and <literal>USE_SSL</literal> replacing <option>--ssl</option>. See the
+ following example.
+ </para>
+
+ <figure>
+ <title>Options dialog: Advanced Parameters</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/ssl-params.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Options dialog: Advanced Parameters</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <para>
+ The file separator used for path parameters
+ is ‘<literal>/</literal>’ and not
+ ‘<literal>\</literal>’.
+ </para>
+ </note>
+
+
+ <para>
+ The parameters used with an SSL connection are found in
+ the <literal>SSL Command Options</literal> section of
+ the reference manual.
+ For instructions on setting up SSL certificates,
+ see <literal>Setting Up SSL Certificates for MySQL</literal>.
+ Links to the different versions
+ of the reference manual are found at
+ <ulink url="&base-url-refman;"/>.
+ </para>
+
+ <para>
+ <remark>[PL] Confirm below with mikez.</remark>
+ </para>
+
+ <!--para>
+ To use SSL under Linux choose the <guilabel>Advanced Options</guilabel>
+ tab of the <literal>Options Dialog</literal> and check the <literal>Encrypt connection if available</literal>
+ check box. Be sure to apply your changes before closing the tab.
+ </para-->
+
+ <para>
+ There is currently no provision for creating an SSL connection
+ when running &gui_tools; on Mac OS X.
+ </para>
+
+ </section>
+
+
+</section>
+<!-- END CONNECTIONS -->
Added: trunk/gui-common-cy/chapter-options-editors.xml
===================================================================
--- trunk/gui-common-cy/chapter-options-editors.xml (rev 0)
+++ trunk/gui-common-cy/chapter-options-editors.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 111, Lines Deleted: 0; 3625 bytes
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ ]>
+<section id="mysql-gui-options-editors">
+
+ <title>Editors</title>
+
+ <para>
+ The <literal>Editors</literal> section is used to configure options
+ specific to the different editors available within the MySQL GUI
+ Suite. At the time of writing this is limited to the
+ <link linkend="gui-table-editor">&table_editor;</link>.
+ </para>
+
+ <note>
+ <para>
+ Currently, configuring editors is only available on the
+ Windows platform.
+ </para>
+ </note>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Show SQL command before applying changes</literal>:
+ Toggles whether the &table_editor; will show you the
+ <literal>CREATE TABLE</literal> or <literal>ALTER
+ TABLE</literal> statement it is about to execute for
+ confirmation when you click <guibutton>Apply
+ Changes</guibutton>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>All columns Not Null per default</literal>: Determines
+ whether the &table_editor; will designate columns as being
+ <literal>NOT NULL</literal> by default when creating new
+ columns.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>All integer columns unsigned per default</literal>:
+ Sets whether integer columns are declared
+ <literal>UNSIGNED</literal> by default when creating new
+ columns.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Default storage engine</literal>: Sets the storage
+ engine to be assigned to newly created tables. This value is
+ independent of the default storage engine of the MySQL server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>PK Naming</literal>: Dictates the format that should be
+ used to name <literal>PRIMARY KEY</literal> columns that are
+ automatically generated. The
+ <replaceable>%tablename%</replaceable> portion will be replaced
+ with the name of the appropriate table.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Index Naming</literal>: Sets the name automatically
+ generated for new indexes. The <replaceable>%nr%</replaceable>
+ string will be replaced with an automatically incrementing
+ number.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>FK Naming</literal>: Configures the name used when
+ creating new foreign keys.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>PK Datatype</literal>: The datatype used when creating
+ a <literal>PRIMARY KEY</literal> column.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Def. data type</literal> The default datatype assigned
+ to all new columns that are not part of a <literal>PRIMARY
+ KEY</literal>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+</section>
+<!-- END EDITORS -->
Added: trunk/gui-common-cy/chapter-options-general.xml
===================================================================
--- trunk/gui-common-cy/chapter-options-general.xml (rev 0)
+++ trunk/gui-common-cy/chapter-options-general.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 103, Lines Deleted: 0; 3364 bytes
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ ]>
+<section id="mysql-gui-options-general-options">
+
+ <title>General Options</title>
+
+ <para>
+ The <literal>General Options</literal> section allows you to specify
+ a number of settings that are valid for all graphical MySQL
+ applications.
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Store Window Positions</literal>: When an application
+ is started the next time, its latest window position will be
+ reused.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Show Tip of Day</literal>: If checked, a pop-up window
+ with the tip of the day appears at program startup.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Store Passwords</literal>: If checked, passwords are
+ stored in the user's connection profile. You can specify the
+ password storage method:
+ </para>
+
+ <para>
+ <literal>Plaintext</literal>: Passwords are stored without
+ encryption; this can be insecure. <literal>Obscured</literal>:
+ Passwords are encrypted using a weak algorithm. This encryption
+ method is operating system independent. <literal>OS
+ Specific</literal>: Use the default encryption method provided
+ by your operating system. The default option is
+ <literal>Plaintext</literal>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Language</literal>: Select the interface language. The
+ default is <literal>English</literal>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Default Font</literal>: The font used for all
+ aplication text.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Data Font</literal>: The font used for all query and
+ table data displayed.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Code Font</literal>: The font used for all queries
+ entered by the user..
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Ignorelist</literal>: Whenever you check the
+ <literal>Do Not Show This Message Again</literal> option on
+ error and message prompts, they are added to this list. If you
+ would like a particular message to be shown again, click the
+ <guibutton>Remove</guibutton> button after selecting the message
+ from the list.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ You may change the font and font size of any of the application
+ fonts by clicking the <guibutton>Choose ...</guibutton> button to
+ the right of the font.
+ </para>
+
+</section>
+<!-- END GENERAL OPTIONS -->
Added: trunk/gui-common-cy/chapter-options-introduction.xml
===================================================================
--- trunk/gui-common-cy/chapter-options-introduction.xml (rev 0)
+++ trunk/gui-common-cy/chapter-options-introduction.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 84, Lines Deleted: 0; 2471 bytes
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ ]>
+<section id="mysql-gui-options-introduction">
+
+ <title>Introduction</title>
+
+ <para>
+ The <literal>Options</literal> dialog allows you to configure
+ connection profiles, general program settings, and more. You can
+ open the <literal>Options</literal> dialog window using one of the
+ following methods:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ In the connection dialog window, click the
+ <guibutton>...</guibutton> button.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In the main application window select <guimenu>Options
+ ...</guimenu> from the <guimenu>Tools</guimenu> menu.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <figure>
+ <title>Options dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/options.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Options dialog</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ In the sidebar of the dialog, you can select the section you wish to
+ configure. There are three action buttons in the lower right corner
+ of the window:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <guibutton>Apply</guibutton>: Applies and saves changes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guibutton>Discard</guibutton>: Discards any changes you have
+ made.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guibutton>Close</guibutton>: Closes the
+ <literal>Options</literal> dialog window. If you have not
+ applied or discarded your changes, you will be prompted to do
+ so.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+</section>
+<!-- END INTRODUCTION -->
Added: trunk/gui-common-cy/chapter-table-editor.xml
===================================================================
--- trunk/gui-common-cy/chapter-table-editor.xml (rev 0)
+++ trunk/gui-common-cy/chapter-table-editor.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 635, Lines Deleted: 0; 21181 bytes
@@ -0,0 +1,635 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ ]>
+<chapter id="gui-table-editor">
+
+ <title>The &table_editor;</title>
+
+ <section id="gui-table-editor-introduction">
+
+ <title>Introduction</title>
+
+ <para>
+ The &table_editor; is a component of the &query_browser;,
+ &administrator;, and &workbench; enabling the visual creation and modification of
+ tables.
+ </para>
+
+ <para>
+ The &table_editor; can be accessed from the &query_browser; by
+ right clicking on a table within the database browser and choosing
+ the <guimenu>Edit Table</guimenu> option, or by right clicking on
+ a database within the database browser and choosing the
+ <guimenu>Create New Table</guimenu> option.
+ </para>
+
+ <para>
+ The &table_editor; can be accessed from &administrator; through
+ the <guimenu>Catalogs</guimenu> screen. Once you have selected a
+ database, right click on a table and choose the <guimenu>Edit
+ Table</guimenu> option from the drop-down menu. You can also
+ select a table and click the <guibutton>Edit Table</guibutton>
+ button to access the &table_editor;.
+ </para>
+
+ <para>
+ The &table_editor; can be accessed from the &workbench; by
+ double clicking a table in the <literal>Main View</literal>
+ panel. On Windows you also have the option of
+ right-clicking in the schemata panel and choosing
+ the <guimenu>Create MySQL Table</guimenu> option from the pop-up menu.
+ </para>
+
+
+ <para>
+ The appearance of the &table_editor; varies slightly depending
+ upon the operating system (OS) and whether the &table_editor; is docked or not.
+ For example, under Linux the
+ Columns and Indexes are separate tabs but under Windows
+ they are combined in one.
+ However, the same basic functionality is available regardless
+ of docking or the particular OS.
+ </para>
+
+ <note>
+ <para>
+ Docking is not supported on all operating systems.
+ </para>
+ </note>
+
+
+ </section>
+
+<!-- END INTRODUCTION -->
+
+ <section id="gui-table-editor-main-window">
+
+ <title>The Main Editor Window</title>
+
+ <para>
+ The &table_editor; consists of a work space divided into
+ tabs, some general information prompts, and two or three action buttons.
+ </para>
+
+ <para>
+ Regardless of the active tab, you can always edit the table name
+ and the table comment.
+ </para>
+
+ <figure>
+ <title>The &table_editor;</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/tableeditor.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The &table_editor;</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The tabbed area is divided into three sections:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <emphasis>Columns and Indices:</emphasis> Use the Columns and
+ Indices tab to create and modify the table's column and index
+ information. You can also create FOREIGN KEY relationships
+ using this tab.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Table Options:</emphasis>Use the Table Options tab
+ to choose the storage engine and default character set used by
+ the table.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Advanced Options:</emphasis> Use the Advanced
+ Options tab to configure options such as the per-table storage
+ directory, MERGE and RAID table options, and table/row length
+ options.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Each of these areas are discussed in further detail in the
+ following sections.
+ </para>
+
+ </section>
+
+<!-- END MAIN WINDOW -->
+
+ <section id="gui-table-editor-columns-and-indices">
+
+ <title>The Columns And Indices Tab</title>
+
+ <para>
+ The <literal>Columns and Indices</literal> tab can be used to
+ display and edit all column and index information for your table.
+ Using this tab, you can add, drop, and alter columns and indexes.
+ </para>
+
+ <section id="gui-table-editor-columns-and-indices-column-editor">
+
+ <title>The Column Editor</title>
+
+ <para>
+ You can use the column editor to change the name, data type,
+ default value, and other properties of your table's columns.
+ </para>
+
+ <figure>
+ <title>The column editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/columneditor.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The column editor</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ To add a column simply double-click a column in an empty row
+ and enter an appropriate value.
+ </para>
+
+ <para>
+ To change the name, data type, default value, or comment of a
+ column, double click on the value you wish to change. The value
+ becomes editable and you can complete your changes by pressing
+ the <keycap>Enter</keycap> key.
+ </para>
+
+ <para>
+ To modify the flags on a column (<literal>UNSIGNED</literal>,
+ <literal>BINARY</literal>, <literal>ASCII</literal>, and so on)
+ check and uncheck the boxes corresponding to the flag you wish
+ to change.
+ </para>
+
+ <para>
+ To the left of the column name is an icon that indicates whether
+ the column is a member of the primary key. If the icon is a
+ small key, that column belongs to the primary key, otherwise the
+ icon is a blue diamond. To add or remove a column from the
+ primary key, you can click on the icon.
+ </para>
+
+ </section>
+
+<!-- END COLUMN EDITOR -->
+
+ <section id="gui-table-editor-columns-and-indices-detail">
+
+ <title>The Detail Area</title>
+
+ <para>
+ The detail area of the <literal>Columns and Indices</literal>
+ tab is divided into three tabs used for modifying the index,
+ foreign key, and miscellaneous information regarding your
+ columns.
+ </para>
+
+ <section id="gui-table-editor-columns-and-indices-detail-indices">
+
+ <title>The Indices Tab</title>
+
+ <para>
+ The <literal>Indices</literal> tab holds all index information
+ for your table. You can add, drop, and modify indexes using
+ the indices tab, in combination with the column editor.
+ </para>
+
+ <figure>
+ <title>The index editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/indexeditor.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The index editor</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ To add an index, click the <guibutton>+</guibutton> (plus)
+ button below the index list. The &query_browser; prompts for
+ an index name and the new index is created. Under Windows, you
+ can change the automatically generated index name by using the
+ <literal>Options</literal> dialog window. For more information
+ see, <xref linkend="mysql-gui-options-editors"/>.
+ </para>
+
+ <para>
+
+ To drop an index,
+ select the index and click the <guibutton>–</guibutton>
+ (minus) button.
+ </para>
+
+ <para>
+ Use the <guilabel>Index Name</guilabel> and <guilabel>Index
+ Kind</guilabel> dialog boxes to modify the name and type
+ (<literal>UNIQUE</literal>, <literal>FULLTEXT</literal>, and
+ so on) of the index.
+ </para>
+
+ <para>
+ To add columns to an index, either click and drag the column
+ to the <guilabel>Index Columns</guilabel> box or select the
+ column you wish to add and click the <guibutton>+</guibutton>
+ (plus) button to the right of the <guilabel>Index
+ Columns</guilabel> box. You can remove a column from the index
+ by selecting the column and clicking the
+ <guibutton>–</guibutton> (minus) button to drop the column
+ from the index.
+ </para>
+
+ <para>
+ To change an index to only refer to a column prefix (such as
+ with the CHAR and VARCHAR string data types), select the index
+ column you wish to prefix in the <guilabel>Index
+ Columns</guilabel> box and then click the arrow icon to the
+ right of the <guilabel>Index Columns</guilabel> box. Select
+ the <guimenu>Set Index Column Length</guimenu> option from the
+ drop-down menu that appears.
+ </para>
+
+ </section>
+
+<!-- END INDICES TAB -->
+
+ <section id="gui-table-editor-columns-and-indices-detail-foreign-keys">
+
+ <title>The Foreign Keys Tab</title>
+
+ <para>
+ The <literal>Foreign Keys</literal> tab is divided into two
+ sections, one with a list of foreign keys and one with various
+ dialog boxes for foreign key settings.
+ </para>
+
+ <para>
+ To add a foreign key, click the <guibutton>+</guibutton>
+ (plus) button below the foreign key list. A dialog box
+ prompts for a foreign key name and the new foreign key is
+ created. Under Windows, you
+ can change the automatically generated foreign key name by using the
+ <literal>Options</literal> dialog window. For more information
+ see, <xref linkend="mysql-gui-options-editors"/>.
+ </para>
+
+ <para>
+ To drop a foreign key, select the foreign key and click the
+ <guibutton>–</guibutton> (minus) button below the foreign key
+ list.
+ </para>
+
+ <para>
+ You can modify the name of the foreign key, its <literal>ON
+ DELETE</literal>, and its <literal>ON UPDATE</literal> actions
+ using the dialog boxes provided in the <guilabel>Foreign Key
+ Settings</guilabel> section of the tab.
+ </para>
+
+ <para>
+ The options are:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>NO ACTION</para>
+ </listitem>
+
+ <listitem>
+ <para>RESTRICT</para>
+ </listitem>
+
+ <listitem>
+ <para>CASCADE</para>
+ </listitem>
+
+ <listitem>
+ <para>SET NULL </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+
+ <para>
+ To establish a foreign key relationship, choose a table from
+ the <guilabel>Ref. Table</guilabel> drop-down list.
+ (Under Linux this list box is called <guilabel>Refer. Table</guilabel>.) The
+ fields that can be related to create a foreign key are listed in
+ the frame below the drop-down list. This frame contains two columns;
+ one labeled <literal>Column</literal> and the other
+ <literal>Reference Column</literal>.
+ To select a column as a foreign key, double click the
+ area below <guilabel>Column</guilabel> and select a
+ column from the drop-down list. Alternately, drag a column from the
+ column editor to the <guilabel>Column</guilabel> section. To
+ add a related column from the referenced table, double click the area
+ below <guilabel>Reference Column</guilabel> and select the related
+ column from the drop-down list.
+ </para>
+
+ </section>
+
+<!-- END FOREIGN KEY -->
+
+ <section id="gui-table-editor-columns-and-indices-detail-column-details">
+
+ <title>The Column Details Tab</title>
+
+ <para>
+ The <literal>Column Details</literal> tab provides an
+ interface for setting the parameters of a column without using
+ the table interface of the column editor.
+ </para>
+
+ <para>
+ All settings that are available in the
+ <link linkend="gui-table-editor-columns-and-indices-column-editor">Column
+ Editor</link> are also available in the Column Details tab,
+ and in addition you can also configure the column character
+ set and column default collation from the Column Details tab.
+ </para>
+
+ <para>
+ Depending upon circumstances one or the other of these views
+ may be more convenient.
+ However, changing the data type in the tabular view is
+ especially easy because a drop-down list shows all available data types.
+ </para>
+
+ </section>
+
+<!-- END COLUMN DETAILS -->
+
+ </section>
+
+<!-- END DETAIL AREA -->
+
+ </section>
+
+<!-- END COLUMNS AND INDICES -->
+
+ <section id="gui-table-editor-Table-Options">
+
+ <title>The Table Options Tab</title>
+
+ <para>
+ The <literal>Table Options</literal> tab allows you to change the
+ storage engine and default character set of your table.
+ </para>
+
+ <para>
+ The potential storage engines are listed in a drop-down list box.
+ Select a particular engine to display a brief summary
+ of that engine's features and capabilities.
+ </para>
+
+ <para>
+ Under Windows, engines that are not available are shown in
+ red.
+ <remark>[PL] Change when appropriate.
+ (This behavior will soon be implemented under Linux as well.)
+ </remark>
+ Under Mac OS X, unavailable engines are grayed out and under Linux
+ there is no differentiation. If your server
+ has built-in support for the <literal>Falcon</literal> engine,
+ that engine will show up in the list of available engines. Otherwise,
+ the <literal>Falcon</literal> engine does not show at all.
+ </para>
+
+ <para>
+ To change the storage engine for your table, select
+ the desired storage engine from the list box.
+ </para>
+
+ <para>
+ To change the default character set or collation of your table,
+ choose a new option from the drop-down list of available character
+ sets.
+ </para>
+
+ </section>
+
+<!-- END TABLE OPTIONS -->
+
+ <section id="gui-table-editor-advanced-options">
+
+ <title>The Advanced Options Tab</title>
+
+ <para>
+ The <literal>Advanced Options</literal> tab is used to configure
+ table options that would be considered outside the standard set of
+ options that most users designate when creating and modifying
+ tables.
+ </para>
+
+ <para>
+ The <literal>Advanced Options</literal> tab is divided into
+ several sub-sections, each of which is described in the upcoming
+ sections of this manual.
+ </para>
+
+ <para>
+ For descriptions of most options set using the Advanced Options
+ tab, see <xref linkend="create-table"/>.
+ </para>
+
+ <section id="gui-table-editor-advanced-options-various">
+
+ <title>The Various Section</title>
+
+ <para>
+ The <literal>Various</literal> section of the <literal>Advanced
+ Options</literal> tab contains options for you to set the
+ <literal>PACK KEYS</literal> behavior, the table password, the
+ initial <literal>AUTO_INCREMENT</literal> value, and the delayed
+ key update behavior.
+ </para>
+
+ <para>
+ The <literal>AUTO_INCREMENT</literal> and delayed key update
+ behaviors apply only to MyISAM tables.
+ </para>
+
+ </section>
+
+<!-- END VARIOUS SECTION -->
+
+ <section id="gui-table-editor-advanced-options-row-options">
+
+ <title>The Row Options Section</title>
+
+ <para>
+ The <literal>Row Options</literal> section can be used to
+ configure options such as the row format, checksum use, and the
+ row size parameters needed for large tables.
+ </para>
+
+ <para>
+ To set the row format, choose the desired row format from the
+ drop-down list. See <xref linkend="myisam-table-formats"/>, for
+ more information on the different row formats that are
+ available. This option only applies to MyISAM tables.
+ </para>
+
+ <para>
+ When you expect a table to be particularly large, use the
+ <guilabel>Avg Row Length</guilabel>, <guilabel>Min
+ Rows</guilabel>, and <guilabel>Max Rows</guilabel> options to
+ enable the MySQL server to better accommodate your data. See
+ <xref linkend="create-table"/>, for more information on how to
+ use these options.
+ </para>
+
+ </section>
+
+<!-- END ROW OPTIONS -->
+
+ <section id="gui-table-editor-advanced-options-storage-options">
+
+ <title>The Storage Options Section</title>
+
+ <para>
+ The <literal>Storage Options</literal> section is used to
+ configure a custom path to the table storage and data files.
+ This option can help improve data integrity and server
+ performance by locating different tables on different
+ hard drives.
+ </para>
+
+ <para>
+ This option is only available for MyISAM tables and is not
+ available for servers running under the Windows operating
+ system.
+ </para>
+
+ </section>
+
+<!-- END STORAGE OPTIONS -->
+
+ <section id="gui-table-editor-advanced-options-merge-options">
+
+ <title>The Merge Table Options Section</title>
+
+ <para>
+ The <literal>Merge Table</literal> Options section is used to
+ configure MERGE tables in MyISAM. To create a MERGE table,
+ select MERGE as your storage engine in the
+ <link linkend="gui-table-editor-Table-Options">Table Options
+ Tab</link> and then specify the tables you wish to MERGE in the
+ <guilabel>Union Tables</guilabel> dialog.
+ </para>
+
+ <para>
+ You can also specify the action the server should take when
+ users attempt to perform INSERT statements on the merge table.
+ See <xref linkend="merge-storage-engine"/>, for more information on MERGE
+ tables.
+ </para>
+
+ </section>
+
+<!-- END MERGE OPTIONS -->
+
+ <section id="gui-table-editor-advanced-options-raid-options">
+
+ <title>The Table RAID Settings Section</title>
+
+ <para>
+ The <literal>Table RAID Settings</literal> section allows you to
+ configure RAID support for MyISAM tables. RAID allows MyISAM
+ table data files to grow larger than the 2GB/4GB size limit
+ imposed by some operating systems.
+ </para>
+
+ <para>
+ For more information on using RAID support with MyISAM, see
+ <xref linkend="create-table"/>.
+ </para>
+
+ </section>
+
+<!-- END RAID SECTION -->
+
+ </section>
+
+<!-- END ADVANCED OPTIONS -->
+
+ <section id="gui-table-editor-changes">
+
+ <title>Applying Your Changes</title>
+
+ <para>
+ The changes you make with the &table_editor; are not immediately
+ applied but are instead queued to be applied in batches after you
+ have made all your edits.
+ </para>
+
+ <para>
+ To apply the changes you have made, click the <guibutton>Apply
+ Changes</guibutton> button. The <literal>Confirm Table
+ Edit</literal> dialog will appear.
+ </para>
+
+ <figure>
+ <title>The Confirm Table Edit dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/confirmchanges.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The Confirm Table Edit dialog</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ You can click the <guibutton>Execute</guibutton> button to confirm
+ the changes and have them applied, or click the
+ <guibutton>Cancel</guibutton> button to cancel the changes (the
+ table editor window is redisplayed with your changes intact). You
+ can also click the <guibutton>Discard Changes</guibutton> button
+ in the main &table_editor; window to discard all changes you have
+ made.
+ </para>
+
+ <para>
+ You can also copy the proposed changes to the clipboard for
+ further editing by highlighting the ALTER TABLE or CREATE TABLE
+ statement, right-clicking and choosing <guimenu>Copy</guimenu>
+ from the drop-down menu.
+ </para>
+
+ </section>
+
+<!-- END APPLYING CHANGES -->
+
+</chapter>
+<!-- END TABLE EDITOR -->
Added: trunk/gui-common-cy/chapter-uninstall-all.xml
===================================================================
--- trunk/gui-common-cy/chapter-uninstall-all.xml (rev 0)
+++ trunk/gui-common-cy/chapter-uninstall-all.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 142, Lines Deleted: 0; 4743 bytes
@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ <!ENTITY % urls.entities SYSTEM "../refman-common/urls.ent">
+ %urls.entities;
+
+ ]>
+<chapter id="guitools-uninstall">
+
+ <title>Removing MySQL GUI Tools</title>
+
+ <para>
+ Under Linux and Mac OS X it is easy to remove all the
+ &gui_tools; or individual applications.
+ Under Windows, removing individual applications is a bit more problematic.
+ </para>
+
+<!-- Windows -->
+
+ <section>
+
+ <title>Uninstall – Windows</title>
+
+ <para>
+ To uninstall &gui_tools;, open the <literal>Control Panel</literal>
+ and Choose <literal>Add or Remove Programs</literal>. Find the
+ <literal>MySQL Tools</literal> entry and choose the
+ <guibutton>Remove</guibutton> button. Choosing this option will
+ remove all of the GUI Tools.
+ </para>
+
+ <note>
+ <para>
+ Currently, there is no command line option for removing
+ &gui_tools;.
+ </para>
+ </note>
+
+ <para>
+ After you have removed &gui_tools; you may remove the
+ <filename>MySQL Tools for
+ <replaceable>version</replaceable></filename> directory. Unless
+ you chose otherwise on installation, you should find this
+ directory below the
+ <filename>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\</filename>
+ directory.
+ </para>
+
+ <para>
+ You may remove individual applications manually. Go to the
+ <filename>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\</filename>
+ directory and delete the <filename>exe</filename> and <filename>chm</filename>
+ files associated with the application you wish to remove. Also remove
+ the appropriate icon from the <literal>Start</literal> menu.
+ </para>
+
+ <note>
+ <para>
+ Removing an application manually will not remove all the files
+ belonging to that application.
+ </para>
+ </note>
+
+ </section>
+
+<!-- END WINDOWS UnINSTALL -->
+
+ <section>
+
+ <title>Uninstall – Linux</title>
+
+ <para>
+ Unless you chose otherwise, you should find &gui_tools; in the
+ <filename>/opt/mysql-gui-tools-<replaceable>version</replaceable></filename>
+ directory.
+ </para>
+
+ <para>
+ If you installed &gui_tools; using the RPM files you can remove
+ all the tools by typing at the command line:
+ </para>
+
+<programlisting>
+shell> rpm -e mysql-*.rpm
+ </programlisting>
+
+ <para>
+ You may remove individual tools by using the <option>e</option> option
+ with the name of the specific tool you wish to remove. For
+ instance, to remove only the Administrator tool type:
+ </para>
+
+<programlisting>
+shell> rpm -e mysql-administrator-<replaceable>version</replaceable>.rpm
+ </programlisting>
+
+ <note>
+ <para>
+ Remember, if you plan to keep any one of the &gui_tools; you
+ must also keep the
+ <filename>mysql-gui-tools-<replaceable>version</replaceable>.rpm</filename>
+ file.
+ </para>
+ </note>
+
+ <para>
+ After removal of all the &gui_tools;, remove the
+ <filename>/opt/mysql-gui-tools-<replaceable>version</replaceable></filename>
+ directory. if you have removed only selected tools, remove only
+ the associated directories.
+ </para>
+
+ <para>
+ If you installed &gui_tools; using the generic tarball,
+ you can remove the tools by deleting the
+ <filename>/opt/mysql-gui-tools-<replaceable>version</replaceable></filename>
+ directory. If you wish to remove an individual tool, find the
+ directory associated with that tool and delete it.
+ </para>
+ </section>
+
+ <!-- END LINUX UnINSTALL -->
+
+ <section>
+
+ <title>Uninstall – Mac OS X</title>
+
+ <para>
+ Find the directory where you installed &gui_tools;,
+ and remove applications by moving their icons
+ to the <literal>Trash</literal>.
+ </para>
+ </section>
+
+<!-- END Mac OS X UnINSTALL -->
+
+</chapter>
Property changes on: trunk/gui-common-cy/chapter-uninstall-all.xml
___________________________________________________________________
Name: svn:executable
+ *
Added: trunk/gui-common-cy/chapter-upgrade-all.xml
===================================================================
--- trunk/gui-common-cy/chapter-upgrade-all.xml (rev 0)
+++ trunk/gui-common-cy/chapter-upgrade-all.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 120, Lines Deleted: 0; 3437 bytes
@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ <!ENTITY % urls.entities SYSTEM "../refman-common/urls.ent">
+ %urls.entities;
+
+ ]>
+<chapter id="guitools-upgrade">
+
+ <title>Upgrading MySQL GUI Tools</title>
+
+<!-- Windows -->
+
+ <section>
+
+ <title>Upgrading – Windows</title>
+
+ <para>
+ If you are upgrading using the installer file follow the
+ instructions given in <xref linkend="installation-windows"/>.
+ There are is no need to remove your current installation.
+ </para>
+
+ <para>
+ If you are not using the installer file remove the current
+ &gui_tools; directory, and extract and install the new version as
+ described in <xref linkend="installation-windows"/>.
+ </para>
+
+ </section>
+
+<!-- END WINDOWS -->
+
+ <section>
+
+ <title>Upgrading – Linux</title>
+
+ <section>
+
+ <title>Tarball Upgrade</title>
+
+ <para>
+ If you are upgrading using the generic tarball file, remove the
+ current &gui_tools; directory, and extract and install the new
+ tarball as described in
+ <xref linkend="install-generic-tarball"/>.
+ </para>
+
+ </section>
+
+ <section id="rpm-upgrade">
+
+ <title>RPM Upgrade</title>
+
+ <para>
+ If you installed the &gui_tools; using RPM files you can upgrade
+ by typing at the command line:
+ </para>
+
+<programlisting>
+shell> rpm -Uvh mysql-*.rpm
+ </programlisting>
+
+ <para>
+ You may upgrade individual tools by using the <option>U</option>
+ with the name of the specific tool you wish to upgrade. You will
+ also need to upgrade the
+ <filename>mysql-gui-tools-<replaceable>version</replaceable>.rpm</filename>
+ file. For instance, to upgrade only the Administrator tool type:
+ </para>
+
+<programlisting>
+shell> rpm -Uvh mysql-administrator-<replaceable>version</replaceable>.rpm mysql-gui-tools-<replaceable>version</replaceable>.rpm
+ </programlisting>
+
+ <note>
+ <para>
+ The
+ <filename>mysql-gui-tools-<replaceable>version</replaceable>.rpm</filename>
+ file is used by all &gui_tools;. You must always upgrade this
+ file.
+ </para>
+ </note>
+
+ <para>
+ When upgrading, packages cannot be installed separately because
+ version conflicts will arise.
+ </para>
+
+ </section>
+
+ </section>
+
+<!-- END LINUX UnINSTALL -->
+
+ <section>
+
+ <title>Upgrading – Mac OS X</title>
+
+ <para>
+ Find the directory where you installed &gui_tools;, and remove the
+ applications by moving their icons to the
+ <literal>Trash</literal>.
+ </para>
+
+ <para>
+ Install the upgrade as described in
+ <xref linkend="gui-tools-installation-osx"/>.
+ </para>
+
+ </section>
+
+<!-- END Mac OS X UnINSTALL -->
+
+</chapter>
Added: trunk/gui-common-cy/gui-common.ent
===================================================================
--- trunk/gui-common-cy/gui-common.ent (rev 0)
+++ trunk/gui-common-cy/gui-common.ent 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 8, Lines Deleted: 0; 622 bytes
@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='utf-8'?>
+<!ENTITY administrator "MySQL Administrator">
+<!ENTITY query_browser "MySQL Query Browser">
+<!ENTITY tray_monitor "MySQL System Tray Monitor">
+<!ENTITY table_editor "MySQL Table Editor">
+<!ENTITY workbench "MySQL Workbench">
+<!ENTITY migration_toolkit "MySQL Migration Toolkit">
+<!ENTITY gui_tools "MySQL GUI Tools">
Added: trunk/gui-common-cy/images/columneditor.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 317 bytes
Added: trunk/gui-common-cy/images/confirmchanges.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 321 bytes
Added: trunk/gui-common-cy/images/connectionerror.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 323 bytes
Added: trunk/gui-common-cy/images/grt-shell.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 337 bytes
Added: trunk/gui-common-cy/images/indexeditor.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 315 bytes
Added: trunk/gui-common-cy/images/options-connection.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes
Added: trunk/gui-common-cy/images/options.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 307 bytes
Added: trunk/gui-common-cy/images/ssl-params.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 339 bytes
Added: trunk/gui-common-cy/images/tableeditor.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 315 bytes
Added: trunk/gui-common-cy/installation-all.xml
===================================================================
--- trunk/gui-common-cy/installation-all.xml (rev 0)
+++ trunk/gui-common-cy/installation-all.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 359, Lines Deleted: 0; 12297 bytes
@@ -0,0 +1,359 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ <!ENTITY % urls.entities SYSTEM "../refman-common/urls.ent">
+ %urls.entities;
+
+ ]>
+<chapter id="guitools-general">
+
+ <title>Installation</title>
+
+ <section id="guitools-introduction">
+
+ <title>Introduction</title>
+
+ <para>
+ &gui_tools; run on Windows, Linux, and Mac OS X. You can find
+ &gui_tools; for the operating system of your choice on the
+ <ulink url="&base-url-downloads;/gui-tools/5.0.html">&gui_tools;
+ Downloads</ulink> page.
+ </para>
+
+ <para>
+ The &migration_toolkit; and the &workbench; both require
+ the Java Runtime Environment (JRE). The minimum version supported
+ is 5.0 update 8.
+ </para>
+
+ <para>
+ Regardless of platform, a working, current
+ <literal>OpenGL</literal> installation is required by the &workbench;.
+ To find out more about <literal>OpenGL</literal>
+ got to <ulink url="http://www.opengl.org/">www.opengl.org</ulink>. The
+ installation of OpenGL is beyond the scope of this document.
+ </para>
+
+ </section>
+
+ <!-- Introduction -->
+
+ <section id="installation-windows">
+
+ <title>Installing Under Windows</title>
+
+ <para>
+ &gui_tools; run on recent 32-bit Windows NT based operating
+ systems, including Windows 2000, XP, and 2003. They don't run on
+ Windows NT 4 and below.
+ </para>
+
+ <section>
+ <title>Using the Windows Installer</title>
+
+
+ <para>
+ &gui_tools; can be installed on all Windows operating systems
+ using the Windows Installer (<literal>.msi</literal>)
+ installation package. The MSI package is contained within a ZIP
+ archive named
+ <literal>mysql-gui-tools-<replaceable>version</replaceable>-win32.msi</literal>,
+ where <replaceable>version</replaceable> indicates the
+ &gui_tools; version.
+ </para>
+
+ <para>
+ The Microsoft Windows Installer Engine was updated with the
+ release of Windows XP; those using a previous version of
+ Windows can reference
+ <ulink url="http://support.microsoft.com/default.aspx?scid=kb;EN-US;292539">this
+ Microsoft Knowledge Base article</ulink> for information on
+ upgrading to the latest version of the Windows Installer
+ Engine.
+ </para>
+
+ <para>
+ In addition, Microsoft has recently introduced the WiX (Windows
+ Installer XML) toolkit. This is the first highly
+ acknowledged Open Source project from Microsoft. We have
+ switched to WiX because it is an Open Source project and it
+ allows us to handle the complete Windows installation process
+ in a flexible manner using scripts.
+ </para>
+
+ <para>
+ Improving the MySQL Installation Wizard depends on the support
+ and feedback of users like you. If you find that the MySQL
+ Installation Wizard is lacking some feature important to you,
+ or if you discover a bug, please report it in our bugs
+ database using the instructions given in
+ <xref linkend="bug-reports"/>.
+ </para>
+
+ <para>
+ To install &gui_tools;, right click on the MSI file and select
+ <guimenu>Install</guimenu>.
+ </para>
+
+ <para>
+ At the <literal>Setup Type</literal> window you may choose a
+ <option>complete</option> or <option>custom</option> installation.
+ If you do not wish to install all
+ of the &gui_tools; choose the custom option. Custom installation
+ also gives you the option of installing support for
+ languages other than English. &gui_tools; supports,
+ German, Greek, Japanese, Polish, and Brazilian Portuguese.
+ </para>
+
+ <para>
+ Unless you choose otherwise, &gui_tools; are installed in
+ <literal>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\MySQL
+ Tools for <replaceable>version</replaceable>\</literal>, where
+ <replaceable>%PROGRAMFILES%</replaceable> is the default
+ directory for programs on your machine and
+ <literal>version</literal> is the version number of &gui_tools;.
+ The <literal>%PROGRAMFILES%</literal>directory might be
+ <literal>C:\Program Files</literal> or
+ <literal>C:\programme</literal>.
+ </para>
+
+ <note>
+
+ <para>
+ Installing &gui_tools; using the Windows installer automatically
+ creates entries in the <literal>Start</literal> menu.
+ </para>
+
+ </note>
+ </section>
+ <section>
+
+ <title>Installing From the ZIP File</title>
+
+ <para>
+ If you are having problems running the installer, as an
+ alternative, you can download a ZIP file without an installer.
+ That file is called
+ <literal>mysql-gui-tools-noinstall-<replaceable>version</replaceable>-win32.zip</literal>.
+ Using a ZIP program, unpack it to the directory of your choice.
+ You may also want to create shortcuts to
+ <literal>MySQLAdministrator.exe</literal>,
+ <literal>MySQLMigrationTool.exe</literal>,
+ <literal>MySQLQueryBrowser.exe</literal>, and
+ <literal>MySQLWorkbench.exe</literal> for your desktop or the
+ quick launch bar.
+ </para>
+ </section>
+
+
+ </section>
+
+ <!-- END WINDOWS INSTALL -->
+
+ <section id="gui-tools-installation-linux">
+
+ <title>Installing Under Linux</title>
+
+ <para>
+ &gui_tools; runs on Linux machines that have a graphical desktop
+ installed. It is designed to run under the Gnome desktop with
+ GTK2 and has been tested on Linux kernel versions 2.4 and 2.6.
+ It should also run on other versions, and even on a number of
+ Unix-like operating systems.
+ </para>
+
+ <note>
+ <para>
+ Currently, the &migration_toolkit; is not available for Linux.
+ </para>
+ </note>
+
+ <section id="install-generic-tarball">
+
+ <title>Installing the Generic Tarball</title>
+
+ <para>
+ The generic tar archive allows you to install &gui_tools; on
+ most Linux distributions. The tarball file is called
+ <literal>mysql-gui-tools-<replaceable>version</replaceable>.tar.gz</literal>,
+ where <replaceable>version</replaceable> indicates the
+ &gui_tools; version (for example, 5.0r3).
+ </para>
+
+ <para>
+ To see all files in the tarball, run this command:
+ </para>
+
+ <programlisting>
+shell> tar -tzf mysql-gui-tools-<replaceable>version</replaceable>.tar.gz
+</programlisting>
+
+ <para>
+ To install &gui_tools;, run this command:
+ </para>
+
+ <programlisting>
+shell> tar --directory=/opt -xzvf mysql-gui-tools-<replaceable>version</replaceable>.tar.gz
+</programlisting>
+
+ <para>
+ This installs the various application binaries in the
+ directory,
+ <literal>/opt/mysql-gui-tools-<replaceable>version</replaceable></literal>.
+ </para>
+
+ <para>
+ If you install &gui_tools; to the <literal>opt</literal>
+ directory, icons for use with desktop shortcuts or for
+ creating menu items are found under the
+ <filename>opt/mysql-gui-tools-<replaceable>version</replaceable>/share/mysql-gui</filename>
+ directory.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>RPM Installation</title>
+
+ <para>
+ In addition to a generic tarball, some distribution-specific
+ RPMs are available. Currently these include Red Hat Enterprise
+ Linux (RHEL) 3 and 4, Fedora Core 5 (FC5), and SuSE Linux
+ 10.x. For FC5 and SuSE the <literal>gtkmm24</literal> toolkit
+ is a requirement for installing the RPM version of
+ &gui_tools;. You may also need to install the
+ widget for displaying HTML pages. On FC5 you may install these RPMs from the
+ command line in the following way:
+ </para>
+
+ <programlisting>
+shell> yum install gtkmm24 gtkhtml2
+ </programlisting>
+
+ <para>
+ For installation on SuSE Linux:
+ </para>
+
+ <programlisting>
+shell> yast2 -i gtkmm24 gtkhtml2
+</programlisting>
+
+ <note>
+ <para>
+ You may need root privileges to run the
+ <literal>yast2</literal> command.
+ </para>
+ </note>
+
+ <para>
+ The Red Hat RPMs are self contained so no additional packages
+ need to be installed.
+ </para>
+
+ <para>
+ The RPM downloads are made up of the individual GUI Tools
+ components combined into a single TAR archive. Extract the
+ individual RPMs in the following way:
+ </para>
+
+ <programlisting>
+shell> tar -zxf mysql-gui-tools-<replaceable>version</replaceable>.tar.gz
+ </programlisting>
+
+ <para>
+ This will decompress the RPM files to the current directory.
+ </para>
+
+ <para>
+ Install all the RPM files by typing:
+ </para>
+
+ <programlisting>
+shell> rpm -ivh mysql-*.rpm
+</programlisting>
+
+ <para>
+ If you are upgrading to a newer version of &gui_tools; see
+ <xref linkend="rpm-upgrade" />.
+ </para>
+
+ <para>
+ If you install the RPM files individually, you must install the
+ <filename>mysql-gui-tools-<replaceable>version</replaceable>.rpm</filename>
+ file first in order to satisfy dependencies.
+ </para>
+
+
+ <para>
+ If you wish, you may install only one of the &gui_tools;.
+ For example, to install &administrator; only, do the following:
+ </para>
+
+ <programlisting>
+shell> rpm -ivh mysql-gui-tools<replaceable>version</replaceable>.rpm mysql-administrator<replaceable>version</replaceable>.rpm
+</programlisting>
+
+ <para>
+ If possible, the RPM installation process creates shortcuts in
+ the start menu of your window manager. For example, SuSE Linux
+ with the KDE window manager adds shortcuts to the &gui_tools;
+ under the <guimenu>Development</guimenu>, <guimenu>Other
+ Tools</guimenu> menu item. Likewise, with FC5, shortcuts are created
+ under the <guimenu>Development</guimenu> menu item.
+ </para>
+
+ <para>
+ Icons for use with desktop shortcuts or for creating menu
+ items are found under the
+ <filename>/usr/share/mysql-gui</filename> directory.
+ </para>
+
+ <para>
+ See the
+ <ulink url="&base-url-downloads;/gui-tools/5.0.html">&gui_tools;
+ Downloads</ulink> page for the most up-to-date listing of the
+ various RPM packages available.
+ </para>
+
+ </section>
+
+ </section>
+
+ <!-- END LINUX INSTALLATION -->
+
+ <section id="gui-tools-installation-osx">
+
+ <title>Installing Under Mac OS X</title>
+
+ <para>
+ To install &gui_tools; under Mac OS X, double-click the
+ downloaded <literal>.dmg</literal> file and wait for it to be
+ opened and attached. Once a window containing the &gui_tools;
+ icon pops up, drag it to your Applications folder — or any
+ other location you prefer.
+ </para>
+
+ <para>
+ Once the copy is complete, you may eject the disk image.
+ </para>
+
+ <para>
+ The minimum
+ supported version is Mac OS X 10.4.
+ </para>
+
+ <note>
+ <para>
+ Currently, the &migration_toolkit; is not available for Mac OS X.
+ </para>
+ </note>
+
+ </section>
+
+</chapter>
Property changes on: trunk/gui-common-cy/installation-all.xml
___________________________________________________________________
Name: svn:executable
+ *
Added: trunk/gui-common-cy/mysql-enterprise.xml
===================================================================
--- trunk/gui-common-cy/mysql-enterprise.xml (rev 0)
+++ trunk/gui-common-cy/mysql-enterprise.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 57, Lines Deleted: 0; 2256 bytes
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ ]>
+
+
+ <chapter id="mysql-enterprise">
+
+ <!--starting tools-->
+
+ <title>MySQL Enterprise</title>
+
+ <para>
+ A MySQL Enterprise subscription is the most comprehensive offering of MySQL database
+ software, services and support; it ensures that your business achieves the highest levels of reliability,
+ security, and uptime.
+ </para>
+
+ <para>
+ An Enterprise Subscription includes:
+ <orderedlist>
+ <listitem>
+ <para>
+ The MySQL Enterprise Server – the most reliable, secure, and up-to-date version of the
+ world’s most popular open source database
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The MySQL Monitoring and Advisory Service – An automated virtual DBA assistant that
+ monitors all your MySQL Servers around-the-clock, identifies exceptions to MySQL best
+ practices, and provides expert advice on fixing any problems discovered
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ MySQL Production Support – Technical and consultative support when you need it, along
+ with regularly scheduled service packs, hot-fixes, and more
+ </para>
+ </listitem>
+ </orderedlist>
+
+ </para>
+
+ <para>
+ For more information, visit <ulink url="http://www.mysql.com/enterprise"/>.
+ </para>
+
+ </chapter>
+
Added: trunk/gui-common-cy/starting-all.xml
===================================================================
--- trunk/gui-common-cy/starting-all.xml (rev 0)
+++ trunk/gui-common-cy/starting-all.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 182, Lines Deleted: 0; 5444 bytes
@@ -0,0 +1,182 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+ ]>
+
+
+ <chapter id="running-guitools">
+
+ <!--starting tools-->
+
+ <title>Running &gui_tools;</title>
+
+
+ <para>
+ How you start any one of the &gui_tools; depends on the operating system you
+ are using.
+ </para>
+
+ <section id="starting-guitools">
+
+ <title>Running Under Windows</title>
+
+ <para>
+ Under Windows, the names of the executable files in the &gui_tools; suite are:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>MySQLAdministrator.exe</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>MySQLQueryBrowser.exe</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>MySQLWorkbench.exe</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>MySQLMigrationTool.exe</literal>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Start any one of the &gui_tools; by double clicking its desktop
+ icon, or by selecting it from the <literal>Start</literal> menu.
+ Alternatively, you can open a DOS window and start it from the
+ command line. For example, you could run the &administrator;
+ in the following way:
+ </para>
+
+ <programlisting>
+C:\> "C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\MySQL Tools for <replaceable>version</replaceable>\MySQLAdministrator.exe"
+ </programlisting>
+
+ <para>
+ <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 must enclose the command within quotation marks as shown
+ above.
+ </para>
+
+ </section>
+
+ <!-- linux -->
+
+ <section>
+
+ <title>Running Under Linux</title>
+
+ <para>
+ Under Linux, the names of the executable files in the &gui_tools; suite are:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>mysql-administrator</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>mysql-query-browser</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>mysql-workbench</literal>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <note>
+ <para>
+ There is no Linux version of &migration_toolkit;.
+ </para>
+ </note>
+
+ <para>
+ If you installed &gui_tools; to the <filename>/opt</filename>
+ directory using the tar archive file, change into the
+ <filename>/opt/mysql-gui-tools-<replaceable>version</replaceable></filename>
+ directory to run any one of the &gui_tools;.
+ </para>
+
+ <para>
+ To run &administrator; you would type:
+ </para>
+
+ <programlisting>
+shell> ./mysql-administrator
+ </programlisting>
+
+ <para>
+ However, adding
+ <filename>/opt/mysql-gui-tools-<replaceable>version</replaceable></filename>
+ to the <literal>PATH</literal> variable makes it much simpler to
+ run &gui_tools; — you need not worry about your present
+ working directory.
+ </para>
+
+ <para>
+ When installed from RPM files, the &gui_tools; are found in the
+ <filename>/usr/bin</filename> directory. This directory is
+ usually included in the <literal>PATH</literal> variable, so
+ running any one of the &gui_tools; simply requires typing the
+ executable file name, regardless of your current directory. For
+ example:
+ </para>
+
+ <programlisting>
+shell> mysql-administrator
+</programlisting>
+
+ <para>
+ For those distributions that create menu items, you may also, of
+ course, start any one of the tools by choosing the menu item.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>Running On Mac OS X</title>
+
+ <para>
+ On Mac OS X, navigate to the &gui_tools; installation directory
+ and double-click on the application you wish to start.
+ </para>
+
+ <note>
+ <para>
+ There is no Mac OS X version of &migration_toolkit;.
+ </para>
+ </note>
+
+ </section>
+
+ </chapter>
+
Property changes on: trunk/gui-common-cy/starting-all.xml
___________________________________________________________________
Name: svn:executable
+ *
Added: trunk/query-browser-cy/Makefile
===================================================================
--- trunk/query-browser-cy/Makefile (rev 0)
+++ trunk/query-browser-cy/Makefile 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 66, Lines Deleted: 0; 3475 bytes
@@ -0,0 +1,66 @@
+# Makefile for MySQL Query Browser manual
+
+# Location of repository root relative to current directory
+REPO_ROOT = ..
+
+# Location of directory containing Makefile components
+MAKE_DIR = $(REPO_ROOT)/make.d
+
+# Set any variables here that should override imported standard variables
+
+DOC_LANG = en
+MAIN_DOC_BASENAME = query-browser
+
+# Set IDMAP and remap variables
+
+IDMAP_LANG = $(DOC_LANG)
+IDMAP_MAIN = query-browser
+
+IDMAP_URLBASE = $(IDMAP_MAIN)/$(IDMAP_LANG)
+IDMAP_REFS = . ../gui-common ../userguide ../refman-5.1 ../refman-common
+IDMAP_SRCS = $(QUERY_BROWSER_SRCS)
+IDMAP_OBJS = $(call xmllist_to_idmaplist,$(IDMAP_SRCS))
+
+# Import standard variables
+
+include $(MAKE_DIR)/vars-layout
+include $(MAKE_DIR)/vars-shell
+include $(MAKE_DIR)/vars-docbook
+
+# Import default target rule (causes help message to print)
+
+include $(MAKE_DIR)/default-target
+
+# Document dependency specifications
+# "make depend" updates the _SRCS variable
+# Set _SRCS_EXTRA variable by hand to any entity files needed
+
+depend:: query-browser.depend
+
+QUERY_BROWSER_SRCS_EXTRA = ../gui-common/gui-common.ent
+
+QUERY_BROWSER_SRCS = $(QUERY_BROWSER_SRCS_EXTRA) query-browser.xml chapter-options-query-browser.xml connection-dialog.xml copyright.xml ../gui-common/appendix-common-files.xml ../gui-common/appendix-connection-storage.xml ../gui-common/appendix-source-install.xml ../gui-common/appendix-third-party.xml ../gui-common/appendix-translator-notes.xml ../gui-common/appendix-troubleshooting.xml ../gui-common/chapter-options-connections.xml ../gui-common/chapter-options-editors.xml ../gui-common/chapter-options-general.xml ../gui-common/chapter-options-introduction.xml ../gui-common/chapter-table-editor.xml ../gui-common/chapter-uninstall-all.xml ../gui-common/chapter-upgrade-all.xml ../gui-common/images/columneditor.png ../gui-common/images/confirmchanges.png ../gui-common/images/connectionerror.png ../gui-common/images/indexeditor.png ../gui-common/images/options-connection.png ../gui-common/images/options.png ../gui-common/images/ssl-params.png ../gui-common/images/tableeditor.p!
ng ../gui-common/installation-all.xml ../gui-common/mysql-enterprise.xml ../gui-common/starting-all.xml images/blob-buttons.png images/buttonbar.png images/connection.png images/file-open-script.png images/mainscreen.png images/qb-options.png images/querybar.png images/schematabrowser.png images/script-editor.png images/stored-procedure-database-browser.png images/tabletool.png images/twosakilas.png introduction.xml legalnotice.en.xml options.xml tour.xml ../userguide/excel-mysql.xml using.xml xml-files.xml
+
+query-browser-prepped.xml: $(QUERY_BROWSER_SRCS) $(IDMAP_OBJS)
+
+# Import standard target rules
+
+include $(MAKE_DIR)/xml-valid
+include $(MAKE_DIR)/xml-format
+include $(MAKE_DIR)/xml-useless
+include $(MAKE_DIR)/xml-prep
+include $(MAKE_DIR)/xml-html
+include $(MAKE_DIR)/xml-html-section
+include $(MAKE_DIR)/xml-html-chapter
+include $(MAKE_DIR)/xml-html-web
+include $(MAKE_DIR)/xml-chm
+#include $(MAKE_DIR)/xml-xhtml
+include $(MAKE_DIR)/xml-pdf
+include $(MAKE_DIR)/xml-toc
+#include $(MAKE_DIR)/xml-txt
+#include $(MAKE_DIR)/xml-info
+include $(MAKE_DIR)/xml-depend
+
+# Import directory specific extensions
+
+include ../gui-common/Makefile.ext
Added: trunk/query-browser-cy/Makefile.ext
===================================================================
--- trunk/query-browser-cy/Makefile.ext (rev 0)
+++ trunk/query-browser-cy/Makefile.ext 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 4, Lines Deleted: 0; 424 bytes
@@ -0,0 +1,4 @@
+# Makefile extensions for operations specific to this directory
+
+../query-browser/metadata/%.idmap: ../query-browser/%.xml
+ make -C ../query-browser idmap
Added: trunk/query-browser-cy/VERSION
===================================================================
--- trunk/query-browser-cy/VERSION (rev 0)
+++ trunk/query-browser-cy/VERSION 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 24, Lines Deleted: 0; 1203 bytes
@@ -0,0 +1,24 @@
+Pfad: query-browser
+URL: svn+ssh://shinz@stripped/svn/mysqldoc/trunk/query-browser
+Basis des Projektarchivs: svn+ssh://shinz@stripped/svn/mysqldoc
+UUID des Projektarchivs: c493bd56-8c02-0410-a43f-aded7e9288fb
+Revision: 5702
+Knotentyp: Verzeichnis
+Plan: normal
+Letzter Autor: mcbrown
+Letzte geänderte Rev: 5667
+Letztes Änderungsdatum: 2007-03-31 07:19:46 +0200 (Sa, 31 Mär 2007)
+Eigenschaften zuletzt geändert: 2006-11-10 23:46:15 +0100 (Fr, 10 Nov 2006)
+
+Pfad: gui-common
+URL: svn+ssh://shinz@stripped/svn/mysqldoc/trunk/gui-common
+Basis des Projektarchivs: svn+ssh://shinz@stripped/svn/mysqldoc
+UUID des Projektarchivs: c493bd56-8c02-0410-a43f-aded7e9288fb
+Revision: 5702
+Knotentyp: Verzeichnis
+Plan: normal
+Letzter Autor: mcbrown
+Letzte geänderte Rev: 5631
+Letztes Änderungsdatum: 2007-03-29 18:10:34 +0200 (Do, 29 Mär 2007)
+Eigenschaften zuletzt geändert: 2006-11-10 23:51:08 +0100 (Fr, 10 Nov 2006)
+
Added: trunk/query-browser-cy/chapter-options-query-browser.xml
===================================================================
--- trunk/query-browser-cy/chapter-options-query-browser.xml (rev 0)
+++ trunk/query-browser-cy/chapter-options-query-browser.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 133, Lines Deleted: 0; 4353 bytes
@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.entities;
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+]>
+<section id="gui-options-query-browser">
+
+ <title>The Browser Section</title>
+
+ <para>
+ The <literal>Browser</literal> section allows you to specify options
+ that relate to the &query_browser;. The <literal>Browser</literal>
+ section is divided into three areas: <literal>Display
+ Options</literal>, <literal>Query Options</literal>, and
+ <literal>Various</literal>.
+ </para>
+
+ <figure>
+ <title>The query browser options dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/qb-options.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The query browser options dialog</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <section id="gui-options-query-browser-display-options">
+
+ <title>Display Options</title>
+
+ <para>
+ The display options affect the appearance of the &query_browser;.
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Show advanced toolbars</literal>: Display or hide the
+ <link linkend="mysql-query-browser-tour-buttonbar">The
+ Advanced Toolbar</link>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Hide the tab when only one page is open</literal>:
+ Determines whether or not to display a tab icon at the top of
+ the <link linkend="mysql-query-browser-tour-resultarea">Result
+ Area</link> if there is only one result area.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Toolbars use gradient background</literal>: Enables
+ and disables use of gradient effects in the background of the
+ <link linkend="mysql-query-browser-tour-querybar">Query
+ Toolbar</link>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Show field overlay images for long VARCHAR, TEXT, and
+ BLOG fields</literal>: Toggles on and off the BLOB management
+ icons.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Show composer buttons toolbar</literal>: Toggles on
+ and off the query composition buttons on the Advanced Toolbar.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </section>
+
+<!-- END DISPLAY OPTIONS -->
+
+ <section id="gui-options-query-browser-query-options">
+
+ <title>Query Options</title>
+
+ <para>
+ <literal>Enforce queries to be editable by adding primary key
+ columns to the select</literal>: Adds <literal>PRIMARY
+ KEY</literal> columns to a query that does not explicitly
+ <literal>SELECT</literal> them to ensure that the results of a
+ query can be edited. The <literal>PRIMARY KEY</literal> columns
+ will not be displayed in this case, but will still be stored.
+ </para>
+
+ <para>
+ <literal>Open resultset in associated application after
+ export</literal>: Causes the associated application to be opened
+ after choosing the <guimenu>Export Resultset</guimenu> option from
+ the right click menu of the
+ <link linkend="mysql-query-browser-tour-resultarea">Result
+ Area</link>.
+ </para>
+
+ </section>
+
+<!-- END QUERY OPTIONS -->
+
+ <section id="gui-options-query-browser-various">
+
+ <title>Various</title>
+
+ <para>
+ <literal>Associate sql/query files with Query Browser</literal>:
+ Configures Windows to associate all .sql files with the
+ &query_browser;. As a result, all such files will be opened with
+ the &query_browser; by default.
+ </para>
+
+ </section>
+
+<!-- END VARIOUS -->
+
+</section>
+<!-- END QUERY BROWSER -->
Added: trunk/query-browser-cy/connection-dialog.xml
===================================================================
--- trunk/query-browser-cy/connection-dialog.xml (rev 0)
+++ trunk/query-browser-cy/connection-dialog.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 135, Lines Deleted: 0; 5367 bytes
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+]>
+<chapter id="query-browser-connection-dialog">
+
+ <title>The &query_browser; Connection Dialog</title>
+
+ <section id="mysql-query-browser-connection">
+
+ <title>Connection Dialog</title>
+
+ <para>
+ Once &query_browser; has been started, it displays a connection
+ dialog window. You need to specify the MySQL server you are
+ connecting to, the credentials needed for authorization on that
+ server, which machine hosts that server (and which port it listens
+ to), and the database (Schema) you will be querying. You may also
+ specify a number of other options, if required.
+ </para>
+
+ <para>
+ <emphasis>You must choose a default database in order to issue
+ queries.</emphasis> It is possible to choose a default database
+ 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>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/connection.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Connection dialog</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ If the server connection is successfully established, all the
+ values are saved for future connections (see the section that
+ describes
+ <link
+ linkend="mysql-gui-appendix-store-connections">
+ how &query_browser; stores connection information</link>). The
+ <literal>Password</literal> field, however, is always empty: For
+ security reasons, the password is not stored along with the other
+ options, unless you explicitly specify otherwise in the
+ <link linkend="mysql-gui-options-general-options">General
+ Options</link> section of the
+ <link linkend="mysql-gui-options">Options dialog</link>.
+ </para>
+
+ <para>
+ To set advanced connection options, click the
+ <guibutton>Details</guibutton> button and check the desired
+ options:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Use compression protocol</literal> - Use compression
+ when communicating with the MySQL server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Use ANSI quotes to quote identifiers</literal> -
+ enclose all object names in double-quotes instead of
+ back-ticks.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Windows Only:</emphasis>
+ <literal>Use named pipe (localhost only)</literal> is
+ equivalent to starting the client from the command line
+ specifying the <option>--protocol</option>=<replaceable>pipe</replaceable>
+ option.
+ </para>
+
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Unix Only:</emphasis>
+ <literal>Connect using socket file</literal> is
+ equivalent to starting the client from the command line
+ specifying the <option>--protocol</option>=<replaceable>socket</replaceable>
+ option.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ If you have difficulties connecting, please see the
+ <link linkend="mysql-gui-appendix-troubleshooting-connection-errors">Troubleshooting
+ Connection Errors</link> section in the
+ <link linkend="mysql-gui-appendix-troubleshooting">Troubleshooting
+ Application Errors</link> appendix.
+ </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
+ only if a successful connection to the MySQL server is
+ established. You can also 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. The values you can set are found in the
+ Connection dialog window in the description of the
+ <literal>Connections</literal> section of the
+ <link linkend="mysql-gui-options">Options dialog</link>.
+ </para>
+
+ </section>
+
+<!-- END CONNECTION DIALOG -->
+
+</chapter>
Property changes on: trunk/query-browser-cy/connection-dialog.xml
___________________________________________________________________
Name: svn:executable
+ *
Added: trunk/query-browser-cy/copyright.xml
===================================================================
--- trunk/query-browser-cy/copyright.xml (rev 0)
+++ trunk/query-browser-cy/copyright.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 6, Lines Deleted: 0; 474 bytes
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+<para>
+ Copyright 2004-2007 MySQL AB
+</para>
Added: trunk/query-browser-cy/images/blob-buttons.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 323 bytes
Added: trunk/query-browser-cy/images/buttonbar.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 317 bytes
Added: trunk/query-browser-cy/images/connection.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 319 bytes
Added: trunk/query-browser-cy/images/dynamiclist.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 321 bytes
Added: trunk/query-browser-cy/images/file-open-script.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 357 bytes
Added: trunk/query-browser-cy/images/gui-command-line.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 331 bytes
Added: trunk/query-browser-cy/images/mainscreen.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 319 bytes
Added: trunk/query-browser-cy/images/qb-options.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 319 bytes
Added: trunk/query-browser-cy/images/querybar.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 315 bytes
Added: trunk/query-browser-cy/images/schematabrowser.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 329 bytes
Added: trunk/query-browser-cy/images/script-editor.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 325 bytes
Added: trunk/query-browser-cy/images/stored-procedure-database-browser.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 365 bytes
Added: trunk/query-browser-cy/images/tabletool.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 317 bytes
Added: trunk/query-browser-cy/images/twosakilas.png
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 319 bytes
Added: trunk/query-browser-cy/introduction.xml
===================================================================
--- trunk/query-browser-cy/introduction.xml (rev 0)
+++ trunk/query-browser-cy/introduction.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 50, Lines Deleted: 0; 2005 bytes
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+]>
+<chapter id="mysql-query-browser-introduction">
+
+ <title>Introduction to the &query_browser;</title>
+
+ <para>
+ The &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 to administer a MySQL server, the
+ &query_browser; is designed to help you query and analyze data
+ stored within your MySQL database.
+ </para>
+
+ <para>
+ While all queries executed in the &query_browser; can also be run
+ from the command-line using the <command>mysql</command> utility,
+ the &query_browser; allows for the querying and editing of data in a
+ more intuitive, graphical manner.
+ </para>
+
+ <para>
+ &query_browser; is designed to work with MySQL versions 4.0 and
+ higher.
+ </para>
+
+ <para>
+ &query_browser; is, to a large extent, the result of feedback MySQL
+ AB has received from many users over a period of several years.
+ However, 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.
+ </para>
+
+ <para>
+ For MySQL Query Browser, there's a dedicated forum available on
+ <ulink url="http://forums.mysql.com/list.php?108"/>.
+ </para>
+
+</chapter>
Added: trunk/query-browser-cy/legalnotice.en.xml
===================================================================
--- trunk/query-browser-cy/legalnotice.en.xml (rev 0)
+++ trunk/query-browser-cy/legalnotice.en.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 32, Lines Deleted: 0; 1787 bytes
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+<legalnotice>
+
+ <xi:include href="copyright.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <para>
+ This documentation is NOT distributed under a GPL license. Use of
+ this documentation is subject to the following terms: You may create
+ a printed copy of this documentation solely for your own personal
+ use. Conversion to other formats is allowed as long as the actual
+ content is not altered or edited in any way. You shall not publish
+ or distribute this documentation in any form or on any media, except
+ if you distribute the documentation in a manner similar to how MySQL
+ disseminates it (that is, electronically for download on a Web site
+ with the software) or on a CD-ROM or similar medium, provided
+ however that the documentation is disseminated together with the
+ software on the same medium. Any other use, such as any
+ dissemination of printed copies or use of this documentation, in
+ whole or in part, in another publication, requires the prior written
+ consent from an authorized representative of MySQL AB. MySQL AB
+ reserves any and all rights to this documentation not expressly
+ granted above.
+ </para>
+
+ <para>
+ Please email <email>docs@stripped</email> for more information or
+ if you are interested in doing a translation.
+ </para>
+
+</legalnotice>
Added: trunk/query-browser-cy/options.xml
===================================================================
--- trunk/query-browser-cy/options.xml (rev 0)
+++ trunk/query-browser-cy/options.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 27, Lines Deleted: 0; 1305 bytes
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+]>
+<chapter id="mysql-gui-options">
+
+ <title>Options Dialog</title>
+
+<!--
+ Include sections that are shared in common between administrator and
+ query-browser documents, then the final document-specific section.
+-->
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common/chapter-options-introduction.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common/chapter-options-general.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common/chapter-options-connections.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common/chapter-options-editors.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-options-query-browser.xml"/>
+
+</chapter>
Added: trunk/query-browser-cy/query-browser.xml
===================================================================
--- trunk/query-browser-cy/query-browser.xml (rev 0)
+++ trunk/query-browser-cy/query-browser.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 81, Lines Deleted: 0; 3190 bytes
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common-cy/gui-common.ent">
+ %gui-common.entities;
+]>
+<book id="mysql-query-browser" lang="cy">
+
+<!--
+If <indexterm> elements are added to this document sometime, add an
+empty <index/> element before the closing </book> tag to enable
+index-generation. Right now there is no such element because there
+is no point in generating an empty index.
+-->
+
+ <title>&query_browser;</title>
+
+ <bookinfo>
+
+ <title>&query_browser;</title>
+
+ <abstract>
+
+ <para>
+ This is the &query_browser; Manual.
+ </para>
+
+ <para>
+ Document generated on:
+
+<?dbtimestamp format="Y-m-d"?>
+
+ <remark role="repository.revision"/>
+ </para>
+
+ </abstract>
+
+ <xi:include href="legalnotice.en.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ </bookinfo>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/mysql-enterprise.xml"/>
+
+ <xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/installation-all.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/chapter-uninstall-all.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/chapter-upgrade-all.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/starting-all.xml"/>
+
+ <xi:include href="connection-dialog.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+
+ <xi:include href="tour.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include href="using.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/chapter-table-editor.xml"/>
+
+ <xi:include href="options.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../userguide/excel-mysql.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/appendix-source-install.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/appendix-troubleshooting.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/appendix-connection-storage.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/appendix-common-files.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="xml-files.xml" />
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/appendix-translator-notes.xml"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common-cy/appendix-third-party.xml"/>
+
+</book>
Added: trunk/query-browser-cy/renamed-nodes.txt
===================================================================
--- trunk/query-browser-cy/renamed-nodes.txt (rev 0)
+++ trunk/query-browser-cy/renamed-nodes.txt 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 20, Lines Deleted: 0; 1194 bytes
@@ -0,0 +1,20 @@
+# renamed-nodes.txt
+#
+# This file lists page name changes for online multi-page documents.
+# These are documents that are built with a command of the form "make
+# docname.html-web". For such documents, page names correspond to
+# the root element id in the DocBook source for the page. For example,
+# <section id="this-is-a-page"> generates a page named this-is-a-page.html.
+# If the section id changes, list the old and new id values in this
+# file so that the mysql.com web server knows how to map requests for
+# the old page to the new page. Each mapping line lists the old id
+# followed by the new id, separated by a space.
+# Example: my-old-page-name my-new-page-name
+# When the .html-web target for the document is built and transferred
+# to the web server host, this file is packaged with the output HTML
+# pages.
+#
+#
+# Lines beginning with # in column one are interpreted as
+# comments and ignored.
+#
Added: trunk/query-browser-cy/tour.xml
===================================================================
--- trunk/query-browser-cy/tour.xml (rev 0)
+++ trunk/query-browser-cy/tour.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 988, Lines Deleted: 0; 35907 bytes
@@ -0,0 +1,988 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+]>
+<chapter id="mysql-query-browser-tour">
+
+ <title>A Tour of the &query_browser;</title>
+
+ <section id="mysql-query-browser-tour-mainwindow">
+
+ <title>The Main Query Window</title>
+
+ <para>
+ Once you successfully connect to a MySQL server you are presented
+ with the main query window of the &query_browser;. All of the
+ application's functionality is available through this window.
+ </para>
+
+ <figure>
+ <title>The &query_browser; main query window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mainscreen.png"
+lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The &query_browser; main query
+ window</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The main query window is divided up into several sections:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <emphasis>Query Toolbar:</emphasis> The query toolbar is where
+ you create and execute your queries. It is composed of three
+ navigation buttons (<guibutton>Go Back</guibutton>,
+ <guibutton>Next</guibutton>, <guibutton>Refresh</guibutton>),
+ the query area, two action buttons
+ (<guibutton>Execute</guibutton> and
+ <guibutton>Stop</guibutton>), and a status indicator.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Advanced Toolbar:</emphasis> The advanced toolbar
+ contains three sets of buttons: the Transaction Buttons
+ (<guibutton>Start</guibutton>, <guibutton>Commit</guibutton>,
+ <guibutton>Rollback</guibutton>), the query management buttons
+ (<guibutton>Explain</guibutton>,
+ <guibutton>Compare</guibutton>), and the query building
+ buttons (<guibutton>Select</guibutton>,
+ <guibutton>From</guibutton>, <guibutton>Where</guibutton>, and
+ so on.)
+ </para>
+
+ <para>
+ The Advanced Toolbar is only visible when the <literal>Show
+ advanced toolbars</literal> and <literal>Show composer buttons
+ toolbar</literal> options in the Browser Options screen are
+ checked. See
+ <xref
+ linkend="gui-options-query-browser"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Result Area:</emphasis> All query results are
+ displayed in the result area. You can have multiple tabs
+ active at one time, allowing you to work on multiple queries.
+ The result area can be split vertically and horizontally for
+ performing comparisons, and queries in different parts of a
+ split result area can be joined together for master-detail
+ analysis.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Object Browser:</emphasis> The object browser is
+ part of the sidebar and allows you to manage your databases,
+ 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 in
+ order to use them again.
+ </para>
+
+ <para>
+ If there are many schemata on your MySQL server, the search field with the
+ magnifying glass icon may be handy for filtering the schemata you
+ are looking for. Typing in <literal>t</literal> or
+ <literal>T</literal>, for example, will set the filter to schemata
+ whose names begin with a <literal>t</literal>. The filter works in
+ a case-insensitive fashion.
+ </para>
+
+ <para>
+ You may also filter schemata using the wild card
+ <literal>?</literal> to stand in for any single character
+ and <literal>*</literal> for zero to any number of characters.
+ For example the string <literal>*boo?*</literal> will find schemata with the names
+ <literal>books, coursebooks,</literal> and <literal>bookings</literal>.
+ </para>
+
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Information Browser:</emphasis> The Information
+ Browser is part of the sidebar and is used to look up built-in
+ functions, and to manage queries that contain parameters. 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>
+ Using the <guimenu>View</guimenu> menu, most of these sections can
+ be displayed and hidden by checking and unchecking the elements
+ you wish to view.
+ </para>
+
+ <para>
+ Each of these topics are covered in more detail in the sections
+ that follow.
+ </para>
+
+ </section>
+
+<!-- END MAIN QUERY WINDOW SECTION -->
+
+ <section id="mysql-query-browser-tour-querybar">
+
+ <title>The Query Toolbar</title>
+
+ <para>
+ All queries, whether generated automatically, graphically, or
+ manually, appear in the <literal>Query Toolbar</literal>. The
+ simplest way to use the &query_browser; is to type a query into
+ the query area and click the execute button. A statement
+ terminator such as <literal>;</literal> or <literal>\G</literal>
+ is not required.
+ </para>
+
+ <section 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
+ <link linkend="mysql-query-browser-tour-objectbrowser">object
+ browser</link>.
+ </para>
+
+ <para>
+ Clicking the <guibutton>Go Back</guibutton> button loads the
+ previous query in your history, whereas the <guibutton>Go
+ Next</guibutton> button loads the following query. 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 are not executed unless you explicitly execute them by
+ clicking the <guibutton>Execute</guibutton> button. The
+ <guibutton>Refresh</guibutton> button re-executes the last
+ executed query, which may or may not be the current query in the
+ query area.
+ </para>
+
+ </section>
+
+<!-- END NAVIGATION BUTTONS -->
+
+ <section 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
+ are displayed. By default, the query area is three lines high
+ and automatically expands to a maximum of ten lines in height.
+ For queries longer than ten lines, the query area is scrollable.
+ </para>
+
+ <para>
+ For additional space, you can press the <keycap>F11</keycap> key
+ to maximize the query area. You can also do this by choosing
+ <guimenu>Maximize Query Area</guimenu> from the
+ <guimenu>View</guimenu> menu. When the query is maximized, line
+ numbers are displayed and the query area can be resized by
+ clicking and dragging the line that divides the query area from
+ the result area. Under Windows, pressing the
+ <keycap>F11</keycap> key again reverts to the normal view.
+ Under Linux choose the <guimenu>Normal View</guimenu>
+ menu option from the <guimenu>View</guimenu> menu.
+ </para>
+
+ <figure>
+ <title>The query area expanded to ten lines</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/querybar.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The query area expanded to ten
+ lines</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The following commands are available by right clicking the query
+ area: <guimenu>Cut</guimenu>
+ (<keycap>Ctrl</keycap>+<keycap>X</keycap>),
+ <guimenu>Copy</guimenu>
+ (<keycap>Ctrl</keycap>+<keycap>C</keycap>),
+ <guimenu>Paste</guimenu>
+ (<keycap>Ctrl</keycap>+<keycap>V</keycap>),
+ <guimenu>Clear</guimenu>
+ (<keycap>Ctrl</keycap>+<keycap>N</keycap>), <guimenu>Open Query
+ ...</guimenu> (<keycap>Ctrl</keycap>+<keycap>O</keycap>), and
+ <guimenu>Save Query As ...</guimenu>
+ (<keycap>Ctrl</keycap>+<keycap>S</keycap>). The Open and Save
+ commands load the contents of an SQL file into the query area or
+ save the contents of the query area into a text file.
+ </para>
+
+ </section>
+
+<!-- END QUERY AREA -->
+
+ <section 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 executes any queries in
+ the query area, whereas the <guibutton>Stop</guibutton> button
+ ceases execution.
+ </para>
+
+ <para>
+ If you click the down arrow below the
+ <guibutton>Execute</guibutton> button, there are three potential
+ execution options:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <guimenu>Execute</guimenu>
+ (<keycap>Ctrl</keycap>+<keycap>Enter</keycap>): This
+ executes the query and displays the results in the currently
+ active result area.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Execute in new Tab</guimenu>
+ (<keycap>Ctrl</keycap>+<keycap>Shift</keycap>+<keycap>Enter
+ </keycap>): This executes the query and displays the results
+ in a newly created result area.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Split Tab and Execute</guimenu>
+ (<keycap>Ctrl</keycap>+<keycap>Alt</keycap>+<keycap>Enter
+ </keycap>): This splits the result area horizontally and
+ then displays the query results in the lower half of the
+ result area.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ To the right of the action buttons is the status indicator. The
+ status indicator shows the standard MySQL logo when the MySQL
+ Query Browser is idle, and displays an animated logo when the
+ &query_browser; is busy processing a query. Both icons can be
+ seen in the following illustration:
+ </para>
+
+ <figure>
+ <title>The &query_browser; status icons</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/twosakilas.png"
+lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The &query_browser; status icons</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+<!-- END ACTION BUTTONS SECTION-->
+
+ </section>
+
+<!-- END QUERY BAR SECTION -->
+
+ <section id="mysql-query-browser-tour-buttonbar">
+
+ <title>The Advanced Toolbar</title>
+
+ <para>
+ Below the query bar is the <literal>Advanced Toolbar</literal>.
+ The <literal>Advanced Toolbar</literal> contains a set of buttons
+ for transaction control, query management, and query building.
+ </para>
+
+ <note>
+ <para>
+ The <literal>Advanced Toolbar</literal> is only available
+ under Windws.
+ </para>
+ </note>
+
+ <figure>
+ <title>The advanced toolbar</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/buttonbar.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The advanced toolbar</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The left panel of the advanced toolbar contains the transaction
+ control buttons. From left to right, the buttons allow you to
+ start, commit, and roll back a transaction. As when using the
+ command-line client, you can only use transactions with table
+ handlers that support them (InnoDB for example). For more
+ information on transactions, see
+ <xref linkend="innodb-transaction-model"/>.
+ </para>
+
+ <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. When you use this feature, the results are shown
+ below the result set window. To remove this window right click
+ anywhere in the window and choose the <guimenu>Remove Resultset</guimenu>
+ option.
+ </para>
+
+ <para>
+ <remark>[PL]This needs explaining. Literals need replacing.</remark>
+ The <guibutton>Compare</guibutton> button
+ allows you to compare the results of two queries.
+ </para>
+
+ <para>
+ The next panel contains the query building buttons. You can use
+ these buttons to build a query visually by clicking on the tables
+ and columns that you wish to involve in your query, using
+ specialized mouse pointers to indicate which part of the query the
+ different fields and tables occupy.
+ </para>
+
+ <para>
+ The right panel contains the <guibutton>Create View</guibutton>
+ button. More information on the <guibutton>Create View</guibutton>
+ button can be found in the
+ <link linkend="mysql-query-browser-creating-views">Creating
+ Views</link> section.
+ </para>
+
+ </section>
+
+<!-- END BUTTON BAR SECTION -->
+
+ <section id="mysql-query-browser-tour-resultarea">
+
+ <title>The Result Area</title>
+
+ <para>
+ All query results are displayed in the result area. Within the
+ result area you can use multiple tabs, and individual result areas
+ can be split either vertically or horizontally. New tabs can be
+ created either by choosing the <guimenu>Execute in new
+ Tab</guimenu> option on the query bar, or by clicking the
+ <guibutton>New Tab</guibutton> button at the top of the result
+ area. In addition, you can also right click on the current result
+ area and choose the <guimenu>Add new Tabsheet (Ctrl+T)</guimenu>
+ option.
+ </para>
+
+ <para>
+ Individual tabs are closed by either right clicking within the
+ result area and choosing the <guimenu>Remove Tab</guimenu> option,
+ or by clicking the <literal>X</literal> icon on the tab you wish
+ to close.
+ </para>
+
+ <para>
+ To split a result area, right click on it and choose either the
+ <guimenu>Split Tab vertically</guimenu> or the <guimenu>Split Tab
+ horizontally</guimenu> option. After splitting the result area you
+ can then choose one half of the result area and view result sets
+ within it. You can remove sections of the result area by
+ right clicking on the section you wish to remove and clicking
+ <guimenu>Remove Resultset</guimenu>.
+ </para>
+
+ <para>
+ When navigating a particularly large result set, you can press the
+ <keycap>F12</keycap> key to maximize the result area or,
+ alternately, you can choose the <guimenu>Maximize
+ Tabsheets</guimenu> option of the <guimenu>View</guimenu> menu.
+ Under Windows, pressing <keycap>F12</keycap> again will restore the result area
+ to its original size. Under Linux, to revert to the normal view choose the
+ <guimenu>Normal View</guimenu> menu option under the <guimenu>View</guimenu>
+ menu.
+ </para>
+
+ <para>
+ The result sets of some queries do not display well in the <literal>Results Area</literal>;
+ <literal>SHOW CREATE TABLE <replaceable>tblname</replaceable></literal>,
+ for example. For a better view of the results of such queries, right click the
+ row you wish to view and choose the <literal>View Field in Popup Editor</literal>
+ option from the pop-up menu.
+ </para>
+
+ <para>
+ The result area 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 there is sufficient key information to uniquely
+ identify rows.
+
+ <remark>
+ [MH] RESULT SETS BASED ON JOINS WILL EVENTUALLY BE EDITABLE,
+ UPDATE THIS WHEN IT IS CHANGED!
+ </remark>
+
+ To edit the contents of the result area you must enable edit mode
+ through the use of the <guibutton>Edit</guibutton> button at the
+ bottom of the result area. Any edits you make are not immediately
+ applied, but instead you need to click the <guibutton>Apply
+ Changes</guibutton> button next to the <guibutton>Edit</guibutton>
+ button. Clicking the <guibutton>Discard Changes</guibutton> button
+ throws away any changes you have made to the data.
+ </para>
+
+ </section>
+
+<!-- END TABSHEET SECTION -->
+
+ <section id="mysql-query-browser-tour-objectbrowser">
+
+ <title>The Object Browser</title>
+
+ <para>
+ Use the object browser to browse your server's databases,
+ bookmarks, and query history.
+ </para>
+
+ <section id="mysql-query-browser-tour-objectbrowser-schemata">
+
+ <title>The Database Browser</title>
+
+ <para>
+ The database (schemata) browser is the primary screen of the
+ object browser. You can use the database browser not only to
+ select tables and fields to query, you can also edit tables,
+ create new tables and databases, and drop tables and databases.
+ The database browser can be used to set the default database;
+ this is required before you can issue queries against tables.
+ </para>
+
+ <figure>
+ <title>The database browser</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/schematabrowser.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The database browser</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The current default database will always be highlighted with
+ bold text. To change the default database, right click on the
+ desired database and choose the <guimenu>Make Default
+ Schema</guimenu> option or simply double click on the desired database.
+ </para>
+
+ <para>
+ You can filter the databases shown by using the search bar at
+ the top of the database browser. As you fill in the search bar,
+ databases that do not match your search are hidden from view.
+ You can clear the search bar by clicking the
+ <guibutton>X</guibutton> button on the right side of the search
+ bar. All databases will once again be displayed. You can specify
+ what objects are filtered by clicking on the hourglass icon at
+ the left side of the search bar and choosing the appropriate
+ option. Options include <literal>Schemata</literal>,
+ <literal>Schema Assets</literal>,
+ <literal>Columns/Indices</literal> and <literal>Custom
+ Selection</literal>.
+ </para>
+
+ <para>
+ To view a database's tables, stored procedures, and views, click
+ the black arrow on the left of the database name. You can view a
+ table's columns by clicking on the black arrow to the left of
+ the table name. Columns that form part of a primary key have a
+ small key icon to the left of their name. Otherwise they have a
+ blue diamond icon.
+ </para>
+
+ <para>
+ When you click the black arrow to the left of a view, the
+ columns that form the view are shown. When you click the black
+ arrow to the left of a stored procedure or stored function, the
+ arguments of the stored procedure or function are shown.
+ </para>
+
+ <para>
+ To create a new database, right click within the database
+ browser and choose the <guimenu>Create New Schema</guimenu>
+ option. To create a new table, right click the database you wish
+ to add a table to and choose the <guimenu>Create New
+ Table</guimenu> option. To create a new view, right click within
+ the database you wish to add a view to and choose the
+ <guimenu>Create New View</guimenu> option. To create a new
+ stored procedure or stored function, right click within the
+ database you wish to add to and choose the <guimenu>Create New
+ Procedure / Function</guimenu> option. You can drop objects by
+ right clicking on the object you wish to drop and choosing the
+ appropriate option (<guimenu>Drop Schema</guimenu>,
+ <guimenu>Drop Table</guimenu>, etc.).
+ </para>
+
+ <para>
+ You can edit an object by right clicking on it and choosing the
+ appropriate edit option (<guimenu>Edit Table</guimenu>,
+ <guimenu>Edit View</guimenu>, etc.). When you choose the
+ <guimenu>Edit Table</guimenu> option, the &table_editor; will be
+ displayed with the selected table. For more information on
+ editing tables, see <link linkend="gui-table-editor">The MySQL
+ Table Editor</link>. When the <guimenu>Edit View</guimenu>,
+ <guimenu>Edit Function</guimenu>, or <guimenu>Edit
+ Procedure</guimenu> options are chosen, the <literal>CREATE
+ VIEW</literal>, <literal>CREATE PROCEDURE</literal>, or
+ <literal>CREATE FUNCTION</literal> statement will be shown in a
+ new tab using the Script Editor. It is possible to edit all
+ server functions/procedures at once by choosing the
+ <guimenu>Edit All Stored Procedures / Functions</guimenu> option
+ from the <guimenu>Script</guimenu> menu.
+ </para>
+
+ <para>
+ If you need the CREATE statement for any object, right click on
+ the object and choose the <guimenu>Copy SQL to
+ Clipboard</guimenu> option. The appropriate
+ <literal>CREATE</literal> statement will be copied to the
+ clipboard and can be used to recreate the selected object.
+ </para>
+
+ <note>
+ <para>
+ Only the object itself is created with the <guimenu>Copy SQL
+ to Clipboard</guimenu> command, the statements required to
+ populate the object are not created.
+ </para>
+ </note>
+
+ </section>
+
+<!-- END SCHEMATA BROWSER -->
+
+ <section 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 <guimenu>Create
+ Bookmark Folder</guimenu> option. You can remove bookmarks and
+ folders by right clicking on them and choosing the
+ <guimenu>Delete Items</guimenu> option. After you confirm that
+ you wish to delete the item it will be removed from your
+ bookmark list.
+ </para>
+
+ <warning>
+ <para>
+ If you delete a folder all items and subfolders within the
+ folder are also deleted.
+ </para>
+ </warning>
+
+ <para>
+ The Bookmark Browser is one of a number of XML files use for
+ internal purposes by the Query Browser. For a listing of these files
+ see <xref linkend="mysql-query-browser-appendix-xml-files"/>.
+ </para>
+
+ </section>
+
+<!-- END BOOKMARK BROWSER -->
+
+ <section id="mysql-query-browser-tour-objectbrowser-history">
+
+ <title>The History Browser</title>
+
+ <para>
+ With the history browser you can browse through all the queries
+ you have previously 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 or drag it to the query area.
+ </para>
+
+ <para>
+ You can remove history items by right clicking on them and
+ choosing the <guimenu>Delete Selected History Entries</guimenu>
+ option from the drop-down menu. You can also use the
+ <guimenu>Clear History</guimenu> option to erase all history
+ entries.
+ </para>
+
+ <para>
+ You can create bookmarks from history items by right clicking on
+ a selected history item and choosing the <guimenu>Add History
+ Item as Bookmark</guimenu> menu option.
+ </para>
+
+ </section>
+
+<!-- END HISTORY BROWSER -->
+
+ </section>
+
+<!-- END OBJECT BROWSER -->
+
+ <section id="mysql-query-browser-tour-pandf">
+
+ <title>The Information Browser</title>
+
+ <para>
+ The Information Browser provides access to all information that is
+ not directly related to actual data within your database. The
+ parameter browser provides different local, global, and dynamic
+ parameters that can help build your queries, whereas the syntax
+ browser provides a convenient reference to MySQL query syntax. The
+ Function browser is a quick reference to the various functions
+ built into MySQL. The Transaction Browser lists all queries that
+ make up a single transaction and serves as a history for a single
+ transaction.
+ </para>
+
+ <section id="mysql-query-browser-tour-pandf-syntaxbrowser">
+
+ <title>The Syntax Browser</title>
+
+ <para>
+ The syntax browser provides a quick reference tool for
+ determining proper syntax to use when constructing queries. By
+ double clicking on the various types of syntax (SELECT, REPLACE,
+ and so forth) you can bring up reference information using the
+ in-line help system.
+ </para>
+
+ <para>
+ Reference information is displayed in a new tab within the
+ result area.
+ </para>
+
+ <para>
+ To expand a given syntax category, double click on the category
+ header.
+ </para>
+
+ </section>
+
+<!-- END SYNTAX BROWSER -->
+
+ <section id="mysql-query-browser-tour-pandf-functionbrowser">
+
+ <title>The Function browser</title>
+
+ <para>
+ The function browser provides a quick reference tool for usage
+ of the built-in functions of the MySQL server. By
+ double clicking on the various functions you can bring up
+ reference information using the in-line help system.
+ </para>
+
+ <para>
+ To expand a given function category, double click on the
+ category header.
+ </para>
+
+ <para>
+ Reference information is displayed in a new tab within the
+ result area.
+ </para>
+
+ </section>
+
+<!-- END FUNCTION BROWSER -->
+
+ <section id="mysql-query-browser-tour-pandf-parameterbrowser">
+
+ <title>The Parameter Browser</title>
+
+ <para>
+ The parameter browser contains all the local, global, and
+ dynamic parameters that can be included in your query. Local
+ parameters affect the query in the current query window only.
+ Global parameters affect all queries. Dynamic parameters are
+ generated automatically from existing queries.
+ </para>
+
+ <para>
+ Parameter categories can be displayed and hidden by clicking on
+ the <guilabel>Global Params</guilabel>, <guilabel>Local
+ Params</guilabel> and <guilabel>Dynamic Params</guilabel>
+ headings.
+ </para>
+
+ <para>
+ To set the value of a parameter, click on the value and press
+ the <keycap>F2</keycap> key, or double click the value.
+ </para>
+
+ <para>
+ To add a new parameter, right click within the parameter browser
+ and select the <guimenu>Add Parameter</guimenu> option.
+ </para>
+
+ <para>
+ To delete a parameter, right click on the parameter and choose
+ the <guimenu>Delete Parameter</guimenu> option.
+ </para>
+
+ <para>
+ To change a Local parameter into a Global parameter, right click
+ on the parameter and choose the <guimenu>Move Parameter to
+ Global Parameters</guimenu> option.
+ </para>
+
+ </section>
+
+<!-- END PARAMETER BROWSER -->
+
+ <section id="mysql-query-browser-tour-pandf-transbrowser">
+
+ <title>The Transaction Browser</title>
+
+ <para>
+ The Transaction Browser provides a list of all statements that
+ have been executed in the current transaction. The Transaction
+ browser will be displayed when you start a transaction using the
+ transaction control buttons.
+ </para>
+
+ </section>
+
+<!-- END TRANSACTION BROWSER -->
+
+ </section>
+
+<!-- END INFORMATION BROWSER -->
+
+ <section id="mysql-query-browser-tour-scripteditor-introduction">
+
+ <title>The Script Editor</title>
+
+ <para>
+ The <literal>Script Editor</literal> provides an alternate
+ interface for use when dealing with large SQL scripts that involve
+ multiple SQL statements.
+ </para>
+
+ <figure>
+ <title>The script editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/script-editor.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The script editor</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The Script Editor displays within an individual tab in the
+ <link linkend="mysql-query-browser-tour-resultarea">Result
+ Area</link>. When a Script Editor tab is active, the
+ <link linkend="mysql-query-browser-tour-buttonbar">Advanced
+ Toolbar</link> buttons are replaced with script debugging buttons.
+ </para>
+
+ <para>
+ To open a script in the Script Editor, choose the <guimenu>Open
+ Script ...</guimenu> option from the <guimenu>File</guimenu> menu.
+ You can also press the <keycap>Ctrl</keycap> + <keycap>O</keycap>
+ keys to open a SQL script.
+ </para>
+
+ <para>
+ To create a new Script Editor window without loading a script,
+ choose the <guimenu>New Script Tab</guimenu> option from the
+ <guimenu>File</guimenu> menu.
+ </para>
+
+ <para>
+ If you're experiencing problems with character sets (for example,
+ Spanish accented characters, Russian, or Chinese characters aren't
+ displayed properly), here's some advice:
+ </para>
+
+ <para>
+ <emphasis role="bold">Avoid ANSI encoding in your script
+ files.</emphasis> Rather than using ANSI, save scripts in
+ <emphasis>UTF-8</emphasis> encoding. Take care when loading script
+ files generated by other tools. Many tools save files in ANSI
+ encoding, which in turn means you have to open them as ANSI in
+ Query Browser (see the <guilabel>Files of type</guilabel> combo
+ box in the file open dialog):
+ </para>
+
+ <figure>
+ <title>The file open dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/file-open-script.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The file open dialog</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ There are significant limitations to ANSI formatted files; the
+ current system locale must be the same as the machine where the
+ file originated. For example, you cannot store a script in ANSI on
+ a French version of Windows and expect it to load correctly on a
+ Spanish version of Windows. Because of this and many other
+ limitations we strongly recommend always using Unicode for
+ scripts. It doesn't matter whether you use UTF-8 or UTF-16, since
+ both are Unicode transformation formats and can be read properly
+ by any of the MySQL GUI tools. Using UTF, you could even write
+ Spanish text with Chinese comments on a German version of Windows.
+ </para>
+
+ <para>
+ The MySQL Query Browser forum provides many contributions by users
+ of non-Latin1 characters sets; see
+ <ulink url="http://forums.mysql.com/list.php?108"/>.
+ </para>
+
+ <section id="mysql-query-browser-tour-scripteditor-buttons">
+
+ <title>The Script Debugging Buttons</title>
+
+ <para>
+ The following buttons are available when using the Script
+ Editor:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Execute</literal>: Execute the script from the
+ beginning and do not stop execution until the end of the
+ script is reached.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Continue</literal>: Execute the script from the
+ beginning (or current position) and stop for errors or break
+ points.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Step</literal>: Execute the next statement,
+ functions will be executed but not stepped into.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Pause</literal>: Stops script execution and
+ highlights on the next statement to be executed.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Stop</literal>: Stop execution of the script.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </section>
+
+<!-- END BUTTONS -->
+
+ <section id="mysql-query-browser-tour-scripteditor-scriptarea">
+
+ <title>The Script Area</title>
+
+ <para>
+ The current script being edited in the Script Editor is
+ displayed in the <literal>Script Area</literal>. The Script Area
+ features line numbering and syntax highlighting to make it
+ easier to work with scripts.
+ </para>
+
+ <para>
+ Script lines that are marked with a blue dot to the left of the
+ line are eligible for use as breakpoints. To set a line as a
+ breakpoint, click the blue dot. You can also set a breakpoint by
+ positioning the cursor in the line you wish to break at and
+ clicking the <guimenu>Toggle Breakpoint</guimenu> option in the
+ <guimenu>Script</guimenu> menu. To remove all breakpoints,
+ choose the <guimenu>Remove All Breakpoints</guimenu> option of
+ the <guimenu>Script</guimenu> menu.
+ </para>
+
+ <para>
+ To execute a selection of statements, highlight the statements
+ you wish to execute and choose the <guimenu>Execute
+ Selection</guimenu> option of the <guimenu>Script</guimenu>
+ menu.
+ </para>
+
+ </section>
+
+<!-- END SCRIPT AREA -->
+
+ </section>
+
+<!-- END SCRIPT EDITOR -->
+
+</chapter>
Added: trunk/query-browser-cy/using.xml
===================================================================
--- trunk/query-browser-cy/using.xml (rev 0)
+++ trunk/query-browser-cy/using.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 847, Lines Deleted: 0; 29245 bytes
@@ -0,0 +1,847 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+]>
+<chapter id="mysql-query-browser-using">
+
+ <title>Using The &query_browser;</title>
+
+ <para>
+ In this chapter we further describe the tools available in the
+ &query_browser; by using practical examples.
+ </para>
+
+ <section id="mysql-query-browser-using-manualentry">
+
+ <title>Entering and Editing Queries Manually</title>
+
+ <para>
+ The query browser is most commonly used for executing 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,
+ and so on) are highlighted in blue.
+ </para>
+
+ <para>
+ As you enter your query, the query area will expand from an
+ initial three lines in height to a maximum ten lines in height.
+ For additional space, you can press the <keycap>F11</keycap> key
+ to maximize the query area. You can also choose the
+ <guimenu>Maximize Query Area</guimenu> of the
+ <guimenu>View</guimenu> menu to maximize the query area. When the
+ query is maximized, line numbers are displayed for the query, and
+ the query area can be resized by clicking and dragging the line
+ that divides the query area from the result area. To restore the
+ query area, press the <keycap>F11</keycap> key again.
+ </para>
+
+ <para>
+ Once you have entered a query, click on the
+ <guibutton>Execute</guibutton> button and your query results are
+ displayed in the result area. You can also press
+ <keycap>Ctrl</keycap>+ <keycap>Enter</keycap> to execute the
+ query. If there is an error in your query, an error area appears
+ at the bottom of the result area and displays the relevant error
+ message and error number.
+ </para>
+
+ <para>
+ In addition to loading the query results into the current active
+ result area, you can also create a new result area for the results
+ of your query or split your current result area and load results
+ into the new section.
+ </para>
+
+ <para>
+ To execute the query and load the results into a new result area
+ click the down-arrow below the <guibutton>Execute</guibutton>
+ button and choose the <guimenu>Execute in new Tab</guimenu> option
+ or press
+ <keycap>Ctrl</keycap>+<keycap>Shift</keycap>+<keycap>Enter
+ </keycap>.
+ </para>
+
+ <para>
+ To split the active result area and display the query results
+ click the down-arrow below the <guibutton>Execute</guibutton>
+ button and choose the <guimenu>Split Tab and Execute</guimenu>
+ option or press
+ <keycap>Ctrl</keycap>+<keycap>Alt</keycap>+<keycap>Enter</keycap>
+ .
+ </para>
+
+ <para>
+ You must set a default database before you can query specific
+ tables (though you can still perform queries that are not
+ database-specific). You can set the default database at the
+ connection screen, or by right-clicking on a database in the
+ database browser and choosing <guimenu>Make Default
+ Schema</guimenu>, or by choosing the <guimenu>Change Default
+ Schema</guimenu> option from the <guimenu>File</guimenu> menu.
+ </para>
+
+ </section>
+
+<!-- END ENTERING QUERIES MANUALLY -->
+
+ <section id="mysql-query-browser-using-graphicalbuilding">
+
+ <title>Building Queries</title>
+
+ <para>
+ One feature of the &query_browser; is the ability to build
+ queries. Use the database browser to select the columns and tables
+ you wish to query and have the query created automatically based
+ on your choices.
+ </para>
+
+ <para>
+ The first step to building a query is to choose a table to query.
+ Click and drag a table to the query area to start a query. For
+ example, by dragging the <literal>City</literal> table to the
+ query area, <literal>SELECT * FROM City C</literal> is added to
+ the query area. You can also double-click a table to start a new
+ <literal>SELECT</literal> query.
+ </para>
+
+ <figure>
+ <title>The table tool</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/tabletool.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The table tool</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ When you select a table from the database browser and drag it over
+ the query area, a table tool with some query composition actions
+ is displayed. Drop the table you're dragging on the desired action
+ and the query is modified accordingly. The following actions are
+ possible:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>SELECT</literal> replaces the current statement with
+ a <literal>SELECT</literal> query containing the dragged
+ table.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Add Table</literal> adds the dragged table to the
+ list of tables in the current <literal>SELECT</literal> query
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>JOIN Table</literal>: If a <literal>SELECT</literal>
+ query is already in the query box, with a table in it, the new
+ dragged table is added and the appropriate
+ <literal>WHERE</literal> clauses to perform a
+ <literal>JOIN</literal> will be added
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>LEFT OUTER JOIN</literal> is the same as the
+ previous, but does a <literal>LEFT OUTER JOIN</literal>
+ instead of a <literal>JOIN</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>UPDATE</literal> replaces the current statement with
+ an <literal>UPDATE</literal> statement containing the dragged
+ table
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>INSERT</literal> replaces the current statement with
+ an <literal>INSERT</literal> statement containing the dragged
+ table
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>DELETE</literal> replaces the current statement with
+ a <literal>DELETE</literal> statement containing the dragged
+ table
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Tables are joined based on identical column names for MyISAM
+ tables and foreign key information for InnoDB tables.
+ </para>
+
+ <para>
+ Once a table is selected, you can choose specific columns to
+ query; click the <guibutton>Select</guibutton> button from the
+ query building buttons on the button bar. Your mouse pointer is
+ changed to a <literal>Select</literal> pointer, which you can use
+ to choose columns from the database browser. For example, by
+ clicking on the Id, Name, and Country fields of the
+ <literal>world</literal> sample database, the query
+ <literal>SELECT C.Id, C.Name, C.Country FROM City C</literal> is
+ built in the query area.
+ </para>
+
+ <para>
+ Once you have chosen the columns you wish to query, you can use
+ the other query building buttons 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 is placed in position for editing; if you click a field
+ with the WHERE pointer, the cursor is 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 <keycap>Ctrl</keycap>+<keycap>Alt</keycap>
+ and the first letter of the pointer you wish to use
+ (<keycap>Ctrl</keycap>+<keycap>Alt</keycap>+<keycap>S</keycap> for
+ <literal>SELECT</literal>,
+ <keycap>Ctrl</keycap>+<keycap>Alt</keycap>+<keycap>W</keycap> for
+ <literal>WHERE</literal>, and so forth.)
+ </para>
+
+ <para>
+ If the query building buttons are not visible, they can be
+ displayed through the Browser Options. See
+ <xref
+ linkend="gui-options-query-browser-display-options"/>
+ for more information.
+ </para>
+
+ </section>
+
+<!-- END BUILDING GRAPHICALLY -->
+
+ <section id="mysql-query-browser-creating-views">
+
+ <title>Creating Views</title>
+
+ <para>
+ The simplest way to create a view using the &query_browser; is to
+ use the <guibutton>Create View</guibutton> button. Execute a query
+ that represents the view you wish to create. Once the query is
+ executed, click the <guibutton>Create View</guibutton> button,
+ provide a name for the view, and the view is created.
+ </para>
+
+ <note>
+ <para>
+ Creating views is not yet supported on all Operating systems.
+ </para>
+ </note>
+
+ <para>
+ You can also create a view by right-clicking on the database you
+ wish to add a view to in the database browser and choosing the
+ <guimenu>Create New View</guimenu> option. After you enter a name
+ for the view, a view template will be displayed in the script
+ editor.
+ </para>
+
+ </section>
+
+<!-- END CREATING VIEWS -->
+
+ <section id="mysql-query-browser-using-navigatingtabsheet">
+
+ <title>Navigating Result Sets Within the Result Area</title>
+
+ <para>
+ Once you have successfully executed a query you can then view and
+ manipulate the result set within the result area.
+ </para>
+
+ <para>
+ You can navigate the result area 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. Your current
+ position within the result set is shown in the bottom-left corner
+ of the application window. The <guibutton>First</guibutton> and
+ <guibutton>Last</guibutton> buttons at the bottom of the result
+ area can be used to move to the first and last rows of the result
+ set.
+ </para>
+
+ <para>
+ NULL data will be indicated with a special <literal>NULL</literal>
+ icon to differentiate NULL data from empty strings. BLOB fields
+ will be empty and will have a special <literal>BLOB</literal>
+ icon.
+ </para>
+
+ <para>
+ When navigating a particularly large result set, you can press the
+ <keycap>F12</keycap> key to maximize the result area. You can also
+ choose the <guimenu>Maximize Tabsheets</guimenu> option of the
+ <guimenu>View</guimenu> menu to maximize the result area. Pressing
+ <keycap>F12</keycap> again will restore the result area to its
+ original size.
+ </para>
+
+ <para>
+ To search for a particular value within the result set, click the
+ <guibutton>Search</guibutton> button. To see additional search
+ options, click the <guibutton>Details >></guibutton> button. The
+ following options are available:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Case Sensitive</literal>: The search is performed in
+ a case-sensitive manner. By default, searches are not
+ case-sensitive.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Whole Words Only</literal>: The search does not allow
+ partial matches. By default, partial matches are allowed (i.e.
+ <literal>Edm</literal> will match
+ <literal>Edmonton</literal>).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Search From Top</literal>: The search begins with the
+ first row in the result set.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Search From Cursor</literal>: The search begins from
+ the currently selected row.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Search all Text / Columns</literal>: The search will
+ involve all columns of the result set.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Search Only in Selected Text / Column</literal>: The
+ search will only involve the currently selected column(s) of
+ the result set.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Search Up</literal>: The search will scan the result
+ set, starting at the designated start location and moving
+ upwards.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Search Down</literal>: The search will scan the
+ result set, starting at the designated start location and
+ moving down.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ To perform a search and replace operation on a result set, click
+ the <literal>Replace</literal> tab in the search dialog window.
+ The options for performing a replace operation are the same as for
+ a search. To replace a single instance of a string, click the
+ <guibutton>Replace</guibutton> button. To replace all instances of
+ a string, click the <guibutton>Replace All</guibutton> button.
+ </para>
+
+ </section>
+
+<!-- END NAVIGATING TABSHEET -->
+
+ <section id="mysql-query-browser-using-export">
+
+ <title>Exporting Result Sets</title>
+
+ <para>
+ You can export any result set from &query_browser; by
+ right-clicking within the result set and choosing an option from
+ the <guimenu>Export Resultset</guimenu> sub-menu. You can choose
+ to export the result set in <literal>CSV</literal>,
+ <literal>XML</literal>, <literal>HTML</literal>, Microsoft Excel
+ <literal>XLS</literal> or <literal>PLIST</literal> formats.
+ </para>
+
+ </section>
+
+<!-- END EXPORTING -->
+
+ <section id="mysql-query-browser-using-blobs">
+
+ <title>Handling BLOB and TEXT Columns</title>
+
+ <para>
+ The &query_browser; provides functionality for dealing with
+ <literal>BLOB</literal> and <literal>TEXT</literal> columns
+ through a series of special icons.
+ </para>
+
+ <figure>
+ <title>The BLOB handling icons</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/blob-buttons.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The BLOB handling icons</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ These icons appear in any <literal>BLOB</literal> or
+ <literal>TEXT</literal> columns in your result set. From left to
+ right the following icons are available:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Open File</literal>: This icon looks like a file
+ folder and is used to open a file for loading into the field.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>View</literal>: This icon looks like a magnifying
+ glass and is used to open the field viewer to view the
+ contents of the field. The field viewer can be used to view
+ <literal>TEXT</literal> fields and <literal>BLOB</literal>
+ fields that contain images.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Edit</literal>: This icon looks like a pencil and
+ opens the field viewer in edit mode, allowing you to make
+ changes to the data and apply the changes to the result set.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Save</literal>: This icon looks like a floppy disk
+ and is used to save the contents of a <literal>TEXT</literal>
+ or <literal>BLOB</literal> field into a file.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Clear</literal>: This icon looks like an X within a
+ black box and is used to clear the contents of a
+ <literal>TEXT</literal> or <literal>BLOB</literal> field.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Only the <literal>View</literal> and <literal>Save</literal> icons
+ are visible if you have not enabled edit mode. See
+ <xref linkend="mysql-query-browser-using-editingtabsheet" /> for
+ information on editing result sets.
+ </para>
+
+ <para>
+ The functionality represented by the icons is also available by
+ right-clicking on the field. The blob handling icons can be
+ displayed and hidden through the display options. See
+ <xref
+ linkend="gui-options-query-browser-display-options"/>
+ for more information.
+ </para>
+
+ </section>
+
+<!-- END BLOB HANDLING -->
+
+ <section id="mysql-query-browser-using-editingtabsheet">
+
+ <title>Editing Result Sets Within the Result Area</title>
+
+ <para>
+ When a query is based on a single table and there is sufficient
+ key information, the result set can be edited from within the
+ result area.
+ <remark>
+ [MH] TODO: THIS WILL CHANGE, UPDATE WHEN APPROPRIATE
+ </remark>
+
+ To edit a result set click the <guibutton>Edit</guibutton> button
+ at the bottom of the window.
+ If the <guibutton>Edit</guibutton> button is not active, your
+ result set is not editable. (Under Linux this button is labeled
+ <guilabel>Start Editing</guilabel>.)
+ </para>
+
+ <note>
+ <para>
+ Queries derived from a single table lacking a primary key
+ or from more than one table are <emphasis>not</emphasis> editable;
+ they are read-only.
+ </para>
+ </note>
+
+ <para>
+ Once in edit mode you can insert, update, and delete rows from the
+ result set. Navigate the fields using the <keycap>Tab</keycap> and
+ arrow keys, and press <keycap>Enter</keycap> to edit the content
+ of a field. You can also double-click a field to make it editable.
+ When editing a field, use the tab key to move to the next editable
+ field. All edited fields are highlighted in blue for easy
+ identification.
+ </para>
+
+ <para>
+ To add rows to the result set, scroll to the blank row at the
+ bottom of the result area and fill in the fields. All new rows are
+ highlighted in green.
+ </para>
+
+ <para>
+ To delete a row right-click on the row and choose the
+ <guimenu>Delete Row</guimenu> option. All deleted rows are
+ highlighted in red.
+ </para>
+
+ <para>
+ Changes made to the result set 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 prompts you to
+ apply or discard your work.
+ </para>
+
+ </section>
+
+<!-- END EDITING TABSHEET -->
+
+ <section id="mysql-query-browser-using-compare">
+
+ <title>Comparing Result Sets</title>
+
+ <para>
+ You can compare result sets graphically with the &query_browser;,
+ allowing you to easily determine where rows have been inserted,
+ updated, or deleted.
+ </para>
+
+ <para>
+ To compare two result sets, execute the first of the queries you
+ wish to compare. Once the result set has loaded, right-click on
+ the result set and choose the <guimenu>Split Tab
+ Horizontally</guimenu> option. Load your second query into the new
+ section of the result area and click the
+ <guibutton>Compare</guibutton> button to compare the two result
+ sets.
+ </para>
+
+ <para>
+ When you have activated the compare mode, both result sets will
+ scroll in unison, 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 result set has a row that the other result set does not
+ have, that row is highlighted in green. The other result set has a
+ blank row inserted that is highlighted in red. If both result sets
+ have a matching row, but individual fields are different, those
+ fields are highlighted in blue.
+ </para>
+
+ <para>
+ In order to successfully compare two result sets, you need two
+ queries with matching column names and column order. For the
+ &query_browser; to match rows, primary keys must be defined in the
+ tables used.
+ </para>
+
+ </section>
+
+<!-- END COMPARING result setS -->
+
+ <!--section id="mysql-query-browser-using-masterdetail">
+
+ <title>Creating Master-Detail Views</title>
+
+ <para>
+ <remark>[PL] This feature is not currently available. (Dec 4, 2006) </remark>
+ </para>
+
+ <para>
+ &query_browser; makes it easy to view data that is in a
+ master-detail (one to many) relationship. This can be useful for
+ viewing customer/order data, group/member data, and so forth.
+ </para>
+
+ <para>
+ To display a master-detail view, first query the master table in a
+ new result area. For example, using the <literal>world</literal>
+ sample database, you could issue a query like <literal>SELECT
+ Code, Name, Continent FROM Country</literal>.
+ </para>
+
+ <para>
+ Once you have created the master result set, right-click on the
+ result area and choose the <guimenu>Split Tab Vertically</guimenu>
+ option. For the detail query, create a query that uses the dynamic
+ parameters available from the master query, as seen in the
+ parameter browser. In this example, we could query the City table
+ in the following way: <literal>SELECT Id, Name FROM City WHERE
+ Country = :Code</literal>.
+ </para>
+
+ <para>
+ The colon character indicates to the &query_browser; that you are
+ adding a dynamic parameter, and a pop-up list of available
+ parameters should appear within the query area, allowing you to
+ use the arrow keys to choose a parameter. You can also type the
+ name of the parameter that you would like to use to link the
+ detail query.
+ </para>
+
+ <figure>
+ <title>The dynamic parameter list</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/dynamiclist.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The dynamic parameter list</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Once you execute the detail query, it will automatically refresh
+ any time you change the active row in the master query, allowing
+ you to quickly see all detail rows as you navigate the master
+ result set.
+ </para>
+
+ <para>
+ You can repeat this process, splitting the result area yet again,
+ allowing you to have detail result sets <emphasis>for</emphasis>
+ detail result sets.
+ </para>
+
+ <note>
+ <para>
+ You can only continue splitting a result set in the same
+ direction as the previous split but you cannot, for example,
+ split vertically and then horizontally.
+ </para>
+ </note>
+
+ </section-->
+
+<!-- END MASTER DETAIL -->
+
+ <section id="mysql-query-browser-using-procedures">
+
+ <title>Managing Stored Procedures and Functions with &query_browser;</title>
+
+ <para>
+ When used with MySQL version 5 and higher, the &query_browser;
+ supports creating, editing, and viewing stored procedures and
+ functions.
+ </para>
+
+ <para>
+ Stored procedures and stored functions are displayed in the
+ database browser with a special icon to distinguish them from
+ regular tables and views. Click the arrow to the left of a stored
+ procedure or stored function to display the parameter list for
+ that procedure or function.
+ </para>
+
+ <figure>
+ <title>Stored procedure in database browser</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/stored-procedure-database-browser.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Stored procedure in database
+ browser</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ To edit a stored procedure or stored function, right-click on it
+ in the database browser and choose the <guimenu>Edit
+ Procedure</guimenu> or <guimenu>Edit Function</guimenu> option.
+ This opens a new script editor tab with the selected
+ procedure/function displayed. Once you have finished editing,
+ click the <guibutton>Execute</guibutton> button above the script
+ area or click the <guimenu>Execute</guimenu> option of the
+ <guimenu>Script</guimenu> menu to update the procedure/function.
+ </para>
+
+ <para>
+ To create a new stored procedure or function, choose the
+ <guimenu>Create Stored Procedure / Function</guimenu> option from
+ the <guimenu>Script</guimenu> menu. Enter the desired
+ procedure/function name and click either the <guibutton>Create
+ PROCEDURE</guibutton> or <guibutton>Create FUNCTION</guibutton>
+ button. A template similar to the following will be created:
+ </para>
+
+<programlisting>
+DELIMITER \\
+
+DROP PROCEDURE IF EXISTS `test`.`new_proc`\\
+CREATE PROCEDURE `test`.`new_proc` ()
+BEGIN
+
+END\\
+
+DELIMITER ;
+ </programlisting>
+
+ <para>
+ After typing the procedure/function, click the
+ <guibutton>Execute</guibutton> button above the script area or
+ click the <guimenu>Execute</guimenu> option of the
+ <guimenu>Script</guimenu> menu to create it.
+ </para>
+
+ <para>
+ To edit all stored procedures/functions at once, choose the
+ <guimenu>Edit All Stored Procedures / Functions</guimenu> option
+ of the <guimenu>Script</guimenu> menu. A new script editing tab
+ will be created, containing all the stored procedures and stored
+ functions for the current default database.
+ </para>
+
+ <para>
+ To remove an existing stored procedure or stored function,
+ right-click on it in the database browser and choose the
+ <guimenu>Drop Procedure</guimenu> or <guimenu>Drop
+ Function</guimenu> option.
+ </para>
+
+ </section>
+
+<!-- END STORED PROCEDURES -->
+
+ <section id="mysql-query-browser-using-codeedit">
+
+ <title>Editing Queries From a Development Tool</title>
+
+ <para>
+ In order to help programmers optimize and troubleshoot their
+ queries more efficiently, the &query_browser; can copy queries
+ from application code using your favorite integrated development
+ environment (IDE).
+ </para>
+
+ <note>
+ <para>
+ This functionality is only available for the Windows version of
+ &query_browser;.
+ </para>
+ </note>
+
+ <para>
+ The following PHP code will be used as an example:
+ </para>
+
+<programlisting>
+$SQL = "SELECT Id, Name, Country FROM City" .
+ "WHERE Name LIKE $cityname";
+</programlisting>
+
+ <para>
+ To copy the listing into the &query_browser;, copy the block of
+ code (including the assignment portion), right click within the
+ query area of the &query_browser;, and choose the <guimenu>Paste
+ Clipboard Content as PHP Code</guimenu> option. The non-query
+ portions of the highlighted area will be stripped and the query
+ will be pasted into the query area.
+ </para>
+
+ <para>
+ The dynamic elements of the query are converted into local
+ parameters, visible in the
+ <link linkend="mysql-query-browser-tour-pandf-parameterbrowser">parameter
+ browser</link>:
+ </para>
+
+<programlisting>
+SELECT Id, Name, Country FROM City
+WHERE Name LIKE :cityname
+</programlisting>
+
+ <para>
+ To set the value of a local parameter, highlight the value in the
+ parameter browser and press <keycap>F2</keycap>. You can also
+ double-click on the value to edit it. The value you assign will be
+ used when the query is executed.
+ </para>
+
+ <para>
+ After editing the query, right-click within the query area and
+ choose the <guimenu>Copy Query as PHP Code</guimenu> option. The
+ surrounding PHP code will be re-inserted along with the modified
+ query. This functionality allows you to edit queries quickly while
+ programming.
+ </para>
+
+ </section>
+
+<!-- END CODE EDIT -->
+
+</chapter>
Added: trunk/query-browser-cy/xml-files.xml
===================================================================
--- trunk/query-browser-cy/xml-files.xml (rev 0)
+++ trunk/query-browser-cy/xml-files.xml 2007-04-03 06:31:39 UTC (rev 5703)
Changed blocks: 1, Lines Added: 66, Lines Deleted: 0; 2287 bytes
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+]>
+ <appendix id="mysql-query-browser-appendix-xml-files">
+
+ <title>XML Files Used by &query_browser;</title>
+
+ <para>
+ Besides the <link linkend="mysql-gui-appendix-xml-files">common
+ files</link>, &query_browser; uses a number of XML files for
+ internal purposes.
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>mysqlqb_functions.xml</literal>: Stores a list of
+ functions and operators for use in the
+ <link linkend="mysql-query-browser-tour-pandf-functionbrowser">Function
+ Browser</link>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>mysqlx_dbm_data types.xml</literal>: Stores a list of
+ the available MySQL data types for use with auto-completion
+ and with the
+ <link linkend="gui-table-editor">&table_editor;</link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>mysqlx_dbm_charsets.xml</literal>: Stores the
+ available MySQL character sets.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>mysqlqb_history.xml</literal> : Stores the queries
+ that make up the
+ <link linkend="mysql-query-browser-tour-objectbrowser-history">History
+ Browser</link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>mysqlqb_bookmark.xml</literal>: Stores the queries
+ that form the
+ <link linkend="mysql-query-browser-tour-objectbrowser-bookmarks">Bookmark
+ Browser</link>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ </appendix>
+
\ No newline at end of file
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5703 - in trunk: . gui-common-cy gui-common-cy/images query-browser-cy query-browser-cy/images | stefan | 3 Apr |
