Author: jstephens
Date: 2005-10-21 04:10:57 +0200 (Fri, 21 Oct 2005)
New Revision: 127
Log:
refman-5.0/extending-mysql.xml,
refman-4.1/extending-mysql.xml,
refman-5.1/extending-mysql.xml
- Version-specific fixes
refman-5.0/installing.xml
- Removed ToDo that had been done
Modified:
trunk/refman-4.1/extending-mysql.xml
trunk/refman-5.0/extending-mysql.xml
trunk/refman-5.0/installing.xml
trunk/refman-5.1/extending-mysql.xml
Modified: trunk/refman-4.1/extending-mysql.xml
===================================================================
--- trunk/refman-4.1/extending-mysql.xml 2005-10-21 01:06:24 UTC (rev 126)
+++ trunk/refman-4.1/extending-mysql.xml 2005-10-21 02:10:57 UTC (rev 127)
@@ -656,23 +656,6 @@
<title id="title-create-function">&title-create-function;</title>
- <remark role="todo">
- Note: 5.0.3 adds DECIMAL as a legal value after RETURNS, but
- </remark>
-
- <remark>
- currently it's implemented like a STRING function. So this will
- </remark>
-
- <remark>
- remain not documented explicitly until DECIMAL UDFs return a
- "real"
- </remark>
-
- <remark>
- decimal value...
- </remark>
-
<indexterm type="function">
<primary>CREATE FUNCTION</primary>
</indexterm>
@@ -2029,8 +2012,8 @@
<literal>xxx_deinit()</literal>,
<literal>xxx_reset()</literal>,
<literal>xxx_clear()</literal>, and
- <literal>xxx_add()</literal> functions. As of MySQL 4.0.24,
- 4.1.10a, and 5.0.3, <command>mysqld</command> supports an
+ <literal>xxx_add()</literal> functions. As of MySQL 4.0.24 and
+ 4.1.10a, <command>mysqld</command> supports an
<option>--allow-suspicious-udfs</option> option that controls
whether UDFs that have only an <literal>xxx</literal> symbol
can be loaded. By default, the option is off, to prevent
@@ -2051,8 +2034,8 @@
directories searched by the dynamic linker, MySQL checks the
shared object file name specified in <literal>CREATE
FUNCTION</literal> statements for pathname delimiter
- characters. As of MySQL 4.0.24, 4.1.10a, and 5.0.3, MySQL also
- checks for pathname delimiters in filenames stored in the
+ characters. As of MySQL 4.0.24 and 4.1.10a, MySQL also checks
+ for pathname delimiters in filenames stored in the
<literal>mysql.func</literal> table when it loads functions.
This prevents attempts at specifying illegitimate pathnames
through direct manipulation of the
Modified: trunk/refman-5.0/extending-mysql.xml
===================================================================
--- trunk/refman-5.0/extending-mysql.xml 2005-10-21 01:06:24 UTC (rev 126)
+++ trunk/refman-5.0/extending-mysql.xml 2005-10-21 02:10:57 UTC (rev 127)
@@ -183,25 +183,16 @@
</para>
<para>
- From MySQL 4.1 on, if you have a copy of
- <command>mysqld</command> running on the machine where you
- want to run the test suite you do not have to stop it, as long
- as it is not using ports <literal>9306</literal> and
- <literal>9307</literal>. If one of those ports is taken, you
- should edit <command>mysql-test-run</command> and change the
- values of the master and/or slave port to one that is
- available.
+ If you have a copy of <command>mysqld</command> running on the
+ machine where you want to run the test suite you do not have
+ to stop it, as long as it is not using ports
+ <literal>9306</literal> and <literal>9307</literal>. If one of
+ those ports is taken, you should edit
+ <command>mysql-test-run</command> and change the values of the
+ master and/or slave port to one that is available.
</para>
<para>
- Before MySQL 4.1, <command>mysql-test-run</command> does not
- try to run its own server by default but tries to use your
- currently running server. To override this and cause
- <command>mysql-test-run</command> to start its own server, run
- it with the <option>--local</option> option.
- </para>
-
- <para>
You can run one individual test case with
<literal>mysql-test/mysql-test-run test_name</literal>.
</para>
@@ -566,12 +557,9 @@
<para>
If you upgrade your MySQL distribution, you can continue to
use your previously installed UDFs, unless you upgrade to a
- newer version for which the UDF interface changes. (An
- incompatible change occurred in MySQL 4.1.1 for aggregate
- functions. A function named <literal>xxx_clear()</literal>
- must be defined rather than <literal>xxx_reset()</literal>.)
- For native functions, you must repeat your modifications each
- time you upgrade.
+ newer version for which the UDF interface changes. For native
+ functions, you must repeat your modifications each time you
+ upgrade.
</para>
</listitem>
@@ -658,21 +646,11 @@
<remark role="todo">
Note: 5.0.3 adds DECIMAL as a legal value after RETURNS, but
- </remark>
-
- <remark>
currently it's implemented like a STRING function. So this will
+ remain explicitly undocumented until DECIMAL UDFs return a
+ "real" decimal value...
</remark>
- <remark>
- remain not documented explicitly until DECIMAL UDFs return a
- "real"
- </remark>
-
- <remark>
- decimal value...
- </remark>
-
<indexterm type="function">
<primary>CREATE FUNCTION</primary>
</indexterm>
@@ -783,9 +761,8 @@
</para>
<para>
- <literal>AGGREGATE</literal> is a new option for MySQL 3.23. An
- <literal>AGGREGATE</literal> function works exactly like a
- native MySQL aggregate (summary) function such as
+ An <literal>AGGREGATE</literal> function works exactly like a
+ native MySQL aggregate (summary) function such as
<literal>SUM</literal> or <literal>COUNT()</literal>. For
<literal>AGGREGATE</literal> to work, your
<literal>mysql.func</literal> table must contain a
@@ -995,22 +972,11 @@
<listitem>
<para>
- <literal>xxx_reset()</literal> (required before 4.1.1)
+ <literal>xxx_clear()</literal> (required in
+ ¤t-series;)
</para>
<para>
- Reset the current aggregate value and insert the argument as
- the initial aggregate value for a new group.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>xxx_clear()</literal> (required starting from
- 4.1.1)
- </para>
-
- <para>
Reset the current aggregate value but do not insert the
argument as the initial aggregate value for a new group.
</para>
@@ -1296,20 +1262,18 @@
</programlisting>
<para>
- <literal>xxx_reset()</literal> is needed only before MySQL
- 4.1.1. It is <emphasis>not</emphasis> needed or used as of
- MySQL 4.1.1, when the UDF interface changed to use
+ <literal>xxx_reset()</literal> is not needed or used in
+ MySQL ¤t-series;, in which the UDF interface uses
<literal>xxx_clear()</literal> instead. However, you can
define both <literal>xxx_reset()</literal> and
<literal>xxx_clear()</literal> if you want to have your
- UDF work both before and after the interface change. (If
- you do include both functions, the
- <literal>xxx_reset()</literal> function in many cases can
- be implemented internally by calling
- <literal>xxx_clear()</literal> to reset all variables, and
- then calling <literal>xxx_add()</literal> to add the
- <literal>UDF_ARGS</literal> argument as the first value in
- the group.)
+ UDF work with older versions of the server. (If you do
+ include both functions, the <literal>xxx_reset()</literal>
+ function in many cases can be implemented internally by
+ calling <literal>xxx_clear()</literal> to reset all
+ variables, and then calling <literal>xxx_add()</literal>
+ to add the <literal>UDF_ARGS</literal> argument as the
+ first value in the group.)
</para>
</listitem>
@@ -1344,9 +1308,8 @@
</para>
<para>
- <literal>xxx_clear()</literal> is required only by MySQL
- 4.1.1 and above. Before MySQL 4.1.1, use
- <literal>xxx_reset()</literal> instead.
+ <literal>xxx_clear()</literal> is required by MySQL
+ ¤t-series;.
</para>
</listitem>
@@ -1711,16 +1674,9 @@
subsequent rows processed by the statement in which
<literal>XXX()</literal> was invoked.
(<literal>xxx()</literal> is not even called for subsequent
- rows.) <emphasis role="bold">Note</emphasis>: Before MySQL
- 3.22.10, you should set both <literal>*error</literal> and
- <literal>*is_null</literal>:
+ rows.)
</para>
-<programlisting>
-*error = 1;
-*is_null = 1;
-</programlisting>
-
</section>
<section id="udf-compiling">
@@ -1901,7 +1857,7 @@
<listitem>
<para>
You need to obtain the BitKeeper source repository for
- MySQL 4.0 or higher. See
+ MySQL ¤t-series;. See
<xref linkend="installing-source-tree"/>.
</para>
</listitem>
@@ -2029,9 +1985,9 @@
<literal>xxx_deinit()</literal>,
<literal>xxx_reset()</literal>,
<literal>xxx_clear()</literal>, and
- <literal>xxx_add()</literal> functions. As of MySQL 4.0.24,
- 4.1.10a, and 5.0.3, <command>mysqld</command> supports an
- <option>--allow-suspicious-udfs</option> option that controls
+ <literal>xxx_add()</literal> functions. As of MySQL 5.0.3,
+ <command>mysqld</command> supports an
+ <option>--allow-suspicious-udfs</option> option that controls
whether UDFs that have only an <literal>xxx</literal> symbol
can be loaded. By default, the option is off, to prevent
attempts at loading functions from shared object files other
@@ -2051,8 +2007,8 @@
directories searched by the dynamic linker, MySQL checks the
shared object file name specified in <literal>CREATE
FUNCTION</literal> statements for pathname delimiter
- characters. As of MySQL 4.0.24, 4.1.10a, and 5.0.3, MySQL also
- checks for pathname delimiters in filenames stored in the
+ characters. As of MySQL 5.0.3, MySQL also checks for pathname
+ delimiters in filenames stored in the
<literal>mysql.func</literal> table when it loads functions.
This prevents attempts at specifying illegitimate pathnames
through direct manipulation of the
@@ -2277,8 +2233,7 @@
</para>
<para>
- We have created an example procedure in MySQL 3.23 to show you
- what can be done.
+ We have created an example procedure to show you what can be done.
</para>
<para>
Modified: trunk/refman-5.0/installing.xml
===================================================================
--- trunk/refman-5.0/installing.xml 2005-10-21 01:06:24 UTC (rev 126)
+++ trunk/refman-5.0/installing.xml 2005-10-21 02:10:57 UTC (rev 127)
@@ -22,12 +22,6 @@
each major section needs intro about what's in section.
</remark>
- <remark role="todo">
- Change version number used in example filenames etc. to 5.0. release
- version after release (currently using 5.0.9-beta as a placeholder
- for these).
- </remark>
-
<para>
This chapter describes how to obtain and install MySQL:
</para>
Modified: trunk/refman-5.1/extending-mysql.xml
===================================================================
--- trunk/refman-5.1/extending-mysql.xml 2005-10-21 01:06:24 UTC (rev 126)
+++ trunk/refman-5.1/extending-mysql.xml 2005-10-21 02:10:57 UTC (rev 127)
@@ -183,8 +183,7 @@
</para>
<para>
- From MySQL 4.1 on, if you have a copy of
- <command>mysqld</command> running on the machine where you
+ If you have a copy of <command>mysqld</command> running on the machine where you
want to run the test suite you do not have to stop it, as long
as it is not using ports <literal>9306</literal> and
<literal>9307</literal>. If one of those ports is taken, you
@@ -194,14 +193,6 @@
</para>
<para>
- Before MySQL 4.1, <command>mysql-test-run</command> does not
- try to run its own server by default but tries to use your
- currently running server. To override this and cause
- <command>mysql-test-run</command> to start its own server, run
- it with the <option>--local</option> option.
- </para>
-
- <para>
You can run one individual test case with
<literal>mysql-test/mysql-test-run test_name</literal>.
</para>
@@ -566,12 +557,9 @@
<para>
If you upgrade your MySQL distribution, you can continue to
use your previously installed UDFs, unless you upgrade to a
- newer version for which the UDF interface changes. (An
- incompatible change occurred in MySQL 4.1.1 for aggregate
- functions. A function named <literal>xxx_clear()</literal>
- must be defined rather than <literal>xxx_reset()</literal>.)
- For native functions, you must repeat your modifications each
- time you upgrade.
+ newer version for which the UDF interface changes. For native
+ functions, you must repeat your modifications each time you
+ upgrade.
</para>
</listitem>
@@ -658,21 +646,11 @@
<remark role="todo">
Note: 5.0.3 adds DECIMAL as a legal value after RETURNS, but
- </remark>
-
- <remark>
currently it's implemented like a STRING function. So this will
+ remain explicitly undocumented until DECIMAL UDFs return a
+ "real" decimal value...
</remark>
- <remark>
- remain not documented explicitly until DECIMAL UDFs return a
- "real"
- </remark>
-
- <remark>
- decimal value...
- </remark>
-
<indexterm type="function">
<primary>CREATE FUNCTION</primary>
</indexterm>
@@ -783,8 +761,7 @@
</para>
<para>
- <literal>AGGREGATE</literal> is a new option for MySQL 3.23. An
- <literal>AGGREGATE</literal> function works exactly like a
+ An <literal>AGGREGATE</literal> function works exactly like a
native MySQL aggregate (summary) function such as
<literal>SUM</literal> or <literal>COUNT()</literal>. For
<literal>AGGREGATE</literal> to work, your
@@ -995,22 +972,11 @@
<listitem>
<para>
- <literal>xxx_reset()</literal> (required before 4.1.1)
+ <literal>xxx_clear()</literal> (required in
+ ¤t-series;)
</para>
<para>
- Reset the current aggregate value and insert the argument as
- the initial aggregate value for a new group.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>xxx_clear()</literal> (required starting from
- 4.1.1)
- </para>
-
- <para>
Reset the current aggregate value but do not insert the
argument as the initial aggregate value for a new group.
</para>
@@ -1296,15 +1262,13 @@
</programlisting>
<para>
- <literal>xxx_reset()</literal> is needed only before MySQL
- 4.1.1. It is <emphasis>not</emphasis> needed or used as of
- MySQL 4.1.1, when the UDF interface changed to use
+ <literal>xxx_reset()</literal> is not needed or used in
+ MySQL ¤t-series;, in which the UDF interface uses
<literal>xxx_clear()</literal> instead. However, you can
define both <literal>xxx_reset()</literal> and
<literal>xxx_clear()</literal> if you want to have your
- UDF work both before and after the interface change. (If
- you do include both functions, the
- <literal>xxx_reset()</literal> function in many cases can
+ UDF work with older versions of the server. (If you do
+ include both functions, the <literal>xxx_reset()</literal> function in many cases can
be implemented internally by calling
<literal>xxx_clear()</literal> to reset all variables, and
then calling <literal>xxx_add()</literal> to add the
@@ -1344,9 +1308,8 @@
</para>
<para>
- <literal>xxx_clear()</literal> is required only by MySQL
- 4.1.1 and above. Before MySQL 4.1.1, use
- <literal>xxx_reset()</literal> instead.
+ <literal>xxx_clear()</literal> is required by MySQL
+ ¤t-series;.
</para>
</listitem>
@@ -1711,18 +1674,10 @@
subsequent rows processed by the statement in which
<literal>XXX()</literal> was invoked.
(<literal>xxx()</literal> is not even called for subsequent
- rows.) <emphasis role="bold">Note</emphasis>: Before MySQL
- 3.22.10, you should set both <literal>*error</literal> and
- <literal>*is_null</literal>:
- </para>
+ rows.) </para>
-<programlisting>
-*error = 1;
-*is_null = 1;
-</programlisting>
+</section>
- </section>
-
<section id="udf-compiling">
<title id="title-udf-compiling">&title-udf-compiling;</title>
@@ -1901,7 +1856,7 @@
<listitem>
<para>
You need to obtain the BitKeeper source repository for
- MySQL 4.0 or higher. See
+ MySQL ¤t-series;. See
<xref linkend="installing-source-tree"/>.
</para>
</listitem>
@@ -2029,8 +1984,8 @@
<literal>xxx_deinit()</literal>,
<literal>xxx_reset()</literal>,
<literal>xxx_clear()</literal>, and
- <literal>xxx_add()</literal> functions. As of MySQL 4.0.24,
- 4.1.10a, and 5.0.3, <command>mysqld</command> supports an
+ <literal>xxx_add()</literal> functions. In MySQL
+ ¤t-series;, <command>mysqld</command> also supports an
<option>--allow-suspicious-udfs</option> option that controls
whether UDFs that have only an <literal>xxx</literal> symbol
can be loaded. By default, the option is off, to prevent
@@ -2048,14 +2003,12 @@
They must be located in some system directory that the dynamic
linker is configured to search. To enforce this restriction
and prevent attempts at specifying pathnames outside of
- directories searched by the dynamic linker, MySQL checks the
- shared object file name specified in <literal>CREATE
- FUNCTION</literal> statements for pathname delimiter
- characters. As of MySQL 4.0.24, 4.1.10a, and 5.0.3, MySQL also
- checks for pathname delimiters in filenames stored in the
- <literal>mysql.func</literal> table when it loads functions.
- This prevents attempts at specifying illegitimate pathnames
- through direct manipulation of the
+ directories searched by the dynamic linker, MySQL ¤t-series;
+ checks the shared object file name specified in <literal>CREATE
+ FUNCTION</literal> as well as for pathname delimiters in
+ filenames stored in the <literal>mysql.func</literal> table when
+ it loads functions. This prevents attempts at specifying
+ illegitimate pathnames through direct manipulation of the
<literal>mysql.func</literal> table. For information about
UDFs and the runtime linker, see
<xref linkend="udf-compiling"/>.
@@ -2277,8 +2230,7 @@
</para>
<para>
- We have created an example procedure in MySQL 3.23 to show you
- what can be done.
+ We have created an example procedure to show you what can be done.
</para>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r127 - in trunk: refman-4.1 refman-5.0 refman-5.1 | jstephens | 21 Oct |
