Author: paul
Date: 2005-12-16 01:02:22 +0100 (Fri, 16 Dec 2005)
New Revision: 572
Log:
r4807@frost: paul | 2005-12-15 16:23:48 -0600
Split CREATE FUNCTION/DROP FUNCTION into two sections
and bifurcate the help markup to make it more specific.
Modified:
trunk/
trunk/refman-4.1/extending-mysql.xml
trunk/refman-5.0/extending-mysql.xml
trunk/refman-5.1/extending-mysql.xml
trunk/refman-common/titles.en.ent
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:4806
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1671
+ b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:4807
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1671
Modified: trunk/refman-4.1/extending-mysql.xml
===================================================================
--- trunk/refman-4.1/extending-mysql.xml 2005-12-16 00:02:11 UTC (rev 571)
+++ trunk/refman-4.1/extending-mysql.xml 2005-12-16 00:02:22 UTC (rev 572)
@@ -657,18 +657,14 @@
<primary>CREATE FUNCTION</primary>
</indexterm>
- <indexterm type="function">
- <primary>DROP FUNCTION</primary>
- </indexterm>
-
<indexterm>
- <primary>deleting</primary>
+ <primary>creating</primary>
<secondary>function</secondary>
</indexterm>
<indexterm>
<primary>function</primary>
- <secondary>deleting</secondary>
+ <secondary>creating</secondary>
</indexterm>
<indexterm type="function">
@@ -684,20 +680,17 @@
<secondary>user-defined</secondary>
</indexterm>
- <remark role="help-topic" condition="FUNCTION"/>
+ <remark role="help-topic" condition="CREATE FUNCTION"/>
<remark role="help-keywords">
- AGGREGATE CREATE FUNCTION DROP STRING REAL INTEGER RETURNS
- SONAME
+ AGGREGATE CREATE FUNCTION STRING REAL INTEGER RETURNS SONAME
</remark>
<remark role="help-syntax-begin"/>
<programlisting>
CREATE [AGGREGATE] FUNCTION <replaceable>function_name</replaceable> RETURNS {STRING|INTEGER|REAL}
- SONAME <replaceable>shared_library_name</replaceable>
-
-DROP FUNCTION <replaceable>function_name</replaceable>
+ SONAME <replaceable>shared_library_name</replaceable>
</programlisting>
<remark role="help-syntax-end"/>
@@ -724,14 +717,11 @@
<para>
To create a function, you must have the
<literal>INSERT</literal> and privilege for the
- <literal>mysql</literal> database. To drop a function, you must
- have the <literal>DELETE</literal> privilege for the
<literal>mysql</literal> database. This is because
<literal>CREATE FUNCTION</literal> adds a row to the
<literal>mysql.func</literal> system table that records the
- function's name, type, and shared library name, and
- <literal>DROP FUNCTION</literal> deletes the function's row from
- that table. If you do not have this table, you should run the
+ function's name, type, and shared library name. If you do not
+ have this table, you should run the
<command>mysql_fix_privilege_tables</command> script to create
it. See <xref linkend="upgrading-grant-tables"/>.
</para>
@@ -771,6 +761,70 @@
</section>
+ <section id="drop-function">
+
+ <title>&title-drop-function;</title>
+
+ <indexterm type="function">
+ <primary>DROP FUNCTION</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>deleting</primary>
+ <secondary>function</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>function</primary>
+ <secondary>deleting</secondary>
+ </indexterm>
+
+ <indexterm type="function">
+ <primary>UDFs</primary>
+ </indexterm>
+
+ <indexterm type="function">
+ <primary>User-defined functions</primary>
+ </indexterm>
+
+ <indexterm type="function">
+ <primary>Functions</primary>
+ <secondary>user-defined</secondary>
+ </indexterm>
+
+ <remark role="help-topic" condition="DROP FUNCTION"/>
+
+ <remark role="help-keywords">
+ DROP FUNCTION
+ </remark>
+
+ <remark role="help-syntax-begin"/>
+
+<programlisting>
+DROP FUNCTION <replaceable>function_name</replaceable>
+</programlisting>
+
+ <remark role="help-syntax-end"/>
+
+ <remark role="help-description-begin"/>
+
+ <para>
+ This statement drops the user-defined function (UDF) named
+ <replaceable>function_name</replaceable>.
+ </para>
+
+ <para>
+ To drop a function, you must have the <literal>DELETE</literal>
+ privilege for the <literal>mysql</literal> database. This is
+ because <literal>DROP FUNCTION</literal> removes a row from the
+ <literal>mysql.func</literal> system table that records the
+ function's name, type, and shared library name.
+ </para>
+
+ <remark role="help-description-end"/>
+
+ </section>
+
<section id="adding-udf">
<title id="title-adding-udf">&title-adding-udf;</title>
Modified: trunk/refman-5.0/extending-mysql.xml
===================================================================
--- trunk/refman-5.0/extending-mysql.xml 2005-12-16 00:02:11 UTC (rev 571)
+++ trunk/refman-5.0/extending-mysql.xml 2005-12-16 00:02:22 UTC (rev 572)
@@ -652,18 +652,14 @@
<primary>CREATE FUNCTION</primary>
</indexterm>
- <indexterm type="function">
- <primary>DROP FUNCTION</primary>
- </indexterm>
-
<indexterm>
- <primary>deleting</primary>
+ <primary>creating</primary>
<secondary>function</secondary>
</indexterm>
<indexterm>
<primary>function</primary>
- <secondary>deleting</secondary>
+ <secondary>creating</secondary>
</indexterm>
<indexterm type="function">
@@ -679,20 +675,17 @@
<secondary>user-defined</secondary>
</indexterm>
- <remark role="help-topic" condition="FUNCTION"/>
+ <remark role="help-topic" condition="CREATE FUNCTION"/>
<remark role="help-keywords">
- AGGREGATE CREATE FUNCTION DROP STRING REAL INTEGER RETURNS
- SONAME
+ AGGREGATE CREATE FUNCTION STRING REAL INTEGER DECIMAL RETURNS SONAME
</remark>
<remark role="help-syntax-begin"/>
<programlisting>
CREATE [AGGREGATE] FUNCTION <replaceable>function_name</replaceable> RETURNS {STRING|INTEGER|REAL|DECIMAL}
- SONAME <replaceable>shared_library_name</replaceable>
-
-DROP FUNCTION <replaceable>function_name</replaceable>
+ SONAME <replaceable>shared_library_name</replaceable>
</programlisting>
<remark role="help-syntax-end"/>
@@ -726,14 +719,11 @@
<para>
To create a function, you must have the
<literal>INSERT</literal> and privilege for the
- <literal>mysql</literal> database. To drop a function, you must
- have the <literal>DELETE</literal> privilege for the
<literal>mysql</literal> database. This is because
<literal>CREATE FUNCTION</literal> adds a row to the
<literal>mysql.func</literal> system table that records the
- function's name, type, and shared library name, and
- <literal>DROP FUNCTION</literal> deletes the function's row from
- that table. If you do not have this table, you should run the
+ function's name, type, and shared library name. If you do not
+ have this table, you should run the
<command>mysql_fix_privilege_tables</command> script to create
it. See <xref linkend="upgrading-grant-tables"/>.
</para>
@@ -772,6 +762,70 @@
</section>
+ <section id="drop-function">
+
+ <title>&title-drop-function;</title>
+
+ <indexterm type="function">
+ <primary>DROP FUNCTION</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>deleting</primary>
+ <secondary>function</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>function</primary>
+ <secondary>deleting</secondary>
+ </indexterm>
+
+ <indexterm type="function">
+ <primary>UDFs</primary>
+ </indexterm>
+
+ <indexterm type="function">
+ <primary>User-defined functions</primary>
+ </indexterm>
+
+ <indexterm type="function">
+ <primary>Functions</primary>
+ <secondary>user-defined</secondary>
+ </indexterm>
+
+ <remark role="help-topic" condition="DROP FUNCTION"/>
+
+ <remark role="help-keywords">
+ DROP FUNCTION
+ </remark>
+
+ <remark role="help-syntax-begin"/>
+
+<programlisting>
+DROP FUNCTION <replaceable>function_name</replaceable>
+</programlisting>
+
+ <remark role="help-syntax-end"/>
+
+ <remark role="help-description-begin"/>
+
+ <para>
+ This statement drops the user-defined function (UDF) named
+ <replaceable>function_name</replaceable>.
+ </para>
+
+ <para>
+ To drop a function, you must have the <literal>DELETE</literal>
+ privilege for the <literal>mysql</literal> database. This is
+ because <literal>DROP FUNCTION</literal> removes a row from the
+ <literal>mysql.func</literal> system table that records the
+ function's name, type, and shared library name.
+ </para>
+
+ <remark role="help-description-end"/>
+
+ </section>
+
<section id="adding-udf">
<title id="title-adding-udf">&title-adding-udf;</title>
Modified: trunk/refman-5.1/extending-mysql.xml
===================================================================
--- trunk/refman-5.1/extending-mysql.xml 2005-12-16 00:02:11 UTC (rev 571)
+++ trunk/refman-5.1/extending-mysql.xml 2005-12-16 00:02:22 UTC (rev 572)
@@ -911,18 +911,14 @@
<primary>CREATE FUNCTION</primary>
</indexterm>
- <indexterm type="function">
- <primary>DROP FUNCTION</primary>
- </indexterm>
-
<indexterm>
- <primary>deleting</primary>
+ <primary>creating</primary>
<secondary>function</secondary>
</indexterm>
<indexterm>
<primary>function</primary>
- <secondary>deleting</secondary>
+ <secondary>creating</secondary>
</indexterm>
<indexterm type="function">
@@ -938,20 +934,17 @@
<secondary>user-defined</secondary>
</indexterm>
- <remark role="help-topic" condition="FUNCTION"/>
+ <remark role="help-topic" condition="CREATE FUNCTION"/>
<remark role="help-keywords">
- AGGREGATE CREATE FUNCTION DROP STRING REAL INTEGER RETURNS
- SONAME
+ AGGREGATE CREATE FUNCTION STRING REAL INTEGER DECIMAL RETURNS SONAME
</remark>
<remark role="help-syntax-begin"/>
<programlisting>
CREATE [AGGREGATE] FUNCTION <replaceable>function_name</replaceable> RETURNS {STRING|INTEGER|REAL|DECIMAL}
- SONAME <replaceable>shared_library_name</replaceable>
-
-DROP FUNCTION <replaceable>function_name</replaceable>
+ SONAME <replaceable>shared_library_name</replaceable>
</programlisting>
<remark role="help-syntax-end"/>
@@ -989,14 +982,11 @@
<para>
To create a function, you must have the
<literal>INSERT</literal> and privilege for the
- <literal>mysql</literal> database. To drop a function, you must
- have the <literal>DELETE</literal> privilege for the
<literal>mysql</literal> database. This is because
<literal>CREATE FUNCTION</literal> adds a row to the
<literal>mysql.func</literal> system table that records the
- function's name, type, and shared library name, and
- <literal>DROP FUNCTION</literal> deletes the function's row from
- that table. If you do not have this table, you should run the
+ function's name, type, and shared library name. If you do not
+ have this table, you should run the
<command>mysql_fix_privilege_tables</command> script to create
it. See <xref linkend="upgrading-grant-tables"/>.
</para>
@@ -1035,6 +1025,70 @@
</section>
+ <section id="drop-function">
+
+ <title>&title-drop-function;</title>
+
+ <indexterm type="function">
+ <primary>DROP FUNCTION</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>deleting</primary>
+ <secondary>function</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>function</primary>
+ <secondary>deleting</secondary>
+ </indexterm>
+
+ <indexterm type="function">
+ <primary>UDFs</primary>
+ </indexterm>
+
+ <indexterm type="function">
+ <primary>User-defined functions</primary>
+ </indexterm>
+
+ <indexterm type="function">
+ <primary>Functions</primary>
+ <secondary>user-defined</secondary>
+ </indexterm>
+
+ <remark role="help-topic" condition="DROP FUNCTION"/>
+
+ <remark role="help-keywords">
+ DROP FUNCTION
+ </remark>
+
+ <remark role="help-syntax-begin"/>
+
+<programlisting>
+DROP FUNCTION <replaceable>function_name</replaceable>
+</programlisting>
+
+ <remark role="help-syntax-end"/>
+
+ <remark role="help-description-begin"/>
+
+ <para>
+ This statement drops the user-defined function (UDF) named
+ <replaceable>function_name</replaceable>.
+ </para>
+
+ <para>
+ To drop a function, you must have the <literal>DELETE</literal>
+ privilege for the <literal>mysql</literal> database. This is
+ because <literal>DROP FUNCTION</literal> removes a row from the
+ <literal>mysql.func</literal> system table that records the
+ function's name, type, and shared library name.
+ </para>
+
+ <remark role="help-description-end"/>
+
+ </section>
+
<section id="adding-udf">
<title id="title-adding-udf">&title-adding-udf;</title>
Modified: trunk/refman-common/titles.en.ent
===================================================================
--- trunk/refman-common/titles.en.ent 2005-12-16 00:02:11 UTC (rev 571)
+++ trunk/refman-common/titles.en.ent 2005-12-16 00:02:22 UTC (rev 572)
@@ -264,7 +264,7 @@
<!ENTITY title-crash-recovery "Using <command>myisamchk</command> for Crash Recovery">
<!ENTITY title-crashing "What to Do If MySQL Keeps Crashing">
<!ENTITY title-create-database "<literal>CREATE DATABASE</literal> Syntax">
-<!ENTITY title-create-function "<literal>CREATE FUNCTION/DROP FUNCTION</literal> Syntax">
+<!ENTITY title-create-function "<literal>CREATE FUNCTION</literal> Syntax">
<!ENTITY title-create-index "<literal>CREATE INDEX</literal> Syntax">
<!ENTITY title-create-procedure "<literal>CREATE PROCEDURE</literal> and <literal>CREATE FUNCTION</literal>">
<!ENTITY title-create-table "<literal>CREATE TABLE</literal> Syntax">
@@ -328,6 +328,7 @@
<!ENTITY title-downgrading-to-4-1 "Downgrading to 4.1">
<!ENTITY title-driver-manager "ODBC Driver Managers">
<!ENTITY title-drop-database "<literal>DROP DATABASE</literal> Syntax">
+<!ENTITY title-drop-function "<literal>DROP FUNCTION</literal> Syntax">
<!ENTITY title-drop-index "<literal>DROP INDEX</literal> Syntax">
<!ENTITY title-drop-procedure "<literal>DROP PROCEDURE</literal> and <literal>DROP FUNCTION</literal>">
<!ENTITY title-drop-table "<literal>DROP TABLE</literal> Syntax">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r572 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-common | paul | 16 Dec |
