Author: plavin
Date: 2007-03-12 15:57:16 +0100 (Mon, 12 Mar 2007)
New Revision: 5304
Log:
Update to match new DTD
Modified:
trunk/dynamic-docs/opsfunctions/opfunctions.xml
Modified: trunk/dynamic-docs/opsfunctions/opfunctions.xml
===================================================================
--- trunk/dynamic-docs/opsfunctions/opfunctions.xml 2007-03-12 13:45:24 UTC (rev 5303)
+++ trunk/dynamic-docs/opsfunctions/opfunctions.xml 2007-03-12 14:57:16 UTC (rev 5304)
Changed blocks: 31, Lines Added: 56, Lines Deleted: 48; 14944 bytes
@@ -370,7 +370,8 @@
<display>ExtractValue</display>
<description lang="en">Extracts a value from an XML string using XPath notation</description>
<arguments>
- <format><![CDATA[ExtractValue(xml_frag, xml_path)]]></format>
+ <format><![CDATA[<replaceable>xml_frag</replaceable>,
+ <replaceable>xml_path</replaceable>]]></format>
<argument seq="1" name="xml_frag" type="string">XML fragment</argument>
<argument seq="2" name="xml_path" type="string">XPath
specification</argument>
@@ -388,7 +389,7 @@
<display>CAST</display>
<description lang="en">Cast a value as a certain type</description>
<arguments>
- <format><![CDATA[CAST(<replaceable>expr</replaceable> AS
+ <format><![CDATA[<replaceable>expr</replaceable> AS
<replaceable>type</replaceable>]]></format>
<argument seq="1" name="expr" type="string">Value to cast</argument>
<argument seq="2" name="type" type="string">Datatype to cast
@@ -407,7 +408,7 @@
<display>ABS</display>
<description lang="en">Return the absolute value</description>
<arguments>
- <format><![CDATA[ABS(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="value"/>
@@ -423,7 +424,7 @@
<display>ACOS</display>
<description lang="en">Return the arc cosine</description>
<arguments>
- <format><![CDATA[ACOS(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="value"/>
@@ -439,7 +440,7 @@
<display>ASIN</display>
<description lang="en">Return the arc sine</description>
<arguments>
- <format><![CDATA[ASIN(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="value"/>
@@ -455,7 +456,7 @@
<display>ATAN</display>
<description lang="en">Return the arc tangent</description>
<arguments>
- <format><![CDATA[ATAN(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="value"/>
@@ -471,8 +472,7 @@
<display>ATAN</display>
<description lang="en">Returns the arc tangent of the two arguments</description>
<arguments>
- <format><![CDATA[ATAN2(<replaceable>Y</replaceable>,<replaceable>X</replaceable>)]]></format>
- <format><![CDATA[ATAN(<replaceable>Y</replaceable>,<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>Y</replaceable>,<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
<argument seq="2" name="expr" type="numeric"></argument>
</arguments>
@@ -491,10 +491,10 @@
<display>CEIL</display>
<description lang="en">Return the smallest integer value of the argument passed</description>
<arguments>
- <format><![CDATA[CEILING(<replaceable>X</replaceable>)]]></format>
- <format><![CDATA[CEIL(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
+
<return type="value"/>
<error type="return"/>
<versions>
@@ -508,7 +508,7 @@
<display>COS</display>
<description lang="en">Return the cosine</description>
<arguments>
- <format><![CDATA[COS(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="value"/>
@@ -524,7 +524,7 @@
<display>COT</display>
<description lang="en">Return the cotangent</description>
<arguments>
- <format><![CDATA[COT(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="value"/>
@@ -540,7 +540,7 @@
<display>CRC32</display>
<description lang="en">Compute a cyclic redundancy check value</description>
<arguments>
- <format><![CDATA[CRC32(<replaceable>expr</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>expr</replaceable>]]></format>
<argument seq="1" name="expr" type="string"></argument>
</arguments>
<return type="value"/>
@@ -556,7 +556,7 @@
<display>DEGREES</display>
<description lang="en">Convert radians to degrees</description>
<arguments>
- <format><![CDATA[DEGREES(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric">Radians</argument>
</arguments>
<return type="value"/>
@@ -573,7 +573,7 @@
<display>EXP</display>
<description lang="en">Raise to the power of</description>
<arguments>
- <format><![CDATA[EXP(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="numeric"/>
@@ -589,7 +589,7 @@
<display>FROM_DAYS</display>
<description lang="en">Convert number to date</description>
<arguments>
- <format><![CDATA[FROM_DAYS(<replaceable>N</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>N</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="date"/>
@@ -605,7 +605,7 @@
<display>FLOOR</display>
<description lang="en">Round up to the nearest integer</description>
<arguments>
- <format><![CDATA[FLOOR(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="value"/>
@@ -621,7 +621,7 @@
<display>LN</display>
<description lang="en">Return the natural logarithm of the argument</description>
<arguments>
- <format><![CDATA[LN(<replaceable>X</replaceable>)<]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="numeric"/>
@@ -640,11 +640,15 @@
The second argument specifies the base.
</description>
<arguments>
- <format><![CDATA[LOG(<replaceable>B</replaceable>)]]></format>
- <format><![CDATA[LOG(<replaceable>B</replaceable>,<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>B</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
+ </arguments>
+ <arguments>
+ <format><![CDATA[<replaceable>B</replaceable>,<replaceable>X</replaceable>]]></format>
+ <argument seq="1" name="expr" type="numeric"></argument>
<argument seq="2" name="expr" type="numeric">Base</argument>
</arguments>
+
<return type="value"/>
<error type="return"/>
<versions>
@@ -658,7 +662,7 @@
<display>LOG2</display>
<description lang="en">Return the base-2 logarithm of the argument</description>
<arguments>
- <format><![CDATA[LOG2(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="numeric"/>
@@ -674,7 +678,7 @@
<display>LOG10</display>
<description lang="en">Return the base-10 logarithm of the argument</description>
<arguments>
- <format><![CDATA[LOG10(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="numeric"/>
@@ -690,7 +694,7 @@
<display>MOD</display>
<description lang="en">Return the modulus</description>
<arguments>
- <format><![CDATA[MOD(<replaceable>N</replaceable>,<replaceable>M</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>N</replaceable>,<replaceable>M</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric">Dividend</argument>
<argument seq="2" name="expr" type="numeric">Divisor</argument>
</arguments>
@@ -707,7 +711,7 @@
<display>PI</display>
<description lang="en">Return the value of pi</description>
<arguments>
- <format><![CDATA[PI()]]></format>
+ <format></format>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -722,8 +726,7 @@
<display>POW, POWER</display>
<description lang="en">Return the argument raised to the specified power</description>
<arguments>
- <format><![CDATA[POW(<replaceable>X</replaceable>,<replaceable>Y</replaceable>)]]></format>
- <format><![CDATA[POWER(<replaceable>X</replaceable>,<replaceable>Y</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>,<replaceable>Y</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
@@ -740,7 +743,7 @@
<display>RADIANS</display>
<description lang="en">Return argument converted to radians</description>
<arguments>
- <format><![CDATA[RADIANS(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric">Degrees</argument>
</arguments>
<return type="numeric"/>
@@ -756,7 +759,7 @@
<display>RAND</display>
<description lang="en">Returns a random floating-point value</description>
<arguments>
- <format><![CDATA[RAND(<replaceable>N</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>N</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric">Seed value</argument>
</arguments>
<return type="numeric"/>
@@ -772,11 +775,14 @@
<display>ROUND</display>
<description lang="en">Round the argument</description>
<arguments>
- <format><![CDATA[ROUND(<replaceable>X</replaceable>)]]></format>
- <format><![CDATA[ROUND(<replaceable>X</replaceable>,<replaceable>D</replaceable>)]]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
+ <argument seq="1" name="expr" type="numeric"></argument>
+ </arguments>
+ <arguments>
+ <format><![CDATA[<replaceable>X</replaceable>,<replaceable>D</replaceable>]]></format>
<argument seq="2" name="expr" type="numeric">Number of decimal places</argument>
</arguments>
+
<return type="numeric"/>
<error type="return"/>
<versions>
@@ -787,10 +793,10 @@
</function>
<function id="sign" class="mathematical">
- <display></display>
+ <display>SIGN</display>
<description lang="en">Return the sign of the argument</description>
<arguments>
- <format><![CDATA[SIGN(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="numeric"/>
@@ -806,7 +812,7 @@
<display>SIN</display>
<description lang="en"></description>
<arguments>
- <format><![CDATA[SIN(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric">Radians</argument>
</arguments>
<return type="numeric"/>
@@ -819,10 +825,10 @@
</function>
<function id="sqrt" class="mathematical">
- <display></display>
+ <display>SQRT</display>
<description lang="en">Return the square root of the argument</description>
<arguments>
- <format><![CDATA[SQRT(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="numeric"/>
@@ -838,7 +844,7 @@
<display>TAN</display>
<description lang="en">Return the tangent of the argument</description>
<arguments>
- <format><![CDATA[TAN(<replaceable>X</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric">Radians</argument>
</arguments>
<return type="numeric"/>
@@ -851,10 +857,10 @@
</function>
<function id="truncate" class="">
- <display></display>
+ <display>TRUNCATE</display>
<description lang="en">Truncate to specified number of decimal places</description>
<arguments>
- <format><![CDATA[TRUNCATE(<replaceable>X</replaceable>,<replaceable>D</replaceable>)]]></format>
+ <format><![CDATA[<replaceable>X</replaceable>,<replaceable>D</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
<argument seq="1" name="expr" type="numeric">Number of decimal places</argument>
</arguments>
@@ -868,19 +874,21 @@
</function>
<function id="adddate" class="date-time">
- <display></display>
+ <display>ADDDATE</display>
<description lang="en"></description>
<arguments>
- <format><![CDATA[ADDDATE(<replaceable>date</replaceable>,INTERVAL
- <replaceable>expr</replaceable>
- <replaceable>unit</replaceable>)]]></format>
- <argument seq="1" name="expr" type="numeric">date</argument>
+ <format><![CDATA[
+ <replaceable>date</replaceable>,INTERVAL
+ <replaceable>expr</replaceable>
+ <replaceable>unit</replaceable>]]>
+ </format>
+ <argument seq="1" name="expr" type="numeric">date</argument>
<argument seq="2" name="expr" type="numeric">INTERVAL number unit</argument>
- </arguments>
+ </arguments>
<arguments>
- <format><![CDATA[ADDDATE(<replaceable>expr</replaceable>,<replaceable>days</replaceable>)]]></format>
- <argument seq="1" name="expr" type="date">date</argument>
- <argument seq="2" name="expr" type="date">days</argument>
+ <format><![CDATA[<replaceable>expr</replaceable>,<replaceable>days</replaceable>]]></format>
+ <argument seq="1" name="expr" type="date">date</argument>
+ <argument seq="2" name="expr" type="date">days</argument>
</arguments>
<return type="date"/>
<error type="return"/>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5304 - trunk/dynamic-docs/opsfunctions | plavin | 12 Mar |
