From: paul Date: December 12 2005 11:51pm Subject: svn commit - mysqldoc@docsrva: r545 - in trunk: . refman-4.1 refman-5.0 refman-5.1 List-Archive: http://lists.mysql.com/commits/92 Message-Id: <200512122351.jBCNpSHm029159@docsrva.mysql.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Author: paul Date: 2005-12-13 00:51:27 +0100 (Tue, 13 Dec 2005) New Revision: 545 Log: r4726@frost: paul | 2005-12-12 16:11:04 -0600 Minor UDF section cleanups. Modified: trunk/ trunk/refman-4.1/extending-mysql.xml trunk/refman-5.0/extending-mysql.xml trunk/refman-5.1/extending-mysql.xml Property changes on: trunk ___________________________________________________________________ Name: svk:merge - b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:4710 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1609 + b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:4726 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:1609 Modified: trunk/refman-4.1/extending-mysql.xml =================================================================== --- trunk/refman-4.1/extending-mysql.xml 2005-12-12 21:26:53 UTC (rev 544) +++ trunk/refman-4.1/extending-mysql.xml 2005-12-12 23:51:27 UTC (rev 545) @@ -559,8 +559,9 @@ - You can add UDFs to a binary MySQL distribution. Native - functions require you to modify a source distribution. + Native functions require you to modify a source distribution. + UDFs do not. You can add UDFs to a binary MySQL distribution. + No access to MySQL source is necessary. @@ -587,8 +588,9 @@ The following sections describe features of the UDF interface, - provide instructions for writing UDFs, and discuss security - precautions that MySQL takes to prevent UDF misuse. + provide instructions for writing UDFs, discuss security + precautions that MySQL takes to prevent UDF misuse, and describe + how to add native mySQL functions. @@ -815,7 +817,7 @@ - If you to use a precompiled distribution of MySQL, use + If you must use a precompiled distribution of MySQL, use MySQL-Max, which contains a dynamically linked server that supports dynamic loading. @@ -882,48 +884,48 @@ The initialization function for xxx(). It - can be used to: + can be used for the following purposes: - Check the number of arguments to + To check the number of arguments to XXX(). - Check that the arguments are of a required type or, - alternatively, tell MySQL to coerce arguments to the + To check that the arguments are of a required type or, + alternatively, to tell MySQL to coerce arguments to the types you want when the main function is called. - Allocate any memory required by the main function. + To allocate any memory required by the main function. - Specify the maximum length of the result. + To specify the maximum length of the result. - Specify (for REAL functions) the - maximum number of decimals. + To specify (for REAL functions) the + maximum number of decimal places in the result. - Specify whether the result can be + To specify whether the result can be NULL. @@ -950,12 +952,13 @@ calls the initialization function xxx_init() to let it perform any required setup, such as argument checking or memory allocation. If xxx_init() returns - an error, the SQL statement is aborted with an error message and - the main and deinitialization functions are not called. - Otherwise, the main function xxx() is called - once for each row. After all rows have been processed, the - deinitialization function xxx_deinit() is - called so it can perform any required cleanup. + an error, MySQL aborts the SQL statement with an error message + and does not call the main or deinitialization functions. + Otherwise, MySQL calls the main function + xxx() once for each row. After all rows have + been processed, MySQL calls the deinitialization function + xxx_deinit() so that it can perform any + required cleanup. @@ -1166,12 +1169,13 @@ - The number of decimals. The default value is the maximum - number of decimals in the arguments passed to the main - function. (For example, if the function is passed + The number of decimal digits to the right of the decimal + point. The default value is the maximum number of decimal + digits in the arguments passed to the main function. (For + example, if the function is passed 1.34, 1.345, and 1.3, the default would be 3, because - 1.345 has 3 decimals. + 1.345 has 3 decimal digits. @@ -1186,10 +1190,10 @@ the result type of the function. For string functions, the default is the length of the longest argument. For integer functions, the default is 21 digits. For real functions, - the default is 13 plus the number of decimals indicated by - initid->decimals. (For numeric - functions, the length includes any sign or decimal point - characters.) + the default is 13 plus the number of decimal digits + indicated by initid->decimals. (For + numeric functions, the length includes any sign or decimal + point characters.) Modified: trunk/refman-5.0/extending-mysql.xml =================================================================== --- trunk/refman-5.0/extending-mysql.xml 2005-12-12 21:26:53 UTC (rev 544) +++ trunk/refman-5.0/extending-mysql.xml 2005-12-12 23:51:27 UTC (rev 545) @@ -550,8 +550,9 @@ - You can add UDFs to a binary MySQL distribution. Native - functions require you to modify a source distribution. + Native functions require you to modify a source distribution. + UDFs do not. You can add UDFs to a binary MySQL distribution. + No access to MySQL source is necessary. @@ -582,8 +583,9 @@ The following sections describe features of the UDF interface, - provide instructions for writing UDFs, and discuss security - precautions that MySQL takes to prevent UDF misuse. + provide instructions for writing UDFs, discuss security + precautions that MySQL takes to prevent UDF misuse, and describe + how to add native mySQL functions. @@ -816,7 +818,7 @@ - If you to use a precompiled distribution of MySQL, use + If you must use a precompiled distribution of MySQL, use MySQL-Max, which contains a dynamically linked server that supports dynamic loading. @@ -890,48 +892,48 @@ The initialization function for xxx(). It - can be used to: + can be used for the following purposes: - Check the number of arguments to + To check the number of arguments to XXX(). - Check that the arguments are of a required type or, - alternatively, tell MySQL to coerce arguments to the + To check that the arguments are of a required type or, + alternatively, to tell MySQL to coerce arguments to the types you want when the main function is called. - Allocate any memory required by the main function. + To allocate any memory required by the main function. - Specify the maximum length of the result. + To specify the maximum length of the result. - Specify (for REAL functions) the - maximum number of decimals. + To specify (for REAL functions) the + maximum number of decimal places in the result. - Specify whether the result can be + To specify whether the result can be NULL. @@ -958,12 +960,13 @@ calls the initialization function xxx_init() to let it perform any required setup, such as argument checking or memory allocation. If xxx_init() returns - an error, the SQL statement is aborted with an error message and - the main and deinitialization functions are not called. - Otherwise, the main function xxx() is called - once for each row. After all rows have been processed, the - deinitialization function xxx_deinit() is - called so it can perform any required cleanup. + an error, MySQL aborts the SQL statement with an error message + and does not call the main or deinitialization functions. + Otherwise, MySQL calls the main function + xxx() once for each row. After all rows have + been processed, MySQL calls the deinitialization function + xxx_deinit() so that it can perform any + required cleanup. @@ -1163,12 +1166,13 @@ - The number of decimals. The default value is the maximum - number of decimals in the arguments passed to the main - function. (For example, if the function is passed + The number of decimal digits to the right of the decimal + point. The default value is the maximum number of decimal + digits in the arguments passed to the main function. (For + example, if the function is passed 1.34, 1.345, and 1.3, the default would be 3, because - 1.345 has 3 decimals. + 1.345 has 3 decimal digits. @@ -1183,10 +1187,10 @@ the result type of the function. For string functions, the default is the length of the longest argument. For integer functions, the default is 21 digits. For real functions, - the default is 13 plus the number of decimals indicated by - initid->decimals. (For numeric - functions, the length includes any sign or decimal point - characters.) + the default is 13 plus the number of decimal digits + indicated by initid->decimals. (For + numeric functions, the length includes any sign or decimal + point characters.) Modified: trunk/refman-5.1/extending-mysql.xml =================================================================== --- trunk/refman-5.1/extending-mysql.xml 2005-12-12 21:26:53 UTC (rev 544) +++ trunk/refman-5.1/extending-mysql.xml 2005-12-12 23:51:27 UTC (rev 545) @@ -766,8 +766,9 @@ - You can add UDFs to a binary MySQL distribution. Native - functions require you to modify a source distribution. + Native functions require you to modify a source distribution. + UDFs do not. You can add UDFs to a binary MySQL distribution. + No access to MySQL source is necessary. @@ -798,8 +799,9 @@ The following sections describe features of the UDF interface, - provide instructions for writing UDFs, and discuss security - precautions that MySQL takes to prevent UDF misuse. + provide instructions for writing UDFs, discuss security + precautions that MySQL takes to prevent UDF misuse, and describe + how to add native mySQL functions. @@ -1031,7 +1033,7 @@ - If you to use a precompiled distribution of MySQL, use + If you must use a precompiled distribution of MySQL, use MySQL-Max, which contains a dynamically linked server that supports dynamic loading. @@ -1105,48 +1107,48 @@ The initialization function for xxx(). It - can be used to: + can be used for the following purposes: - Check the number of arguments to + To check the number of arguments to XXX(). - Check that the arguments are of a required type or, - alternatively, tell MySQL to coerce arguments to the + To check that the arguments are of a required type or, + alternatively, to tell MySQL to coerce arguments to the types you want when the main function is called. - Allocate any memory required by the main function. + To allocate any memory required by the main function. - Specify the maximum length of the result. + To specify the maximum length of the result. - Specify (for REAL functions) the - maximum number of decimals. + To specify (for REAL functions) the + maximum number of decimal places in the result. - Specify whether the result can be + To specify whether the result can be NULL. @@ -1173,12 +1175,13 @@ calls the initialization function xxx_init() to let it perform any required setup, such as argument checking or memory allocation. If xxx_init() returns - an error, the SQL statement is aborted with an error message and - the main and deinitialization functions are not called. - Otherwise, the main function xxx() is called - once for each row. After all rows have been processed, the - deinitialization function xxx_deinit() is - called so it can perform any required cleanup. + an error, MySQL aborts the SQL statement with an error message + and does not call the main or deinitialization functions. + Otherwise, MySQL calls the main function + xxx() once for each row. After all rows have + been processed, MySQL calls the deinitialization function + xxx_deinit() so that it can perform any + required cleanup. @@ -1378,12 +1381,13 @@ - The number of decimals. The default value is the maximum - number of decimals in the arguments passed to the main - function. (For example, if the function is passed + The number of decimal digits to the right of the decimal + point. The default value is the maximum number of decimal + digits in the arguments passed to the main function. (For + example, if the function is passed 1.34, 1.345, and 1.3, the default would be 3, because - 1.345 has 3 decimals. + 1.345 has 3 decimal digits. @@ -1398,10 +1402,10 @@ the result type of the function. For string functions, the default is the length of the longest argument. For integer functions, the default is 21 digits. For real functions, - the default is 13 plus the number of decimals indicated by - initid->decimals. (For numeric - functions, the length includes any sign or decimal point - characters.) + the default is 13 plus the number of decimal digits + indicated by initid->decimals. (For + numeric functions, the length includes any sign or decimal + point characters.)