Author: plavin
Date: 2007-03-14 19:48:35 +0100 (Wed, 14 Mar 2007)
New Revision: 5355
Log:
Add functions
Modified:
trunk/dynamic-docs/opsfunctions/opfunctions.xml
Modified: trunk/dynamic-docs/opsfunctions/opfunctions.xml
===================================================================
--- trunk/dynamic-docs/opsfunctions/opfunctions.xml 2007-03-14 16:52:51 UTC (rev 5354)
+++ trunk/dynamic-docs/opsfunctions/opfunctions.xml 2007-03-14 18:48:35 UTC (rev 5355)
Changed blocks: 13, Lines Added: 542, Lines Deleted: 0; 18498 bytes
@@ -930,6 +930,9 @@
<function id="curdate" class="datetime">
<display>CURDATE()</display>
<description lang="en">Return the current date</description>
+ <arguments>
+ <format></format>
+ </arguments>
<return type="datetime"/>
<error type="return"/>
@@ -945,6 +948,9 @@
<display>CURRENT_DATE()</display>
<display>CURRENT_DATE</display>
<description lang="en">Synonyms for CURDATE()</description>
+ <arguments>
+ <format></format>
+ </arguments>
<return type="datetime"/>
<error type="return"/>
@@ -958,6 +964,9 @@
<function id="curtime" class="datetime">
<display>CURTIME()</display>
<description lang="en">Return the current time</description>
+ <arguments>
+ <format></format>
+ </arguments>
<return type="datetime"/>
<error type="return"/>
@@ -973,6 +982,9 @@
<display>CURRENT_TIME()</display>
<display>CURRENT_TIME</display>
<description lang="en">Synonyms for CURTIME()</description>
+ <arguments>
+ <format></format>
+ </arguments>
<return type="datetime"/>
<error type="return"/>
@@ -987,6 +999,9 @@
<display>CURRENT_TIMESTAMP()</display>
<display>CURRENT_TIMESTAMP</display>
<description lang="en">Synonyms for NOW()</description>
+ <arguments>
+ <format></format>
+ </arguments>
<return type="datetime"/>
<error type="return"/>
@@ -1274,6 +1289,10 @@
<display>LOCALTIME()</display>
<display>LOCALTIME</display>
<description lang="en">Synonym for NOW()</description>
+ <arguments>
+ <format></format>
+ </arguments>
+
<return type="datetime"/>
<error type="return"/>
<versions>
@@ -1287,6 +1306,9 @@
<display>LOCALSTAMP</display>
<display>LOCALSTAMP()</display>
<description lang="en">Synonym for NOW()</description>
+ <arguments>
+ <format></format>
+ </arguments>
<return type="datetime"/>
<error type="return"/>
@@ -1400,6 +1422,10 @@
<function id="now" class="datetime">
<display>NOW</display>
<description lang="en">Return the current date and time</description>
+ <arguments>
+ <format></format>
+ </arguments>
+
<return type="datetime"/>
<error type="return"/>
<versions>
@@ -1555,6 +1581,9 @@
<function id="sysdate" class="datetime">
<display>SYSDATE()</display>
<description lang="en">Returns the time at which the function executes</description>
+ <arguments>
+ <format></format>
+ </arguments>
<!-- Returns the current date and time as a value in
'YYYY-MM-DD HH:MM:SS' or
YYYYMMDDHHMMSS format -->
@@ -1732,6 +1761,9 @@
<function id="utc-date" class="datetime">
<display>UTC_DATE()</display>
<description lang="en">Returns the current UTC date</description>
+ <arguments>
+ <format></format>
+ </arguments>
<return type="date"/>
<error type="sql"/>
@@ -1745,6 +1777,9 @@
<function id="utc-time" class="datetime">
<display>UTC_TIME()</display>
<description lang="en">Returns the current UTC time</description>
+ <arguments>
+ <format></format>
+ </arguments>
<return type="time"/>
<error type="sql"/>
@@ -1758,6 +1793,9 @@
<function id="utc-timestamp" class="datetime">
<display>UTC_TIMESTAMP()</display>
<description lang="en">Returns the current UTC date and time</description>
+ <arguments>
+ <format></format>
+ </arguments>
<return type="datetime"/>
<error type="sql"/>
@@ -2154,4 +2192,508 @@
</versions>
</function>
+ <function id="charset" class="informational">
+ <display>CHARSET()</display>
+ <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>
+ </arguments>
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="coercibility" class="informational">
+ <display>COERCIBILITY()</display>
+ <description lang="en">Returns the collation coercibility value of the string
+ argument</description>
+ <arguments>
+ <format><![CDATA[<replaceable>str</replaceable>]]></format>
+ <argument seq="1" name="expr" type="string"></argument>
+ </arguments>
+ <return type="numeric"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="collation" class="informational">
+ <display>COLLATION()</display>
+ <description lang="en">Returns the collation of the string argument</description>
+ <arguments>
+ <format><![CDATA[<replaceable>str</replaceable>]]></format>
+ <argument seq="1" name="expr" type="string"></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="connection-id" class="informational">
+ <display>CONNECTION_ID()</display>
+ <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>
+ </arguments>
+ <return type="numeric"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="current-user" class="informational">
+ <display>CURRENT_USER()</display>
+ <display>CURRENT_USER</display>
+ <description lang="en">Returns the username and hostname combination </description>
+ <arguments>
+ <format></format>
+ </arguments>
+
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="database" class="informational">
+ <display>DATABASE()</display>
+ <description lang="en">Returns the default (current) database name</description>
+ <arguments>
+ <format></format>
+ </arguments>
+
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <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>
+ <arguments>
+ <format></format>
+ </arguments>
+
+ <return type="numeric"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+
+ <function id="last-insert-id" class="informational">
+ <display>LAST_INSERT_ID()</display>
+ <description lang="en">Value of the AUTOINCREMENT column</description>
+ <arguments>
+ <format></format>
+ </arguments>
+
+ <return type="numeric"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="count-row" class="informational">
+ <display>COUNT_ROW()</display>
+ <description lang="en">The number of rows
+ updated</description>
+ <arguments>
+ <format></format>
+ </arguments>
+
+ <return type="numeric"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+
+ <function id="schema" class="informational">
+ <display>SCHEMA()</display>
+ <description lang="en">A synonym for DATABASE()</description>
+ <arguments>
+ <format></format>
+ </arguments>
+
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="session-user" class="informational">
+ <display>SESSION_USER()</display>
+ <description lang="en">Synonym for USER()</description>
+ <arguments>
+ <format></format>
+ </arguments>
+
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="syatem-user" class="informational">
+ <display>SYSTEM_USER()</display>
+ <description lang="en">Synonym for USER()</description>
+ <arguments>
+ <format></format>
+ </arguments>
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+
+ <function id="user" class="informational">
+ <display>USER()</display>
+ <description lang="en">Returns the current username/hostname</description>
+ <arguments>
+ <format></format>
+ </arguments>
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="server" class="informational">
+ <display>SERVER()</display>
+ <description lang="en">Returns the MySQL server version</description>
+ <arguments>
+ <format></format>
+ </arguments>
+
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+
+ <function id="default" class="misc">
+ <display>DEFAULT()</display>
+ <description lang="en">Returns the default value for a table column</description>
+ <arguments>
+ <format><![CDATA[<replaceable>col_name</replaceable>]]></format>
+ <argument seq="1" name="expr" type="string">Column Name</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="get-lock" class="misc">
+ <display>GET_LOCK()</display>
+ <description lang="en"></description>
+ <arguments>
+ <format><![CDATA[<replaceable>str</replaceable>,<replaceable>timeout</replaceable>]]></format>
+ <argument seq="1" name="expr" type="string">Lock name</argument>
+ <argument seq="1" name="expr" type="numeric">Seconds</argument>
+ </arguments>
+ <return type="bool"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+
+ <function id="inet-aton" class="misc">
+ <display>INET_ATON()</display>
+ <description lang="en">Return the numeric value of an IP address</description>
+ <arguments>
+ <format><![CDATA[<replaceable>expr</replaceable>]]></format>
+ <argument seq="1" name="expr" type="string">IP address</argument>
+ </arguments>
+ <return type="numeric"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="inet-ntoa" class="misc">
+ <display>INET_NTOA()</display>
+ <description lang="en">Return the IP address from a numeric value</description>
+ <arguments>
+ <format><![CDATA[<replaceable>expr</replaceable>]]></format>
+ <argument seq="1" name="expr" type="numeric"></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="is-lock-free" class="misc">
+ <display>IS_LOCK_FREE()</display>
+ <description lang="en">Checks whether the named lock
+ is free</description>
+ <arguments>
+ <format><![CDATA[<replaceable>str</replaceable>]]></format>
+ <argument seq="1" name="expr" type="numeric">Lock name</argument>
+ </arguments>
+ <return type="bool"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="is-lock-used" class="misc">
+ <display>()</display>
+ <description lang="en">Checks whether the named lock is in use.
+ Returns connection identifier if true.</description>
+ <arguments>
+ <format><![CDATA[<replaceable>str</replaceable>]]></format>
+ <argument seq="1" name="expr" type="string">Lock name</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="master-pos-wait" class="misc">
+ <display>MASTER_POS_WAIT()</display>
+ <description lang="en">Block until the slave has read and
+ applied all updates up to the specified position</description>
+ <arguments>
+ <format><![CDATA[<replaceable>log_name</replaceable>,<replaceable>log_pos</replaceable>
+ [,<replaceable>timeout</replaceable>]]></format>
+ <argument seq="1" name="expr" type="string">Log name</argument>
+ <argument seq="2" name="expr" type="numeric"></argument>
+ <argument seq="3" name="expr" type="numeric"></argument>
+ </arguments>
+ <return type="mixed"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="name-const" class="misc" inversion="5.0.12">
+ <display>NAME_CONST()</display>
+ <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="1" name="expr" type="numeric">Value</argument>
+ </arguments>
+ <return type="numeric"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+
+ <function id="release-lock" class="misc">
+ <display>RELEASE_LOCK()</display>
+ <description lang="en">Releases the named lock</description>
+ <arguments>
+ <format><![CDATA[<replaceable>str</replaceable>]]></format>
+ <argument seq="1" name="expr" type="string">Lock name</argument>
+ </arguments>
+ <return type="bool"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+ <function id="" class="misc">
+ <display>()</display>
+ <description lang="en"></description>
+ <arguments>
+ <format><![CDATA[]]></format>
+ <argument seq="1" name="expr" type="numeric"></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="" class="misc">
+ <display>()</display>
+ <description lang="en"></description>
+ <arguments>
+ <format><![CDATA[]]></format>
+ <argument seq="1" name="expr" type="numeric"></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="" class="misc">
+ <display>()</display>
+ <description lang="en"></description>
+ <arguments>
+ <format><![CDATA[]]></format>
+ <argument seq="1" name="expr" type="numeric"></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="" class="misc">
+ <display>()</display>
+ <description lang="en"></description>
+ <arguments>
+ <format><![CDATA[]]></format>
+ <argument seq="1" name="expr" type="numeric"></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="" class="misc">
+ <display>()</display>
+ <description lang="en"></description>
+ <arguments>
+ <format><![CDATA[]]></format>
+ <argument seq="1" name="expr" type="numeric"></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="" class="misc">
+ <display>()</display>
+ <description lang="en"></description>
+ <arguments>
+ <format><![CDATA[]]></format>
+ <argument seq="1" name="expr" type="numeric"></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="" class="misc">
+ <display>()</display>
+ <description lang="en"></description>
+ <arguments>
+ <format><![CDATA[]]></format>
+ <argument seq="1" name="expr" type="numeric"></argument>
+ </arguments>
+ <return type="string"/>
+ <error type="return"/>
+ <versions>
+ <manual version="4.1"/>
+ <manual version="5.0"/>
+ <manual version="5.1"/>
+ </versions>
+ </function>
+
+
+
</opfunctions>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5355 - trunk/dynamic-docs/opsfunctions | plavin | 14 Mar |
