Skip to content

Latest commit

 

History

History
139 lines (98 loc) · 11.4 KB

user-defined-functions.md

File metadata and controls

139 lines (98 loc) · 11.4 KB
title ms.custom ms.date ms.prod ms.prod_service ms.reviewer ms.technology ms.topic helpviewer_keywords ms.assetid author ms.author monikerRange
User-Defined Functions | Microsoft Docs
08/05/2016
sql
database-engine, sql-database
conceptual
user-defined functions [SQL Server], components
user-defined functions [SQL Server], about user-defined functions
UDF
TVF
d7ddafab-f5a6-44b0-81d5-ba96425aada4
rothja
jroth
=azuresqldb-current||>=sql-server-2016||=sqlallproducts-allversions||>=sql-server-linux-2017||=azuresqldb-mi-current

User-Defined Functions

[!INCLUDEtsql-appliesto-ss2008-asdb-xxxx-xxx-md] Like functions in programming languages, [!INCLUDEssNoVersion] user-defined functions are routines that accept parameters, perform an action, such as a complex calculation, and return the result of that action as a value. The return value can either be a single scalar value or a result set.

User-defined functions

Why use user-defined functions (UDFs)?

  • They allow modular programming.

    You can create the function once, store it in the database, and call it any number of times in your program. User-defined functions can be modified independently of the program source code.

  • They allow faster execution.

    Similar to stored procedures, [!INCLUDEtsql] user-defined functions reduce the compilation cost of [!INCLUDEtsql] code by caching the plans and reusing them for repeated executions. This means the user-defined function does not need to be reparsed and reoptimized with each use resulting in much faster execution times.

    CLR functions offer significant performance advantage over [!INCLUDEtsql] functions for computational tasks, string manipulation, and business logic. [!INCLUDEtsql] functions are better suited for data-access intensive logic.

  • They can reduce network traffic.

    An operation that filters data based on some complex constraint that cannot be expressed in a single scalar expression can be expressed as a function. The function can then be invoked in the WHERE clause to reduce the number of rows sent to the client.

Important

[!INCLUDEtsql] UDFs in queries can only be executed on a single thread (serial execution plan). Therefore using UDFs inhibits parallel query processing. For more information about parallel query processing, see the Query Processing Architecture Guide.

Types of functions

Scalar Function
User-defined scalar functions return a single data value of the type defined in the RETURNS clause. For an inline scalar function, the returned scalar value is the result of a single statement. For a multistatement scalar function, the function body can contain a series of [!INCLUDEtsql] statements that return the single value. The return type can be any data type except text, ntext, image, cursor, and timestamp. Examples.

Table-Valued Functions
User-defined table-valued functions return a table data type. For an inline table-valued function, there is no function body; the table is the result set of a single SELECT statement. Examples.

System Functions
[!INCLUDEssNoVersion] provides many system functions that you can use to perform a variety of operations. They cannot be modified. For more information, see Built-in Functions (Transact-SQL), System Stored Functions (Transact-SQL), and Dynamic Management Views and Functions (Transact-SQL).

Guidelines

[!INCLUDEtsql] errors that cause a statement to be canceled and continue with the next statement in the module (such as triggers or stored procedures) are treated differently inside a function. In functions, such errors cause the execution of the function to stop. This in turn causes the statement that invoked the function to be canceled.

The statements in a BEGIN...END block cannot have any side effects. Function side effects are any permanent changes to the state of a resource that has a scope outside the function such as a modification to a database table. The only changes that can be made by the statements in the function are changes to objects local to the function, such as local cursors or variables. Modifications to database tables, operations on cursors that are not local to the function, sending e-mail, attempting a catalog modification, and generating a result set that is returned to the user are examples of actions that cannot be performed in a function.

Note

If a CREATE FUNCTION statement produces side effects against resources that do not exist when the CREATE FUNCTION statement is issued, [!INCLUDEssNoVersion] executes the statement. However, [!INCLUDEssNoVersion] does not execute the function when it is invoked.

The number of times that a function specified in a query is actually executed can vary between execution plans built by the optimizer. An example is a function invoked by a subquery in a WHERE clause. The number of times the subquery and its function is executed can vary with different access paths chosen by the optimizer.

Important

For more information and performance considerations on user-defined functions, see Create User-defined Functions (Database Engine).

Valid statements in a function

The types of statements that are valid in a function include:

  • DECLARE statements can be used to define data variables and cursors that are local to the function.

  • Assignments of values to objects local to the function, such as using SET to assign values to scalar and table local variables.

  • Cursor operations that reference local cursors that are declared, opened, closed, and deallocated in the function. FETCH statements that return data to the client are not allowed. Only FETCH statements that assign values to local variables using the INTO clause are allowed.

  • Control-of-flow statements except TRY...CATCH statements.

  • SELECT statements containing select lists with expressions that assign values to variables that are local to the function.

  • UPDATE, INSERT, and DELETE statements modifying table variables that are local to the function.

  • EXECUTE statements calling an extended stored procedure.

Built-in system functions

The following nondeterministic built-in functions can be used in Transact-SQL user-defined functions.
CURRENT_TIMESTAMP @@MAX_CONNECTIONS
GET_TRANSMISSION_STATUS @@PACK_RECEIVED
GETDATE @@PACK_SENT
GETUTCDATE @@PACKET_ERRORS
@@CONNECTIONS @@TIMETICKS
@@CPU_BUSY @@TOTAL_ERRORS
@@DBTS @@TOTAL_READ
@@IDLE @@TOTAL_WRITE
@@IO_BUSY

The following nondeterministic built-in functions cannot be used in [!INCLUDEtsql] user-defined functions.
NEWID RAND
NEWSEQUENTIALID TEXTPTR

For a list of deterministic and nondeterministic built-in system functions, see Deterministic and Nondeterministic Functions.

Schema-bound functions

CREATE FUNCTION supports a SCHEMABINDING clause that binds the function to the schema of any objects it references, such as tables, views, and other user-defined functions. An attempt to alter or drop any object referenced by a schema-bound function fails.

These conditions must be met before you can specify SCHEMABINDING in CREATE FUNCTION:

  • All views and user-defined functions referenced by the function must be schema-bound.

  • All objects referenced by the function must be in the same database as the function. The objects must be referenced using either one-part or two-part names.

  • You must have REFERENCES permission on all objects (tables, views, and user-defined functions) referenced in the function.

You can use ALTER FUNCTION to remove the schema binding. The ALTER FUNCTION statement should redefine the function without specifying WITH SCHEMABINDING.

Specifying parameters

A user-defined function takes zero or more input parameters and returns either a scalar value or a table. A function can have a maximum of 1024 input parameters. When a parameter of the function has a default value, the keyword DEFAULT must be specified when calling the function to get the default value. This behavior is different from parameters with default values in user-defined stored procedures in which omitting the parameter also implies the default value. User-defined functions do not support output parameters.

More examples!
Task Description Topic
Describes how to create a Transact-SQL user-defined function. Create User-defined Functions (Database Engine)
Describes how create a CLR function. Create CLR Functions
Describes how to create a user-defined aggregate function Create User-defined Aggregates
Describes how to modify a Transact-SQL user-defined function. Modify User-defined Functions
Describes how to delete a user-defined function. Delete User-defined Functions
Describes how to execute a user-defined function. Execute User-defined Functions
Describes how to rename a user-defined function Rename User-defined Functions
Describes how to view the definition of a user-defined function. View User-defined Functions