Benutzerdefinierte FunktionenUser-Defined Functions

Anwendungsbereich:Applies to: JaSQL ServerSQL Server (alle unterstützten Versionen) yesSQL ServerSQL Server (all supported versions) JaAzure SQL-DatenbankAzure SQL DatabaseYesAzure SQL-DatenbankAzure SQL DatabaseAnwendungsbereich:Applies to: JaSQL ServerSQL Server (alle unterstützten Versionen) yesSQL ServerSQL Server (all supported versions) JaAzure SQL-DatenbankAzure SQL DatabaseYesAzure SQL-DatenbankAzure SQL Database

Ebenso wie Funktionen in Programmiersprachen sind auch benutzerdefinierte Funktionen von SQL ServerSQL Server Routinen, die Parameter annehmen, eine Aktion ausführen (z. B. eine komplexe Berechnung) und das Ergebnis dieser Aktion als Wert zurückgeben können.Like functions in programming languages, SQL ServerSQL Server 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. Der Rückgabewert kann ein einzelner Skalarwert oder ein Resultset sein.The return value can either be a single scalar value or a result set.

Benutzerdefinierte FunktionenUser-defined functions

Gründe für die Verwendung benutzerdefinierter FunktionenWhy use user-defined functions (UDFs)?

  • Modulare Programmierung.They allow modular programming.

    Sie können die Funktion einmal erstellen, sie dann in der Datenbank speichern und beliebig oft in einem Programm aufrufen.You can create the function once, store it in the database, and call it any number of times in your program. Benutzerdefinierte Funktionen können unabhängig vom Programmquellcode geändert werden.User-defined functions can be modified independently of the program source code.

  • Schnellere Ausführung.They allow faster execution.

    Ähnlich wie gespeicherte Prozeduren verringern auch benutzerdefinierte Funktionen von Transact-SQLTransact-SQL die Kompilierungskosten von Transact-SQLTransact-SQL -Code, da die Pläne zwischengespeichert und für wiederholte Ausführungen erneut verwendet werden.Similar to stored procedures, Transact-SQLTransact-SQL user-defined functions reduce the compilation cost of Transact-SQLTransact-SQL code by caching the plans and reusing them for repeated executions. Dies bedeutet, dass die benutzerdefinierte Funktion nicht für jede Verwendung neu analysiert und optimiert werden muss; aus diesem Umstand ergeben sich wesentlich schnellere Ausführungszeiten.This means the user-defined function does not need to be reparsed and reoptimized with each use resulting in much faster execution times.

    CLR-Funktionen bieten gegenüber Transact-SQLTransact-SQL -Funktionen für Berechnungsaufgaben, Zeichenfolgebearbeitung und Geschäftslogik erhebliche Leistungsvorteile.CLR functions offer significant performance advantage over Transact-SQLTransact-SQL functions for computational tasks, string manipulation, and business logic. Transact-SQLTransact-SQL-Funktionen sind besser für datenzugriffsintensive Programmlogik geeignet.functions are better suited for data-access intensive logic.

  • Reduzierung der Netzwerkverkehrs.They can reduce network traffic.

    Eine Operation, die Daten basierend auf einer komplexen Einschränkung filtert, die nicht als einzelner Skalarausdruck ausgedrückt werden kann, kann als Funktion definiert werden.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. Diese Funktion kann anschließend in der WHERE-Klausel aufgerufen werden, um die Anzahl der an den Client gesendeten Zeilen zu verringern.The function can then be invoked in the WHERE clause to reduce the number of rows sent to the client.

Wichtig

Benutzerdefinierte Transact-SQLTransact-SQL-Funktionen in Abfragen können nur auf einem einzelnen Thread (serieller Ausführungsplan) ausgeführt werden.Transact-SQLTransact-SQL UDFs in queries can only be executed on a single thread (serial execution plan). Daher verhindert die Verwendung benutzerdefinierter Funktionen eine parallele Abfrageverarbeitung.Therefore using UDFs inhibits parallel query processing. Weitere Informationen zur parallelen Abfrageverarbeitung finden Sie im Handbuch zur Architektur der Abfrageverarbeitung.For more information about parallel query processing, see the Query Processing Architecture Guide.

FunktionstypenTypes of functions

SkalarfunktionScalar Function
Benutzerdefinierte Skalarfunktionen geben einen einzelnen Datenwert des definierten Datentyps in einer RETURNS-Klausel zurück.User-defined scalar functions return a single data value of the type defined in the RETURNS clause. Bei einer Inlineskalarfunktion ist der zurückgegebene Skalarwert das Ergebnis einer einzelnen Anweisung.For an inline scalar function, the returned scalar value is the result of a single statement. Bei einer aus mehreren Anweisungen bestehenden Skalarfunktion kann der Hauptteil der Funktion eine Reihe von Transact-SQLTransact-SQL-Anweisungen enthalten, die den einzelnen Wert zurückgeben.For a multistatement scalar function, the function body can contain a series of Transact-SQLTransact-SQL statements that return the single value. Der Rückgabetyp kann ein beliebiger Datentypen mit Ausnahme von text, ntext, image, cursorund timestampsein.The return type can be any data type except text, ntext, image, cursor, and timestamp. Beispiele.Examples.

TabellenwertfunktionenTable-Valued Functions
Benutzerdefinierte Tabellenwertfunktionen geben einen table -Datentyp zurück.User-defined table-valued functions return a table data type. Bei einer Inlinefunktion mit Tabellenrückgabe gibt es keinen Funktionshauptteil; die Tabelle ist das Resultset einer einzelnen SELECT-Anweisung.For an inline table-valued function, there is no function body; the table is the result set of a single SELECT statement. Beispiele.Examples.

SystemfunktionenSystem Functions
SQL ServerSQL Server stellt viele Systemfunktionen bereit, mit denen Sie eine Vielzahl von Vorgängen ausführen können.provides many system functions that you can use to perform a variety of operations. Sie können nicht geändert werden.They cannot be modified. Weitere Informationen finden Sie unter Integrierte Funktionen (Transact-SQL), Systemgespeicherte Funktionen (Transact-SQL) und Dynamische Verwaltungssichten und -funktionen (Transact-SQL).For more information, see Built-in Functions (Transact-SQL), System Stored Functions (Transact-SQL), and Dynamic Management Views and Functions (Transact-SQL).

RichtlinienGuidelines

Transact-SQLTransact-SQL-Fehler, die dazu führen, dass eine Anweisung abgebrochen und mit der nächsten Anweisung fortgefahren wird (z.B. Trigger oder gespeicherte Prozeduren), werden innerhalb einer Funktion anders behandelt.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 Funktionen bewirken solche Fehler, dass die Ausführung der Funktion beendet wird.In functions, such errors cause the execution of the function to stop. Dies hat wiederum zur Folge, dass die Anweisung abgebrochen wird, die die Funktion aufgerufen hat.This in turn causes the statement that invoked the function to be canceled.

Die Anweisungen in einem BEGIN...END-Block dürfen keine Nebeneffekte haben.The statements in a BEGIN...END block cannot have any side effects. Nebeneffekte von Funktionen sind dauerhafte Änderungen am Status einer Ressource, deren Gültigkeitsbereich außerhalb der Funktion liegt, wie z. B. Änderungen an einer Datenbanktabelle.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. Die einzigen Änderungen, die von den Anweisungen in der Funktion vorgenommen werden dürfen, sind Änderungen an lokalen Objekten der Funktion, wie z. B. lokale Cursor oder Variablen.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. Änderungen an Datenbanktabellen, Cursorvorgänge außerhalb der Funktion, das Senden von E-Mails, das Ausführen einer Katalogänderung und das Generieren eines Resultsets, das an den Benutzer zurückgegeben wird, sind Beispiele für Aktionen, die in einer Funktion nicht ausgeführt werden können.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.

Hinweis

Wenn eine CREATE FUNCTION-Anweisung zu Nebeneffekten bei Ressourcen führt, die beim Ausgeben der CREATE FUNCTION-Anweisung nicht vorhanden sind, führt SQL ServerSQL Server die Anweisung aus.If a CREATE FUNCTION statement produces side effects against resources that do not exist when the CREATE FUNCTION statement is issued, SQL ServerSQL Server executes the statement. SQL ServerSQL Server führt die Funktion jedoch beim Aufrufen nicht aus.However, SQL ServerSQL Server does not execute the function when it is invoked.

Wie oft eine in einer Abfrage angegebene Funktion tatsächlich ausgeführt wird, kann bei den vom Abfrageoptimierer erstellten Ausführungsplänen variieren.The number of times that a function specified in a query is actually executed can vary between execution plans built by the optimizer. Ein Beispiel hierfür ist eine Funktion, die von einer Unterabfrage in einer WHERE-Klausel aufgerufen wird.An example is a function invoked by a subquery in a WHERE clause. Wie oft die Unterabfrage und deren Funktion ausgeführt wird, kann bei den verschiedenen Zugriffsmethoden variieren, die der Abfrageoptimierer auswählt.The number of times the subquery and its function is executed can vary with different access paths chosen by the optimizer.

Wichtig

Weitere Informationen und Leistungsüberlegungen zu benutzerdefinierten Funktionen finden Sie unter Erstellen von benutzerdefinierten Funktionen (Datenbank-Engine).For more information and performance considerations on user-defined functions, see Create User-defined Functions (Database Engine).

Gültige Anweisungen in einer FunktionValid statements in a function

Die folgenden Anweisungstypen sind in einer Funktion zulässig:The types of statements that are valid in a function include:

  • DECLARE-Anweisungen zum Definieren von lokalen Datenvariablen und lokalen Cursorn für die Funktion.DECLARE statements can be used to define data variables and cursors that are local to the function.

  • Zuweisungen von Werten zu lokalen Objekten für die Funktion, wie z.B. das Zuweisen von Werten zu lokalen Skalar- und Tabellenwerten mithilfe von SET.Assignments of values to objects local to the function, such as using SET to assign values to scalar and table local variables.

  • Cursorvorgänge, die auf lokale Cursor verweisen, die in der Funktion deklariert, geöffnet, geschlossen und deren Zuordnungen aufgehoben werden.Cursor operations that reference local cursors that are declared, opened, closed, and deallocated in the function. FETCH-Anweisungen, die Daten an den Client zurückgeben, sind nicht zulässig.FETCH statements that return data to the client are not allowed. Nur FETCH-Anweisungen, die lokalen Variablen Werte mithilfe der INTO-Klausel zuweisen, sind zulässig.Only FETCH statements that assign values to local variables using the INTO clause are allowed.

  • Anweisungen zur Ablaufsteuerung mit Ausnahme von TRY...CATCH-Anweisungen.Control-of-flow statements except TRY...CATCH statements.

  • SELECT-Anweisungen, die Auswahllisten mit Ausdrücken enthalten, in denen Werte Variablen zugewiesen werden, die in der Funktion lokal gelten.SELECT statements containing select lists with expressions that assign values to variables that are local to the function.

  • UPDATE-, INSERT- und DELETE-Anweisungen, die lokale Tabellenvariablen der Funktion ändern.UPDATE, INSERT, and DELETE statements modifying table variables that are local to the function.

  • EXECUTE-Anweisungen, die eine erweiterte gespeicherte Prozedur aufrufen.EXECUTE statements calling an extended stored procedure.

Integrierte SystemfunktionenBuilt-in system functions

Die folgenden nicht deterministischen integrierten Funktionen können in benutzerdefinierten Transact-SQL-Funktionen verwendet werden.The following nondeterministic built-in functions can be used in Transact-SQL user-defined functions.

CURRENT_TIMESTAMPCURRENT_TIMESTAMP

@@MAX_CONNECTIONS@@MAX_CONNECTIONS

GET_TRANSMISSION_STATUSGET_TRANSMISSION_STATUS

@@PACK_RECEIVED@@PACK_RECEIVED

GETDATEGETDATE

@@PACK_SENT@@PACK_SENT

GETUTCDATEGETUTCDATE

@@PACKET_ERRORS@@PACKET_ERRORS

@@CONNECTIONS@@CONNECTIONS

@@TIMETICKS@@TIMETICKS

@@CPU_BUSY@@CPU_BUSY

@@TOTAL_ERRORS@@TOTAL_ERRORS

@@DBTS@@DBTS

@@TOTAL_READ@@TOTAL_READ

@@IDLE@@IDLE

@@TOTAL_WRITE@@TOTAL_WRITE

@@IO_BUSY@@IO_BUSY

Die folgenden nicht deterministischen integrierten Funktionen können in benutzerdefinierten Transact-SQLTransact-SQL-Funktionen nicht verwendet werden.The following nondeterministic built-in functions cannot be used in Transact-SQLTransact-SQL user-defined functions.

NEWIDNEWID

RANDRAND

NEWSEQUENTIALIDNEWSEQUENTIALID

TEXTPTRTEXTPTR

Eine Liste der deterministischen und nicht deterministischen integrierten Systemfunktionen finden Sie unter Deterministische und nicht deterministische Funktionen.For a list of deterministic and nondeterministic built-in system functions, see Deterministic and Nondeterministic Functions.

Schemagebundene FunktionenSchema-bound functions

CREATE FUNCTION unterstützt eine SCHEMABINDING-Klausel, die die Funktion an das Schema von Objekten bindet, auf die verwiesen wird, wie z.B. Tabellen, Sichten und andere benutzerdefinierte Funktionen.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. Der Versuch, ein Objekt zu ändern oder zu löschen, auf das von einer schemagebundenen Funktion verwiesen wird, erzeugt einen Fehler.An attempt to alter or drop any object referenced by a schema-bound function fails.

Die folgenden Bedingungen müssen erfüllt sein, um SCHEMABINDING in CREATE FUNCTION angeben zu können:These conditions must be met before you can specify SCHEMABINDING in CREATE FUNCTION:

  • Alle Sichten und benutzerdefinierten Funktionen, auf die die Funktion verweist, müssen schemagebunden sein.All views and user-defined functions referenced by the function must be schema-bound.

  • Alle Objekte, auf die die Funktion verweist, müssen sich in derselben Datenbank wie die Funktion befinden.All objects referenced by the function must be in the same database as the function. Auf die Objekte muss mit ein- oder zweiteiligen Namen verwiesen werden.The objects must be referenced using either one-part or two-part names.

  • Sie benötigen die REFERENCES-Berechtigung für alle Objekte (Tabellen, Sichten und benutzerdefinierte Funktion), auf die in der Funktion verwiesen wird.You must have REFERENCES permission on all objects (tables, views, and user-defined functions) referenced in the function.

Mit ALTER FUNCTION können Sie die Schemabindung entfernen.You can use ALTER FUNCTION to remove the schema binding. Die ALTER FUNCTION-Anweisung sollte die Funktion neu definieren, ohne WITH SCHEMABINDING anzugeben.The ALTER FUNCTION statement should redefine the function without specifying WITH SCHEMABINDING.

Angeben von ParameternSpecifying parameters

Eine benutzerdefinierte Funktion verwendet null oder mehr Eingabeparameter und gibt einen Skalarwert oder eine Tabelle zurück.A user-defined function takes zero or more input parameters and returns either a scalar value or a table. Eine Funktion kann maximal 1024 Eingabeparameter haben.A function can have a maximum of 1024 input parameters. Wenn ein Parameter der Funktion über einen Standardwert verfügt, muss beim Aufrufen der Funktion das DEFAULT-Schlüsselwort angegeben werden, um den Standardwert zu erhalten.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. In diesem Punkt gibt es einen Unterschied zu den Parametern einer benutzerdefinierten gespeicherten Prozedur. Fehlt im Aufruf einer benutzerdefinierten gespeicherten Prozedur ein Parameter, der einen Standardwert hat, wird automatisch dieser Standardwert verwendet.This behavior is different from parameters with default values in user-defined stored procedures in which omitting the parameter also implies the default value. Benutzerdefinierte Funktionen unterstützen keine Ausgabeparameter.User-defined functions do not support output parameters.

Weitere Beispiele!More examples!

TaskbeschreibungTask Description ThemaTopic
Beschreibt, wie eine benutzerdefinierte Transact-SQL-Funktion erstellt wird.Describes how to create a Transact-SQL user-defined function. Erstellen benutzerdefinierter Funktionen (Datenbank-Engine)Create User-defined Functions (Database Engine)
Beschreibt, wie eine CLR-Funktion erstellt wird.Describes how create a CLR function. Erstellen von CLR-FunktionenCreate CLR Functions
Beschreibt, wie eine benutzerdefinierte Aggregatfunktion erstellt wird.Describes how to create a user-defined aggregate function Erstellen benutzerdefinierter AggregateCreate User-defined Aggregates
Beschreibt, wie eine benutzerdefinierte Transact-SQL-Funktion geändert wird.Describes how to modify a Transact-SQL user-defined function. Ändern benutzerdefinierter FunktionenModify User-defined Functions
Beschreibt, wie eine benutzerdefinierte Funktion gelöscht wird.Describes how to delete a user-defined function. Löschen von benutzerdefinierten FunktionenDelete User-defined Functions
Beschreibt, wie eine benutzerdefinierte Funktion ausgeführt wird.Describes how to execute a user-defined function. Ausführen von benutzerdefinierten FunktionenExecute User-defined Functions
Beschreibt, wie eine benutzerdefinierte Funktion umbenannt wird.Describes how to rename a user-defined function Umbenennen von benutzerdefinierten FunktionenRename User-defined Functions
Beschreibt, wie die Definition einer benutzerdefinierten Funktion angezeigt wird.Describes how to view the definition of a user-defined function. Anzeigen benutzerdefinierter FunktionenView User-defined Functions