| List: | Commits | « Previous MessageNext Message » | |
| From: | paul | Date: | February 24 2006 3:53pm |
| Subject: | svn commit - mysqldoc@docsrva: r1438 - in trunk: . internals | ||
| View as plain text | |||
Author: paul Date: 2006-02-24 15:53:22 +0100 (Fri, 24 Feb 2006) New Revision: 1438 Log: r8123@frost: paul | 2006-02-24 08:53:05 -0600 Add mysqltest material. Modified: trunk/ trunk/internals/mysqltest.xml Property changes on: trunk ___________________________________________________________________ Name: svk:merge - b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:8120 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3548 + b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:8123 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3548 Modified: trunk/internals/mysqltest.xml =================================================================== --- trunk/internals/mysqltest.xml 2006-02-24 03:45:41 UTC (rev 1437) +++ trunk/internals/mysqltest.xml 2006-02-24 14:53:22 UTC (rev 1438) @@ -1,76 +1,195 @@ <?xml version="1.0" encoding="utf-8" standalone="no"?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ <!ENTITY % fixedchars.entities SYSTEM "fixedchars.ent"> %fixedchars.entities; <!ENTITY current-series "MySQL 5.1"> -<!ENTITY title-mysqltest-for-manpage "MySQL test program"> -<!ENTITY title-mysqltest-for-manual "MySQL Test Program"> +<!ENTITY title-mysqltest-for-manpage "program to run test cases"> +<!ENTITY title-mysqltest-for-manual "Program to Run Test Cases"> +<!ENTITY title-mysql-test-run-for-manpage "<command>mysqltest</command> driver program"> +<!ENTITY title-mysql-test-run-for-manual "<command>mysqltest</command> Driver Program"> ]> -<section id="fake-id-for-mysqltest-manpage-section-wrapper"> +<book lang="en"> - <title>fake title for mysqltest manpage section wrapper</title> + <title>The MySQL Test Platform</title> - <refentry id="mysqltest"> + <bookinfo> - <indexterm> - <primary><command>mysqltest</command></primary> - </indexterm> + <abstract> - <refmeta> - <refentrytitle>mysqltest</refentrytitle> - - <manvolnum>1</manvolnum> - <refmiscinfo class="manual">MySQL Database System</refmiscinfo> - <refmiscinfo class="source">MySQL</refmiscinfo> - <refmiscinfo class="version">¤t-series;</refmiscinfo> - <refmiscinfo class="refman">&title-mysqltest-for-manual;</refmiscinfo> - </refmeta> + <para> + This manual describes the MySQL test platform. + </para> - <refnamediv> - <refname>mysqltest</refname> - - <refpurpose>&title-mysqltest-for-manpage;</refpurpose> - </refnamediv> + <para> + Document generated on: - <refsynopsisdiv> - <cmdsynopsis> - <command>mysqltest [<replaceable>options</replaceable>] [<replaceable>db_name</replaceable>]</command> - </cmdsynopsis> - </refsynopsisdiv> +<?dbtimestamp format="Y-m-d"?> - <refsection id="mysqltest-description"> + <remark role="repository.revision"/> + </para> - <title>Description</title> + </abstract> - <para> - <command>mysqltest</command> runs a test case against a MySQL - server and compares the output with a result file. - </para> + </bookinfo> - <para> - Invoke <command>mysqltest</command> like this: - </para> + <preface id="preface"> + <title>Preface</title> + + <para> + This manual describes the MySQL test platform. It describes the + programs used to run tests and the language used to write test + cases. + </para> + + <para> + Copyright © 2006 MySQL AB + </para> + + </preface> + + <chapter id="introduction"> + + <title>Introduction</title> + + <para> + Note: <command>mysql-test-run</command> shell script is being + replaced by the <command>mysql-test-run.pl</command> Perl script. + Need to account for that in this document. + </para> + + <para> + MySQL distributions include a set of test files and programs for + running them. These tools provide a means for verifying that MySQL + Server and its client programs operate according to expectations. + </para> + + <para> + The programs are <command>mysqltest</command>, which runs a test + case, and <command>mysql-test-run</command>, which invokes + <command>mysqltest</command> once for each case. Input for each + test case is stored in a file, and the expected result from + running the test is stored in another file. The expected result + can be compared to the actual result from running a test to verify + program operation. + </para> + + <para> + For a MySQL source distribution, <command>mysqltest</command> is + located in the <filename>client</filename> directory. + <command>mysql-test-run</command> and the test input and result + files are located in the <filename>mysql-test</filename> + directory. Both <filename>client</filename> and + <filename>mysql-test</filename> are located in the root directory + of the distribution. + </para> + + <para> + For a MySQL binary distribution, <command>mysqltest</command> is + located in the same directory where other client programs such as + <command>mysql</command> or <command>mysqladmin</command> are + installed. <command>mysql-test-run</command> and the test input + and result files are located in the + <filename>mysql-test</filename> directory. The location of these + directories depends on the particular layout of the distribution + format. + </para> + + <para> + This manual describes how the test programs work, the language + used for writing test cases, and the layout of the + <filename>mysql-test</filename> directory. + </para> + + </chapter> + + <chapter id="test-programs"> + + <title>MySQL Test Programs</title> + + <remark> + Note: The sections here that describe each program are written + using refentry markup so that the content can be included in the + MySQL Reference Manual and used for generating Unix manpages more + easily. + </remark> + + <para> + This chapter describes the test programs that run test cases, + <command>mysqltest</command> and + <command>mysql-tesrt-run</command>. For information about the + language used for writing test cases, see + <xref linkend="mysqltest-language"/>. + </para> + + <section id="fake-id-for-mysqltest-manpage-section-wrapper"> + + <title>fake title for mysqltest manpage section wrapper</title> + + <refentry id="mysqltest"> + + <indexterm> + <primary><command>mysqltest</command></primary> + </indexterm> + + <refmeta> + <refentrytitle>mysqltest</refentrytitle> + + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">MySQL Database System</refmiscinfo> + <refmiscinfo class="source">MySQL</refmiscinfo> + <refmiscinfo class="version">¤t-series;</refmiscinfo> + <refmiscinfo class="refman">&title-mysqltest-for-manual;</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>mysqltest</refname> + + <refpurpose>&title-mysqltest-for-manpage;</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>mysqltest [<replaceable>options</replaceable>] [<replaceable>db_name</replaceable>]</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="mysqltest-description"> + + <title>Description</title> + + <para> + <command>mysqltest</command> runs a test case against a + MySQL server and compares the output with a result file. + </para> + + <para> + Invoke <command>mysqltest</command> like this: + </para> + <programlisting> shell> <userinput>mysqltest [<replaceable>options</replaceable>] [<replaceable>db_name</replaceable>] < <replaceable>test_file</replaceable></userinput> </programlisting> - </refsection> + </refsection> - <refsection id="mysqltest-options"> + <refsection id="mysqltest-options"> - <title>Options</title> + <title>Options</title> - <remark role="note"> - Also supports the standard SSL options. (And what else?) - </remark> + <remark role="note"> + Also supports the standard SSL options. (And what else?) + </remark> - <para> - Note: These need to be put in proper lexical order in - <filename>mysqltest.c</filename>. - </para> + <para> + The <command>mysqltest</command> program runs test cases. + This program reads input written in a special test language. + Typically, you invoke it via + <command>mysql-test-run</command> rather than invoking it + directly. + </para> <!-- THIS IS FOR MANPAGE IN REFMAN, NOT mysql manual itself <para> @@ -83,784 +202,899 @@ </para> --> - <para> - <command>mysqltest</command> supports the following options: - </para> + <para> + <command>mysqltest</command> supports the following options: + </para> - <itemizedlist> + <itemizedlist> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>help option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>help option</secondary> + </indexterm> - <indexterm> - <primary>help option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>help option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--help</option>, <option>-?</option> - </para> + <option>--help</option>, <option>-?</option> + </para> - <para> - Display a help message and exit. - </para> - </listitem> + <para> + Display a help message and exit. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>basedir option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>basedir option</secondary> + </indexterm> - <indexterm> - <primary>basedir option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>basedir option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--basedir=<replaceable>dir_name</replaceable></option>, - <option>-b <replaceable>dir_name</replaceable></option> - </para> + <option>--basedir=<replaceable>dir_name</replaceable></option>, + <option>-b <replaceable>dir_name</replaceable></option> + </para> - <para> - The base directory for tests. - </para> - </listitem> + <para> + The base directory for tests. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>big-test option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>big-test option</secondary> + </indexterm> - <indexterm> - <primary>big-test option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>big-test option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--big-test</option>, <option>-B</option> - </para> + <option>--big-test</option>, <option>-B</option> + </para> - <para> - Define <literal>BIG_TEST</literal> as 1. - </para> - </listitem> + <para> + Define <literal>BIG_TEST</literal> as 1. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>compress option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>compress option</secondary> + </indexterm> - <indexterm> - <primary>compress option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>compress option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--compress</option>, <option>-C</option> - </para> + <option>--compress</option>, <option>-C</option> + </para> - <para> - Compress all information sent between the client and the - server if both support compression. - </para> - </listitem> + <para> + Compress all information sent between the client and the + server if both support compression. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>database option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>database option</secondary> + </indexterm> - <indexterm> - <primary>database option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>database option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--database=<replaceable>db_name</replaceable></option>, - <option>-D <replaceable>db_name</replaceable></option> - </para> + <option>--database=<replaceable>db_name</replaceable></option>, + <option>-D <replaceable>db_name</replaceable></option> + </para> - <para> - The database to use. - </para> - </listitem> + <para> + The database to use. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>debug option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>debug option</secondary> + </indexterm> - <indexterm> - <primary>debug option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>debug option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--debug[=<replaceable>debug_options</replaceable>]</option>, - <option>-# - [<replaceable>debug_options</replaceable>]</option> - </para> + <option>--debug[=<replaceable>debug_options</replaceable>]</option>, + <option>-# + [<replaceable>debug_options</replaceable>]</option> + </para> - <para> - Write a debugging log. The - <replaceable>debug_options</replaceable> string often is - <literal>'d:t:o,<replaceable>file_name</replaceable>'</literal>. - </para> - </listitem> + <para> + Write a debugging log. The + <replaceable>debug_options</replaceable> string often is + <literal>'d:t:o,<replaceable>file_name</replaceable>'</literal>. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>host option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>host option</secondary> + </indexterm> - <indexterm> - <primary>host option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>host option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--host=<replaceable>host_name</replaceable></option>, - <option>-h <replaceable>host_name</replaceable></option> - </para> + <option>--host=<replaceable>host_name</replaceable></option>, + <option>-h <replaceable>host_name</replaceable></option> + </para> - <para> - Connect to the MySQL server on the given host. - </para> - </listitem> + <para> + Connect to the MySQL server on the given host. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>include option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>include option</secondary> + </indexterm> - <indexterm> - <primary>include option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>include option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--include=<replaceable>file_name</replaceable></option>, - <option>-i <replaceable>file_name</replaceable></option> - </para> + <option>--include=<replaceable>file_name</replaceable></option>, + <option>-i <replaceable>file_name</replaceable></option> + </para> - <para> - Include the contents of the given file before processing the - contents of the test file. The included file should have the - same format as other <command>mysqltest</command> test - files. This option has the same effect as putting a - <literal>--source - <replaceable>file_name</replaceable></literal> command as - the first line of the test file. This option was added in - MySQL 5.1.7. - </para> - </listitem> + <para> + Include the contents of the given file before processing + the contents of the test file. The included file should + have the same format as other + <command>mysqltest</command> test files. This option has + the same effect as putting a <literal>--source + <replaceable>file_name</replaceable></literal> command + as the first line of the test file. This option was + added in MySQL 5.1.7. + </para> + </listitem> - <listitem> - <remark role="todo"> - This and the next several options should be commented out - for the manpage in the reference manual. - </remark> + <listitem> + <remark role="todo"> + This and the next several options should be commented + out for the manpage in the reference manual. + </remark> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>manager-host option</secondary> - </indexterm> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>manager-host option</secondary> + </indexterm> - <indexterm> - <primary>manager-host option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>manager-host option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--manager-host=<replaceable>host_name</replaceable></option> - </para> + <option>--manager-host=<replaceable>host_name</replaceable></option> + </para> - <para> - Undocumented: Used for debugging. - </para> - </listitem> + <para> + Undocumented: Used for debugging. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>manager-password option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>manager-password option</secondary> + </indexterm> - <indexterm> - <primary>manager-password option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>manager-password option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--manager-password=<replaceable>password</replaceable></option> - </para> + <option>--manager-password=<replaceable>password</replaceable></option> + </para> - <para> - Undocumented: Used for debugging. - </para> - </listitem> + <para> + Undocumented: Used for debugging. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>manager-port option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>manager-port option</secondary> + </indexterm> - <indexterm> - <primary>manager-port option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>manager-port option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--manager-port=<replaceable>port_num</replaceable></option> - </para> + <option>--manager-port=<replaceable>port_num</replaceable></option> + </para> - <para> - Undocumented: Used for debugging. - </para> - </listitem> + <para> + Undocumented: Used for debugging. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>manager-user option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>manager-user option</secondary> + </indexterm> - <indexterm> - <primary>manager-user option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>manager-user option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--manager-user=<replaceable>user_name</replaceable></option> - </para> + <option>--manager-user=<replaceable>user_name</replaceable></option> + </para> - <para> - Undocumented: Used for debugging. - </para> - </listitem> + <para> + Undocumented: Used for debugging. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>no-defaults option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>no-defaults option</secondary> + </indexterm> - <indexterm> - <primary>no-defaults option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>no-defaults option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--no-defaults</option> - </para> + <option>--no-defaults</option> + </para> - <para> - Do not read default options from any option files. - </para> - </listitem> + <para> + Do not read default options from any option files. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>password option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>password option</secondary> + </indexterm> - <indexterm> - <primary>password option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>password option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--password[=<replaceable>password</replaceable>]</option>, - <option>-p[<replaceable>password</replaceable>]</option> - </para> + <option>--password[=<replaceable>password</replaceable>]</option>, + <option>-p[<replaceable>password</replaceable>]</option> + </para> - <para> - The password to use when connecting to the server. If you - use the short option form (<option>-p</option>), you - <emphasis>cannot</emphasis> have a space between the option - and the password. If you omit the - <replaceable>password</replaceable> value following the - <option>--password</option> or <option>-p</option> option on - the command line, you are prompted for one. - </para> - </listitem> + <para> + The password to use when connecting to the server. If + you use the short option form (<option>-p</option>), you + <emphasis>cannot</emphasis> have a space between the + option and the password. If you omit the + <replaceable>password</replaceable> value following the + <option>--password</option> or <option>-p</option> + option on the command line, you are prompted for one. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>port option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>port option</secondary> + </indexterm> - <indexterm> - <primary>port option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>port option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--port=<replaceable>port_num</replaceable></option>, - <option>-P <replaceable>port_num</replaceable></option> - </para> + <option>--port=<replaceable>port_num</replaceable></option>, + <option>-P <replaceable>port_num</replaceable></option> + </para> - <para> - The TCP/IP port number to use for the connection. - </para> - </listitem> + <para> + The TCP/IP port number to use for the connection. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>ps-protocol option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>ps-protocol option</secondary> + </indexterm> - <indexterm> - <primary>ps-protocol option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>ps-protocol option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--ps-protocol</option> - </para> + <option>--ps-protocol</option> + </para> - <para> - Use the prepared-statement protocol for communication. - </para> - </listitem> + <para> + Use the prepared-statement protocol for communication. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>quiet option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>quiet option</secondary> + </indexterm> - <indexterm> - <primary>quiet option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>quiet option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--quiet</option> - </para> + <option>--quiet</option> + </para> - <para> - Suppress all normal output. This is a synonym for + <para> + Suppress all normal output. This is a synonym for - <indexterm> - <primary>mysqltest</primary> - <secondary>silent option</secondary> - </indexterm> + <indexterm> + <primary>mysqltest</primary> + <secondary>silent option</secondary> + </indexterm> - <indexterm> - <primary>silent option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>silent option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--silent</option>. - </para> - </listitem> + <option>--silent</option>. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>record option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>record option</secondary> + </indexterm> - <indexterm> - <primary>record option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>record option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--record</option>, <option>-r</option> - </para> + <option>--record</option>, <option>-r</option> + </para> - <remark role="todo"> - What happens if no --result-file option is given? - </remark> + <remark role="todo"> + What happens if no --result-file option is given? + </remark> - <para> - Record the output that results from running the test file - into the file named by the <option>--result-file</option> - option. - </para> - </listitem> + <para> + Record the output that results from running the test + file into the file named by the + <option>--result-file</option> option. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>result-file option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>result-file option</secondary> + </indexterm> - <indexterm> - <primary>result-file option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>result-file option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--result-file=<replaceable>file_name</replaceable></option>, - <option>-R <replaceable>file_name</replaceable></option> - </para> + <option>--result-file=<replaceable>file_name</replaceable></option>, + <option>-R <replaceable>file_name</replaceable></option> + </para> - <remark role="todo"> - Determine if my interpretation of this option's meaning is - incorrect. - </remark> + <remark role="todo"> + Determine if my interpretation of this option's meaning + is incorrect. + </remark> - <para> - Read expected results from this file. In addition, if the - <option>--record</option> option is given, write actual - results to this file. - </para> - </listitem> + <para> + Read expected results from this file. In addition, if + the <option>--record</option> option is given, write + actual results to this file. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>server-arg option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>server-arg option</secondary> + </indexterm> - <indexterm> - <primary>server-arg option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>server-arg option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--server-arg=<replaceable>value</replaceable></option>, - <option>-A <replaceable>value</replaceable></option> - </para> + <option>--server-arg=<replaceable>value</replaceable></option>, + <option>-A <replaceable>value</replaceable></option> + </para> - <para> - Pass the argument as an argument to the embedded server. - </para> - </listitem> + <para> + Pass the argument as an argument to the embedded server. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>server-file option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>server-file option</secondary> + </indexterm> - <indexterm> - <primary>server-file option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>server-file option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--server-file=<replaceable>file_name</replaceable></option>, - <option>-F <replaceable>file_name</replaceable></option> - </para> + <option>--server-file=<replaceable>file_name</replaceable></option>, + <option>-F <replaceable>file_name</replaceable></option> + </para> - <para> - Read arguments for the embedded server from the given file. - </para> - </listitem> + <para> + Read arguments for the embedded server from the given + file. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>silent option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>silent option</secondary> + </indexterm> - <indexterm> - <primary>silent option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>silent option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--silent</option>, <option>-s</option> - </para> + <option>--silent</option>, <option>-s</option> + </para> - <para> - Suppress all normal output. - </para> - </listitem> + <para> + Suppress all normal output. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>skip-safemalloc option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>skip-safemalloc option</secondary> + </indexterm> - <indexterm> - <primary>skip-safemalloc option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>skip-safemalloc option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--skip-safemalloc</option> - </para> + <option>--skip-safemalloc</option> + </para> - <para> - Do not use memory allocation checking. - </para> - </listitem> + <para> + Do not use memory allocation checking. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>sleep option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>sleep option</secondary> + </indexterm> - <indexterm> - <primary>sleep option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>sleep option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--sleep=<replaceable>num</replaceable></option>, - <option>-T <replaceable>num</replaceable></option> - </para> + <option>--sleep=<replaceable>num</replaceable></option>, + <option>-T <replaceable>num</replaceable></option> + </para> - <remark role="todo"> - All sleep commands, or just those with no argument? - </remark> + <remark role="todo"> + All sleep commands, or just those with no argument? + </remark> - <para> - Cause the <literal>sleep</literal> command to always sleep - <replaceable>num</replaceable> seconds. - </para> - </listitem> + <para> + Cause the <literal>sleep</literal> command to always + sleep <replaceable>num</replaceable> seconds. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>socket option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>socket option</secondary> + </indexterm> - <indexterm> - <primary>socket option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>socket option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--socket=<replaceable>path</replaceable></option>, - <option>-S <replaceable>path</replaceable></option> - </para> + <option>--socket=<replaceable>path</replaceable></option>, + <option>-S <replaceable>path</replaceable></option> + </para> - <para> - The socket file to use when connecting to - <literal>localhost</literal> (which is the default host). - </para> - </listitem> + <para> + The socket file to use when connecting to + <literal>localhost</literal> (which is the default + host). + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>test-file option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>test-file option</secondary> + </indexterm> - <indexterm> - <primary>test-file option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>test-file option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--test-file=<replaceable>file_name</replaceable></option>, - <option>-x <replaceable>file_name</replaceable></option> - </para> + <option>--test-file=<replaceable>file_name</replaceable></option>, + <option>-x <replaceable>file_name</replaceable></option> + </para> - <para> - Read test input from this file. The default is to read from - the standard input. - </para> - </listitem> + <para> + Read test input from this file. The default is to read + from the standard input. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>timer-file option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>timer-file option</secondary> + </indexterm> - <indexterm> - <primary>timer-file option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>timer-file option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--timer-file=<replaceable>file_name</replaceable></option>, - <option>-m <replaceable>file_name</replaceable></option> - </para> + <option>--timer-file=<replaceable>file_name</replaceable></option>, + <option>-m <replaceable>file_name</replaceable></option> + </para> - <remark role="todo"> - This is an input file? Output file? - </remark> + <remark role="todo"> + This is an input file? Output file? + </remark> - <para> - The file where the timing in microseconds is stored. - </para> - </listitem> + <para> + The file where the timing in microseconds is stored. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>tmpdir option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>tmpdir option</secondary> + </indexterm> - <indexterm> - <primary>tmpdir option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>tmpdir option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--tmpdir=<replaceable>dir_name</replaceable></option>, - <option>-t <replaceable>dir_name</replaceable></option> - </para> + <option>--tmpdir=<replaceable>dir_name</replaceable></option>, + <option>-t <replaceable>dir_name</replaceable></option> + </para> - <remark role="todo"> - "put" = "created"? - </remark> + <remark role="todo"> + "put" = "created"? + </remark> - <para> - The temporary directory where sockets are put. - </para> - </listitem> + <para> + The temporary directory where sockets are put. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>user option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>user option</secondary> + </indexterm> - <indexterm> - <primary>user option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>user option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--user=<replaceable>user_name</replaceable></option>, - <option>-u <replaceable>user_name</replaceable></option> - </para> + <option>--user=<replaceable>user_name</replaceable></option>, + <option>-u <replaceable>user_name</replaceable></option> + </para> - <para> - The MySQL username to use when connecting to the server. - </para> - </listitem> + <para> + The MySQL username to use when connecting to the server. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>verbose option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>verbose option</secondary> + </indexterm> - <indexterm> - <primary>verbose option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>verbose option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--verbose</option>, <option>-v</option> - </para> + <option>--verbose</option>, <option>-v</option> + </para> - <para> - Verbose mode. Print out more information what the program - does. - </para> - </listitem> + <para> + Verbose mode. Print out more information what the + program does. + </para> + </listitem> - <listitem> - <para> - <indexterm> - <primary>mysqltest</primary> - <secondary>version option</secondary> - </indexterm> + <listitem> + <para> + <indexterm> + <primary>mysqltest</primary> + <secondary>version option</secondary> + </indexterm> - <indexterm> - <primary>version option</primary> - <secondary>mysqltest</secondary> - </indexterm> + <indexterm> + <primary>version option</primary> + <secondary>mysqltest</secondary> + </indexterm> - <option>--version</option>, <option>-V</option> - </para> + <option>--version</option>, <option>-V</option> + </para> - <para> - Display version information and exit. - </para> - </listitem> + <para> + Display version information and exit. + </para> + </listitem> - </itemizedlist> + </itemizedlist> - </refsection> + </refsection> - <refsection id="mysqltest-commands"> + </refentry> - <title>Test File Command Language</title> + </section> - <para> - This section describes the test language implemented by - <command>mysqltest</command>. - </para> + <section id="fake-id-for-mysql-test-run-manpage-section-wrapper"> - <para> - Note: For now, the commands are in a single lexical list. - Eventually, they need to be categorized. - </para> + <title>fake title for mysql-test-run manpage section wrapper</title> - <para> - Note: Cover the -- prefix. Cover comment writing. - </para> + <refentry id="mysql-test-run"> - <para> - <command>mysqltest</command> supports the following commands: - </para> + <indexterm> + <primary><command>mysql-test-run</command></primary> + </indexterm> - <para> - General input conventions: - </para> + <refmeta> + <refentrytitle>mysql-test-run</refentrytitle> + + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">MySQL Database System</refmiscinfo> + <refmiscinfo class="source">MySQL</refmiscinfo> + <refmiscinfo class="version">¤t-series;</refmiscinfo> + <refmiscinfo class="refman">&title-mysql-test-run-for-manual;</refmiscinfo> + </refmeta> - <itemizedlist> + <refnamediv> + <refname>mysql-test-run</refname> + + <refpurpose>&title-mysql-test-run-for-manpage;</refpurpose> + </refnamediv> - <listitem> + <refsynopsisdiv> + <cmdsynopsis> + <command>mysql-test-run [<replaceable>options</replaceable>] [<replaceable>test_case</replaceable>]</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection id="mysql-test-run-description"> + + <title>Description</title> + <para> - A line that begins with a ‘<literal>#</literal>’ - character is treated as a comment that extends to the end of - the line and is ignored. + <command>mysql-test-run</command> invokes + <command>mysqltest</command> to run test case. </para> <para> - Must the <literal>#</literal> occur in column 1 only, or can - it be the first non-whitespace character on the line? + Invoke <command>mysql-test-run</command> like this: </para> - </listitem> - <listitem> +<programlisting> +shell> <userinput>mysql-test-run [<replaceable>options</replaceable>] [<replaceable>test_case</replaceable>]</userinput> +</programlisting> + + </refsection> + + <refsection id="mysql-test-run-options"> + + <title>Options</title> + <para> - A line that begins with ‘<literal>--</literal>’ - also is treated as a comment that extends to the end of the - line. However, if the first word of the comment is a valid - <command>mysqltest</command> command, the comment is - executed. This can be useful for writing commands that - contain embedded instances of the command delimiter. + The <command>mysql-test-run</command> program invokes the + <command>mysqltest</command> program to run a test case. </para> - </listitem> - <listitem> <para> - Other input is taken as containing commands to be sent to - the server. These commands are delimited by instances of the - delimiter. Such input can contain multiple commands per - line, and a given command can span multiple lines. Consider - the following two input lines: + <command>mysql-test-run</command> supports the following + options: </para> + <itemizedlist> + + <listitem> + <para> + <indexterm> + <primary>mysql-test-run</primary> + <secondary>help option</secondary> + </indexterm> + + <indexterm> + <primary>help option</primary> + <secondary>mysql-test-run</secondary> + </indexterm> + + <option>--help</option>, <option>-?</option> + </para> + + <para> + Display a help message and exit. + </para> + + <para> + <emphasis role="bold">Note</emphasis>: In fact, + <command>mysql-test-run</command> does not have a + <option>--help</option> option, which is a deficiency. + (Corrected by <command>mysql-test-run.pl</command>.) + </para> + + <para> + [Fill in this section with all + <command>mysql-test-run</command> options] + </para> + </listitem> + + </itemizedlist> + + </refsection> + + </refentry> + + </section> + + </chapter> + + <chapter id="mysqltest-language"> + + <title>The <command>mysqltest</command> Command Language</title> + + <para> + This chapter describes the test language implemented by + <command>mysqltest</command>. + </para> + + <para> + Note: For now, the commands are in a single lexical list. + Eventually, they need to be categorized. + </para> + + <para> + Note: Cover the -- prefix. Cover comment writing. + </para> + + <para> + <command>mysqltest</command> supports the following commands: + </para> + + <para> + General input conventions: + </para> + + <itemizedlist> + + <listitem> + <para> + A line that begins with a ‘<literal>#</literal>’ + character is treated as a comment that extends to the end of + the line and is ignored. + </para> + + <para> + Must the <literal>#</literal> occur in column 1 only, or can + it be the first non-whitespace character on the line? + </para> + </listitem> + + <listitem> + <para> + A line that begins with ‘<literal>--</literal>’ + also is treated as a comment that extends to the end of the + line. However, if the first word of the comment is a valid + <command>mysqltest</command> command, the comment is executed. + This can be useful for writing commands that contain embedded + instances of the command delimiter. + </para> + </listitem> + + <listitem> + <para> + Other input is taken as containing commands to be sent to the + server. These commands are delimited by instances of the + delimiter. Such input can contain multiple commands per line, + and a given command can span multiple lines. Consider the + following two input lines: + </para> + <programlisting> select 1; select 'hello'; select 'goodbye'; </programlisting> - <para> - Three commands result from that input: - </para> + <para> + Three commands result from that input: + </para> <programlisting> select 1; @@ -868,533 +1102,531 @@ select 'goodbye'; </programlisting> - <para> - The default delimiter is the semicolon character - (‘<literal>;</literal>’). It can be changed with - the <literal>delimiter</literal> command. - </para> - </listitem> + <para> + The default delimiter is the semicolon character + (‘<literal>;</literal>’). It can be changed with + the <literal>delimiter</literal> command. + </para> + </listitem> - </itemizedlist> + </itemizedlist> - <itemizedlist> + <itemizedlist> - <listitem> - <para> - <literal>character_set</literal> - </para> - </listitem> + <listitem> + <para> + <literal>character_set</literal> + </para> + </listitem> - <listitem> - <para> - <literal>connect</literal> - </para> - </listitem> + <listitem> + <para> + <literal>connect</literal> + </para> + </listitem> - <listitem> - <para> - <literal>connection</literal> - </para> - </listitem> + <listitem> + <para> + <literal>connection</literal> + </para> + </listitem> - <listitem> - <para> - <literal>dec</literal> - </para> + <listitem> + <para> + <literal>dec</literal> + </para> - <para> - Decrement a variable. (Does it need to be numeric?) - </para> - </listitem> + <para> + Decrement a variable. (Does it need to be numeric?) + </para> + </listitem> - <listitem> - <para> - <literal>delimiter <replaceable>str</replaceable></literal> - </para> + <listitem> + <para> + <literal>delimiter <replaceable>str</replaceable></literal> + </para> - <para> - Set the command delimiter to <replaceable>str</replaceable>, - which may consist of one or more characters. The default - delimiter is the semicolon character - (‘<literal>;</literal>’). - </para> - </listitem> + <para> + Set the command delimiter to <replaceable>str</replaceable>, + which may consist of one or more characters. The default + delimiter is the semicolon character + (‘<literal>;</literal>’). + </para> + </listitem> - <listitem> - <para> - <literal>dirty_close</literal> - </para> - </listitem> + <listitem> + <para> + <literal>dirty_close</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_abort_on_error</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_abort_on_error</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_info</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_info</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_metadata</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_metadata</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_parsing</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_parsing</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_ps_protocol</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_ps_protocol</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_ps_warnings</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_ps_warnings</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_query_log</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_query_log</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_reconnect</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_reconnect</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_result_log</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_result_log</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_rpl_parse</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_rpl_parse</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disable_warnings</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disable_warnings</literal> + </para> + </listitem> - <listitem> - <para> - <literal>disconnect</literal> - </para> - </listitem> + <listitem> + <para> + <literal>disconnect</literal> + </para> + </listitem> - <listitem> - <para> - <literal>echo</literal> - </para> - </listitem> + <listitem> + <para> + <literal>echo</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_abort_on_error</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_abort_on_error</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_info</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_info</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_metadata</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_metadata</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_parsing</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_parsing</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_ps_protocol</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_ps_protocol</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_ps_warnings</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_ps_warnings</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_query_log</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_query_log</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_reconnect</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_reconnect</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_result_log</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_result_log</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_rpl_parse</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_rpl_parse</literal> + </para> + </listitem> - <listitem> - <para> - <literal>enable_warnings</literal> - </para> - </listitem> + <listitem> + <para> + <literal>enable_warnings</literal> + </para> + </listitem> - <listitem> - <para> - <literal>end</literal> - </para> - </listitem> + <listitem> + <para> + <literal>end</literal> + </para> + </listitem> - <listitem> - <para> - <literal>end_timer</literal> - </para> - </listitem> + <listitem> + <para> + <literal>end_timer</literal> + </para> + </listitem> - <listitem> - <para> - <literal>error {<replaceable>error_num</replaceable> | - <replaceable>sqlstate_code</replaceable>}</literal> - </para> + <listitem> + <para> + <literal>error {<replaceable>error_num</replaceable> | + <replaceable>sqlstate_code</replaceable>}</literal> + </para> - <para> - Specify an error value that the next command is expected to - return. The argument can be either a MySQL-specific error - number or a SQLSTATE value. (These are the kinds of values - returned by the <literal>mysql_errno()</literal> and - <literal>mysql_sqlstate()</literal> C API functions.) If you - specify a SQLSTATE value, it should begin with an - <literal>S</literal> to enable <command>mysqltest</command> - to distinguish it from a MySQL error number. For example, to - specify the SQLSTATE value <literal>42000</literal>, write - it as <literal>S42000</literal>: - </para> + <para> + Specify an error value that the next command is expected to + return. The argument can be either a MySQL-specific error + number or a SQLSTATE value. (These are the kinds of values + returned by the <literal>mysql_errno()</literal> and + <literal>mysql_sqlstate()</literal> C API functions.) If you + specify a SQLSTATE value, it should begin with an + <literal>S</literal> to enable <command>mysqltest</command> to + distinguish it from a MySQL error number. For example, to + specify the SQLSTATE value <literal>42000</literal>, write it + as <literal>S42000</literal>: + </para> <programlisting> --error S42000 </programlisting> - </listitem> + </listitem> - <listitem> - <para> - <literal>eval</literal> - </para> - </listitem> + <listitem> + <para> + <literal>eval</literal> + </para> + </listitem> - <listitem> - <para> - <literal>eval_result</literal> - </para> - </listitem> + <listitem> + <para> + <literal>eval_result</literal> + </para> + </listitem> - <listitem> - <para> - <literal>exec</literal> - </para> + <listitem> + <para> + <literal>exec</literal> + </para> - <para> - Difference from <literal>system</literal>? - </para> - </listitem> + <para> + Difference from <literal>system</literal>? + </para> + </listitem> - <listitem> - <para> - <literal>exit</literal> - </para> - </listitem> + <listitem> + <para> + <literal>exit</literal> + </para> + </listitem> - <listitem> - <para> - <literal>horizontal_results</literal> - </para> - </listitem> + <listitem> + <para> + <literal>horizontal_results</literal> + </para> + </listitem> - <listitem> - <para> - <literal>if</literal> - </para> - </listitem> + <listitem> + <para> + <literal>if</literal> + </para> + </listitem> - <listitem> - <para> - <literal>inc</literal> - </para> + <listitem> + <para> + <literal>inc</literal> + </para> - <para> - Increment a variable. - </para> - </listitem> + <para> + Increment a variable. + </para> + </listitem> - <listitem> - <para> - <literal>let $<replaceable>var_name</replaceable> = - <replaceable>value</replaceable>;</literal> - </para> + <listitem> + <para> + <literal>let $<replaceable>var_name</replaceable> = + <replaceable>value</replaceable>;</literal> + </para> - <para> - Assign a value to a variable. (Multiple assignments per - statement possible?) - </para> - </listitem> + <para> + Assign a value to a variable. (Multiple assignments per + statement possible?) + </para> + </listitem> - <listitem> - <para> - <literal>ping</literal> - </para> - </listitem> + <listitem> + <para> + <literal>ping</literal> + </para> + </listitem> - <listitem> - <para> - <literal>query</literal> - </para> - </listitem> + <listitem> + <para> + <literal>query</literal> + </para> + </listitem> - <listitem> - <para> - <literal>query_horizontal</literal> - </para> - </listitem> + <listitem> + <para> + <literal>query_horizontal</literal> + </para> + </listitem> - <listitem> - <para> - <literal>query_vertical</literal> - </para> - </listitem> + <listitem> + <para> + <literal>query_vertical</literal> + </para> + </listitem> - <listitem> - <para> - <literal>real_sleep</literal> - </para> - </listitem> + <listitem> + <para> + <literal>real_sleep</literal> + </para> + </listitem> - <listitem> - <para> - <literal>reap</literal> - </para> - </listitem> + <listitem> + <para> + <literal>reap</literal> + </para> + </listitem> - <listitem> - <para> - <literal>replace_column <replaceable>col_num</replaceable> - <replaceable>value</replaceable> - [<replaceable>col_num</replaceable> - <replaceable>value</replaceable>] ...;</literal> - </para> + <listitem> + <para> + <literal>replace_column <replaceable>col_num</replaceable> + <replaceable>value</replaceable> + [<replaceable>col_num</replaceable> + <replaceable>value</replaceable>] ...;</literal> + </para> - <para> - Replace a column with a given value. - </para> + <para> + Replace a column with a given value. + </para> - <para> - Do column numbers start with 0 or 1? - </para> - </listitem> + <para> + Do column numbers start with 0 or 1? + </para> + </listitem> - <listitem> - <para> - <literal>replace_regex - /<replaceable>pattern</replaceable>/<replaceable>replacement</replaceable>/[i] - ...</literal> - </para> + <listitem> + <para> + <literal>replace_regex + /<replaceable>pattern</replaceable>/<replaceable>replacement</replaceable>/[i] + ...</literal> + </para> - <para> - Replace strings that match the pattern - <replaceable>pattern</replaceable> with - <replaceable>replacment</replaceable>. Each instance of the - pattern on the line is replaced. The <literal>i</literal> - modifier, if given, causes case-insensitive pattern - matching. - </para> + <para> + Replace strings that match the pattern + <replaceable>pattern</replaceable> with + <replaceable>replacment</replaceable>. Each instance of the + pattern on the line is replaced. The <literal>i</literal> + modifier, if given, causes case-insensitive pattern matching. + </para> - <para> - The same patterns can be given as for the - <literal>REGEXP</literal> SQL operator. The pattern can - contain parentheses to mark substrings matched by the - pattern. Instances of - <literal>\<replaceable>N</replaceable></literal> in the - replacement string cause insertion of the - <replaceable>N</replaceable>-th substring matched by the - pattern. For example, the following command will match - <literal>strawberry</literal> and replace it with - <literal>raspbetter strawberry</literal> - </para> + <para> + The same patterns can be given as for the + <literal>REGEXP</literal> SQL operator. The pattern can + contain parentheses to mark substrings matched by the pattern. + Instances of <literal>\<replaceable>N</replaceable></literal> + in the replacement string cause insertion of the + <replaceable>N</replaceable>-th substring matched by the + pattern. For example, the following command will match + <literal>strawberry</literal> and replace it with + <literal>raspbetter strawberry</literal> + </para> <programlisting> --replace_regex /(strawberry)/raspberry and \1/ </programlisting> - <para> - Multiple pattern/replacement pairs may be given. The - following command replaces instances of <literal>A</literal> - with <literal>C</literal> (the first pattern replaces - <literal>A</literal> with <literal>B</literal>, the second - replaces <literal>B</literal> with <literal>C</literal>): - </para> + <para> + Multiple pattern/replacement pairs may be given. The following + command replaces instances of <literal>A</literal> with + <literal>C</literal> (the first pattern replaces + <literal>A</literal> with <literal>B</literal>, the second + replaces <literal>B</literal> with <literal>C</literal>): + </para> <programlisting> --replace_regex /A/B/ /B/C/ </programlisting> - <para> - If a pattern is not found, no error occurs and the input is - unchanged. - </para> + <para> + If a pattern is not found, no error occurs and the input is + unchanged. + </para> - <para> - The <literal>replace_regex</literal> command was added in - MySQL 5.1.6. - </para> - </listitem> + <para> + The <literal>replace_regex</literal> command was added in + MySQL 5.1.6. + </para> + </listitem> - <listitem> - <para> - <literal>replace_result</literal> - </para> - </listitem> + <listitem> + <para> + <literal>replace_result</literal> + </para> + </listitem> - <listitem> - <para> - <literal>require</literal> - </para> - </listitem> + <listitem> + <para> + <literal>require</literal> + </para> + </listitem> - <listitem> - <para> - <literal>require_manager</literal> - </para> - </listitem> + <listitem> + <para> + <literal>require_manager</literal> + </para> + </listitem> - <listitem> - <para> - <literal>result</literal> - </para> - </listitem> + <listitem> + <para> + <literal>result</literal> + </para> + </listitem> - <listitem> - <para> - <literal>rpl_probe</literal> - </para> - </listitem> + <listitem> + <para> + <literal>rpl_probe</literal> + </para> + </listitem> - <listitem> - <para> - <literal>save_master_pos</literal> - </para> - </listitem> + <listitem> + <para> + <literal>save_master_pos</literal> + </para> + </listitem> - <listitem> - <para> - <literal>send</literal> - </para> - </listitem> + <listitem> + <para> + <literal>send</literal> + </para> + </listitem> - <listitem> - <para> - <literal>server_start</literal> - </para> - </listitem> + <listitem> + <para> + <literal>server_start</literal> + </para> + </listitem> - <listitem> - <para> - <literal>server_stop</literal> - </para> - </listitem> + <listitem> + <para> + <literal>server_stop</literal> + </para> + </listitem> - <listitem> - <para> - <literal>sleep</literal> - </para> - </listitem> + <listitem> + <para> + <literal>sleep</literal> + </para> + </listitem> - <listitem> - <para> - <literal>source <filename>file_name</filename></literal> - </para> + <listitem> + <para> + <literal>source <filename>file_name</filename></literal> + </para> - <para> - Reads test input from the named file. - </para> - </listitem> + <para> + Reads test input from the named file. + </para> + </listitem> - <listitem> - <para> - <literal>start_timer</literal> - </para> - </listitem> + <listitem> + <para> + <literal>start_timer</literal> + </para> + </listitem> - <listitem> - <para> - <literal>sync_slave_with_master</literal> - </para> - </listitem> + <listitem> + <para> + <literal>sync_slave_with_master</literal> + </para> + </listitem> - <listitem> - <para> - <literal>sync_with_master</literal> - </para> - </listitem> + <listitem> + <para> + <literal>sync_with_master</literal> + </para> + </listitem> - <listitem> - <para> - <literal>system</literal> - </para> + <listitem> + <para> + <literal>system</literal> + </para> - <para> - Difference from <literal>exec</literal>? - </para> - </listitem> + <para> + Difference from <literal>exec</literal>? + </para> + </listitem> - <listitem> - <para> - <literal>vertical_results</literal> - </para> - </listitem> + <listitem> + <para> + <literal>vertical_results</literal> + </para> + </listitem> - <listitem> - <para> - <literal>wait_for_slave_to_stop</literal> - </para> - </listitem> + <listitem> + <para> + <literal>wait_for_slave_to_stop</literal> + </para> + </listitem> - <listitem> - <para> - <literal>while</literal> - </para> + <listitem> + <para> + <literal>while</literal> + </para> - <para> - Create a loop. - </para> + <para> + Create a loop. + </para> <programlisting> while (<replaceable>condition</replaceable>) @@ -1402,33 +1634,31 @@ <replaceable>command list</replaceable> } </programlisting> - </listitem> + </listitem> - </itemizedlist> + </itemizedlist> - <para> - <literal>$mysql_errno</literal> is a built-in variable that - contains the numeric error returned by the most recent command - sent to the server, or 0 if the command executes successfully. - <literal>$mysql_errno</literal> has a value of −1 if no - command has yet been sent. - </para> + <para> + <literal>$mysql_errno</literal> is a built-in variable that + contains the numeric error returned by the most recent command + sent to the server, or 0 if the command executes successfully. + <literal>$mysql_errno</literal> has a value of −1 if no + command has yet been sent. + </para> - <para> - If an expected error is specified and that error occurs, - <command>mysqltest</command> continues reading input. If the - command is successful or a different error occurs, - <command>mysqltest</command> aborts. - </para> + <para> + If an expected error is specified and that error occurs, + <command>mysqltest</command> continues reading input. If the + command is successful or a different error occurs, + <command>mysqltest</command> aborts. + </para> - <para> - If no expected error is specified, <command>mysqltest</command> - aborts unless the command is successful. (It is implicit that - you expect <literal>$mysql_errno</literal> to be 0.) - </para> + <para> + If no expected error is specified, <command>mysqltest</command> + aborts unless the command is successful. (It is implicit that you + expect <literal>$mysql_errno</literal> to be 0.) + </para> - </refsection> + </chapter> - </refentry> - -</section> +</book>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r1438 - in trunk: . internals | paul | 24 Feb |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 1.599 sec. using MySQL 5.1.14-beta-log