List:Commits« Previous MessageNext Message »
From:paul Date:February 17 2006 11:31pm
Subject:svn commit - mysqldoc@docsrva: r1374 - in trunk: . refman-5.0 refman-5.1
View as plain text  
Author: paul
Date: 2006-02-18 00:31:37 +0100 (Sat, 18 Feb 2006)
New Revision: 1374

Log:
 r7739@frost:  paul | 2006-02-17 16:07:13 -0600
 Uncomment and fill in mysql_upgrade section.


Modified:
   trunk/
   trunk/refman-5.0/database-administration.xml
   trunk/refman-5.0/views.xml
   trunk/refman-5.1/database-administration.xml
   trunk/refman-5.1/views.xml


Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:7737
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3223
   + b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:7739
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:3223

Modified: trunk/refman-5.0/database-administration.xml
===================================================================
--- trunk/refman-5.0/database-administration.xml	2006-02-17 21:53:56 UTC (rev 1373)
+++ trunk/refman-5.0/database-administration.xml	2006-02-17 23:31:37 UTC (rev 1374)
@@ -12285,6 +12285,13 @@
           </para>
 
           <para>
+            <emphasis role="bold">Note</emphasis>: As of MySQL 5.0.19,
+            <command>mysql_fix_privilege_tables</command> is superseded
+            by <command>mysql_upgrade</command>, which should be used
+            instead. See <xref linkend="mysql-upgrade"/>.
+          </para>
+
+          <para>
             On Unix or Unix-like systems, update the system tables by
             running the <command>mysql_fix_privilege_tables</command>
             script:
@@ -12361,7 +12368,6 @@
 
     </section>
 
-<!--
     <section id="fake-id-for-mysql-upgrade">
 
       <title>fake title for mysql_upgrade manpage section wrapper</title>
@@ -12407,16 +12413,204 @@
 
           <title>Description</title>
 
-          <remark role="todo">
-            Fill in
-          </remark>
+          <para>
+            <command>mysql_upgrade</command> should be run each time you
+            upgrade MySQL. It checks all tables in all databases for
+            incompatibilities with the current version of MySQL Server.
+            If a table is found to have a possible incompatibility, it
+            is checked. If any problems are found, the table is
+            repaired.
+          </para>
 
+          <para>
+            All checked and repaired tables are marked with the current
+            MySQL version number. This ensures that next time you run
+            <command>mysql_upgrade</command> with the same version of
+            the server, it can tell whether there is any need to check
+            or repair the table again.
+          </para>
+
+          <para>
+            <command>mysql_upgrade</command> also saves the MySQL
+            version number in a file named
+            <filename>mysql_upgrade.info</filename> in the data
+            directory. This is used to quickly check if all tables have
+            been checked for this release so that table-checking can be
+            skipped. To ignore this file, use the
+            <option>--force</option> option.
+          </para>
+
+          <para>
+            To check and repair tables, <command>mysql_upgrade</command>
+            executes the following commands:
+          </para>
+
+<programlisting>
+mysqlcheck --for-upgrade --all-databases --auto-repair
+mysql_fix_privilege_tables
+</programlisting>
+
+          <para>
+            <command>mysql_upgrade</command> currently works only on
+            Unix. On Windows, you can execute the
+            <command>mysqlcheck</command> command manually, and then
+            upgrade your system tables as described in
+            <xref linkend="mysql-fix-privilege-tables"/>.
+          </para>
+
+          <para>
+            For details about what is checked, see the description of
+            the <literal>FOR UPGRADE</literal> option of the
+            <literal>CHECK TABLE</literal> statement (see
+            <xref linkend="check-table"/>).
+          </para>
+
+          <para>
+            Invoke <command>mysql_upgrade</command> like this:
+          </para>
+
+<programlisting>
+shell&gt; <userinput>mysql_upgrade [<replaceable>options</replaceable>]</userinput>
+</programlisting>
+
+          <para>
+            <command>mysql_upgrade</command> reads options from the
+            command line and fromm the <literal>[mysqld]</literal> and
+            <literal>[mysql_upgrade]</literal> groups in option files.
+            It supports the following options:
+          </para>
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>basedir option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>basedir option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <option>--basedir=<replaceable>path</replaceable></option>
+              </para>
+
+              <para>
+                The path to the MySQL installation directory.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>datadir option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>datadir option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <option>--datadir=<replaceable>path</replaceable></option>
+              </para>
+
+              <para>
+                The path to the data directory.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>force option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>force option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <option>--force</option>
+              </para>
+
+              <para>
+                Force execution of <command>mysqlcheck</command> even if
+                <command>mysql_upgrade</command> has already been
+                executed for the current version of MySQL. (In other
+                words, this option causes the
+                <filename>mysql_upgrade.info</filename> file to be
+                ignored.)
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>user option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>user option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <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.
+                The default username is <literal>root</literal>.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>verbose option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>verbose option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <option>--verbose</option>
+              </para>
+
+              <para>
+                Verbose mode. Print more information about what the
+                program does.
+              </para>
+            </listitem>
+
+          </itemizedlist>
+
+          <para>
+            Other options are passed to <command>mysqlcheck</command>
+            and to <command>mysql_fix_privilege_tables</command>. For
+            example, it might be necessary to specify the
+            <option>--password[=<replaceable>password</replaceable>]</option>
+            option.
+          </para>
+
+          <para>
+            <command>mysql_upgrade</command> was added in MySQL 5.0.19.
+            It supersedes the older
+            <command>mysql_fix_privilege_tables</command> script.
+          </para>
+
         </refsection>
 
       </refentry>
 
     </section>
--->
 
   </section>
 

Modified: trunk/refman-5.0/views.xml
===================================================================
--- trunk/refman-5.0/views.xml	2006-02-17 21:53:56 UTC (rev 1373)
+++ trunk/refman-5.0/views.xml	2006-02-17 23:31:37 UTC (rev 1374)
@@ -54,15 +54,14 @@
   <para>
     To use views if you have upgraded to MySQL 5.0.1 from an older
     release, you should upgrade your grant tables so that they contain
-    the view-related privileges. See
-    <xref linkend="mysql-fix-privilege-tables"/>.
+    the view-related privileges. See <xref linkend="mysql-upgrade"/>.
   </para>
-  
+
   <para>
     Metadata about views can be obtained from the
     <literal>INFORMATION_SCHEMA.VIEWS</literal> table and by using the
-    <literal>SHOW CREATE VIEW</literal> statement. See 
-    <xref linkend="views-table"/> and 
+    <literal>SHOW CREATE VIEW</literal> statement. See
+    <xref linkend="views-table"/>, and
     <xref linkend="show-create-view"/>.
   </para>
 

Modified: trunk/refman-5.1/database-administration.xml
===================================================================
--- trunk/refman-5.1/database-administration.xml	2006-02-17 21:53:56 UTC (rev 1373)
+++ trunk/refman-5.1/database-administration.xml	2006-02-17 23:31:37 UTC (rev 1374)
@@ -12094,6 +12094,13 @@
           </para>
 
           <para>
+            <emphasis role="bold">Note</emphasis>: As of MySQL 5.1.7,
+            <command>mysql_fix_privilege_tables</command> is superseded
+            by <command>mysql_upgrade</command>, which should be used
+            instead. See <xref linkend="mysql-upgrade"/>.
+          </para>
+
+          <para>
             On Unix or Unix-like systems, update the system tables by
             running the <command>mysql_fix_privilege_tables</command>
             script:
@@ -12170,7 +12177,6 @@
 
     </section>
 
-<!--
     <section id="fake-id-for-mysql-upgrade">
 
       <title>fake title for mysql_upgrade manpage section wrapper</title>
@@ -12216,16 +12222,204 @@
 
           <title>Description</title>
 
-          <remark role="todo">
-            Fill in
-          </remark>
+          <para>
+            <command>mysql_upgrade</command> should be run each time you
+            upgrade MySQL. It checks all tables in all databases for
+            incompatibilities with the current version of MySQL Server.
+            If a table is found to have a possible incompatibility, it
+            is checked. If any problems are found, the table is
+            repaired.
+          </para>
 
+          <para>
+            All checked and repaired tables are marked with the current
+            MySQL version number. This ensures that next time you run
+            <command>mysql_upgrade</command> with the same version of
+            the server, it can tell whether there is any need to check
+            or repair the table again.
+          </para>
+
+          <para>
+            <command>mysql_upgrade</command> also saves the MySQL
+            version number in a file named
+            <filename>mysql_upgrade.info</filename> in the data
+            directory. This is used to quickly check if all tables have
+            been checked for this release so that table-checking can be
+            skipped. To ignore this file, use the
+            <option>--force</option> option.
+          </para>
+
+          <para>
+            To check and repair tables, <command>mysql_upgrade</command>
+            executes the following commands:
+          </para>
+
+<programlisting>
+mysqlcheck --for-upgrade --all-databases --auto-repair
+mysql_fix_privilege_tables
+</programlisting>
+
+          <para>
+            <command>mysql_upgrade</command> currently works only on
+            Unix. On Windows, you can execute the
+            <command>mysqlcheck</command> command manually, and then
+            upgrade your system tables as described in
+            <xref linkend="mysql-fix-privilege-tables"/>.
+          </para>
+
+          <para>
+            For details about what is checked, see the description of
+            the <literal>FOR UPGRADE</literal> option of the
+            <literal>CHECK TABLE</literal> statement (see
+            <xref linkend="check-table"/>).
+          </para>
+
+          <para>
+            Invoke <command>mysql_upgrade</command> like this:
+          </para>
+
+<programlisting>
+shell&gt; <userinput>mysql_upgrade [<replaceable>options</replaceable>]</userinput>
+</programlisting>
+
+          <para>
+            <command>mysql_upgrade</command> reads options from the
+            command line and fromm the <literal>[mysqld]</literal> and
+            <literal>[mysql_upgrade]</literal> groups in option files.
+            It supports the following options:
+          </para>
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>basedir option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>basedir option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <option>--basedir=<replaceable>path</replaceable></option>
+              </para>
+
+              <para>
+                The path to the MySQL installation directory.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>datadir option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>datadir option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <option>--datadir=<replaceable>path</replaceable></option>
+              </para>
+
+              <para>
+                The path to the data directory.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>force option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>force option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <option>--force</option>
+              </para>
+
+              <para>
+                Force execution of <command>mysqlcheck</command> even if
+                <command>mysql_upgrade</command> has already been
+                executed for the current version of MySQL. (In other
+                words, this option causes the
+                <filename>mysql_upgrade.info</filename> file to be
+                ignored.)
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>user option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>user option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <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.
+                The default username is <literal>root</literal>.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <indexterm>
+                  <primary>mysql_upgrade</primary>
+                  <secondary>verbose option</secondary>
+                </indexterm>
+
+                <indexterm>
+                  <primary>verbose option</primary>
+                  <secondary>mysql_upgrade</secondary>
+                </indexterm>
+
+                <option>--verbose</option>
+              </para>
+
+              <para>
+                Verbose mode. Print more information about what the
+                program does.
+              </para>
+            </listitem>
+
+          </itemizedlist>
+
+          <para>
+            Other options are passed to <command>mysqlcheck</command>
+            and to <command>mysql_fix_privilege_tables</command>. For
+            example, it might be necessary to specify the
+            <option>--password[=<replaceable>password</replaceable>]</option>
+            option.
+          </para>
+
+          <para>
+            <command>mysql_upgrade</command> was added in MySQL 5.1.7.
+            It supersedes the older
+            <command>mysql_fix_privilege_tables</command> script.
+          </para>
+
         </refsection>
 
       </refentry>
 
     </section>
--->
 
   </section>
 

Modified: trunk/refman-5.1/views.xml
===================================================================
--- trunk/refman-5.1/views.xml	2006-02-17 21:53:56 UTC (rev 1373)
+++ trunk/refman-5.1/views.xml	2006-02-17 23:31:37 UTC (rev 1374)
@@ -54,14 +54,14 @@
     To use views if you have upgraded to MySQL &current-series; from an
     older release that did not support views, you should upgrade your
     grant tables so that they contain the view-related privileges. See
-    <xref linkend="mysql-fix-privilege-tables"/>.
+    <xref linkend="mysql-upgrade"/>.
   </para>
-  
+
   <para>
     Metadata about views can be obtained from the
     <literal>INFORMATION_SCHEMA.VIEWS</literal> table and by using the
-    <literal>SHOW CREATE VIEW</literal> statement. See 
-    <xref linkend="views-table"/> and 
+    <literal>SHOW CREATE VIEW</literal> statement. See
+    <xref linkend="views-table"/>, and
     <xref linkend="show-create-view"/>.
   </para>
 

Thread
svn commit - mysqldoc@docsrva: r1374 - in trunk: . refman-5.0 refman-5.1paul18 Feb