From 3c49c6facb22cdea979f5d1465ba53f972d32163 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Thu, 23 Nov 2017 09:39:47 -0500 Subject: Convert documentation to DocBook XML MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Since some preparation work had already been done, the only source changes left were changing empty-element tags like to , and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz --- doc/src/sgml/ref/create_function.sgml | 36 +++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'doc/src/sgml/ref/create_function.sgml') diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index 970dc133595..75331165fef 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -141,7 +141,7 @@ CREATE [ OR REPLACE ] FUNCTION name of an input argument is just extra documentation, so far as the function itself is concerned; but you can use input argument names when calling a function to improve readability (see ). In any case, the name + linkend="sql-syntax-calling-funcs"/>). In any case, the name of an output argument is significant, because it defines the column name in the result row type. (If you omit the name for an output argument, the system will choose a default column name.) @@ -269,7 +269,7 @@ CREATE [ OR REPLACE ] FUNCTION Lists which transforms a call to the function should apply. Transforms convert between SQL types and language-specific data types; - see . Procedural language + see . Procedural language implementations usually have hardcoded knowledge of the built-in types, so those don't need to be listed here. If a procedural language implementation does not know how to handle a type and no transform is @@ -338,7 +338,7 @@ CREATE [ OR REPLACE ] FUNCTION - For additional details see . + For additional details see . @@ -363,7 +363,7 @@ CREATE [ OR REPLACE ] FUNCTION In addition, functions which do not take arguments or which are not passed any arguments from the security barrier view or table do not have to be marked as leakproof to be executed before security conditions. See - and . + and . This option can only be set by the superuser. @@ -455,7 +455,7 @@ CREATE [ OR REPLACE ] FUNCTION A positive number giving the estimated execution cost for the function, - in units of . If the function + in units of . If the function returns a set, this is the cost per returned row. If the cost is not specified, 1 unit is assumed for C-language and internal functions, and 100 units for functions in all other languages. Larger values @@ -504,8 +504,8 @@ CREATE [ OR REPLACE ] FUNCTION - See and - + See and + for more information about allowed parameter names and values. @@ -523,7 +523,7 @@ CREATE [ OR REPLACE ] FUNCTION It is often helpful to use dollar quoting (see ) to write the function definition + linkend="sql-syntax-dollar-quoting"/>) to write the function definition string, rather than the normal single quote syntax. Without dollar quoting, any single quotes or backslashes in the function definition must be escaped by doubling them. @@ -543,7 +543,7 @@ CREATE [ OR REPLACE ] FUNCTION the SQL function. The string obj_file is the name of the shared library file containing the compiled C function, and is interpreted - as for the command. The string + as for the command. The string link_symbol is the function's link symbol, that is, the name of the function in the C language source code. If the link symbol is omitted, it is assumed @@ -598,7 +598,7 @@ CREATE [ OR REPLACE ] FUNCTION - Refer to for further information on writing + Refer to for further information on writing functions. @@ -681,7 +681,7 @@ CREATE FUNCTION foo(int, int default 42) ... Here are some trivial examples to help you get started. For more - information and examples, see . + information and examples, see . CREATE FUNCTION add(integer, integer) RETURNS integer AS 'select $1 + $2;' @@ -750,7 +750,7 @@ SELECT * FROM dup(42); Because a SECURITY DEFINER function is executed with the privileges of the user that owns it, care is needed to ensure that the function cannot be misused. For security, - should be set to exclude any schemas + should be set to exclude any schemas writable by untrusted users. This prevents malicious users from creating objects (e.g., tables, functions, and operators) that mask objects intended to be used by the function. @@ -795,7 +795,7 @@ $$ LANGUAGE plpgsql Another point to keep in mind is that by default, execute privilege is granted to PUBLIC for newly created functions - (see for more + (see for more information). Frequently you will wish to restrict use of a security definer function to only some users. To do that, you must revoke the default PUBLIC privileges and then grant execute @@ -843,11 +843,11 @@ COMMIT; See Also - - - - - + + + + + -- cgit v1.2.3