Below is the list of changes that have just been committed into a local
mysqldoc repository of jon. When jon does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://www.mysql.com/doc/I/n/Installing_source_tree.html
ChangeSet
1.3050 05/07/19 01:30:22 jon@stripped +3 -0
MySQL Programs chapter:
- RefMan-5.0 edits.
- Added pointers to GUI tools docs.
- Added info about -e (--execute) option
for mysql client.
Added note to NDB CLuster chapter
about -e option for mdb_mgm (Bug#11327).
Updated Status.
refman-5.0/using-mysql-programs.xml
1.2 05/07/19 01:30:21 jon@stripped +257 -186
RefMan-5.0 edits.
Added pointers to GUI tools docs.
Added info about -e (--execute) option
for mysql client.
refman-5.0/ndbcluster.xml
1.10 05/07/19 01:30:21 jon@stripped +9 -2
Added note about -e option to ndb_mgm.
refman-5.0/Status
1.7 05/07/19 01:30:20 jon@stripped +1 -1
Updating...
# This is a BitKeeper patch. What follows are the unified diffs for the
# set of deltas contained in the patch. The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User: jon
# Host: gigan.
# Root: /home/jon/bk/mysqldoc
--- 1.9/refman-5.0/ndbcluster.xml 2005-07-15 06:11:32 +10:00
+++ 1.10/refman-5.0/ndbcluster.xml 2005-07-19 01:30:21 +10:00
@@ -1328,11 +1328,18 @@
shell> ndb_mgm -e shutdown
</programlisting>
+<!-- TODO: Document any other commands that can be passed to ndb_mgm in
+ this fashion. /JS 2005-07-19
+-->
+
<para>
This will cause the <command>ndb_mgm</command>,
- <command>ndb_mgm</command>, and any <command>ndbd</command>
+ <command>ndb_mgmd</command>, and any <command>ndbd</command>
processes to terminate gracefully. Any SQL nodes can be terminated
- using <command>mysqladmin shutdown</command> and other means.
+ using <command>mysqladmin shutdown</command> and other means. Note
+ that the <literal>-e</literal> option here is used to pass a command
+ to the <command>ndb_mgm</command> client from the shell. See
+ <xref linkend="command-line-options"/>.
</para>
<para>
--- 1.1/refman-5.0/using-mysql-programs.xml 2005-06-17 05:46:22 +10:00
+++ 1.2/refman-5.0/using-mysql-programs.xml 2005-07-19 01:30:21 +10:00
@@ -8,17 +8,53 @@
%title.entities;
]>
<chapter id='using-mysql-programs'>
+
+<!--
+ TODO: This chapter ought to be called something like "Using MySQL
+ Command-Line Programs" since we now have the GUI tools. I've
+ updated this section to include a brief description of and a link
+ to the documentation for each of them. /JS 2005-07-18
+-->
<title id='title-using-mysql-programs'>&title-using-mysql-programs;</title>
<para>
- This chapter provides a brief overview of the programs provided by
- MySQL AB and discusses how to specify options when you run these
- programs. Most programs have options that are specific to their own
- operation, but the syntax for specifying options is similar for all of
- them. Later chapters provide more detailed descriptions of individual
- programs, including which options they recognize.
+ This chapter provides a brief overview of the command-line programs
+ provided by MySQL AB and discusses how to specify options when you run
+ these programs. Most programs have options that are specific to their
+ own operation, but the syntax for specifying options is similar for
+ all of them. Later chapters provide more detailed descriptions of
+ individual programs, including which options they recognize.
</para>
+
+ <para>
+ MySQL AB also provide three GUI client programs for use with the
+ MySQL server:
+
+ <itemizedlist>
+
+ <listitem><para>
+ <ulink url="http://dev.mysql.com/doc/administrator/en/">MySQL Administrator</ulink>:
+ This tool is used for administering MySQL servers, databases,
+ tables, and users.
+ </para></listitem>
+
+ <listitem><para>
+ <ulink url="http://dev.mysql.com/doc/query-browser/en/">MySQL Query Browser</ulink>:
+ This graphical tool is provided by MySQL AB for creating,
+ executing, and optimizing queries on MySQL databases.
+ </para></listitem>
+
+ <listitem><para>
+ <ulink url="http://dev.mysql.com/doc/migration-toolkit/en/">MySQL Migration Toolkit</ulink>:
+ This tool is intended to help you with migrating schemas and
+ data from other relational database management systems to
+ MySQL.
+ </para></listitem>
+
+ </itemizedlist>
+ </para>
+
<section id="program-overview">
@@ -70,36 +106,30 @@
<listitem><para>
<command>mysql</command> is a command-line client for executing
- SQL statements interactively or in batch mode
- </para></listitem>
-
- <listitem><para>
- <command>mysqlcc</command> (MySQL Control Center) is an
- interactive graphical tool for executing SQL statements and
- administration
+ SQL statements interactively or in batch mode.
</para></listitem>
<listitem><para>
- <command>mysqladmin</command> is an administrative client
+ <command>mysqladmin</command> is an administrative client.
</para></listitem>
<listitem><para>
- <command>mysqlcheck</command> performs table maintenance
+ <command>mysqlcheck</command> performs table maintenance.
operations
</para></listitem>
<listitem><para>
<command>mysqldump</command> and <command>mysqlhotcopy</command>
- make database backups
+ make database backups.
</para></listitem>
<listitem><para>
- <command>mysqlimport</command> imports data files
+ <command>mysqlimport</command> imports data files.
</para></listitem>
<listitem><para>
<command>mysqlshow</command> displays information about databases
- and tables
+ and tables.
</para></listitem>
</itemizedlist>
@@ -118,37 +148,33 @@
<itemizedlist>
<listitem><para>
- <command>myisamchk</command> performs table maintenance operations
+ <command>myisamchk</command> performs table maintenance
+ operations.
</para></listitem>
<listitem><para>
<command>myisampack</command> produces compressed, read-only
- tables
+ tables.
</para></listitem>
<listitem><para>
<command>mysqlbinlog</command> is a tool for processing binary log
- files
+ files.
</para></listitem>
<listitem><para>
- <command>perror</command> displays error code meanings
+ <command>perror</command> displays error code meanings.
</para></listitem>
</itemizedlist>
</para>
- <para>
<!-- TODO: this table is missing some programs (e.g., replace). -->
- </para>
-
- <para>
-<!-- TODO: not all programs named here have their own entries in the following -->
- </para>
- <para>
-<!-- chapters (e.g., mysql_install_db) -->
- </para>
+<!--
+ TODO: not all programs named here have their own entries in the
+ following chapters (e.g., mysql_install_db)
+-->
<para>
<command>myisamchk</command> is discussed further in
@@ -176,18 +202,18 @@
<title id='title-invoking-programs'>&title-invoking-programs;</title>
<para>
- To invoke a MySQL program at the command line (that is, from your
+ To invoke a MySQL program from the command line (that is, from your
shell or command prompt), enter the program name followed by any
options or other arguments needed to instruct the program what you
want it to do. The following commands show some sample program
- invocations. ``<literal>shell></literal>'' represents the prompt
- for your command interpreter; it is not part of what you type. The
- particular prompt you see depends on your command interpreter.
- Typical prompts are <literal>$</literal> for <command>sh</command> or
- <command>bash</command>, <literal>%</literal> for
- <command>csh</command> or <command>tcsh</command>, and
- <literal>C:\></literal> for Windows <command>command.com</command>
- or <command>cmd.exe</command>.
+ invocations. <quote><literal>shell></literal></quote> represents
+ the prompt for your command interpreter; it is not part of what you
+ type. The particular prompt you see depends on your command
+ interpreter. Typical prompts are <literal>$</literal> for
+ <command>sh</command> or <command>bash</command>,
+ <literal>%</literal> for <command>csh</command> or
+ <command>tcsh</command>, and <literal>C:\></literal> for Windows
+ <command>command.com</command> or <command>cmd.exe</command>.
</para>
<programlisting>
@@ -241,13 +267,13 @@
<para>
You may find it necessary to invoke MySQL programs using the pathname
to the <filename>bin</filename> directory in which they are
- installed. This is likely to be the case if you get a ``program not
- found'' error whenever you attempt to run a MySQL program from any
- directory other than the <filename>bin</filename> directory. To make
- it more convenient to use MySQL, you can add the pathname of the
- <filename>bin</filename> directory to your <literal>PATH</literal>
- environment variable setting. Then to run a program you need only
- type its name, not its entire pathname.
+ installed. This is likely to be the case if you get a <quote>program
+ not found</quote> error whenever you attempt to run a MySQL program
+ from any directory other than the <filename>bin</filename> directory.
+ To make it more convenient to use MySQL, you can add the pathname of
+ the <filename>bin</filename> directory to your
+ <literal>PATH</literal> environment variable setting. Then to run a
+ program you need only type its name, not its entire pathname.
</para>
<para>
@@ -353,18 +379,19 @@
(<literal>-hlocalhost</literal> and <literal>-h localhost</literal>
are equivalent.) An exception to this rule is the option for
specifying your MySQL password. This option can be given in long
- form as <literal>--password=pass_val</literal> or as
- <literal>--password</literal>. In the latter case (with no password
- value given), the program prompts you for the password. The
- password option also may be given in short form as
- <literal>-ppass_val</literal> or as <literal>-p</literal>. However,
- for the short form, if the password value is given, it must follow
- the option letter with <emphasis>no intervening space</emphasis>.
- The reason for this is that if a space follows the option letter,
- the program has no way to tell whether a following argument is
- supposed to be the password value or some other kind of argument.
- Consequently, the following two commands have two completely
- different meanings:
+ form as
+ <literal>--password=<replaceable>pass_val</replaceable></literal>
+ or as <literal>--password</literal>. In the latter case (with no
+ password value given), the program prompts you for the password.
+ The password option also may be given in short form as
+ <literal>-p<replaceable>pass_val</replaceable></literal> or as
+ <literal>-p</literal>. However, for the short form, if the password
+ value is given, it must follow the option letter with <emphasis>no
+ intervening space</emphasis>. The reason for this is that if a
+ space follows the option letter, the program has no way to tell
+ whether a following argument is supposed to be the password value
+ or some other kind of argument. Consequently, the following two
+ commands have two completely different meanings:
</para>
<programlisting>
@@ -381,7 +408,8 @@
</para></listitem>
</itemizedlist>
-
+<!-- TODO: Probably just drop this para for RefMan-5.0. -->
+<!--
<para>
MySQL 4.0 introduced some additional flexibility in the way you
specify options. These changes were made in MySQL 4.0.2. Some of
@@ -392,10 +420,11 @@
use options to set program variables.
<xref linkend="program-variables"/> discusses that topic further.
</para>
-
-<!-- TODO: also: can specify unambigious prefix of option - hm, but that's -->
-
-<!-- not 4.0.2 (?), so it should be mentioned earlier. -->
+-->
+<!--
+ TODO: also can specify unambigious prefix of option - but that's
+ not 4.0.2 (?), so it should be mentioned earlier.
+-->
<para>
Some options control behavior that can be turned on or off. For
@@ -426,8 +455,8 @@
</para>
<para>
- The ``enabled'' form of the option may be specified in any of these
- ways:
+ The <quote>enabled</quote> form of the option may be specified in
+ any of these ways:
</para>
<programlisting>
@@ -437,11 +466,9 @@
</programlisting>
<para>
- Another change to option processing introduced in MySQL 4.0 is that
- you can use the <literal>--loose</literal> prefix for command-line
- options. If an option is prefixed by <literal>--loose</literal>, the
- program does not exit with an error if it does not recognize the
- option, but instead issues only a warning:
+ If an option is prefixed by <literal>--loose</literal>, the program
+ does not exit with an error if it does not recognize the option, but
+ instead issues only a warning:
</para>
<programlisting>
@@ -451,18 +478,89 @@
<para>
The <literal>--loose</literal> prefix can be useful when you run
- programs from multiple installations of MySQL on the same machine,
- at least if all the versions are as recent as 4.0.2. This prefix is
- particularly useful when you list options in an option file. An
- option that may not be recognized by all versions of a program can
- be given using the <literal>--loose</literal> prefix (or
- <literal>loose</literal> in an option file). Versions of the program
- that do not recognize the option issue a warning and ignore it. This
- strategy requires that versions involved be 4.0.2 or later, because
- earlier versions know nothing of the <literal>--loose</literal>
- convention.
+ programs from multiple installations of MySQL on the same machine.
+ This prefix is particularly useful when you list options in an
+ option file. An option that may not be recognized by all versions of
+ a program can be given using the <literal>--loose</literal> prefix
+ (or <literal>loose</literal> in an option file). Versions of the
+ program that do not recognize the option issue a warning and ignore
+ the option. <emphasis role="bold">Note</emphasis>: This strategy
+ requires that versions involved be 4.0.2 or later, because earlier
+ versions know nothing of the <literal>--loose</literal> convention.
+ </para>
+
+ <para>
+ Another option which may be occasionally useful with
+ <command>mysql</command> is the <literal>-e</literal> or
+ <literal>--execute</literal> option, which can be used to pass SQL
+ statements to the server. The statements must be surrounded by
+ (single or double) quotation marks. (However, if you wish to use
+ quoted values within the query, then you should use double quotes
+ for the query, and single quotes for any quoted values within the
+ query.) When this option is used, the statements are executed, and
+ then <command>mysql</command> exits to the command shell
+ immediately thereafter.
+ </para>
+
+ <para>
+ For example, you can use the following to obtain a list
+ of user accounts:
</para>
+<programlisting>
+shell> mysql -u root -p -e "SELECT User, Host FROM user" mysql
+Enter password: <userinput>******</userinput>
++------+-----------+
+| User | Host |
++------+-----------+
+| | gigan |
+| root | gigan |
+| | localhost |
+| jon | localhost |
+| root | localhost |
++------+-----------+
+shell>
+</programlisting>
+
+ <para>
+ Note that the name of the <literal>mysql</literal> database was
+ passed as a separate argument. However, the same query could have
+ been executed using <command>mysql -u root -p -e "SELECT User,
+ Host FROM mysql.user"</command> from the shell prompt.
+ </para>
+
+ <para>
+ Multiple SQL statements may be passed in this way, separated by
+ semicolons:
+ </para>
+
+<programlisting>
+shell> mysql -u root -p --execute="SELECT Name FROM Country WHERE Name LIKE 'AU%';SELECT COUNT(*) FROM City" world
+Enter password: <userinput>******</userinput>
++-----------+
+| Name |
++-----------+
+| Australia |
+| Austria |
++-----------+
++----------+
+| COUNT(*) |
++----------+
+| 4079 |
++----------+
+</programlisting>
+
+ <para>
+ Note that the long form (<literal>--execute</literal>) must be
+ followed by an equals sign (<literal>=</literal>).
+ </para>
+
+ <para>The <literal>-e</literal> option may also be used to pass
+ commands in an analogous fashion to the <command>ndb_mgm</command>
+ management client for MySQL Cluster. See
+ <xref linkend="multi-shutdown-restart"/> for an example.
+ </para>
+
</section>
<section id="option-files">
@@ -492,7 +590,6 @@
sometimes called configuration files). Option files provide a
convenient way to specify commonly used options so that they need
not be entered on the command line each time you run a program.
- Option file capability is available from MySQL 3.22 on.
</para>
<para>
@@ -505,6 +602,12 @@
<command>mysqld</command>, <command>mysqlhotcopy</command>,
<command>mysqlimport</command>, and <command>mysqlshow</command>.
</para>
+
+ <para>
+ <emphasis role="bold">Note</emphasis>: Option files used with MySQL
+ Cluster programs are covered in
+ <xref linkend="mysql-cluster-configuration"/>.
+ </para>
<para>
On Windows, MySQL programs read startup options from the following
@@ -564,8 +667,8 @@
<para>
<replaceable>WINDIR</replaceable> represents the location of your
- Windows directory. This is commonly <filename>C:\Windows</filename>
- or <filename>C:\WinNT</filename>. You can determine its exact
+ Windows directory. This is commonly <filename>C:\WINDOWS</filename>
+ or <filename>C:\WINNT</filename>. You can determine its exact
location from the value of the <filename>WINDIR</filename>
environment variable using the following command:
</para>
@@ -576,9 +679,14 @@
<para>
<replaceable>INSTALLDIR</replaceable> represents the installation
- directory of MySQL. This is typically the case with MySQL 4.1.5 and
- higher, when installed using the installation and configuration
- wizards. See <xref linkend="mysql-config-wizard-file-location"/>.
+ directory of MySQL. This is typically
+ <filename>C:\<replaceable>PROGRAMDIR</replaceable>\MySQL\MySQL 5.0
+ Server</filename> where <replaceable>PROGRAMDIR</replaceable>
+ represents the programs directory (usually <filename>Program
+ Files</filename> on English-language versions of Windows), when
+ MySQL 5.0 has been installed using the installation and
+ configuration wizards. See
+ <xref linkend="mysql-config-wizard-file-location"/>.
</para>
<para>
@@ -644,8 +752,8 @@
<para>
<literal>MYSQL_HOME</literal> is an environment variable containing
the path to the directory in which the server-specific
- <literal>my.cnf</literal> file resides. This used to be
- <replaceable>DATADIR</replaceable> prior to MySQL version 5.0.3.
+ <literal>my.cnf</literal> file resides. (This was
+ <literal>DATADIR</literal> prior to MySQL version 5.0.3.)
</para>
<para>
@@ -712,9 +820,8 @@
<para>
Comment lines start with '<literal>#</literal>' or
- '<literal>;</literal>'. As of MySQL 4.0.14, a
- '<literal>#</literal>'-comment can start in the middle of a line as
- well.
+ '<literal>;</literal>'. A '<literal>#</literal>' comment can start
+ in the middle of a line as well.
</para></listitem>
<listitem><para>
@@ -748,11 +855,15 @@
<literal>--<replaceable>opt_name</replaceable>=<replaceable>value</replaceable></literal>
on the command line. In an option file, you can have spaces around
the '<literal>=</literal>' character, something that is not true on
- the command line. As of MySQL 4.0.16, you can quote the value with
- double quotes or single quotes. This is useful if the value
- contains a '<literal>#</literal>' comment character or whitespace.
+ the command line. In MySQL 5.0, you can quote the value with single
+ quotes or double quotes. This is useful if the value contains a
+ '<literal>#</literal>' comment character or whitespace.
</para></listitem>
-
+<!--
+ NOTE: Commented out. Probably should just be dropped?
+ /JS 2005-07-18
+-->
+<!--
<listitem><para>
<literal>set-variable =
<replaceable>var_name</replaceable>=<replaceable>value</replaceable></literal>
@@ -761,14 +872,14 @@
<para>
Set the program variable <replaceable>var_name</replaceable> to the
given value. This is equivalent to
- <literal>--set-variable=<replaceable>var_name</replaceable>=<replaceable>value</replaceable></literal>
+ <literal>- -set-variable=<replaceable>var_name</replaceable>=<replaceable>value</replaceable></literal>
on the command line. Spaces are allowed around the first
'<literal>=</literal>' character but not around the second. This
syntax is deprecated as of MySQL 4.0. See
<xref linkend="program-variables"/> for more information on setting
program variables.
</para></listitem>
-
+-->
</itemizedlist>
<para>
@@ -797,24 +908,24 @@
<para>
The <literal>[client]</literal> option group is read by all client
- programs (but not by <command>mysqld</command>). This allows you to
- specify options that apply to every client. For example,
- <literal>[client]</literal> is the perfect group to use to specify
- the password that you use to connect to the server. (But make sure
- that the option file is readable and writable only by yourself, so
- that other people cannot find out your password.) Be sure not to put
- an option in the <literal>[client]</literal> group unless it is
- recognized by <emphasis>all</emphasis> client programs that you use.
- Programs that do not understand the option quit after displaying an
- error message if you try to run them.
+ programs (but <emphasis role="bold">not</emphasis> by
+ <command>mysqld</command>). This allows you to specify options that
+ apply to all clients. For example, <literal>[client]</literal> is
+ the perfect group to use to specify the password that you use to
+ connect to the server. (But make sure that the option file is
+ readable and writable only by yourself, so that other people cannot
+ find out your password.) Be sure not to put an option in the
+ <literal>[client]</literal> group unless it is recognized by
+ <emphasis>all</emphasis> client programs that you use. Programs that
+ do not understand the option quit after displaying an error message
+ if you try to run them.
</para>
<para>
- Beginning with MySQL 4.1.11 in the 4.1 series and MySQL 5.0.4 in the
- 5.0 series, it is possible to use <literal>!include</literal>
- directives in option files to include specific files and
- <literal>!includedir</literal> to search specific directories for
- option files. For example, to include the file
+ Beginning MySQL 5.0.4 in the 5.0 series, it is possible to use
+ <literal>!include</literal> directives in option files to include
+ specific files and <literal>!includedir</literal> to search specific
+ directories for option files. For example, to include the file
<filename>/home/mydir/myopt.cnf</filename>, you can use the
following:
</para>
@@ -872,17 +983,18 @@
</para>
<para>
- As of MySQL 4.0.14, if you want to create option groups that should
- be read only by one specific <command>mysqld</command> server
- release series, you can do this by using groups with names of
- <literal>[mysqld-4.0]</literal>, <literal>[mysqld-4.1]</literal>,
+ With MySQL 4.0.14 and later versions of MySQL, if you want to
+ create option groups that should be read by one specific
+ <command>mysqld</command> server release series only, you can do
+ this by using groups with names of <literal>[mysqld-4.0]</literal>,
+ <literal>[mysqld-4.1]</literal>, <literal>[mysqld-5.0]</literal>,
and so forth. The following group indicates that the
<literal>--new</literal> option should be used only by MySQL servers
- with 4.0.x version numbers:
+ with 5.0.x version numbers:
</para>
<programlisting>
-[mysqld-4.0]
+[mysqld-5.0]
new
</programlisting>
@@ -909,9 +1021,7 @@
The preceding option file uses
<literal><replaceable>var_name</replaceable>=<replaceable>value</replaceable></literal>
syntax for the lines that set the <literal>key_buffer_size</literal>
- and <literal>max_allowed_packet</literal> variables. Prior to MySQL
- 4.0.2, you would need to use <literal>set-variable</literal> syntax
- instead (described earlier in this section).
+ and <literal>max_allowed_packet</literal> variables.
</para>
<para>
@@ -925,20 +1035,13 @@
[mysql]
no-auto-rehash
-set-variable = connect_timeout=2
+connect_timeout=2
[mysqlhotcopy]
interactive-timeout
</programlisting>
- <para>
- This option file uses <literal>set-variable</literal> syntax to set
- the <literal>connect_timeout</literal> variable. For MySQL 4.0.2 and
- up, you can also set the variable using just
- <literal>connect_timeout=2</literal>.
- </para>
-
<indexterm type="type">
<primary>.my.cnf file</primary>
</indexterm>
@@ -948,14 +1051,14 @@
named <filename>my-<replaceable>xxxx</replaceable>.cnf</filename> in
the <filename>support-files</filename> directory. If you have a
binary distribution, look in the <filename>support-files</filename>
- directory under your MySQL installation directory (typically
- <filename>C:\mysql</filename> on Windows or
- <filename>/usr/local/mysql</filename> on Unix). On Windows the
+ directory under your MySQL installation directory. On Windows the
sample option files may also be located in the MySQL installation
- directory. Currently there are sample option files for small,
- medium, large, and very large systems. To experiment with one of
- these files, copy it to <filename>C:\my.cnf</filename> on Windows or
- to <filename>.my.cnf</filename> in your home directory on Unix.
+ directory (see earlier in this section or
+ <xref linkend="installing"/> if you do not know where this is).
+ Currently there are sample option files for small, medium, large,
+ and very large systems. To experiment with one of these files, copy
+ it to <filename>C:\my.cnf</filename> on Windows or to
+ <filename>.my.cnf</filename> in your home directory on Unix.
</para>
<para>
@@ -1037,15 +1140,15 @@
</programlisting>
<para>
- Note for developers: Option file handling is implemented in the C
- client library simply by processing all matching options (that is,
- options in the appropriate group) before any command-line arguments.
- This works nicely for programs that use the last instance of an
- option that is specified multiple times. If you have a C or C++
- program that handles multiply specified options this way but doesn't
- read option files, you need add only two lines to give it that
- capability. Check the source code of any of the standard MySQL
- clients to see how to do this.
+ <emphasis>Note for developers</emphasis>: Option file handling is
+ implemented in the C client library simply by processing all
+ matching options (that is, options in the appropriate group) before
+ any command-line arguments. This works nicely for programs that use
+ the last instance of an option that is specified multiple times. If
+ you have a C or C++ program that handles multiply specified options
+ this way but does not read option files, you need add only two lines
+ to give it that capability. Check the source code of any of the
+ standard MySQL clients to see how to do this.
</para>
<para>
@@ -1082,7 +1185,7 @@
specify the TCP/IP port number using the
<literal>MYSQL_TCP_PORT</literal> variable. Typical syntax (such as
for <command>sh</command>, <literal>bash</literal>,
- <command>zsh</command>, etc.) is as follows:
+ <command>zsh</command>, and so on) is as follows:
</para>
<programlisting>
@@ -1140,11 +1243,13 @@
<primary>setting program variables</primary>
</indexterm>
-<!-- TODO: check whether program variables can be set by unique prefix. -->
+<!--
+ TODO: check whether program variables can be set by unique prefix.
+-->
<para>
Many MySQL programs have internal variables that can be set at
- runtime. As of MySQL 4.0.2, program variables are set the same way
+ runtime. In MySQL 5.0, program variables are set the same way
as any other long option that takes a value. For example,
<command>mysql</command> has a <literal>max_allowed_packet</literal>
variable that controls the maximum size of its communication buffer.
@@ -1191,43 +1296,9 @@
</para>
<para>
- Prior to MySQL 4.0.2, program variable names are not recognized as
- option names. Instead, use the <literal>--set-variable</literal>
- option to assign a value to a variable:
- </para>
-
-<programlisting>
-shell> mysql --set-variable=max_allowed_packet=16777216
-shell> mysql --set-variable=max_allowed_packet=16M
-</programlisting>
-
- <para>
- In an option file, omit the leading dashes:
- </para>
-
-<programlisting>
-[mysql]
-set-variable = max_allowed_packet=16777216
-</programlisting>
-
- <para>
- Or:
- </para>
-
-<programlisting>
-[mysql]
-set-variable = max_allowed_packet=16M
-</programlisting>
-
- <para>
- With <literal>--set-variable</literal>, underscores in variable
- names cannot be given as dashes for versions of MySQL older than
- 4.0.2.
- </para>
-
- <para>
- The <literal>--set-variable</literal> option is still recognized in
- MySQL 4.0.2 and up, but is deprecated.
+ <emphasis role="bold">Note</emphasis>: The older syntax
+ <literal>--set-variable = <replaceable>option</replaceable>=<replaceable>value</replaceable></literal>
+ is still recognized in MySQL 5.0, but is now deprecated.
</para>
<para>
--- 1.6/refman-5.0/Status 2005-07-18 19:02:58 +10:00
+++ 1.7/refman-5.0/Status 2005-07-19 01:30:20 +10:00
@@ -13,9 +13,9 @@
replication
environment-variables
installing
+ using-mysql-programs
- 5.0 chapters awaiting edits:
- using-mysql-programs
optimization
innodb
ndbcluster
| Thread |
|---|
| • bk commit - mysqldoc@docsrva tree (jon:1.3050) | jon | 18 Jul |
