List:Internals« Previous MessageNext Message »
From:mhillyer Date:June 25 2005 8:51pm
Subject:bk commit - mysqldoc@docsrva tree (Mike.Hillyer:1.2884)
View as plain text  
Below is the list of changes that have just been committed into a local
mysqldoc repository of root. When root does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://www.mysql.com/doc/I/n/Installing_source_tree.html

  userguide/logfiles.xml
    1.1 05/06/25 12:51:54 Mike.Hillyer@stripped +112 -0

ChangeSet
  1.2884 05/06/25 12:51:54 Mike.Hillyer@stripped +7 -0
  Document some C/NET bugs, edit indexing chapter of refman.

  userguide/userguide.xml
    1.4 05/06/25 12:51:54 Mike.Hillyer@stripped +2 -0
    Include new document on server log files.

  userguide/logfiles.xml
    1.0 05/06/25 12:51:54 Mike.Hillyer@stripped +0 -0
    BitKeeper file /home/mysqldoc/mysqldoc/userguide/logfiles.xml

  userguide/indexing.xml
    1.6 05/06/25 12:51:54 Mike.Hillyer@stripped +11 -102
    Working on some of stefan's feedback/edits.

  Docs/connector-net/changelog.xml
    1.12 05/06/25 12:51:54 Mike.Hillyer@stripped +15 -0
    Bug #'s
    11542
    11550
    10637
    10486
    10152

  userguide/images/logfiles-slow-query-log-administrator-view.png
    1.2 05/06/24 18:29:00 Mike.Hillyer@stripped +0 -0
    Rename: userguide/images/indexing-choosing-slowlog-administrator-view.png -> userguide/images/logfiles-slow-query-log-administrator-view.png

  userguide/images/logfiles-slow-query-log-administrator-settings.png
    1.2 05/06/24 18:28:13 Mike.Hillyer@stripped +0 -0
    Rename: userguide/images/indexing-choosing-slowlog-administrator-settings.png -> userguide/images/logfiles-slow-query-log-administrator-settings.png

  BitKeeper/deleted/.del-README~3ab7aaa45cecff83
    1.2 05/06/24 18:17:40 Mike.Hillyer@stripped +0 -0
    Delete: userguide/README

# This is a BitKeeper patch.  What follows are the unified diffs for the
# set of deltas contained in the patch.  The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User:	Mike.Hillyer
# Host:	www.openwin.org
# Root:	/home/mysqldoc/mysqldoc

--- 1.11/Docs/connector-net/changelog.xml	2005-06-23 16:01:05 -06:00
+++ 1.12/Docs/connector-net/changelog.xml	2005-06-25 12:51:54 -06:00
@@ -38,6 +38,21 @@
   <itemizedlist>
 
    <listitem><para>
+    Connection could fail when .NET thread pool had no available worker
+    threads. (Bug #10637)
+   </para></listitem>
+
+   <listitem><para>
+    Decimal parameters caused syntax errors. (Bug #11550, Bug #10486,
+    Bug #10152)
+   </para></listitem>
+
+   <listitem><para>
+    Call to stored procedure causes exception if stored procedure has no
+    parameters. (Bug #11542)
+   </para></listitem>
+
+   <listitem><para>
     Certain malformed queries will trigger a "Connection must be valid
     and open" error message. (Bug #11490)
    </para></listitem>

--- 1.5/userguide/indexing.xml	2005-06-20 10:17:56 -06:00
+++ 1.6/userguide/indexing.xml	2005-06-25 12:51:54 -06:00
@@ -102,14 +102,15 @@
     efficiency of querying information in <literal>CHAR</literal>,
     <literal>VARCHAR</literal>, and <literal>TEXT</literal> columns. The
     <literal>FULLTEXT</literal> index is available for the
-    <literal>MyISAM</literal> storage engine only.
+   <link linkend="storage-engines-myisam" 
+   endterm="<literal>MyISAM</literal> storage engine"/> only. 
    </para></listitem>
 
    <listitem><para>
     <literal>SPATIAL</literal>: This index is used with
     <literal>GIS</literal> applications to improve the performance of
     functions such as <literal>MBRContains()</literal> or
-    <literal>MBRWithin()</literal>.
+    <literal>MBRWithin()</literal>. The <literal>SPATIAL</literal> index is available for the <literal>MyISAM</literal> storage engine only.
    </para></listitem>
 
   </itemizedlist>
@@ -123,7 +124,7 @@
    index. If your values are unique, but are not considered to uniquely
    identify the row, choose a <literal>UNIQUE</literal> index. If you
    wish to improve the performance of queries that match values in a
-   column, use a regular <literal>INDEX</literal>.
+   column, use a regular <literal>INDEX</literal>. Only one <literal>PRIMARY</literal> index is allowed per table, all other index types can occur multiple times in a single table.
   </para>
 
   <para>
@@ -148,8 +149,8 @@
 
   <para>
    To use indexes effectively, it is necessary to identify those queries
-   that are executing slowly and not making effective use of indexes.
-   This can either be done by directly reviewing the queries you use or
+   that are executing slowly and not making effective use of indexes, or which need to contain unique values.
+   Slow queries can be identified by directly reviewing the queries you use or
    by using the MySQL Slow Query Log.
   </para>
 
@@ -203,7 +204,7 @@
    </para>
 
    <para>
-    Remember that each index you add to a table will have a negative
+    Each index you add to a table will have a negative
     effect on the performance of <literal>INSERT</literal>,
     <literal>UPDATE</literal> and <literal>DELETE</literal> queries
     because not only does the row data need to be changed, the index
@@ -228,102 +229,10 @@
    <para>
     If you need to identify slow queries on a production MySQL server
     you may benefit from using the MySQL Slow Query Log. When the MySQL
-    server is started with the <literal>--log-slow-queries</literal>
-    option, it writes all queries that take longer than a configurable
+    server is started with the Slow Query Log enabled, it writes all queries that take longer than a configurable
     number of seconds to a log file. The queries in the Slow Query Log
-    can be further examined and optimized.
+    can be further examined and optimized. For more information see <xref linkend="logfiles-slow-query-log" />
    </para>
-
-   <para>
-    The Slow Query Log can also be activated by adding the
-    <literal>slog-slow-queries</literal> directive to the
-    <literal>[mysqld]</literal> section of your server configuration
-    file, or through the MySQL Administrator:
-   </para>
-
-   <figure>
-    <title>Activating the Slow Query Log using MySQL Administrator</title>
-    <graphic fileref="images/indexing-choosing-slowlog-administrator-settings.png" lang="en" format="PNG"/>
-   </figure>
-
-   <para>
-    The <literal>Slow Queries Log</literal> option is found in the
-    <literal>Log Files</literal> tab of the <literal>Startup
-    Variables</literal> screen. Click the clipboard icon to the left of
-    the option to activate the Slow Query Log and click the
-    <guibutton>Apply Changes</guibutton> button. Once the Slow Query Log
-    is activated, restart the MySQL server using the <literal>Service
-    Control</literal> screen.
-   </para>
-
-   <para>
-    The default name of the log file is
-    <filename><replaceable>server-name</replaceable>-slow.log</filename>.
-    If your server is named <literal>doomhammer.myserver.org</literal>,
-    the log file will be named
-    <filename>doomhammer.myserver.org-slow.log</filename>.
-   </para>
-
-   <para>
-    The Slow Query Log is a plain-text file that contains three lines
-    for every query logged:
-   </para>
-
-<programlisting>
-# User@Host: root[root] @ localhost [127.0.0.1]
-# Query_time: 0  Lock_time: 0  Rows_sent: 1  Rows_examined: 3
-SELECT last_name, first_name, actor_id FROM actor WHERE last_name = 'Brando';
-</programlisting>
-
-   <para>
-    The first line lists the username and hostname of the user who
-    executed the query. The second line lists the time taken to execute
-    the query, the time required to acquire the necessary locks, the
-    number of rows returned by the query, and the number of rows the
-    MySQL optimizer needed to examine. The final line of the entry shows
-    the query that was executed.
-   </para>
-
-   <para>
-    The Slow Query Log can also be read using the MySQL Administrator
-    using the <literal>Slow Log</literal> tab of the <literal>Server
-    Logs</literal> screen:
-   </para>
-
-   <figure>
-    <title>Viewing the Slow Query Log with MySQL Administrator</title>
-    <graphic fileref="images/indexing-choosing-slowlog-administrator-view.png" lang="en" format="PNG"/>
-   </figure>
-
-   <para>
-    The Slow Queries Log determines whether a query is slow by how long
-    the query takes to execute in seconds, not counting the time
-    required to acquire table locks. The default time is two seconds and
-    can be adjusted by setting the <literal>long_query_time</literal>
-    option in the <literal>[mysqld]</literal> section of the server
-    configuration file. The <literal>long_query_time</literal> option
-    can also be set using the <literal>Log Files</literal> tab of the
-    <literal>Startup Variables</literal> screen of MySQL Administrator.
-   </para>
-
-   <para>
-    It should be noted that queries can appear in the Slow Query Log
-    even if they are properly optimized if the server load is high
-    enough to cause the query to take longer than the
-    <literal>long_query_time</literal>.
-   </para>
-
-   <para>
-    If you wish to log all queries that do not use indexes, regardless
-    of how long the queries take to execute, add the
-    <literal>log-queries-not-using-indexes</literal> option to the
-    <literal>[mysqld]</literal> section of your MySQL server
-    configuration file, or check the <literal>Log queries that don't use
-    indexes</literal> option of the <literal>Log Files</literal> tab of
-    the <literal>Startup Variables</literal> screen of MySQL
-    Administrator.
-   </para>
-
   </section>
 
 <!-- END SLOW LOG -->
@@ -340,7 +249,7 @@
    Before creating a new index, it is important to know what indexes
    currently exist for a given table. Index information can be retrieved
    using either the <literal>SHOW</literal> syntax or through use of the
-   <literal>INFORMATION_SCHEMA</literal>. Index information can also be
+   <literal>INFORMATION_SCHEMA</literal>. <literal>INFORMATION_SCHEMA</literal> is a standard method for accessing information, while <literal>SHOW</literal> is an extension of the SQL standard. Index information can also be
    browsed using the MySQL GUI tools.
   </para>
 
@@ -956,7 +865,7 @@
   </para>
 
 <programlisting>
- SELECT * FROM army WHERE MATCH (title, description) AGAINST ('army')
+ SELECT * FROM film WHERE MATCH (title, description) AGAINST ('army')
 
 UPDATEME: SHOW RESULTS WHEN SAMPLE DB IS FINISHED AND POPULATED
 </programlisting>
--- New file ---
+++ userguide/logfiles.xml	05/06/25 12:51:54
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<chapter id="logfiles">

  <title>MySQL Log Files</title>

  <section id="logfiles-slow-query-log">
    <title>The Slow Query Log</title>
    <para>
    If you need to identify slow queries on a production MySQL server
    you may benefit from using the MySQL Slow Query Log. When the MySQL
    server is started with the <literal>--log-slow-queries</literal>
    option, it writes all queries that take longer than a configurable
    number of seconds to a log file. The queries in the Slow Query Log
    can be further examined and optimized.
   </para>

   <para>
    The Slow Query Log can also be activated by adding the
    <literal>slog-slow-queries</literal> directive to the
    <literal>[mysqld]</literal> section of your server option
    file, or through the MySQL Administrator:
   </para>

   <figure>
    <title>Activating the Slow Query Log using MySQL Administrator</title>
    <graphic fileref="images/logfiles-slow-query-log-administrator-settings.png" lang="en" format="PNG"/>
   </figure>

   <para>
    The <literal>Slow Queries Log</literal> option is found in the
    <literal>Log Files</literal> tab of the <literal>Startup
    Variables</literal> screen. Click the clipboard icon to the left of
    the option to activate the Slow Query Log and click the
    <guibutton>Apply Changes</guibutton> button. Once the Slow Query Log
    is activated, restart the MySQL server using the <literal>Service
    Control</literal> screen.
   </para>

   <para>
    The default name of the log file is
    <filename><replaceable>server-name</replaceable>-slow.log</filename>.
    If your server is named <literal>doomhammer.myserver.org</literal>,
    the log file will be named
    <filename>doomhammer.myserver.org-slow.log</filename>.
   </para>

   <para>
    The Slow Query Log is a plain-text file that contains three lines
    for every query logged:
   </para>

<programlisting>
# User@Host: root[root] @ localhost [127.0.0.1]
# Query_time: 0  Lock_time: 0  Rows_sent: 1  Rows_examined: 3
SELECT last_name, first_name, actor_id FROM actor WHERE last_name = 'Brando';
</programlisting>

   <para>
    The first line lists the username and hostname of the user who
    executed the query. The second line lists the time taken to execute
    the query, the time required to acquire the necessary locks, the
    number of rows returned by the query, and the number of rows the
    MySQL optimizer needed to examine. The final line of the entry shows
    the query that was executed.
   </para>

   <para>
    The Slow Query Log can also be read using the MySQL Administrator
    using the <literal>Slow Log</literal> tab of the <literal>Server
    Logs</literal> screen:
   </para>

   <figure>
    <title>Viewing the Slow Query Log with MySQL Administrator</title>
    <graphic fileref="images/logfiles-slow-query-log-administrator-view.png" lang="en" format="PNG"/>
   </figure>

   <para>
    The Slow Queries Log determines whether a query is slow by how long
    the query takes to execute in seconds, not counting the time
    required to acquire table locks. The default time is two seconds and
    can be adjusted by setting the <literal>long_query_time</literal>
    option in the <literal>[mysqld]</literal> section of the server
    configuration file. The <literal>long_query_time</literal> option
    can also be set using the <literal>Log Files</literal> tab of the
    <literal>Startup Variables</literal> screen of MySQL Administrator.
   </para>

   <para>
    It should be noted that queries can appear in the Slow Query Log
    even if they are properly optimized if the server load is high
    enough to cause the query to take longer than the
    <literal>long_query_time</literal>.
   </para>

   <para>
    If you wish to log all queries that do not use indexes, regardless
    of how long the queries take to execute, add the
    <literal>log-queries-not-using-indexes</literal> option to the
    <literal>[mysqld]</literal> section of your MySQL server
    configuration file, or check the <literal>Log queries that don't use
    indexes</literal> option of the <literal>Log Files</literal> tab of
    the <literal>Startup Variables</literal> screen of MySQL
    Administrator.
   </para>
</section>


</chapter>
<!-- END CONFIGURING CHAPTER -->


--- 1.3/userguide/userguide.xml	2005-06-15 16:05:48 -06:00
+++ 1.4/userguide/userguide.xml	2005-06-25 12:51:54 -06:00
@@ -44,6 +44,8 @@
 
   <xi:include href="security.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
+<xi:include href="logfiles.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
  <xi:include href="disaster.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
  </part>
Thread
bk commit - mysqldoc@docsrva tree (Mike.Hillyer:1.2884)mhillyer25 Jun