Author: plavin
Date: 2007-03-16 22:20:22 +0100 (Fri, 16 Mar 2007)
New Revision: 5426
Log:
More corrections
Modified:
trunk/dynamic-docs/opsfunctions/opfunctions.xml
Modified: trunk/dynamic-docs/opsfunctions/opfunctions.xml
===================================================================
--- trunk/dynamic-docs/opsfunctions/opfunctions.xml 2007-03-16 19:17:24 UTC (rev 5425)
+++ trunk/dynamic-docs/opsfunctions/opfunctions.xml 2007-03-16 21:20:22 UTC (rev 5426)
Changed blocks: 86, Lines Added: 149, Lines Deleted: 208; 37996 bytes
@@ -894,7 +894,7 @@
</function>
- <function id="convert_tz" class="datetime">
+ <function id="convert-tz" class="datetime">
<display>CONVERT_TZ()</display>
<description lang="en">Convert from one timezone to another</description>
<arguments>
@@ -929,7 +929,7 @@
</function>
- <function id="current_date" class="datetime">
+ <function id="current-date" class="datetime">
<display>CURRENT_DATE()</display>
<display>CURRENT_DATE</display>
<description lang="en">Synonyms for CURDATE()</description>
@@ -963,7 +963,7 @@
</function>
- <function id="current_time" class="datetime">
+ <function id="current-time" class="datetime">
<display>CURRENT_TIME()</display>
<display>CURRENT_TIME</display>
<description lang="en">Synonyms for CURTIME()</description>
@@ -980,7 +980,7 @@
</versions>
</function>
- <function id="current_timestamp" class="datetime">
+ <function id="current-timestamp" class="datetime">
<display>CURRENT_TIMESTAMP()</display>
<display>CURRENT_TIMESTAMP</display>
<description lang="en">Synonyms for NOW()</description>
@@ -1037,9 +1037,9 @@
<format><![CDATA[<replaceable>date</replaceable>,INTERVAL
<replaceable>expr</replaceable>
<replaceable>unit</replaceable>]]></format>
- <argument seq="1" name="expr" type="date">Starting date</argument>
+ <argument seq="1" name="expr" type="date">Date</argument>
<argument seq="2" name="expr" type="numeric">Amount to be added</argument>
- <argument seq="3" name="expr" type="string">Units</argument>
+ <argument seq="3" name="expr" type="string">Unit</argument>
</arguments>
<return type="date"/>
<error type="return"/>
@@ -1058,9 +1058,9 @@
<format><![CDATA[<replaceable>date</replaceable>,INTERVAL
<replaceable>expr</replaceable>
<replaceable>unit</replaceable>]]></format>
- <argument seq="1" name="expr" type="date">Starting date</argument>
- <argument seq="2" name="expr" type="numeric">Amount to be added</argument>
- <argument seq="3" name="expr" type="string">Units</argument>
+ <argument seq="1" name="expr" type="date">Date</argument>
+ <argument seq="2" name="expr" type="numeric">Amount to be subtracted</argument>
+ <argument seq="3" name="expr" type="string">Unit</argument>
</arguments>
<return type="date"/>
<error type="return"/>
@@ -1071,7 +1071,7 @@
</versions>
</function>
- <function id="date_format" class="datetime">
+ <function id="date-format" class="datetime">
<display>DATE_FORMAT()</display>
<description lang="en">Format date as specified</description>
<arguments>
@@ -1087,25 +1087,7 @@
<manual version="5.1"/>
</versions>
</function>
-
- <function id="date_sub" class="datetime">
- <display>DATE_SUB()</display>
- <description lang="en">Subtract dates</description>
- <arguments>
- <format><![CDATA[<replaceable>date</replaceable>,INTERVAL
- <replaceable>expr</replaceable]]></format>
- <argument seq="1" name="expr" type="numeric">Date</argument>
- <argument seq="2" name="expr" type="numeric">Interval specifier</argument>
- </arguments>
- <return type="date"/>
- <error type="return"/>
- <versions>
- <manual version="4.1"/>
- <manual version="5.0"/>
- <manual version="5.1"/>
- </versions>
- </function>
-
+
<function id="day" class="">
<display>DAY()</display>
<description lang="en">Synonym for DAYOFMONTH()</description>
@@ -1122,9 +1104,9 @@
</versions>
</function>
- <function id="day_name" class="datetime">
+ <function id="day-name" class="datetime">
<display>DAY_NAME()</display>
- <description lang="en">Returns the name of the weekday</description>
+ <description lang="en">Return the name of the weekday</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
<argument seq="1" name="expr" type="date"></argument>
@@ -1140,7 +1122,7 @@
<function id="dayofmonth" class="datetime">
<display>DAYOFMONTH()</display>
- <description lang="en">Returns the day of the month (1-31)</description>
+ <description lang="en">Return the day of the month (1-31)</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
@@ -1156,7 +1138,7 @@
<function id="dayofweek" class="datetime">
<display>DAYOFWEEK()</display>
- <description lang="en">Returns the weekday index of the argument</description>
+ <description lang="en">Return the weekday index of the argument</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
<argument seq="1" name="expr" type="date"></argument>
@@ -1172,7 +1154,7 @@
<function id="dayofyear" class="datetime">
<display>DAYOFYEAR()</display>
- <description lang="en">Returns the day of the year (1-366)</description>
+ <description lang="en">Return the day of the year (1-366)</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
<argument seq="1" name="expr" type="date"></argument>
@@ -1206,7 +1188,7 @@
<function id="from-days" class="datetime">
<display>FROM_DAYS()</display>
- <description lang="en">Convert number to date</description>
+ <description lang="en">Convert a day number to a date</description>
<arguments>
<format><![CDATA[<replaceable>N</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
@@ -1242,13 +1224,13 @@
</versions>
</function>
- <function id="get_format" class="datetime">
+ <function id="get-format" class="datetime">
<display>GET_FORMAT()</display>
- <description lang="en">Return a format string</description>
+ <description lang="en">Return a date format string</description>
<arguments>
<format><![CDATA[DATE|TIME|DATETIME,
'EUR'|'USA'|'JIS'|'ISO'|'INTERNAL']]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
+ <argument seq="1" name="expr" type="numeric">Type specifier</argument>
</arguments>
<return type="string"/>
<error type="return"/>
@@ -1264,7 +1246,7 @@
<description lang="en">Extract the hour</description>
<arguments>
<format><![CDATA[<replaceable>time</replaceable>]]></format>
- <argument seq="1" name="expr" type="date"></argument>
+ <argument seq="1" name="expr" type="time"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1280,9 +1262,10 @@
<description lang="en">Return the last day of the month for the argument</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
- <argument seq="1" name="expr" type="date"></argument>
+ <!--date or datetime, should this be mixed?-->
+ <argument seq="1" name="expr" type="datetime"></argument>
</arguments>
- <return type="string"/>
+ <return type="date"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -1291,14 +1274,13 @@
</versions>
</function>
- <function id="local_time" class="datetime">
+ <function id="local-time" class="datetime">
<display>LOCALTIME()</display>
<display>LOCALTIME</display>
<description lang="en">Synonym for NOW()</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="datetime"/>
<error type="return"/>
<versions>
@@ -1314,8 +1296,7 @@
<description lang="en">Synonym for NOW()</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="datetime"/>
<error type="return"/>
<versions>
@@ -1330,7 +1311,7 @@
<description lang="en">Create a date from the year and day of year</description>
<arguments>
<format><![CDATA[<replaceable>year</replaceable>,<replaceable>dayofyear</replaceable>]]></format>
- <argument seq="1" name="expr" type="datetime">Year</argument>
+ <argument seq="1" name="expr" type="numeric">Year</argument>
<argument seq="2" name="expr" type="numeric">Day of year</argument>
</arguments>
<return type="date"/>
@@ -1366,7 +1347,7 @@
<description lang="en">Return the microseconds from argument</description>
<arguments>
<format><![CDATA[<replaceable>expr</replaceable>]]></format>
- <argument seq="1" name="expr" type="date"></argument>
+ <argument seq="1" name="expr" type="datetime"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1382,7 +1363,7 @@
<description lang="en">Return the minute from the argument</description>
<arguments>
<format><![CDATA[<replaceable>time</replaceable>]]></format>
- <argument seq="1" name="expr" type="time"></argument>
+ <argument seq="1" name="expr" type="datetime"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1426,12 +1407,11 @@
</function>
<function id="now" class="datetime">
- <display>NOW</display>
+ <display>NOW()</display>
<description lang="en">Return the current date and time</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="datetime"/>
<error type="return"/>
<versions>
@@ -1441,7 +1421,7 @@
</versions>
</function>
- <function id="periodadd" class="datetime">
+ <function id="period-add" class="datetime">
<display>PERIOD_ADD()</display>
<description lang="en">Add a period to a year-month</description>
<arguments>
@@ -1458,7 +1438,7 @@
</versions>
</function>
- <function id="period_diff" class="datetime">
+ <function id="period-diff" class="datetime">
<display>PERIOD_DIFF()</display>
<description lang="en">Returns the number of months between periods</description>
<arguments>
@@ -1475,12 +1455,12 @@
</versions>
</function>
- <function id="quarter" class="date">
+ <function id="quarter" class="datetime">
<display>QUARTER()</display>
<description lang="en">Return the quarter from a date argument</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
+ <argument seq="1" name="expr" type="date"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1509,13 +1489,13 @@
<function id="sec-to-time" class="datetime">
<display>SEC_TO_TIME()</display>
- <description lang="en">Converts seconds 'HH:MM:SS' format</description>
+ <description lang="en">Converts seconds to 'HH:MM:SS' format</description>
<arguments>
<format><![CDATA[<replaceable>seconds</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<!-- Correct return type? -->
- <return type="string"/>
+ <return type="mixed"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -1556,8 +1536,7 @@
<format><![CDATA[<replaceable>expr</replaceable>,<replaceable>days</replaceable>]]></format>
<argument seq="1" name="expr" type="date"></argument>
<argument seq="2" name="expr" type="numeric">Number of days</argument>
- </arguments>
-
+ </arguments>
<return type="numeric"/>
<error type="return"/>
<versions>
@@ -1575,7 +1554,7 @@
<argument seq="1" name="expr" type="datetime"></argument>
<argument seq="2" name="expr" type="datetime"></argument>
</arguments>
- <return type="numeric"/>
+ <return type="string"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -1593,7 +1572,7 @@
<!-- Returns the current date and time as a value in
'YYYY-MM-DD HH:MM:SS' or
YYYYMMDDHHMMSS format -->
- <return type="date"/>
+ <return type="mixed"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -1608,9 +1587,8 @@
<arguments>
<format><![CDATA[<replaceable>expr</replaceable>]]></format>
<argument seq="1" name="expr" type="datetime">Date</argument>
- <argument seq="2" name="expr" type="string">Properly formatted string</argument>
</arguments>
- <return type="numeric"/>
+ <return type="string"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -1624,8 +1602,8 @@
<description lang="en">Subtract time</description>
<arguments>
<format><![CDATA[<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>]]></format>
- <argument seq="1" name="expr" type="string">Properly formatted string</argument>
- <argument seq="2" name="expr" type="string">Properly formatted string</argument>
+ <argument seq="1" name="expr" type="datetime">Properly formatted string</argument>
+ <argument seq="2" name="expr" type="datetime">Properly formatted string</argument>
</arguments>
<return type="string"/>
<error type="return"/>
@@ -1642,14 +1620,14 @@
datetime expression. With two arguments, the sum of the arguments</description>
<arguments>
<format><![CDATA[<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>]]></format>
- <argument seq="1" name="expr" type="string">Properly formatted string</argument>
- <argument seq="2" name="expr" type="string">Properly formatted string</argument>
+ <argument seq="1" name="expr" type="datetime"></argument>
+ <argument seq="2" name="expr" type="datetime"></argument>
</arguments>
<arguments>
<format><![CDATA[<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>]]></format>
- <argument seq="1" name="expr" type="string">Properly formatted string</argument>
+ <argument seq="1" name="expr" type="string"></argument>
</arguments>
- <return type="date"/>
+ <return type="datetime"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -1666,7 +1644,7 @@
<replaceable>interval</replaceable>,<replaceable>datetime_expr</replaceable>]]></format>
<argument seq="1" name="expr" type="string">Time unit</argument>
<argument seq="2" name="expr" type="numeric">Number of units</argument>
- <argument seq="3" name="expr" type="string">Properly formatted string</argument>
+ <argument seq="3" name="expr" type="datetime"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1683,9 +1661,9 @@
<arguments>
<format><![CDATA[<replaceable>unit</replaceable>,<replaceable>datetime_expr1</replaceable>,
<replaceable>datetime_expr2</replaceable>]]></format>
- <argument seq="1" name="expr" type="numeric">Time unit</argument>
- <argument seq="2" name="expr" type="numeric">Properly formatted string</argument>
- <argument seq="3" name="expr" type="numeric">Properly formatted string</argument>
+ <argument seq="1" name="expr" type="string">Time unit</argument>
+ <argument seq="2" name="expr" type="date">Date subtrahend</argument>
+ <argument seq="3" name="expr" type="date">Date minuend</argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1704,7 +1682,7 @@
<argument seq="1" name="expr" type="time"></argument>
<argument seq="2" name="expr" type="string">Properly formatted string</argument>
</arguments>
- <return type="numeric"/>
+ <return type="time"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -1715,11 +1693,10 @@
<function id="time-to-sec" class="datetime">
<display>TIME_TO_SEC()</display>
- <description lang="en">Returns the time argument converted to seconds</description>
+ <description lang="en">Returns the argument converted to seconds</description>
<arguments>
<format><![CDATA[<replaceable>time</replaceable>]]></format>
- <argument seq="1" name="expr" type="datetime">Formatted as time</argument>
-
+ <argument seq="1" name="expr" type="datetime"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1735,8 +1712,7 @@
<description lang="en">Return the date argument converted to days</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
-
+ <argument seq="1" name="expr" type="date"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1751,9 +1727,8 @@
<display>UNIX_TIMESTAMP()</display>
<description lang="en">Returns a UNIX timestamp</description>
<arguments>
- <format><![CDATA[<replaceable>date</replaceable>]]></format>
- <argument seq="1" name="expr" type="string">Properly formatted string</argument>
-
+ <format><![CDATA[[<replaceable>date</replaceable>]]]></format>
+ <argument seq="1" name="expr" type="datetime"></argument>
</arguments>
<return type="datetime"/>
<error type="return"/>
@@ -1769,8 +1744,7 @@
<description lang="en">Returns the current UTC date</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="date"/>
<error type="sql"/>
<versions>
@@ -1785,8 +1759,7 @@
<description lang="en">Returns the current UTC time</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="time"/>
<error type="sql"/>
<versions>
@@ -1801,8 +1774,7 @@
<description lang="en">Returns the current UTC date and time</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="datetime"/>
<error type="sql"/>
<versions>
@@ -1817,7 +1789,7 @@
<description lang="en">Return the week number</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>[,<replaceable>mode</replaceable>]]]></format>
- <argument seq="1" name="expr" type="string">Properly formatted date</argument>
+ <argument seq="1" name="expr" type="date"></argument>
<argument seq="2" name="expr" type="numeric">Week start indicator</argument>
</arguments>
<return type="numeric"/>
@@ -1834,7 +1806,7 @@
<description lang="en">Return the weekday index</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
- <argument seq="1" name="expr" type="string">Properly formatted date</argument>
+ <argument seq="1" name="expr" type="date"></argument>
</arguments>
<return type="numeric"/>
@@ -1851,8 +1823,7 @@
<description lang="en">Return the calendar week of the date (1-53)</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
- <argument seq="1" name="expr" type="string">Properly formatted date</argument>
-
+ <argument seq="1" name="expr" type="date"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1868,8 +1839,7 @@
<description lang="en">Return the year</description>
<arguments>
<format><![CDATA[<replaceable>date</replaceable>]]></format>
- <argument seq="1" name="expr" type="string">Properly formatted string</argument>
-
+ <argument seq="1" name="expr" type="date"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1884,16 +1854,10 @@
<display>YEARWEEK()</display>
<description lang="en">Return the year and week</description>
<arguments>
- <format><![CDATA[<replaceable>date</replaceable>]]></format>
+ <format><![CDATA[<replaceable>date</replaceable>,[<replaceable>mode</replaceable>]]]></format>
<argument seq="1" name="expr" type="string">Properly formatted string</argument>
-
- </arguments>
- <arguments>
- <format><![CDATA[<replaceable>date</replaceable>,<replaceable>mode</replaceable>]]></format>
- <argument seq="1" name="expr" type="string">Properly formatted string</argument>
<argument seq="2" name="expr" type="numeric">Week start indicator</argument>
- </arguments>
-
+ </arguments>
<return type="numeric"/>
<error type="return"/>
<versions>
@@ -1912,7 +1876,7 @@
<replaceable>new_xml</replaceable>)]]></format>
<argument seq="1" name="expr" type="string">XML Target</argument>
<argument seq="2" name="expr" type="string">XPath</argument>
- <argument seq="3" name="expr" type="numeric">New XML </argument>
+ <argument seq="3" name="expr" type="string">New XML</argument>
</arguments>
<return type="string"/>
<error type="return"/>
@@ -1921,16 +1885,14 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="bit-count" class="bit">
<display>BIT_COUNT()</display>
<description lang="en">Return the number of bits that are set</description>
<arguments>
<format><![CDATA[<replaceable>N</replaceable>]]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
-
+ <argument seq="1" name="expr" type="numeric"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -1939,24 +1901,34 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
- <function id="aes_encrypt" class="encryption">
+ <function id="aes-encrypt" class="encryption">
<display>AES_ENCRYPT()</display>
<description lang="en">Encrypt using AES</description>
<arguments>
<format><![CDATA[<replaceable>str</replaceable>,<replaceable>key_str</replaceable>]]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
- <argument seq="2" name="expr" type="numeric"></argument>
- </arguments>
+ <argument seq="1" name="expr" type="string">To be encrypted</argument>
+ <argument seq="2" name="expr" type="string">Key</argument>
+ </arguments>
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="aes-decrypt" class="encryption">
+ <display>AES_DECRYPT()</display>
+ <description lang="en">Dencrypt using AES</description>
<arguments>
<format><![CDATA[<replaceable>crypt_str</replaceable>,<replaceable>key_str</replaceable>]]></format>
- <argument seq="1" name="expr" type="string"></argument>
- <argument seq="2" name="expr" type="string"></argument>
- </arguments>
-
- <return type="numeric"/>
+ <argument seq="1" name="expr" type="string">To be decrypted</argument>
+ <argument seq="2" name="expr" type="string">Key</argument>
+ </arguments>
+ <return type="string"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -1971,8 +1943,7 @@
<arguments>
<format><![CDATA[<replaceable>string_to_compress</replaceable]]></format>
<argument seq="1" name="expr" type="string"></argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -1984,13 +1955,12 @@
<function id="decode" class="encryption">
<display>DECODE()</display>
- <description lang="en">Decodes the encrypted string</description>
+ <description lang="en">Decodes a string encrypted using ENCODE()</description>
<arguments>
<format><![CDATA[<replaceable>crypt_str</replaceable>,<replaceable>pass_str</replaceable>]]></format>
<argument seq="1" name="expr" type="string">String to be decoded</argument>
<argument seq="2" name="expr" type="string">Password string</argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2007,8 +1977,7 @@
<format><![CDATA[<replaceable>str</replaceable>,<replaceable>pass_str</replaceable>]]></format>
<argument seq="1" name="expr" type="string">String to be encoded</argument>
<argument seq="2" name="expr" type="string">Password string</argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2025,8 +1994,7 @@
<format><![CDATA[<replaceable>crypt_str</replaceable>[,<replaceable>key_str</replaceable>]]></format>
<argument seq="1" name="expr" type="string">Encrypted string</argument>
<argument seq="2" name="expr" type="string">Key string</argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2038,15 +2006,14 @@
<function id="des-encrypt" class="encryption">
<display>DES_ENCRYPT()</display>
- <description lang="en">Encrypt a string</description>
+ <description lang="en">Decrypt a string</description>
<arguments>
<format><![CDATA[<replaceable>str</replaceable>[,
{<replaceable>key_num</replaceable>|<replaceable>key_str</replaceable>}]]]></format>
<argument seq="1" name="expr" type="string">String to be encrypted</argument>
<argument seq="2" name="expr" type="numeric">Key number for encryption</argument>
<argument seq="3" name="expr" type="string">String used for encryption</argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2062,9 +2029,8 @@
<arguments>
<format><![CDATA[<replaceable>str</replaceable>[,<replaceable>salt</replaceable>]]]></format>
<argument seq="1" name="expr" type="string">String to be encrypted</argument>
- <argument seq="2" name="expr" type="string"></argument>
- </arguments>
-
+ <argument seq="2" name="expr" type="mixed">Key</argument>
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2080,8 +2046,7 @@
<arguments>
<format><![CDATA[<replaceable>str</replaceable>]]></format>
<argument seq="1" name="expr" type="string"></argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2089,18 +2054,16 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
- <function id="old_password" class="encryption">
+ <function id="old-password" class="encryption">
<display>OLD_PASSWORD()</display>
<description lang="en">Return the value of the
old (pre-4.1) implementation of PASSWORD</description>
<arguments>
<format><![CDATA[<replaceable>str</replaceable>]]></format>
<argument seq="1" name="expr" type="string"></argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2108,17 +2071,15 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="password" class="encryption">
<display>PASSWORD()</display>
<description lang="en">Calculate and return a password string</description>
<arguments>
<format><![CDATA[<replaceable>str</replaceable>]]></format>
<argument seq="1" name="expr" type="string"></argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2135,8 +2096,7 @@
<arguments>
<format><![CDATA[<replaceable>str</replaceable>]]></format>
<argument seq="1" name="expr" type="string"></argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2163,14 +2123,13 @@
</versions>
</function>
- <function id="uncompress_length" class="encryption">
+ <function id="uncompress-length" class="encryption">
<display>UNCOMPRESS_LENGTH()</display>
<description lang="en">Return the length of a string before compression</description>
<arguments>
<format><![CDATA[<replaceable>compressed_string</replaceable>]]></format>
<argument seq="1" name="expr" type="string"></argument>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2187,9 +2146,8 @@
<format><![CDATA[<replaceable>count</replaceable>,<replaceable>expr</replaceable>]]></format>
<argument seq="1" name="expr" type="numeric">Number of times</argument>
<argument seq="2" name="expr" type="string">Expression to be executed</argument>
- </arguments>
-
- <return type="string"/>
+ </arguments>
+ <return type="numeric"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -2203,7 +2161,7 @@
<description lang="en">Return the character set of the argument</description>
<arguments>
<format><![CDATA[<replaceable>str</replaceable>]]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
+ <argument seq="1" name="expr" type="string"></argument>
</arguments>
<return type="string"/>
<error type="return"/>
@@ -2252,8 +2210,7 @@
<description lang="en">Returns the connection ID (thread ID)
for the connection</description>
<arguments>
- <format><![CDATA[]]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
+ <format></format>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -2267,11 +2224,10 @@
<function id="current-user" class="informational">
<display>CURRENT_USER()</display>
<display>CURRENT_USER</display>
- <description lang="en">Returns the username and hostname combination </description>
+ <description lang="en">Returns the username and hostname combination</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2286,8 +2242,7 @@
<description lang="en">Returns the default (current) database name</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2299,12 +2254,11 @@
<function id="found-rows" class="informational">
<display>FOUND_ROWS()</display>
- <description lang="en">For a SELECT with a LIMIT clause,the
- number of rows without a LIMIT clause</description>
+ <description lang="en">For a SELECT with a LIMIT clause, the
+ number of rows that would be returned were there no LIMIT clause</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="numeric"/>
<error type="return"/>
<versions>
@@ -2312,16 +2266,15 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="last-insert-id" class="informational">
<display>LAST_INSERT_ID()</display>
- <description lang="en">Value of the AUTOINCREMENT column</description>
+ <description lang="en">Value of the AUTOINCREMENT column
+ for the last INSERT</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="numeric"/>
<error type="return"/>
<versions>
@@ -2337,8 +2290,7 @@
updated</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="numeric"/>
<error type="return"/>
<versions>
@@ -2346,16 +2298,14 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="schema" class="informational">
<display>SCHEMA()</display>
<description lang="en">A synonym for DATABASE()</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2370,8 +2320,7 @@
<description lang="en">Synonym for USER()</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2381,7 +2330,7 @@
</versions>
</function>
- <function id="syatem-user" class="informational">
+ <function id="system-user" class="informational">
<display>SYSTEM_USER()</display>
<description lang="en">Synonym for USER()</description>
<arguments>
@@ -2394,12 +2343,11 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="user" class="informational">
<display>USER()</display>
- <description lang="en">Returns the current username/hostname</description>
+ <description lang="en">Returns the current username and hostname</description>
<arguments>
<format></format>
</arguments>
@@ -2417,8 +2365,7 @@
<description lang="en">Returns the MySQL server version</description>
<arguments>
<format></format>
- </arguments>
-
+ </arguments>
<return type="string"/>
<error type="return"/>
<versions>
@@ -2426,9 +2373,8 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="default" class="misc">
<display>DEFAULT()</display>
<description lang="en">Returns the default value for a table column</description>
@@ -2436,7 +2382,7 @@
<format><![CDATA[<replaceable>col_name</replaceable>]]></format>
<argument seq="1" name="expr" type="string">Column Name</argument>
</arguments>
- <return type="string"/>
+ <return type="mixed"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
@@ -2460,9 +2406,8 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="inet-aton" class="misc">
<display>INET_ATON()</display>
<description lang="en">Return the numeric value of an IP address</description>
@@ -2494,8 +2439,7 @@
<manual version="5.1"/>
</versions>
</function>
-
-
+
<function id="is-lock-free" class="misc">
<display>IS_LOCK_FREE()</display>
<description lang="en">Checks whether the named lock
@@ -2528,9 +2472,8 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="master-pos-wait" class="misc">
<display>MASTER_POS_WAIT()</display>
<description lang="en">Block until the slave has read and
@@ -2556,19 +2499,18 @@
<description lang="en">Causes the column to have the given name</description>
<arguments>
<format><![CDATA[<replaceable>name</replaceable>,<replaceable>value</replaceable>]]></format>
- <argument seq="1" name="expr" type="string">Name</argument>
- <argument seq="2" name="expr" type="numeric">Value</argument>
+ <argument seq="1" name="expr" type="string">Column Name</argument>
+ <argument seq="2" name="expr" type="mixed">Value</argument>
</arguments>
- <return type="numeric"/>
+ <return type="mixed"/>
<error type="return"/>
<versions>
<manual version="4.1"/>
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="release-lock" class="misc">
<display>RELEASE_LOCK()</display>
<description lang="en">Releases the named lock</description>
@@ -2599,9 +2541,8 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="uuid" class="misc">
<display>UUID()</display>
<description lang="en">Returns a Universal Unique Identifier (UUID)</description>
@@ -2633,9 +2574,8 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="avg" class="aggregate">
<display>AVG()</display>
<description lang="en">Returns the average value of the argument</description>
@@ -2667,9 +2607,8 @@
<manual version="5.0"/>
<manual version="5.1"/>
</versions>
- </function>
+ </function>
-
<function id="bit-or" class="aggregate">
<display>BIT_OR()</display>
<description lang="en">Return bitwise or</description>
@@ -2707,7 +2646,7 @@
<description lang="en">Return a count of the number of rows returned</description>
<arguments>
<format><![CDATA[<replaceable>expr</replaceable>]]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
+ <argument seq="1" name="expr" type="mixed"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -2724,7 +2663,8 @@
<arguments>
<format><![CDATA[DISTINCT
<replaceable>expr</replaceable>,[<replaceable>expr</replaceable>...]]]></format>
- <argument seq="1" name="expr" type="numeric"></argument>
+ <argument seq="1" name="expr" type="mixed"></argument>
+ <argument seq="2" name="expr" type="mixed"></argument>
</arguments>
<return type="numeric"/>
<error type="return"/>
@@ -2741,7 +2681,8 @@
<arguments>
<format><![CDATA[[DISTINCT] <replaceable>expr</replaceable>
[,<replaceable>expr</replaceable> ...]]></format>
- <argument seq="1" name="expr" type="string"></argument>
+ <argument seq="1" name="expr" type="mixed"></argument>
+ <argument seq="2" name="expr" type="mixed"></argument>
</arguments>
<return type="string"/>
<error type="return"/>
@@ -3068,7 +3009,7 @@
</versions>
</function>
- <function id="concat_ws" class="string">
+ <function id="concat-ws" class="string">
<display>CONCAT_WS()</display>
<description lang="en">Return concatenate with
separator</description>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5426 - trunk/dynamic-docs/opsfunctions | plavin | 16 Mar |
