Integration Services-Paket- und Projektparameter (SSIS)

Gilt für: SQL Server SSIS Integration Runtime in Azure Data Factory

Mit Integration Services-Parametern (SSIS) können Sie Eigenschaften in Paketen zur Zeit der Paketausführung Werte zuweisen. Sie können Projektparameter auf Projektebene und Paketparameter auf Paketebene erstellen. Projektparameter werden verwendet, um jegliche externen Eingaben bereitzustellen, die das Projekt für ein oder mehrere Pakete im Projekt empfängt. Mit Paketparametern können Sie die Paketausführung ändern, ohne das Paket bearbeiten und erneut bereitstellen zu müssen.

In SQL Server Data Tools können Sie im Fenster Project.params Projektparameter erstellen, ändern oder löschen. Sie erstellen, ändern und löschen Paketparameter mit der Registerkarte Parameter im SSIS -Designer. Im Dialogfeld Parametrisieren können Sie einen neuen oder vorhandenen Parameter einer Taskeigenschaft zuordnen. Weitere Informationen zum Verwenden des Fensters Project.params und der Registerkarte Parameter finden Sie unter Create Parameters. Weitere Informationen zum Dialogfeld Parametrisieren finden Sie unter Parameterize Dialog Box.

Parameter und Paketbereitstellungsmodell

Im Allgemeinen sollten Sie beim Bereitstellen eines Pakets mit dem Paketbereitstellungsmodell Konfigurationen anstelle von Parametern verwenden.

Wenn Sie mithilfe des Paketbereitstellungsmodells ein Paket bereitstellen, das Parameter enthält, und dann das Paket ausführen, werden die Parameter während der Ausführung nicht aufgerufen. Wenn das Paket Paketparameter und Ausdrücke innerhalb des Pakets enthält, verwenden Sie die Parameter, die resultierenden Werte werden zur Laufzeit übernommen. Wenn das Paket Projektparameter enthält, tritt bei der Paketausführung möglicherweise ein Fehler auf.

Parameter und Projektbereitstellungsmodell

Wenn Sie ein Projekt auf dem Integration Services-Server (SSIS) bereitstellen, verwenden Sie Sichten, gespeicherte Prozeduren und die SQL Server Management Studio -Benutzeroberfläche zum Verwalten von Projekt- und Paketparametern. Weitere Informationen finden Sie in den nachfolgenden Themen.

• Sichten (Integration Services-Katalog)

• Gespeicherte Prozeduren (Integration Services-Katalog)

• Konfigurieren (Dialogfeld)

• Paket ausführen (Dialogfeld)

Parameterwerte

Sie können einem Parameter bis zu drei verschiedene Werttypen zuweisen. Wenn eine Paketausführung gestartet wird, wird ein einzelner Wert für den Parameter verwendet, und der Parameter wird in seinen abschließenden Literalwert aufgelöst.

In der folgenden Tabelle sind die Werttypen aufgeführt.

Sie können mehreren Paketeigenschaften mithilfe eines einzelnen Parameters einen Wert zuweisen. Einer einzelnen Paketeigenschaft kann nur ein Wert aus einem einzelnen Parameter zugewiesen werden.

Ausführungen und Parameterwerte

Die Ausführung ist ein Objekt, das eine einzelne Instanz der Paketausführung darstellt. Wenn Sie eine Ausführung erstellen, geben Sie alle Details an, die zum Ausführen eines Pakets erforderlich sind, z. B. Ausführungsparameterwerte. Sie können die Parameterwerte vorhandener Ausführungen auch ändern.

Wenn Sie einen Ausführungsparameterwert explizit festlegen, ist dieser Wert nur auf diese spezielle Instanz der Ausführung anwendbar. Der Ausführungswert wird anstelle eines Serverwerts oder eines Entwurfswerts verwendet. Wenn Sie keinen Ausführungswert explizit festlegen und ein Serverwert angegeben wurde, wird der Serverwert verwendet.

Wenn ein Parameter entsprechend markiert ist, muss für diesen Parameter ein Serverwert oder ein Ausführungswert angegeben werden. Andernfalls wird das entsprechende Paket nicht ausgeführt. Obwohl der Parameter zur Entwurfszeit über einen Standardwert verfügt, wird er nie verwendet, nachdem das Projekt bereitgestellt wurde.

Umgebungsvariablen

Wenn ein Parameter auf eine Umgebungsvariable verweist, wird der Literalwert dieser Variable durch den angegebenen Umgebungsverweis aufgelöst und auf den Parameter angewendet. Der finale Literalparameterwert, der für die Paketausführung verwendet wird, wird als Ausführungsparameterwert bezeichnet. Sie geben den Umgebungsverweis für eine Ausführung im Dialogfeld Ausführen an.

Wenn ein Projektparameter auf eine Umgebungsvariable verweist und der Literalwert in der Variablen bei der Ausführung nicht aufgelöst werden kann, wird der Entwurfswert verwendet. Der Serverwert wird nicht verwendet.

Um die Umgebungsvariablen anzuzeigen, die Parameterwerten zugewiesen werden, fragen Sie die catalog.object_parameters-Sicht ab. Weitere Informationen finden Sie unter catalog.object_parameters (SSISDB-Datenbank).

Bestimmen von Ausführungsparameterwerten

Die folgenden Transact-SQL-Sichten und die gespeicherte Prozedur können verwendet werden, um Parameterwerte anzuzeigen und festzulegen.

catalog.execution_parameter_values (SSISDB-Datenbank) (Sicht)
Hiermit werden die tatsächlichen Parameterwerte in einer bestimmten Ausführung angezeigt.

catalog.get_parameter_values (SSISDB-Datenbank) (gespeicherte Prozedur)
Hiermit werden die tatsächlichen Werte für das angegebene Paket und den Umgebungsverweis aufgelöst und angezeigt.

catalog.object_parameters (SSISDB-Datenbank) (Sicht)
Zeigt die Parameter und Eigenschaften für alle Pakete und Projekte im Integration Services -Katalog an, einschließlich der Entwurfsstandard- und Serverstandardwerte.

catalog.set_execution_parameter_value (SSISDB-Datenbank)
Legt den Wert eines Parameters für eine Instanz der Ausführung im Integration Services -Katalog fest.

Sie können den Parameterwert auch im Dialogfeld Paket ausführen in SQL Server Data Tools (SSDT) ändern. Weitere Informationen finden Sie unter Execute Package Dialog Box.

Sie können einen Parameterwert auch mit der dtexec-Option /Parameter ändern. Weitere Informationen finden Sie hier.

Parameterüberprüfung

Wenn Parameterwerte nicht aufgelöst werden können, schlägt die entsprechende Paketausführung fehl. Zur Fehlervermeidung können Sie Projekte und Pakete im Dialogfeld Überprüfen in SQL Server Data Tools (SSDT)überprüfen. Mit der Überprüfung stellen Sie sicher, dass alle Parameter über die notwendigen Werte verfügen oder die notwendigen Werte mit bestimmten Umgebungsverweisen auflösen können. Mit der Überprüfung können auch andere häufig auftretende Paketprobleme überprüft werden.

Weitere Informationen finden Sie unter Validate Dialog Box.

Parameterbeispiel

In diesem Beispiel wird ein Parameter mit dem Namen pkgOptions beschrieben, der für die Angabe von Optionen für das Paket verwendet wird, in dem er sich befindet.

Während der Entwurfszeit, als der Parameter in SQL Server Data Toolserstellt wurde, wurde dem Parameter der Standardwert 1 zugewiesen. Dieser Standardwert wird als Entwurfsstandard bezeichnet. Wenn das Projekt im SSISDB-Katalog bereitgestellt wurde und diesem Parameter keine anderen Werte zugewiesen wurden, würde der Paketeigenschaft, die dem pkgOptions -Parameter entspricht, während der Paketausführung der Wert 1 zugewiesen werden. Der Entwurfsstandard bleibt während des gesamten Lebenszyklus des Projekts erhalten.

Während der Vorbereitung einer bestimmten Instanz der Paketausführung wird dem pkgOptions -Parameter der Wert 5 zugewiesen. Dieser Wert wird als Ausführungswert bezeichnet, da es für den Parameter nur für diese spezifische Instanz der Ausführung gilt. Wenn die Ausführung startet, wird der dem pkgOptions -Parameter entsprechenden Paketeigenschaft der Wert 5 zugewiesen.

Erstellen von Parametern

Sie verwenden SQL Server Data Tools (SSDT) , um Projektparameter und Paketparameter zu erstellen. Die folgenden Prozeduren stellen schrittweise Anweisungen zum Erstellen von Paket-/Projektparametern bereit.

Erstellen von Paketparametern

1. Öffnen Sie das Paket in SQL Server Data Tools, und klicken Sie dann auf die Registerkarte Parameter im SSIS-Designer.

   

2. Klicken Sie auf die Schaltfläche Parameter hinzufügen auf der Symbolleiste.

   

3. Geben Sie Werte für die Eigenschaften Name, Datentyp, Wert, Vertraulichund Erforderlich in der Liste selbst oder im Fenster Eigenschaften ein. In der folgenden Tabelle werden diese Eigenschaften beschrieben.

   Eigenschaft	Beschreibung
   Name	Der Name des Parameters.
   Datentyp	Der Datentyp des Parameters.
   Standardwert	Der Standardwert für den zur Entwurfszeit zugewiesenen Parameter. Dieser wird auch als Entwurfsstandard bezeichnet.
   Sensibel	Vertrauliche Parameterwerte werden im Katalog verschlüsselt und in Transact-SQL oder SQL Server Management Studio als NULL-Wert angezeigt.
   Erforderlich	Dazu muss ein anderer als der Entwurfsstandardwert angegeben werden, bevor das Paket ausgeführt werden kann.
   BESCHREIBUNG	Die Beschreibung des Parameters für bessere Verwaltbarkeit. Legen Sie im Visual Studio-Eigenschaftenfenster von SQL Server Data Tools (SSDT)die Parameterbeschreibung fest, wenn der Parameter im entsprechenden Parameterfenster ausgewählt wurde.

   Hinweis

   Wenn Sie im Katalog ein Projekt bereitstellen, werden dem Projekt einige weitere Eigenschaften zugeordnet. Um alle Eigenschaften für alle Parameter im Katalog anzuzeigen, verwenden Sie die Sicht catalog.object_parameters (SSISDB-Datenbank).

4. Speichern Sie das Projekt, um Änderungen an Parametern zu speichern. Parameterwerte werden in der Projektdatei gespeichert.

   Warnung

   Nehmen Sie Bearbeitungen direkt in der Liste vor, oder verwenden Sie das Fenster Eigenschaften, um die Werte von Parametereigenschaften zu ändern. Sie können mit der Symbolleistenschaltfläche Löschen (X) einen Parameter löschen. Über die letzte Symbolleistenschaltfläche können Sie einen Wert für einen Parameter angeben, der nur verwendet wird, wenn Sie das Paket in SQL Server Data Toolsausführen.

   Hinweis

   Wenn Sie die Paketdatei erneut öffnen, ohne das Projekt in SQL Server Data Tools zu öffnen, ist die Registerkarte Parameter leer und deaktiviert.

Erstellen von Projektparametern

1. Öffnen Sie das Projekt in SQL Server Data Tools.

2. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf Project.params, und klicken Sie auf Öffnen. Oder doppelklicken auf Project.params, um das Projekt zu öffnen.

   

3. Klicken Sie auf die Schaltfläche Parameter hinzufügen auf der Symbolleiste.

   

4. Geben Sie Werte für die Eigenschaften Name, Datentyp, Wert, Vertraulichund Erforderlich ein.

   Eigenschaft	Beschreibung
   Name	Der Name des Parameters.
   Datentyp	Der Datentyp des Parameters.
   Standardwert	Der Standardwert für den zur Entwurfszeit zugewiesenen Parameter. Dieser wird auch als Entwurfsstandard bezeichnet.
   Sensibel	Vertrauliche Parameterwerte werden im Katalog verschlüsselt und in Transact-SQL oder SQL Server Management Studio als NULL-Wert angezeigt.
   Erforderlich	Dazu muss ein anderer als der Entwurfsstandardwert angegeben werden, bevor das Paket ausgeführt werden kann.
   BESCHREIBUNG	Die Beschreibung des Parameters für bessere Verwaltbarkeit. Legen Sie im Visual Studio-Eigenschaftenfenster von SQL Server Data Toolsdie Parameterbeschreibung fest, wenn der Parameter im entsprechenden Parameterfenster ausgewählt wurde.

5. Speichern Sie das Projekt, um Änderungen an Parametern zu speichern. Parameterwerte werden in Konfigurationen in der Projektdatei gespeichert. Speichern Sie die Projektdatei, um alle Änderungen in den Parameterwerten in einem Commit an den Datenträger zu übergeben.

   Warnung

   Nehmen Sie Bearbeitungen direkt in der Liste vor, oder verwenden Sie das Fenster Eigenschaften, um die Werte von Parametereigenschaften zu ändern. Sie können mit der Symbolleistenschaltfläche Löschen (X) einen Parameter löschen. Über die letzte Symbolleistenschaltfläche können Sie das Dialogfeld Parameterwerte verwalten öffnen, um einen Wert für einen Parameter anzugeben, der nur verwendet wird, wenn Sie das Paket in SQL Server Data Toolsausführen.

Parameterize Dialog Box

Im Dialogfeld Parametrisieren können Sie einen neuen oder vorhandenen Parameter einer Eigenschaft oder einem Task zuordnen. Sie öffnen das Dialogfeld, indem Sie mit der rechten Maustaste auf einen Task oder die Registerkarte „Ablaufsteuerung“ im SSIS-Designer klicken und dann auf Parametrisieren klicken. Die folgende Liste beschreibt Benutzeroberflächenelemente im Dialogfeld. Weitere Informationen zu Parametern finden Sie unter Integration Services-Parameter (SSIS).

Tastatur

Eigenschaft
Wählen Sie die Eigenschaft der Aufgabe aus, der Sie einem Parameter zuordnen möchten. Diese Liste wird mit allen Eigenschaften aufgefüllt, die parametrisiert werden können.

Vorhandenen Parameter verwenden
Aktivieren Sie diese Option, um die Eigenschaft der Aufgaben einem vorhandenen Parameter zuzuordnen und dann den Parameter aus Dropdownliste auszuwählen.

Keinen Parameter verwenden
Wählen Sie diese Option aus, um einen Verweist auf einen Parameter zu entfernen. Der Parameter wurde nicht gelöscht.

Neuen Parameter erstellen
Aktivieren Sie diese Option, um einen neuen Parameter zu erstellen, den Sie der Eigenschaft der Aufgabe zuordnen möchten.

Name
Geben Sie den Namen des Parameters an, den Sie erstellen möchten.

Beschreibung
Geben Sie die Beschreibung für den Parameter an.

Wert
Geben Sie den Standardwert für den Parameter an. Dies wird auch als der Entwurfsstandard bezeichnet, der später zur Bereitstellungszeit überschrieben werden kann.

Umfang
Geben Sie den Bereich des Parameters an, indem Sie die Option Projekt oder die Option Paket aktivieren. Projektparameter werden verwendet, um jegliche externen Eingaben bereitzustellen, die das Projekt für ein oder mehrere Pakete im Projekt empfängt. Mit Paketparametern können Sie die Paketausführung ändern, ohne das Paket bearbeiten und erneut bereitstellen zu müssen.

Vertraulich
Geben Sie an, ob der Parameter vertraulich ist, indem Sie das Kontrollkästchen aktivieren oder deaktivieren. Vertrauliche Parameterwerte werden im Katalog verschlüsselt und in Transact-SQL oder SQL Server Management Studio als NULL-Wert angezeigt.

Erforderlich
Geben Sie an, ob für den Parameter ein anderer als der Entwurfsstandardwert angegeben werden muss, bevor das Paket ausgeführt werden kann.

Festlegen von Parameterwerten nach der Bereitstellung des Projekts

Mit dem Bereitstellungs-Assistenten können Sie Serverstandardparameterwerte festlegen, wenn Sie das Projekt im Katalog bereitstellen. Nachdem das Projekt dem Katalog hinzugefügt worden ist, Sie können Serverstandardwerte mithilfe von SQL Server Management Studio (SSMS)-Objekt-Explorer oder Transact-SQL festlegen.

Festlegen von Serverstandardwerten mit dem Objekt-Explorer von SSMS

1. Wählen Sie das Projekt unter dem Knoten Integration Services aus, und klicken Sie mit der rechten Maustaste darauf.

2. Klicken Sie auf Eigenschaften , um das Dialogfeld Projekteigenschaften zu öffnen.

3. Öffnen Sie die Parameterseite, indem Sie unter Seite auswählen auf Parameterklicken.

4. Wählen Sie in der Liste Parameter den gewünschten Parameter aus. Hinweis: Anhand der Spalte Container können Projektparameter leichter von Paketparametern unterschieden werden.

5. Geben Sie in der Spalte Wert den gewünschten Serverstandardparameterwert an.

Festlegen von Serverstandardwerten mit Transact-SQL

Verwenden Sie zum Festlegen von Serverstandardwerten mit Transact-SQL die gespeicherte Prozedur catalog.set_object_parameter_value (SSISDB-Datenbank). Um die aktuellen Serverstandards anzuzeigen, fragen Sie die Sicht catalog.object_parameters (SSISDB-Datenbank) ab. Verwenden Sie zum Löschen von Serverstandardwerten die gespeicherte Prozedur catalog.clear_object_parameter_value (SSISDB-Datenbank).