User-defined function

COBOL language

In the COBOL programming language, a user-defined function is an entity that is defined by the user by specifying a FUNCTION-ID paragraph. A user-defined function must return a value by specifying the RETURNING phrase of the procedure division header and they are invoked using the function-identifier syntax. See the ISO/IEC 1989:2014 Programming Language COBOL standard for details.

As of May 2022, the IBM Enterprise COBOL for z/OS 6.4 (IBM COBOL) compiler contains support for user-defined functions.

Databases

In relational database management systems, a user-defined function provides a mechanism for extending the functionality of the database server by adding a function, that can be evaluated in standard query language (usually SQL) statements. The SQL standard (ISO/IEC 9075) distinguishes between scalar and table functions. A scalar function returns only a single value (or NULL), whereas a table function returns a (relational) table comprising zero or more rows, each row with one or more columns.

User-defined functions in SQL are declared using the CREATE FUNCTION statement. For example, a user-defined function that converts Celsius to Fahrenheit might be declared like this:

<span id="mwNA"></span><span class="k" id="mwNQ">CREATE</span><span class="w" id="mwNg"> </span><span class="k" id="mwNw">FUNCTION</span><span class="w" id="mwOA"> </span><span class="n" id="mwOQ">dbo</span><span class="p" id="mwOg">.</span><span class="n" id="mwOw">CtoF</span><span class="p" id="mwPA">(</span><span class="n" id="mwPQ">Celsius</span><span class="w" id="mwPg"> </span><span class="nb" id="mwPw">FLOAT</span><span class="p" id="mwQA">)</span> <span class="w" id="mwQQ"> </span><span class="k" id="mwQg">RETURNS</span><span class="w" id="mwQw"> </span><span class="nb" id="mwRA">FLOAT</span> <span class="w" id="mwRQ"> </span><span class="k" id="mwRg">RETURN</span><span class="w" id="mwRw"> </span><span class="p" id="mwSA">(</span><span class="n" id="mwSQ">Celsius</span><span class="w" id="mwSg"> </span><span class="o" id="mwSw">*</span><span class="w" id="mwTA"> </span><span class="mi" id="mwTQ">1</span><span class="p" id="mwTg">.</span><span class="mi" id="mwTw">8</span><span class="p" id="mwUA">)</span><span class="w" id="mwUQ"> </span><span class="o" id="mwUg">+</span><span class="w" id="mwUw"> </span><span class="mi" id="mwVA">32</span>

Once created, a user-defined function may be used in expressions in SQL statements. For example, it can be invoked where most other intrinsic functions are allowed. This also includes SELECT statements, where the function can be used against data stored in tables in the database. Conceptually, the function is evaluated once per row in such usage. For example, assume a table named Elements, with a row for each known chemical element. The table has a column named BoilingPoint for the boiling point of that element, in Celsius. The query

<span id="mwWw"></span><span class="k" id="mwXA">SELECT</span><span class="w" id="mwXQ"> </span><span class="n" id="mwXg">Name</span><span class="p" id="mwXw">,</span><span class="w" id="mwYA"> </span><span class="n" id="mwYQ">CtoF</span><span class="p" id="mwYg">(</span><span class="n" id="mwYw">BoilingPoint</span><span class="p" id="mwZA">)</span> <span class="w" id="mwZQ"> </span><span class="k" id="mwZg">FROM</span><span class="w" id="mwZw"> </span><span class="n" id="mwaA">Elements</span>

would retrieve the name and the boiling point from each row. It invokes the CtoF user-defined function as declared above in order to convert the value in the column to a value in Fahrenheit.

Each user-defined function carries certain properties or characteristics. The SQL standard defines the following properties:

• Language - defines the programming language in which the user-defined function is implemented; examples include SQL, C, C# and Java.
• Parameter style - defines the conventions that are used to pass the function parameters and results between the implementation of the function and the database system (only applicable if language is not SQL).
• Specific name - a name for the function that is unique within the database. Note that the function name does not have to be unique, considering overloaded functions. Some SQL implementations require that function names are unique within a database, and overloaded functions are not allowed.
• Determinism - specifies whether the function is deterministic or not. The determinism characteristic has an influence on the query optimizer when compiling a SQL statement.
• SQL-data access - tells the database management system whether the function contains no SQL statements (NO SQL), contains SQL statements but does not access any tables or views (CONTAINS SQL), reads data from tables or views (READS SQL DATA), or actually modifies data in the database (MODIFIES SQL DATA).

User-defined functions should not be confused with stored procedures. Stored procedures allow the user to group a set of SQL commands. A procedure can accept parameters and execute its SQL statements depending on those parameters. A procedure is not an expression and, thus, cannot be used like user-defined functions.

Some database management systems allow the creation of user defined functions in languages other than SQL. Microsoft SQL Server, for example, allows the user to use .NET languages including C# for this purpose. DB2 and Oracle support user-defined functions written in C or Java programming languages.

SQL Server 2000

There are three types of UDF in Microsoft SQL Server 2000: scalar functions, inline table-valued functions, and multistatement table-valued functions.

Scalar functions return a single data value (not a table) with RETURNS clause. Scalar functions can use all scalar data types, with exception of timestamp and user-defined data types. Inline table-valued functions return the result set of a single SELECT statement. Multistatement table-valued functions return a table, which was built with many TRANSACT-SQL statements.

User-defined functions can be invoked from a query like built‑in functions such as OBJECT_ID, LEN, DATEDIFF, or can be executed through an EXECUTE statement like stored procedures.

Performance Notes:

1. On Microsoft SQL Server 2000 a table-valued function which "wraps" a View may be much faster than the View itself. The following MyFunction is an example of a "function-wrapper" which runs faster than the underlying view MyView:

   <span id="mwhg"></span><span class="k" id="mwhw">CREATE</span><span class="w" id="mwiA"> </span><span class="k" id="mwiQ">FUNCTION</span><span class="w" id="mwig"> </span><span class="n" id="mwiw">MyFunction</span><span class="p" id="mwjA">()</span> <span class="w" id="mwjQ"> </span><span class="k" id="mwjg">RETURNS</span><span class="w" id="mwjw"> </span><span class="nv" id="mwkA">@Tbl</span><span class="w" id="mwkQ"> </span><span class="nc" id="mwkg">TABLE</span><span class="w" id="mwkw"> </span> <span class="w" id="mwlA"> </span><span class="p" id="mwlQ">(</span> <span class="w" id="mwlg"> </span><span class="n" id="mwlw">StudentID</span><span class="w" id="mwmA"> </span><span class="nc" id="mwmQ">VARCHAR</span><span class="p" id="mwmg">(</span><span class="mi" id="mwmw">255</span><span class="p" id="mwnA">),</span> <span class="w" id="mwnQ"> </span><span class="n" id="mwng">SAS_StudentInstancesID</span><span class="w" id="mwnw"> </span><span class="nc" id="mwoA">INT</span><span class="p" id="mwoQ">,</span> <span class="w" id="mwog"> </span><span class="n" id="mwow">Label</span><span class="w" id="mwpA"> </span><span class="nc" id="mwpQ">VARCHAR</span><span class="p" id="mwpg">(</span><span class="mi" id="mwpw">255</span><span class="p" id="mwqA">),</span> <span class="w" id="mwqQ"> </span><span class="k" id="mwqg">Value</span><span class="w" id="mwqw"> </span><span class="nc" id="mwrA">MONEY</span><span class="p" id="mwrQ">,</span> <span class="w" id="mwrg"> </span><span class="n" id="mwrw">CMN_PersonsID</span><span class="w" id="mwsA"> </span><span class="nc" id="mwsQ">INT</span> <span class="w" id="mwsg"> </span><span class="p" id="mwsw">)</span> <span class="k" id="mwtA">AS</span> <span class="k" id="mwtQ">BEGIN</span> <span class="w" id="mwtg"> </span><span class="k" id="mwtw">INSERT</span><span class="w" id="mwuA"> </span><span class="nv" id="mwuQ">@Tbl</span> <span class="w" id="mwug"> </span><span class="p" id="mwuw">(</span> <span class="w" id="mwvA"> </span><span class="n" id="mwvQ">StudentID</span><span class="p" id="mwvg">,</span> <span class="w" id="mwvw"> </span><span class="n" id="mwwA">SAS_StudentInstancesID</span><span class="p" id="mwwQ">,</span> <span class="w" id="mwwg"> </span><span class="n" id="mwww">Label</span><span class="p" id="mwxA">,</span> <span class="w" id="mwxQ"> </span><span class="k" id="mwxg">Value</span><span class="p" id="mwxw">,</span> <span class="w" id="mwyA"> </span><span class="n" id="mwyQ">CMN_PersonsID</span> <span class="w" id="mwyg"> </span><span class="p" id="mwyw">)</span> <span class="w" id="mwzA"> </span><span class="k" id="mwzQ">SELECT</span><span class="w" id="mwzg"> </span> <span class="w" id="mwzw"> </span><span class="n" id="mw0A">StudentID</span><span class="p" id="mw0Q">,</span> <span class="w" id="mw0g"> </span><span class="n" id="mw0w">SAS_StudentInstancesID</span><span class="p" id="mw1A">,</span> <span class="w" id="mw1Q"> </span><span class="n" id="mw1g">Label</span><span class="p" id="mw1w">,</span> <span class="w" id="mw2A"> </span><span class="k" id="mw2Q">Value</span><span class="p" id="mw2g">,</span> <span class="w" id="mw2w"> </span><span class="n" id="mw3A">CMN_PersonsID</span> <span class="w" id="mw3Q"> </span><span class="k" id="mw3g">FROM</span><span class="w" id="mw3w"> </span><span class="n" id="mw4A">MyView</span><span class="w" id="mw4Q"> </span><span class="c1" id="mw4g">-- where MyView selects (with joins) the same columns from large table(s)</span> <span class="w" id="mw4w"> </span><span class="k" id="mw5A">RETURN</span> <span class="k" id="mw5Q">END</span>

2. On Microsoft SQL Server 2005 the result of the same code execution is the opposite: view is executed faster than the "function-wrapper".

User-defined functions are subroutines made of one or more Transact-SQL statements that can be used to encapsulate code for reuse. It takes zero or more arguments and evaluates a return value. Has both control-flow and DML statements in its body similar to stored procedures. Does not allow changes to any Global Session State, like modifications to database or external resource, such as a file or network. Does not support output parameter. DEFAULT keyword must be specified to pass the default value of parameter. Errors in UDF cause UDF to abort which, in turn, aborts the statement that invoked the UDF.

<span id="mw6Q"></span><span class="k" id="mw6g">CREATE</span><span class="w" id="mw6w"> </span><span class="k" id="mw7A">FUNCTION</span><span class="w" id="mw7Q"> </span><span class="n" id="mw7g">CubicVolume</span> <span class="c1" id="mw7w">-- Input dimensions in centimeters</span> <span class="p" id="mw8A">(</span> <span class="w" id="mw8Q"> </span><span class="nv" id="mw8g">@CubeLength</span><span class="w" id="mw8w"> </span><span class="nc" id="mw9A">decimal</span><span class="p" id="mw9Q">(</span><span class="mi" id="mw9g">4</span><span class="p" id="mw9w">,</span><span class="mi" id="mw-A">1</span><span class="p" id="mw-Q">),</span><span class="w" id="mw-g"> </span> <span class="w" id="mw-w"> </span><span class="nv" id="mw_A">@CubeWidth</span><span class="w" id="mw_Q"> </span><span class="nc" id="mw_g">decimal</span><span class="p" id="mw_w">(</span><span class="mi" id="mwAQA">4</span><span class="p" id="mwAQE">,</span><span class="mi" id="mwAQI">1</span><span class="p" id="mwAQM">),</span> <span class="w" id="mwAQQ"> </span><span class="nv" id="mwAQU">@CubeHeight</span><span class="w" id="mwAQY"> </span><span class="nc" id="mwAQc">decimal</span><span class="p" id="mwAQg">(</span><span class="mi" id="mwAQk">4</span><span class="p" id="mwAQo">,</span><span class="mi" id="mwAQs">1</span><span class="p" id="mwAQw">)</span> <span class="p" id="mwAQ0">)</span> <span class="w" id="mwAQ4"> </span><span class="k" id="mwAQ8">RETURNS</span><span class="w" id="mwARA"> </span><span class="nc" id="mwARE">decimal</span><span class="p" id="mwARI">(</span><span class="mi" id="mwARM">12</span><span class="p" id="mwARQ">,</span><span class="mi" id="mwARU">3</span><span class="p" id="mwARY">)</span> <span class="k" id="mwARc">AS</span> <span class="k" id="mwARg">BEGIN</span> <span class="w" id="mwARk"> </span><span class="k" id="mwARo">RETURN</span><span class="p" id="mwARs">(</span><span class="nv" id="mwARw">@CubeLength</span><span class="w" id="mwAR0"> </span><span class="o" id="mwAR4">*</span><span class="w" id="mwAR8"> </span><span class="nv" id="mwASA">@CubeWidth</span><span class="w" id="mwASE"> </span><span class="o" id="mwASI">*</span><span class="w" id="mwASM"> </span><span class="nv" id="mwASQ">@CubeHeight</span><span class="p" id="mwASU">)</span> <span class="k" id="mwASY">END</span>

Apache Hive

Apache Hive defines, in addition to the regular user-defined functions (UDF), also user-defined aggregate functions (UDAF) and table-generating functions (UDTF). Hive enables developers to create their own custom functions with Java.

Apache Doris

Apache Doris, an open-source real-time analytical database, allows external users to contribute their own UDFs written in C++ to it.