| List: | Commits | « Previous MessageNext Message » | |
| From: | plavin | Date: | May 17 2007 11:42pm |
| Subject: | svn commit - mysqldoc@docsrva: r6517 - trunk/userguide | ||
| View as plain text | |||
Author: plavin Date: 2007-05-17 23:42:47 +0200 (Thu, 17 May 2007) New Revision: 6517 Log: Minor changes, reformat Modified: trunk/userguide/Makefile.depends trunk/userguide/mysql-client-programs.xml trunk/userguide/newuserguide.xml Modified: trunk/userguide/Makefile.depends =================================================================== --- trunk/userguide/Makefile.depends 2007-05-17 17:46:20 UTC (rev 6516) +++ trunk/userguide/Makefile.depends 2007-05-17 21:42:47 UTC (rev 6517) Changed blocks: 1, Lines Added: 2, Lines Deleted: 2; 601 bytes @@ -99,8 +99,8 @@ indexing_SOURCES = indexing.xml $(indexing_INCLUDES) indexing_IDMAPS = \ metadata/glossary.idmap \ - metadata/storage-engines.idmap \ - metadata/logfiles.idmap + metadata/logfiles.idmap \ + metadata/storage-engines.idmap indexing.validpure: $(indexing_SOURCES) indexing.titles: $(indexing_SOURCES) indexing.useless: $(indexing_SOURCES) Modified: trunk/userguide/mysql-client-programs.xml =================================================================== --- trunk/userguide/mysql-client-programs.xml 2007-05-17 17:46:20 UTC (rev 6516) +++ trunk/userguide/mysql-client-programs.xml 2007-05-17 21:42:47 UTC (rev 6517) Changed blocks: 5, Lines Added: 481, Lines Deleted: 477; 43108 bytes @@ -6,569 +6,575 @@ %all.entities; ]> <chapter id="mysql-client-programs"> - -<title>MySQL Client Programs</title> - - <para> - a number of client programs - </para> - - <para> - The <command>mysql</command> program is usually referred to - as the MySQL client - </para> - - <section> - <title>The MySQL Client</title> - <para> - To interact with a database server you need a client program. The - most useful client for interacting with a MySQL server is - <command>mysql</command>, the command-line, client program. Use - <command>mysql</command> to: + <title>MySQL Client Programs</title> - <itemizedlist> + <section id="mysql-client"> - <listitem> - <para> - create a database or database objects - </para> - </listitem> + <title>The MySQL Client</title> - <listitem> - <para> - query a database - </para> - </listitem> + <para> + A number of client programs are packaged with the MySQL RDMS. + There are administrative programs, utilities to assist in backing + up data, utilities for repairing tables, and numerous other tools. + The most important of these client tools is the + <command>mysql</command> program, usually referred to as the MySQL + client. This is a command-line program for interacting with a MySQL + server. Use <command>mysql</command> to: - <listitem> - <para> - perform administration tasks - </para> - </listitem> + <itemizedlist> - </itemizedlist> - </para> + <listitem> + <para> + create a database or database objects + </para> + </listitem> - <para> - Most often databases are integrated into applications and most of - the interaction with the database server happens through the - program's user interface. However, this is usually not a convenient - way to create databases or database objects. Nor is it a convenient - way of creating users or changing their privileges. Likewise, it is - often helpful to test any SQL statements that are issued by a - program. A convenient way to perform all these tasks is to use the - MySQL client. - </para> + <listitem> + <para> + query a database + </para> + </listitem> - <para> - However, we won't be discussing SQL commands here. The purpose of - this section is to explain the options and commands most commonly - used with the MySQL client. Using these options and commands is an - essential part of mastering MySQL. - </para> + <listitem> + <para> + perform administration tasks + </para> + </listitem> - <para> - Options passed to the <command>mysql</command> command make - connecting to a MySQL server possible and also change the way that - the <command>mysql</command> client program behaves. Some of these - options are absolutely essential, some are nice to know, and others - are used infrequently. We will deal with the essential and - nice-to-know options. - </para> + </itemizedlist> + </para> -<!-- start essential options --> + <para> + Most often databases are integrated into applications and most of + the interaction with the database server happens through the + program's user interface. However, this is usually not a + convenient way to create databases or database objects. Nor is it + a convenient way of creating users or changing their privileges. + Likewise, it is often helpful to test any SQL statements that are + issued by a program. An easy way to perform all these tasks is to + use the MySQL client. - <section id="mysql-client-essential-options"> + <remark> + GUI vs command line? Mention here? + </remark> + </para> - <title>Essential Options</title> + <para> + However, we won't be discussing SQL commands here. The purpose of + this section is to explain the options and commands most commonly + used with the MySQL client. Using these options and commands is an + essential part of mastering MySQL. + </para> <para> - The essential options are as follows: + Options passed to the <command>mysql</command> command make + connecting to a MySQL server possible and also change the way that + the <command>mysql</command> client program behaves. Some of these + options are absolutely essential, some are nice to know, and + others are used infrequently. We will deal with the essential and + nice-to-know options. </para> - <itemizedlist> +<!-- start essential options --> - <listitem> - <para> - <option>--host=<replaceable>hostname</replaceable>, -h - <replaceable>hostname</replaceable> </option> – the host - to connect to - </para> - </listitem> + <section id="mysql-client-essential-options"> - <listitem> - <para> - <option>--password=<replaceable>[user_password]</replaceable>, - -p<replaceable>[user_password]</replaceable></option> – - password for connecting to the server - </para> - </listitem> + <title>Essential Options</title> - <listitem> - <para> - <option>--port=<replaceable>port_number</replaceable>, -P - <replaceable>port_number</replaceable></option> – the - TCP/IP port number - </para> - </listitem> + <para> + The essential options are as follows: + </para> - <listitem> + <itemizedlist> + + <listitem> + <para> + <option>--host=<replaceable>hostname</replaceable>, -h + <replaceable>hostname</replaceable> </option> – the + host to connect to + </para> + </listitem> + + <listitem> + <para> + <option>--password=<replaceable>[user_password]</replaceable>, + -p<replaceable>[user_password]</replaceable></option> + – password for connecting to the server + </para> + </listitem> + + <listitem> + <para> + <option>--port=<replaceable>port_number</replaceable>, -P + <replaceable>port_number</replaceable></option> – the + TCP/IP port number + </para> + </listitem> + + <listitem> + <para> + <option>--user=<replaceable>user_name</replaceable>, -u + <replaceable>user_name</replaceable></option> – the + MySQL username to use when connecting to the server + </para> + </listitem> + + </itemizedlist> + + <note> <para> - <option>--user=<replaceable>user_name</replaceable>, -u - <replaceable>user_name</replaceable></option> – the - MySQL username to use when connecting to the server + The commonly used options of any MySQL program typically have + a long and a short form. The long form is always a full word + preceded by two dashes and followed by an equals sign and a + value, if a value is required. The short form is a single + letter, upper or lower case, preceded by one dash and followed + by a space and a value if necessary. (The short form of the + password option is the only exception to this rule and will be + dealt with shortly.) When an option is first introduced, using + the long form is helpful for reasons of clarity. Afterwards, + the short form is preferred for the sake of brevity. </para> - </listitem> + </note> - </itemizedlist> + <para> + A MySQL server runs on a specific host and listens on a specific + port. The MySQL client connects to the server using TCP/IP and + for this reason you must provide <option>--host</option> and + <option>--port</option> options. + </para> - <note> <para> - The commonly used options of any MySQL program typically have a - long and a short form. The long form is always a full word - preceded by two dashes and followed by an equals sign and a - value, if a value is required. The short form is a single - letter, upper or lower case, preceded by one dash and followed - by a space and a value if necessary. (The short form of the - password option is the only exception to this rule and will be - dealt with shortly.) When an option is first introduced, using - the long form is helpful for reasons of clarity. Afterwards, the - short form is preferred for the sake of brevity. + Since the <command>mysql</command> client program gives access + to a specific MySQL server, you must have credentials on that + server; you must provide values for the <option>--user</option> + and <option>--password</option> options. </para> - </note> - <para> - A MySQL server runs on a specific host and listens on a specific - port. The MySQL client connects to the server using TCP/IP and for - this reason you must provide <option>--host</option> and - <option>--port</option> options. - </para> + <para> + Any of the utilities that require a connection to the MySQL + server, will have <option>host, port, user</option>, and + <option>password</option> options. The syntax for using these + options is the same for all the various MySQL programs so you + must master use of these options. + </para> - <para> - Since the <command>mysql</command> client program gives access to - a specific MySQL server, you must have credentials on that server; - you must provide values for the <option>--user</option> and - <option>--password</option> options. - </para> + <para> + To open a <command>mysql</command> console window and + communicate with a MySQL server, type the following: + </para> - <para> - Any of the utilities that require a connection to the MySQL - server, will have <option>host, port, user</option>, and - <option>password</option> options. The syntax for using these - options is the same for all the various MySQL programs so you must - master use of these options. - </para> - - <para> - To open a <command>mysql</command> console window and communicate - with a MySQL server, type the following: - </para> - <programlisting> shell> <userinput>mysql <option>--user=<replaceable>user_name</replaceable> --password=<replaceable>user_password</replaceable> --host=<replaceable>localhost</replaceable> --port=<replaceable>3306</replaceable></option></userinput> </programlisting> - <note> + <note> + <para> + If you have only just installed MySQL and have not yet defined + any MySQL users then specify the default, + <literal>root</literal>, as the user name. There is no + password for this default user. For information on creating + additional users see <xref>. + </para> + </note> + <para> - If you have only just installed MySQL and have not yet defined - any MySQL users then specify the default, - <literal>root</literal>, as the user name. There is no password - for this default user. For information on creating additional - users see <xref>. + The same effect can be achieved using the short forms of the + above options. Starting <command>mysql</command> using short + forms is done as follows: </para> - </note> - <para> - The same effect can be achieved using the short forms of the above - options. Starting <command>mysql</command> using short forms is - done as follows: - </para> - <programlisting> shell> <userinput>mysql <option>-u <replaceable>user_name</replaceable> -p<replaceable>user_password</replaceable> -h<replaceable> localhost</replaceable> -P <replaceable>3306</replaceable></option></userinput> </programlisting> - <para> - Specifying a password immediately after the <option>-p</option> - option is not a requirement but if you do so no space is permitted - between the option <option>-p</option> and the password. Omitting - the password value following the password option is considered - more secure. If you do this, you are prompted for a password and - asterisks replace any letters typed. - </para> + <para> + Specifying a password immediately after the <option>-p</option> + option is not a requirement but if you do so no space is + permitted between the option <option>-p</option> and the + password. Omitting the password value following the password + option is considered more secure. If you do this, you are + prompted for a password and asterisks replace any letters typed. + </para> - <para> - Fortunately, both the <option>host</option> and - <option>port</option> options have default values so you need not - supply them every time you connect to a MySQL server. The default - value for the port is <literal>3306</literal>, and for the host, - <literal>localhost</literal>. Most MySQL servers listen on port - <literal>3306</literal> and typically you will connect to a server - running on the same machine as the MySQL client. - </para> + <para> + Fortunately, both the <option>host</option> and + <option>port</option> options have default values so you need + not supply them every time you connect to a MySQL server. The + default value for the port is <literal>3306</literal>, and for + the host, <literal>localhost</literal>. Most MySQL servers + listen on port <literal>3306</literal> and typically you will + connect to a server running on the same machine as the MySQL + client. + </para> - <para> - If the server you wish to connect to is running on port - <literal>3306</literal> on the same machine as the MySQL client - then you need not specify either the port or the hostname. The - <command>mysql</command> program will also check for the - environment variable <literal>USER</literal>, if no user name is - provided at the command line. To check the value of this variable - under Windows go to the command line and type: - </para> + <para> + If the server you wish to connect to is running on port + <literal>3306</literal> on the same machine as the MySQL client + then you need not specify either the port or the hostname. The + <command>mysql</command> program will also check for the + environment variable <literal>USER</literal>, if no user name is + provided at the command line. To check the value of this + variable under Windows go to the command line and type: + </para> <programlisting> shell> <userinput>echo %USER%</userinput> </programlisting> - <para> - Under Linux or Mac OS X type: - </para> + <para> + Under Linux or Mac OS X type: + </para> <programlisting> shell> <userinput>echo $USER</userinput> </programlisting> - <warning> + <warning> + <para> + On any operating system (OS) the value of the variable + <literal>USER</literal> is typically the name of the current + user — there is no requirement that there also be a + MySQL user with the same name, though this may often in fact + be the case. + </para> + </warning> + <para> - On any operating system (OS) the value of the variable - <literal>user</literal> is typically the name of the current - user — there is no requirement that there also be a MySQL - user with the same name, though this may often in fact be the - case. + If this user name is a valid user name for the MySQL server then + you need not specify the <option>--user</option> option in order + to connect. Connecting to a MySQL server can be as simple as: </para> - </warning> - <para> - If this user name is a valid user name for the MySQL server then - you need not specify the <option>--user</option> option in order - to connect. Connecting to a MySQL server can be as simple as: - </para> - <programlisting> shell> <userinput>mysql <option>-p</option></userinput> </programlisting> - <para> - With the use of a configuration file, even this option need not be - specified at the command line. If you typically start up - <command>mysql</command> using a number of options, then storing - these options in a configuration file is a good way to simplify - things. Configuration files are discussed in detail in - <xref>. + <para> + With the use of a configuration file, even this option need not + be specified at the command line. If you typically start up + <command>mysql</command> using a number of options, then storing + these options in a configuration file is a good way to simplify + things. Configuration files are discussed in detail in + <xref>. - <remark> - no longer use these options from this point on? - </remark> - </para> + <remark> + no longer use these options from this point on? + </remark> + </para> - </section> + </section> - <section id="mysql-client-other-options"> + <section id="mysql-client-other-options"> - <title>Other Options</title> + <title>Other Options</title> - <para> - The following list of options are useful to know and can - appreciably improve your efficiency when using - <command>mysql</command>. + <para> + The following list of options are useful to know and can + appreciably improve your efficiency when using + <command>mysql</command>. - <itemizedlist> + <itemizedlist> - <listitem> - <para> - <option>--help, -?</option> – show the available - options and their default values and close the MySQL client - </para> - </listitem> + <listitem> + <para> + <option>--help, -?</option> – show the available + options and their default values and close the MySQL + client + </para> + </listitem> - <listitem> - <para> - <option>--auto-rehash</option> – enable table name and - column name completion - </para> - </listitem> + <listitem> + <para> + <option>--auto-rehash</option> – enable table name + and column name completion + </para> + </listitem> - <listitem> - <para> - <option>--database-name=<replaceable>db_name</replaceable>, - -D <replaceable>db_name</replaceable>, - <replaceable>db_name</replaceable></option> – the - database to use on start up - </para> - </listitem> + <listitem> + <para> + <option>--database-name=<replaceable>db_name</replaceable>, + -D <replaceable>db_name</replaceable>, + <replaceable>db_name</replaceable></option> – the + database to use on start up + </para> + </listitem> - <listitem> - <para> - <option>--execute=<replaceable>statement</replaceable>, -e - <replaceable>statement</replaceable></option> – - execute the specified statement and close the MySQL client - </para> - </listitem> + <listitem> + <para> + <option>--execute=<replaceable>statement</replaceable>, -e + <replaceable>statement</replaceable></option> – + execute the specified statement and close the MySQL client + </para> + </listitem> - <listitem> - <para> - <option>--html, -H</option> – output in HTML format - </para> - </listitem> + <listitem> + <para> + <option>--html, -H</option> – output in HTML format + </para> + </listitem> - <listitem> - <para> - <option>--no-tee</option> – do not copy output to file - </para> - </listitem> + <listitem> + <para> + <option>--no-tee</option> – do not copy output to + file + </para> + </listitem> - <listitem> - <para> - <option>--prompt=<replaceable>opt_string</replaceable></option> - – configure the prompt - </para> - </listitem> + <listitem> + <para> + <option>--prompt=<replaceable>opt_string</replaceable></option> + – configure the prompt + </para> + </listitem> - <listitem> - <para> - <option>--tee=<replaceable>outfile</replaceable>, -T - <replaceable>outfile</replaceable></option> – copy - output to the specified file - </para> - </listitem> + <listitem> + <para> + <option>--tee=<replaceable>outfile</replaceable>, -T + <replaceable>outfile</replaceable></option> – copy + output to the specified file + </para> + </listitem> - <listitem> - <para> - <option>--xml, -X</option> – output in XML format - </para> - </listitem> + <listitem> + <para> + <option>--xml, -X</option> – output in XML format + </para> + </listitem> - </itemizedlist> - </para> + </itemizedlist> + </para> - <para> - The <option>--help</option> option is especially useful should you - forget what options are available. Execute the - <command>mysql</command> command with this option in order to - display all available options and their default values. The - interactive MySQL shell does not open when you use this option. - Most of the MySQL programs have <option>--help</option> as an - option. - </para> + <para> + The <option>--help</option> option is especially useful should + you forget what options are available. Execute the + <command>mysql</command> command with this option in order to + display all available options and their default values. The + interactive MySQL shell does not open when you use this option. + Most of the MySQL programs have <option>--help</option> as an + option. + </para> - <para> - The <option>--auto-rehash</option> option is on by default. It - enables automatic completion of table and column names, in the way - that most Unix command shells complete file names. Unfortunately, - this option only works on Unix operating systems. For performance - purposes you can turn this option off by specifying - <option>--skip-auto-rehash</option>. - </para> + <para> + The <option>--auto-rehash</option> option is on by default. It + enables automatic completion of table and column names, in the + way that most Unix command shells complete file names. + Unfortunately, this option only works on Unix operating systems. + For performance purposes you can turn this option off by + specifying <option>--skip-auto-rehash</option>. + </para> - <para> - If you wish to start the MySQL client using a specific database, - use the - <option>--database=<replaceable>dbname</replaceable></option> - option. In addition to using the short form, <option>-D - <replaceable>dbname</replaceable></option>, you can also start the - MySQL client using a specific database simply by specifying the - database name at the command line. This option is equivalent to - opening the MySQL client and then issuing a <command>use - <replaceable>dbname</replaceable></command> command. - </para> + <para> + If you wish to start the MySQL client using a specific database, + use the + <option>--database=<replaceable>dbname</replaceable></option> + option. In addition to using the short form, <option>-D + <replaceable>dbname</replaceable></option>, you can also start + the MySQL client using a specific database simply by specifying + the database name at the command line. This option is equivalent + to opening the MySQL client and then issuing a <command>use + <replaceable>dbname</replaceable></command> command. + </para> - <para> - To execute a single SQL statement and then exit the client shell, - use the - <option>--execute=<replaceable>statement</replaceable></option> - option. For example, the following command shows all the records - in a specific table: - </para> + <para> + To execute a single SQL statement and then exit the client + shell, use the + <option>--execute=<replaceable>statement</replaceable></option> + option. For example, the following command shows all the records + in a specific table: + </para> <programlisting> shell> <command>mysql -u <option>user_name</option> -p --execute="SELECT * FROM <replaceable>dbname.table_name</replaceable>;"</command> </programlisting> - <para> - The ‘<literal>;</literal>’ terminating the - <literal>SELECT</literal> statement is optional. - </para> + <para> + The ‘<literal>;</literal>’ terminating the + <literal>SELECT</literal> statement is optional. + </para> - <para> - The <option>--html</option> and <option>--xml</option> options - format all output as HTML or XML. This can be especially useful - and time-saving if you need to dump the contents of a table in - HTML or XML format. To get maximum benefit from these options you - need to be familiar with the - <option>--tee=<replaceable>file_name</replaceable></option> option - — an option that copies all the output of - <command>mysql</command> to a text file. To create an HTML file of - all statements issue the following command: - </para> + <para> + The <option>--html</option> and <option>--xml</option> options + format all output as HTML or XML. This can be especially useful + and time-saving if you need to dump the contents of a table in + HTML or XML format. To get maximum benefit from these options + you need to be familiar with the + <option>--tee=<replaceable>file_name</replaceable></option> + option — an option that copies all the output of + <command>mysql</command> to a text file. To create an HTML file + of all statements issue the following command: + </para> <programlisting> shell> <userinput>mysql <option>-u <replaceable>user_name</replaceable> -p --tee=<replaceable>outfile.html</replaceable> --html</option></userinput> </programlisting> - <para> - <emphasis>Note</emphasis>: There is no short form for the - <option>--tee=<replaceable>file_name</replaceable></option> - option. - </para> + <para> + <emphasis>Note</emphasis>: There is no short form for the + <option>--tee=<replaceable>file_name</replaceable></option> + option. + </para> - <para> - The <option>--tee=<replaceable>file_name</replaceable></option> - option is also especially useful if you want to keep a record of - the SQL statements that you have issued. This is also an excellent - way to begin creating a script file. Script files are dealt with - in detail in <xref>. - </para> + <para> + The <option>--tee=<replaceable>file_name</replaceable></option> + option is also especially useful if you want to keep a record of + the SQL statements that you have issued. This is also an + excellent way to begin creating a script file. Script files are + dealt with in detail in <xref>. + </para> - <para> - The <option>--prompt</option> option allows you to customized the - prompt that the MySQL console displays. The prompt can be - configured in a variety of ways; to show the current date and - time, to display the default database, and the current server - version, for example. This topic will be dealt with in detail in - <xref>. - </para> + <para> + The <option>--prompt</option> option allows you to customized + the prompt that the MySQL console displays. The prompt can be + configured in a variety of ways; to show the current date and + time, to display the default database, and the current server + version, for example. This topic will be dealt with in detail in + <xref>. + </para> - <para> - As noted earlier, only selected <command>mysql</command> options - are discussed here. For a complete list see - <ulink url="&base-url-refman;5.0/en/mysql.html"/> or, at the - command line simply type <userinput>mysql -?</userinput>. - </para> + <para> + As noted earlier, only selected <command>mysql</command> options + are discussed here. For a complete list see + <ulink url="&base-url-refman;5.0/en/mysql.html"/> or, at the + command line simply type <userinput>mysql -?</userinput>. + </para> - </section> + </section> - <section id="mysql-client-commands"> + <section id="mysql-client-commands"> - <title>The <command>mysql</command> Commands</title> + <title>The <command>mysql</command> Commands</title> - <para> - The <command>mysql</command> client is interactive shell. Once you - have opened it you can use the <command>mysql</command> - commands. A shortlist of the most useful commands follows: - </para> + <para> + The <command>mysql</command> client is interactive shell. Once + you have opened it you can use the <command>mysql</command> + commands. A shortlist of the most useful commands follows: + </para> - <itemizedlist> + <itemizedlist> - <listitem> - <para> - <command>help <replaceable>[argument]</replaceable>, \? - <replaceable>[argument]</replaceable>, ? - <replaceable>[argument]</replaceable></command> – - display the available commands, provide assistance with SQL - </para> - </listitem> + <listitem> + <para> + <command>help <replaceable>[argument]</replaceable>, \? + <replaceable>[argument]</replaceable>, ? + <replaceable>[argument]</replaceable></command> – + display the available commands, provide assistance with SQL + </para> + </listitem> - <listitem> - <para> - <command>exit, quit, \q</command> – exit the MySQL shell - </para> - </listitem> + <listitem> + <para> + <command>exit, quit, \q</command> – exit the MySQL + shell + </para> + </listitem> - <listitem> - <para> - <command>notee, \t</command> – stop capturing output to - file - </para> - </listitem> + <listitem> + <para> + <command>notee, \t</command> – stop capturing output + to file + </para> + </listitem> - <listitem> - <para> - <command>source, \. - <replaceable>file_name</replaceable></command> – run a - script file - </para> - </listitem> + <listitem> + <para> + <command>source, \. + <replaceable>file_name</replaceable></command> – run a + script file + </para> + </listitem> - <listitem> - <para> - <command>tee <replaceable>file_name</replaceable>, \T - <replaceable>file_name</replaceable></command> – copy - output to the specified file - </para> - </listitem> + <listitem> + <para> + <command>tee <replaceable>file_name</replaceable>, \T + <replaceable>file_name</replaceable></command> – copy + output to the specified file + </para> + </listitem> - <listitem> - <para> - <command>use <replaceable>dbname</replaceable>, \u - <replaceable>dbname</replaceable></command> – - </para> - </listitem> + <listitem> + <para> + <command>use <replaceable>dbname</replaceable>, \u + <replaceable>dbname</replaceable></command> – + </para> + </listitem> - </itemizedlist> + </itemizedlist> - <para> - The long forms of commands can be issued by typing the command - name with or without a <literal>‘;’</literal>. For - example, the commands <command>help;</command> and - <command>help</command> produce the same output. - </para> + <para> + The long forms of commands can be issued by typing the command + name with or without a <literal>‘;’</literal>. For + example, the commands <command>help;</command> and + <command>help</command> produce the same output. + </para> - <para> - To quit the MySQL shell use one of the forms of the - <command>quit</command> command. - </para> + <para> + To quit the MySQL shell use one of the forms of the + <command>quit</command> command. + </para> - <para> - To execute a script file use the <command>source</command> - command. You can also execute script commands by redirecting a - file to the <command>mysql</command> command. This is done on all - operating systems by using the redirection operator like so; - <userinput>mysql -u <replaceable>user_name</replaceable> -p < - <replaceable>script.sql</replaceable></userinput>. Using script - files is especially useful when you have repetitive tasks to - perform. Script files are discussed in detail in <xref>. - </para> + <para> + To execute a script file use the <command>source</command> + command. You can also execute script commands by redirecting a + file to the <command>mysql</command> command. This is done on + all operating systems by using the redirection operator like so; + <userinput>mysql -u <replaceable>user_name</replaceable> -p < + <replaceable>script.sql</replaceable></userinput>. Using script + files is especially useful when you have repetitive tasks to + perform. Script files are discussed in detail in <xref>. + </para> - <para> - To avoid having to fully qualify a table name by preceding it with - the database name, use the <command>use - <replaceable>dbname</replaceable></command> command. This command - makes the specified database the default database. - </para> + <para> + To avoid having to fully qualify a table name by preceding it + with the database name, use the <command>use + <replaceable>dbname</replaceable></command> command. This + command makes the specified database the default database. + </para> - <para> - Some of the commands are identical to the options shown in - <xref linkend="mysql-client-other-options"/>. For example issuing - the <command>tee <replaceable>outfile.txt</replaceable></command> - command is identical to using the start-up option <option>--tee - <replaceable>outfile.txt</replaceable></option>. Being able to - redirect output to a file after starting up the MySQL client can - be very convenient when you only want to capture some and not all - output to file. When you no longer wish to capture output, issue - the <command>no-tee</command> command. - </para> + <para> + Some of the commands are identical to the options shown in + <xref linkend="mysql-client-other-options"/>. For example + issuing the <command>tee + <replaceable>outfile.txt</replaceable></command> command is + identical to using the start-up option <option>--tee + <replaceable>outfile.txt</replaceable></option>. Being able to + redirect output to a file after starting up the MySQL client can + be very convenient when you only want to capture some and not + all output to file. When you no longer wish to capture output, + issue the <command>no-tee</command> command. + </para> - <para> - On the other hand, the <command>help</command> command, though it - shares the same name as the <option>--help</option> option, when - issued without an argument, outputs a list of all the commands but - no options. For a complete list of all the available commands see - <ulink url="&base-url-refman;5.0/en/mysql-commands.html"/>, or - from the <command>mysql</command> shell, issue the command - <userinput>?</userinput>. - </para> + <para> + On the other hand, the <command>help</command> command, though + it shares the same name as the <option>--help</option> option, + when issued without an argument, outputs a list of all the + commands but no options. For a complete list of all the + available commands see + <ulink url="&base-url-refman;5.0/en/mysql-commands.html"/>, or + from the <command>mysql</command> shell, issue the command + <userinput>?</userinput>. + </para> - <para> - However, the <command>help</command> command does a lot more than - list available commands. For this reason the next section is - devoted entirely to this command. - </para> + <para> + However, the <command>help</command> command does a lot more + than list available commands. For this reason the next section + is devoted entirely to this command. + </para> - </section> + </section> + <section id="mysql-client-help-command"> - + <title>Using the <command>help</command> Command</title> - + <para> It is very easy to overlook the usefulness of the <command>help</command> command. Firstly, it is easily confused with the <option>--help</option> <emphasis>option</emphasis>. - Secondly, you may mistakenly believe that it only displays a list - of the <command>mysql</command> commands. + Secondly, you may mistakenly believe that it only displays a + list of the <command>mysql</command> commands. </para> - + <para> To see just how helpful this command can be, from the <command>mysql</command> shell, issue the command @@ -576,7 +582,7 @@ <literal>contents</literal>. Doing this results in the following display: </para> - + <programlisting> You asked for help about help category: "Contents" For more information, type 'help <item>', where <item> is one of the following @@ -596,52 +602,50 @@ Transactions Triggers </programlisting> - + <para> - Now try issuing the <userinput>? FUNCTIONS</userinput> command. + Now try issuing the <userinput>? Functions</userinput> command. You should see a listing of all the function categories. To see - the date and time functions type <userinput>? DATE AND TIME - FUNCTIONS</userinput>. This displays the names of all functions in - this category + the date and time functions type <userinput>? Date and Time + Functions</userinput>. This displays the names of all functions + in this category. </para> - + <para> To drill down even further, specify a function name in the - following way; <userinput>? DATE_FORMAT</userinput>. Issuing this - command displays the function prototype and gives examples of how - this function is used. This is very useful given the many and - various format specifiers that can be used with this function. + following way; <userinput>? DATE_FORMAT</userinput>. Issuing + this command displays the function prototype and gives examples + of how this function is used. This is very useful given the many + and various format specifiers that can be used with this + function. </para> - + <para> - The proper operation of this statement requires that the help - tables in the mysql database be initialized with help topic - information. This help information is stored in the - <literal>help_* </literal>tables in the <literal>mysql</literal> - database. Most recent binary releases come with these tables If - you find that these tables are missing, go to - <ulink url="&base-url-docs;"/> and locate the <literal>MySQL Help - Tables</literal> section. Find the help file for the MySQL server - version 5.0 and download it. Decompress it and install it in the - following way: + The <command>help <replaceable>topic</replaceable></command> + command only works if the <literal>help_*</literal> tables in + have been installed in the <literal>mysql</literal> database. Most + recent binary releases come with these tables installed but if + you find that they are missing, go to + <ulink url="&base-url-docs;"/> and locate the <literal>MySQL + Help Tables</literal> section. Find the help file for the MySQL + server version 5.0 and download it. Decompress it and install it + in the following way: </para> - + <programlisting> shell> <userinput>mysql <option>-u root -p</option> mysql < <replaceable>file_name</replaceable></userinput> </programlisting> - + <para> - The <command>help</command> command is especially useful if you are new to - MySQL but even experienced users will find it helpful on many - occasions. + The <command>help</command> command is especially useful if you + are new to MySQL but even experienced users will find it helpful + on many occasions. </para> - + </section> - + </section> - - <!-- start mysqladmin --> <section id="user-guide-mysqladmin"> @@ -742,8 +746,8 @@ <para> Essential commands are shown above; the essential - <command>mysqladmin</command> <emphasis>options</emphasis> - are as follows: + <command>mysqladmin</command> <emphasis>options</emphasis> are + as follows: <itemizedlist> @@ -1644,4 +1648,4 @@ <!-- end mysqldump section --> </chapter> -<!-- END mysql client ptogrammes CHAPTER --> +<!-- END mysql client programmes CHAPTER --> Modified: trunk/userguide/newuserguide.xml =================================================================== --- trunk/userguide/newuserguide.xml 2007-05-17 17:46:20 UTC (rev 6516) +++ trunk/userguide/newuserguide.xml 2007-05-17 21:42:47 UTC (rev 6517) Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 371 bytes @@ -1212,7 +1212,7 @@ <part label="VI"> - <title>Appendices</title> + <title>Appendixes</title> <appendix>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r6517 - trunk/userguide | plavin | 17 May |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 1.043 sec. using MySQL 5.1.14-beta-log