Verwenden von Token in Auftragsschritten

Gilt für:SQL ServerAzure SQL Managed Instance

Der SQL Server-Agent ermöglicht die Verwendung von Token in Transact-SQL-Auftragsschrittskripts. Durch die Verwendung von Token verfügen Sie beim Schreiben von Auftragsschritten über dieselbe Flexibilität, die die Verwendung von Variablen beim Schreiben von Softwareprogrammen bietet. Die von Ihnen in ein Auftragsschrittskript eingefügten Token werden vom SQL Server-Agent zur Laufzeit ersetzt, bevor der Auftragsschritt vom Transact-SQL-Subsystem ausgeführt wird.

Grundlegendes zum Verwenden von Token

SQL Server Agent-Token können einfach und effizient ersetzt werden: Der SQL Server -Agent ersetzt das Token durch ein genaues Zeichenfolgenliteral. Die Groß- und Kleinschreibung ist bei Token grundsätzlich zu beachten. Dies muss in den Auftragsschritten berücksichtigt werden, damit die verwendeten Token richtig angegeben werden oder die Ersatzzeichenfolge in den richtigen Datentyp konvertiert wird.

Mit der folgenden Anweisung können Sie z. B. den Namen der Datenbank in einem Auftragsschritt drucken:

PRINT N'Current database name is $(ESCAPE_SQUOTE(A-DBN))' ;

In diesem Beispiel wird das Makro ESCAPE_SQUOTE mit dem Token A-DBN eingefügt. Zur Laufzeit ersetzt das Token A-DBN durch den entsprechenden Datenbanknamen. Das Escapemakro umgeht alle einfachen Anführungszeichen, die möglicherweise unbeabsichtigt in der Zeichenfolge, durch die das Token ersetzt werden soll, übergeben werden. SQL Server Agent ersetzt in der endgültigen Zeichenfolge jedes einfache Anführungszeichen durch zwei einfache Anführungszeichen.

Wenn beispielsweise als Ersatz für das Token die Zeichenfolge AdventureWorks2022'SELECT @@VERSION --übergeben wird, wird im SQL Server -Agent-Auftragsschritt der folgende Befehl ausgeführt:

PRINT N'Current database name is AdventureWorks2022''SELECT @@VERSION --' ;

In diesem Fall wird die eingefügte Anweisung SELECT @@VERSION nicht ausgeführt. Stattdessen wird durch das überzählige einfache Anführungszeichen der Server veranlasst, die eingefügte Anweisung als Zeichenfolge zu analysieren. Wenn die Zeichenfolge, durch die das Token ersetzt werden soll, keine einfachen Anführungszeichen enthält, werden keine Zeichen umgangen, und der Auftragsschritt mit dem Token wird wie beabsichtigt ausgeführt.

Verwenden Sie zum Debuggen der Tokenverwendung in Auftragsschritten Druckanweisungen, wie z. B. PRINT N'$(ESCAPE_SQUOTE(SQLDIR))' , und speichern Sie die Auftragsschrittausgabe in einer Datei oder Tabelle. Auf der Seite Erweitert des Dialogfelds Auftragsschritt-Eigenschaften können Sie eine Datei oder Tabelle für die Auftragsschrittausgabe angeben.

SQL Server-Agent-Token und -Makros

In der folgenden Tabelle sind die vom SQL Server -Agent unterstützten Token und Makros aufgelistet und beschrieben.

SQL Server-Agent-Token

SQL Server-Agent-Escapemakros

Aktualisieren von Auftragsschritten für die Verwendung von Makros

Die folgende Tabelle beschreibt, wie die symbolische Ersetzung von SQL Server -Agent behandelt wird. Um die Tokenersetzung durch Warnungen ein- oder auszuschalten, klicken Sie im Objekt-Explorer mit der rechten Maustaste auf SQL Server-Agent , wählen Sie Eigenschaften, und aktivieren bzw. deaktivieren Sie anschließend auf der Seite Warnungssystem das Kontrollkästchen Token für alle Auftragsantworten auf Warnungen ersetzen .

Beispiele für Updates der Tokensyntax

Im Folgenden finden Sie Beispiele für die Tokensyntax, um zu veranschaulichen, wie diese Befehle verwendet werden.

.A Verwenden von Token in nicht geschachtelten Zeichenfolgen

Im folgenden Beispiel wird gezeigt, wie Sie ein einfaches, nicht geschachteltes Skript mit dem entsprechenden Escapemakro aktualisieren. Vor dem Ausführen des Updateskripts verwendet das folgende Auftragsschrittskript ein Auftragsschritttoken, um den entsprechenden Datenbanknamen zu drucken:

PRINT N'Current database name is $(A-DBN)' ;

Nach dem Ausführen des Updateskripts wird vor dem ESCAPE_NONE -Token ein A-DBN -Makro eingefügt. Da die Druckzeichenfolge durch einfache Anführungszeichen begrenzt wird, müssen Sie den Auftragsschritt aktualisieren, indem Sie das ESCAPE_SQUOTE -Makro folgendermaßen einfügen:

PRINT N'Current database name is $(ESCAPE_SQUOTE(A-DBN))' ;

B. Verwenden von Token in geschachtelten Zeichenfolgen

In Auftragsschritten, in denen Token in geschachtelten Zeichenfolgen oder Anweisungen verwendet werden, sollten die geschachtelten Anweisungen als Einzelanweisungen neu geschrieben werden, bevor die entsprechenden Escapemakros eingefügt werden.

Betrachten Sie z. B. den folgenden Auftragsschritt, der das Token A-MSG verwendet und nicht mit einem Escapemakro aktualisiert wurde:

PRINT N'Print ''$(A-MSG)''' ;

Nach dem Ausführen des Updateskripts wird mit dem Token ein ESCAPE_NONE -Makro eingefügt. In diesem Fall müssten Sie das Skript jedoch ohne Verwenden von Schachtelungen folgendermaßen neu schreiben und das ESCAPE_SQUOTE -Makro einfügen, damit die in der Token-Ersetzungszeichenfolge möglicherweise übergebenen Begrenzungszeichen richtig umgangen werden:

DECLARE @msgString nvarchar(max);
SET @msgString = '$(ESCAPE_SQUOTE(A-MSG))';
SET @msgString = QUOTENAME(@msgString,'''');
PRINT N'Print ' + @msgString;

C. Verwenden von Token mit dem ESCAPE_NONE-Makro

Das folgende Beispiel ist Teil eines Skripts, mit dem die Auftrags-ID (job_id) aus der sysjobs-Tabelle abgerufen wird und mithilfe des JOBID-Tokens die zuvor im Skript als binärer Datentyp deklarierte @JobID-Variable aufgefüllt wird.

DECLARE @JobID uniqueidentifier
SET @JobID = $(ESCAPE_NONE(JOBID))

Dadurch wird der Wert aus dem JOBID-Token direkt @JobID zugewiesen, wodurch unnötige Datenbankabfragen und implizite Konvertierungen beseitigt werden, wobei die in Abschnitt C angesprochenen Bedenken behandelt werden.

Siehe auch

• Implementieren von Aufträgen
• Verwalten von Auftragsschritten