Erstellen einer Quelle mit der Skriptkomponente

Eine Quellkomponente verwendet normalerweise einen vorhandenen Verbindungs-Manager zum Herstellen einer Verbindung mit der Datenquelle, aus der Daten in den Datenfluss geladen werden. Klicken Sie im Transformations-Editor für Skripterstellung auf der Seite Verbindungs-Manager auf Hinzufügen, um den passenden Verbindungs-Manager hinzuzufügen.

Ein Verbindungs-Manager ist jedoch nur eine praktische Einheit, die Daten kapselt und speichert, die sie benötigt, um eine Verbindung mit einer bestimmten Art von Datenquelle herzustellen. Sie müssen, um Daten zu laden und zu speichern sowie möglicherweise auch um eine Verbindung mit der Datenquelle herzustellen und diese zu beenden, eigenen benutzerdefinierten Code schreiben.

Allgemeine Informationen über das Verwenden von Verbindungs-Managern mit der Skriptkomponente finden Sie unter Herstellen einer Verbindung zu Datenquellen in der Skriptkomponente.

Weitere Informationen über die Seite Verbindungs-Manager des Transformations-Editors für Skripterstellung finden Sie unter Transformations-Editor für Skripterstellung (Seite Verbindungs-Manager).

Eine Quellkomponente verfügt über keine Eingaben und unterstützt eine oder mehrere Ausgaben. Auf der Seite Eingaben und Ausgaben im Transformations-Editor für Skripterstellung ist standardmäßig eine Ausgabe eingerichtet. Ausgabespalten sind hingegen nicht vorhanden. Auf dieser Seite des Editors haben Sie die Möglichkeit, die folgenden Elemente zu konfigurieren.

• Sie müssen Ausgabespalten für jede Ausgabe manuell hinzufügen und konfigurieren. Wählen Sie den Ausgabespaltenordner für die jeweilige Ausgabe, und verwalten Sie anschließend die Ausgabespalten für alle Ausgaben der Quellkomponente mithilfe der Schaltflächen Spalte hinzufügen und Spalte entfernen. Die Namen, die Sie den Ausgabespalten hier zuweisen, verwenden Sie später mithilfe der typisierten Accessoreigenschaften, die im automatisch generierten Code erstellt wurden, für Verweise im Skript.

• Sie haben die Möglichkeit, eine oder mehrere zusätzliche Ausgaben zu erstellen, beispielsweise eine simulierte Fehlerausgabe für Zeilen, die unerwartete Werte aufweisen. Verwenden Sie die Schaltflächen Ausgabe hinzufügen und Ausgabe entfernen, um die Ausgaben der Quellkomponente zu verwalten. Alle Eingabezeilen werden an alle verfügbaren Ausgaben weitergeleitet, außer Sie legen einen identischen Wert ungleich Null für die ExclusionGroup-Eigenschaft der Ausgaben fest, bei denen Sie jede Zeile nur an eine der Ausgaben weiterleiten möchten, die denselben ExclusionGroup-Wert aufweisen. Der spezifische ganzzahlige Wert, den Sie auswählen, um die ExclusionGroup zu kennzeichnen, ist nicht von Bedeutung.

  Hinweis
  Sie können auch einen Wert ungleich Null für die ExclusionGroup-Eigenschaft für eine einzelne Ausgabe verwenden, wenn Sie nicht alle Zeilen ausgeben möchten. In diesem Fall müssen Sie jedoch für alle Zeilen, die an die Ausgabe gesendet werden sollen, explizit die DirectRowTo<outputbuffer>-Methode aufrufen.

• Sie können allen Ausgaben einen Anzeigenamen zuweisen. Sie verwenden die Namen der Ausgaben in Ihrem Skript später für Verweise mithilfe der typisierten Accessoreigenschaften, die im automatisch generierten Code erstellt wurden.

• Gewöhnlich haben mehrere Ausgaben in der gleichen ExclusionGroup die gleichen Ausgabespalten. Falls Sie eine simulierte Fehlerausgabe erstellen, sollten Sie jedoch mehrere Spalten hinzufügen, um Fehlerinformationen zu speichern. Informationen dazu, wie das Datenflussmodul Fehlerzeilen verarbeitet, finden Sie unter Verwenden von Fehlerausgaben in einer Datenflusskomponente. In der Skriptkomponente müssen Sie hingegen eigenen Code schreiben, um geeignete Fehlerinformationen für die zusätzlichen Spalten zu erhalten. Weitere Informationen finden Sie unter Simulieren einer Fehlerausgabe für die Skriptkomponente.

Weitere Informationen zur Seite Eingaben und Ausgaben im Transformations-Editor für Skripterstellung finden Sie unter Transformations-Editor für Skripterstellung (Seiten Eingaben und Ausgaben).

Wenn Sie die Werte vorhandener Variablen in Ihrem Skript verwenden möchten, können Sie diese in den Eigenschaftenfeldern für ReadOnlyVariables und ReadWriteVariables auf der Seite Skript des Transformations-Editors für Skripterstellung hinzufügen.

Wenn Sie mehrere Variablen in die Eigenschaftenfelder eingeben, trennen Sie die Variablennamen durch Kommas. Sie können auch mehrere Variablen eingeben, indem Sie auf die Schaltfläche mit den drei Punkten (…) neben den Eigenschaftenfeldern für ReadOnlyVariables und ReadWriteVariables klicken und Variablen im Dialogfeld Variablen auswählen festlegen.

Allgemeine Informationen über das Verwenden von Variablen mit der Skriptkomponente finden Sie unter Verwenden von Variablen in der Skriptkomponente.

Weitere Informationen zur Seite Skript des Transformations-Editors für Skripterstellung finden Sie unter Transformations-Editor für Skripterstellung (Seite Skript).

Wenn Sie nach der Erstellung und Konfiguration einer Quellkomponente die VSTA IDE öffnen, wird die bearbeitbare ScriptMain-Klasse im Code-Editor angezeigt. Sie schreiben den benutzerdefinierten Code in der ScriptMain-Klasse.

Die ScriptMain-Klasse schließt einen Stub für die CreateNewOutputRows-Methode ein. CreateNewOutputRows ist die wichtigste Methode in einer Quellkomponente.

Wenn Sie das Fenster Projektexplorer in VSTA öffnen, können Sie sehen, dass die Skriptkomponente auch schreibgeschützte BufferWrapper- und ComponentWrapper-Projektelemente generiert hat. Die ScriptMain-Klasse erbt von der UserComponent-Klasse im ComponentWrapper-Projektelement.

Zur Laufzeit ruft das Datenflussmodul die PrimeOutput-Methode in der UserComponent-Klasse auf, die die PrimeOutput-Methode der übergeordneten ScriptComponent-Klasse überschreibt. Die PrimeOutput-Methode ruft anschließend die folgenden Methoden auf:

1. Die CreateNewOutputRows-Methode, die Sie in ScriptMain überschreiben können, um den Ausgabepuffern, die zunächst leer sind, Zeilen der Datenquelle hinzuzufügen.

2. Die FinishOutputs-Methode, die standardmäßig leer ist. Setzen Sie diese Methode in ScriptMain außer Kraft, um Verarbeitungsschritte auszuführen, die zum Abschluss der Ausgabe erforderlich sind.

3. Die private MarkOutputsAsFinished-Methode, welche die SetEndOfRowset-Methode der übergeordneten ScriptBuffer-Klasse aufruft, um das Datenflussmodul über die Fertigstellung der Ausgabe in Kenntnis zu setzen. Sie müssen SetEndOfRowset nicht explizit in Ihrem eigenen Code aufrufen.

Um die Erstellung einer benutzerdefinierten Quellkomponente abzuschließen, können Sie Skripts in den folgenden Methoden schreiben, die in der ScriptMain-Klasse zur Verfügung stehen.

1. Überschreiben Sie die AcquireConnections-Methode, um eine Verbindung mit der externen Datenquelle herzustellen. Extrahieren Sie das Verbindungsobjekt bzw. die erforderlichen Verbindungsinformationen vom Verbindungs-Manager.

2. Überschreiben Sie die PreExecute-Methode, um Daten zu laden, falls Sie alle Quelldaten gleichzeitig laden können. Sie können beispielsweise einen SqlCommand an einer ADO.NET-Verbindung mit einer SQL Server-Datenbank ausführen und alle Quelldaten gleichzeitig in einen SqlDataReader laden. Falls Sie die Quelldaten zeilenweise laden müssen (z. B. beim Lesen einer Textdatei), können Sie die Daten beim Durchlaufen der Zeilen in CreateNewOutputRows laden.

3. Mithilfe der überschriebenen CreateNewOutputRows-Methode können Sie leere Ausgabepuffer um neue Zeilen ergänzen und die Werte der einzelnen Spalten den neuen Ausgabezeilen hinzufügen. Verwenden Sie die AddRow-Methode der einzelnen Ausgabepuffer, um leere neue Zeilen hinzuzufügen, und legen Sie anschließend die Werte der einzelnen Spalten fest. Üblicherweise kopieren Sie die Werte aus den Spalten, die aus der externen Quelle geladen werden.

4. Überschreiben Sie die PostExecute-Methode, um die Verarbeitung der Daten abzuschließen. Sie können beispielsweise den SqlDataReader schließen, mit dem Sie die Daten geladen haben.

5. Überschreiben Sie ggf. die ReleaseConnections-Methode, um die Verbindung mit der externen Datenquelle zu trennen.

Diese Beispiel zeigt eine Quellkomponente, die einen vorhandenen ADO.NET-Verbindungs-Manager zum Laden von Daten aus einer SQL Server-Tabelle in den Datenfluss einsetzt.

Wenn Sie diesen Beispielcode ausführen möchten, müssen Sie das Paket und die Komponente folgendermaßen konfigurieren:

1. Erstellen Sie einen ADO.NET-Verbindungs-Manager, der mithilfe des SqlClient-Anbieters eine Verbindung mit der AdventureWorks-Datenbank herstellt.

2. Fügen Sie der Datenfluss-Designeroberfläche eine neue Skriptkomponente hinzu, und konfigurieren Sie sie als Quelle.

3. Öffnen Sie den Transformations-Editor für Skripterstellung. Geben Sie der standardmäßigen Ausgabe auf der Seite Eingaben und Ausgaben einen aussagekräftigeren Namen, z. B. MeineAdressausgabe. Fügen Sie die beiden Ausgabespalten AddressID und City hinzu, und konfigurieren Sie diese.

4. Fügen Sie auf der Seite Verbindungs-Manager den ADO.NET-Verbindungs-Manager hinzu, oder erstellen Sie diesen, und geben Sie ihm einen Namen wie MeineADONETVerbindung.

5. Klicken Sie auf der Seite Skript auf Skript bearbeiten, und geben Sie das folgende Skript ein. Schließen Sie anschließend die Skriptentwicklungsumgebung und den Transformations-Editor für Skripterstellung.

6. Erstellen und konfigurieren Sie eine Zielkomponente, die die Spalten AddressID und City erwartet, z. B. ein SQL Server-Ziel oder die Beispielzielkomponente, die unter Erstellen eines Ziels mit der Skriptkomponente veranschaulicht wird. Stellen Sie anschließend eine Verbindung der Quellkomponente mit dem Ziel her. (Sie können eine Quelle ohne Transformationen direkt mit einem Ziel verbinden.) Sie können eine Zieltabelle erstellen, indem Sie den folgenden Transact-SQL-Befehl in der AdventureWorks-Datenbank ausführen:

   CREATE TABLE [Person].[Address2](
       [AddressID] [int] NOT NULL,
       [City] [nvarchar](30) NOT NULL
   )
   

7. Führen Sie das Beispiel aus.

   Imports System.Data.SqlClient
   ...
   Public Class ScriptMain
       Inherits UserComponent
   
       Dim connMgr As IDTSConnectionManager100
       Dim sqlConn As SqlConnection
       Dim sqlReader As SqlDataReader
   
       Public Overrides Sub AcquireConnections(ByVal Transaction As Object)
   
           connMgr = Me.Connections.MyADONETConnection
           sqlConn = CType(connMgr.AcquireConnection(Nothing), SqlConnection)
   
       End Sub
   
       Public Overrides Sub PreExecute()
   
           Dim cmd As New SqlCommand("SELECT AddressID, City, StateProvinceID FROM Person.Address", sqlConn)
           sqlReader = cmd.ExecuteReader
   
       End Sub
   
       Public Overrides Sub CreateNewOutputRows()
   
           Do While sqlReader.Read
               With MyAddressOutputBuffer
                   .AddRow()
                   .AddressID = sqlReader.GetInt32(0)
                   .City = sqlReader.GetString(1)
               End With
           Loop
   
       End Sub
   
       Public Overrides Sub PostExecute()
   
           sqlReader.Close()
   
       End Sub
   
       Public Overrides Sub ReleaseConnections()
   
           connMgr.ReleaseConnection(sqlConn)
   
       End Sub
   
   End Class
   

   using System.Data.SqlClient;
   public class ScriptMain:
       UserComponent
   
   {
       IDTSConnectionManager100 connMgr;
       SqlConnection sqlConn;
       SqlDataReader sqlReader;
   
       public override void AcquireConnections(object Transaction)
       {
           connMgr = this.Connections.MyADONETConnectionManager;
           sqlConn = (SqlConnection)connMgr.AcquireConnection(null);
   
       }
   
       public override void PreExecute()
       {
   
           SqlCommand cmd = new SqlCommand("SELECT AddressID, City, StateProvinceID FROM Person.Address", sqlConn);
           sqlReader = cmd.ExecuteReader();
   
       }
   
       public override void CreateNewOutputRows()
       {
   
           while (sqlReader.Read())
           {
               {
                   MyAddressOutputBuffer.AddRow();
                   MyAddressOutputBuffer.AddressID = sqlReader.GetInt32(0);
                   MyAddressOutputBuffer.City = sqlReader.GetString(1);
               }
           }
   
       }
   
       public override void PostExecute()
       {
   
           sqlReader.Close();
   
       }
   
       public override void ReleaseConnections()
       {
   
           connMgr.ReleaseConnection(sqlConn);
   
       }
   
   }
   

Diese Beispiel zeigt eine Quellkomponente, die einen vorhandenen Verbindungs-Manager für Flatfiles zum Laden von Daten aus einer Flatfile in den Datenfluss einsetzt. Die Flatfilequelldaten werden durch einen Export aus SQL Server erstellt.

Wenn Sie den Beispielcode ausführen möchten, müssen Sie das Paket und die Komponente folgendermaßen konfigurieren:

1. Exportieren Sie mithilfe des SQL Server-Import/Export-Assistenten die Tabelle Person.Address aus der AdventureWorks-Beispieldatenbank in eine kommagetrennte Flatfile. In diesem Beispiel wird der Dateiname ExportedAddresses.txt verwendet.

2. Erstellen Sie einen Verbindungs-Manager für Flatfiles, der eine Verbindung mit der exportierten Datendatei herstellt.

3. Fügen Sie der Datenfluss-Designeroberfläche eine neue Skriptkomponente hinzu, und konfigurieren Sie sie als Quelle.

4. Öffnen Sie den Transformations-Editor für Skripterstellung. Geben Sie auf der Seite Eingaben und Ausgaben der standardmäßigen Ausgabe einen aussagekräftigeren Namen, z. B. MyAddressOutput. Fügen Sie die beiden Ausgabespalten AddressID und City hinzu, und konfigurieren Sie diese.

5. Fügen Sie auf der Seite Verbindungs-Manager den Verbindungs-Manager für Flatfiles hinzu, oder erstellen Sie diesen, und geben Sie ihm einen aussagekräftigen Namen, z. B. MeinFlatdateiQuellVerbindungsManager.

6. Klicken Sie auf der Seite Skript auf Skript bearbeiten, und geben Sie das folgende Skript ein. Schließen Sie anschließend die Skriptentwicklungsumgebung und den Transformations-Editor für Skripterstellung.

7. Erstellen und konfigurieren Sie eine Zielkomponente, z. B. ein SQL Server-Ziel oder die Beispielzielkomponente, die unter Erstellen eines Ziels mit der Skriptkomponente veranschaulicht wird. Stellen Sie anschließend eine Verbindung der Quellkomponente mit dem Ziel her. (Sie können eine Quelle ohne Transformationen direkt mit einem Ziel verbinden.) Sie können eine Zieltabelle erstellen, indem Sie den folgenden Transact-SQL-Befehl in der AdventureWorks-Datenbank ausführen:

   CREATE TABLE [Person].[Address2](
       [AddressID] [int] NOT NULL,
       [City] [nvarchar](30) NOT NULL
   )
   

8. Führen Sie das Beispiel aus.

   Imports System.IO
   ...
   Public Class ScriptMain
       Inherits UserComponent
   
       Private textReader As StreamReader
       Private exportedAddressFile As String
   
       Public Overrides Sub AcquireConnections(ByVal Transaction As Object)
   
           Dim connMgr As IDTSConnectionManager100 = _
               Me.Connections.MyFlatFileSrcConnectionManager
           exportedAddressFile = _
               CType(connMgr.AcquireConnection(Nothing), String)
   
       End Sub
   
       Public Overrides Sub PreExecute()
           MyBase.PreExecute()
           textReader = New StreamReader(exportedAddressFile)
       End Sub
   
       Public Overrides Sub CreateNewOutputRows()
   
           Dim nextLine As String
           Dim columns As String()
   
           Dim delimiters As Char()
           delimiters = ",".ToCharArray
   
           nextLine = textReader.ReadLine
           Do While nextLine IsNot Nothing
               columns = nextLine.Split(delimiters)
               With MyAddressOutputBuffer
                   .AddRow()
                   .AddressID = columns(0)
                   .City = columns(3)
               End With
               nextLine = textReader.ReadLine
           Loop
   
       End Sub
   
       Public Overrides Sub PostExecute()
           MyBase.PostExecute()
           textReader.Close()
   
       End Sub
   
   End Class
   

   using System.IO;
   public class ScriptMain:
       UserComponent
   
   {
       private StreamReader textReader;
       private string exportedAddressFile;
   
       public override void AcquireConnections(object Transaction)
       {
   
           IDTSConnectionManager100 connMgr = this.Connections.MyFlatFileSrcConnectionManager;
           exportedAddressFile = (string)connMgr.AcquireConnection(null);
   
       }
   
       public override void PreExecute()
       {
           base.PreExecute();
           textReader = new StreamReader(exportedAddressFile);
       }
   
       public override void CreateNewOutputRows()
       {
   
           string nextLine;
           string[] columns;
   
           char[] delimiters;
           delimiters = ",".ToCharArray();
   
           nextLine = textReader.ReadLine();
           while (nextLine != null)
           {
               columns = nextLine.Split(delimiters);
               {
                   MyAddressOutputBuffer.AddRow();
                   MyAddressOutputBuffer.AddressID = columns[0];
                   MyAddressOutputBuffer.City = columns[3];
               }
               nextLine = textReader.ReadLine();
           }
   
       }
   
       public override void PostExecute()
       {
   
           base.PostExecute();
           textReader.Close();
   
       }
   
   }