Udostępnij za pomocą


Używanie wyjść błędów w składniku przepływu danych

Dotyczy:SQL Server SSIS Integration Runtime w ramach usługi Azure Data Factory

Obiekty specjalne IDTSOutput100 nazywane danymi wyjściowymi błędów można dodać do składników, aby umożliwić składnikowi przekierowywanie wierszy, których nie można przetworzyć podczas wykonywania. Problemy, które może napotkać składnik, są zazwyczaj klasyfikowane jako błędy lub obcinania i są specyficzne dla każdego składnika. Składniki dostarczające dane wyjściowe błędów zapewniają użytkownikom składnika elastyczność obsługi warunków błędów przez filtrowanie wierszy błędów z zestawu wyników, niepowodzenie składnika w przypadku wystąpienia problemu lub ignorowanie błędów i kontynuowanie.

Aby zaimplementować i obsługiwać dane wyjściowe błędów w składniku, należy najpierw ustawić UsesDispositions właściwość składnika na true. Następnie należy dodać dane wyjściowe do składnika, który ma jego IsErrorOut właściwość ustawioną na wartość true. Na koniec składnik musi zawierać kod, który przekierowuje wiersze do danych wyjściowych błędu w przypadku wystąpienia błędów lub obcinania. W tym temacie opisano te trzy kroki i wyjaśniono różnice między synchronicznymi i asynchronicznymi danymi wyjściowymi błędów.

Tworzenie danych wyjściowych błędu

Dane wyjściowe błędu są tworzone przez wywołanie New metody OutputCollection, a następnie ustawienie IsErrorOut właściwości nowych danych wyjściowych na true. Jeśli dane wyjściowe są asynchroniczne, żadne inne dane wyjściowe nie muszą być wykonywane. Jeśli dane wyjściowe są synchroniczne i istnieją inne dane wyjściowe synchroniczne dla tych samych danych wejściowych, należy również ustawić ExclusionGroup właściwości i SynchronousInputID . Obie właściwości powinny mieć te same wartości co inne dane wyjściowe, które są synchroniczne dla tych samych danych wejściowych. Jeśli te właściwości nie są ustawione na wartość inną niż zero, wiersze dostarczone przez dane wejściowe są wysyłane do obu danych wyjściowych, które są synchroniczne do danych wejściowych.

Gdy składnik napotka błąd lub obcięcie podczas wykonywania, będzie on kontynuowany na podstawie ustawień ErrorRowDisposition właściwości i TruncationRowDisposition danych wejściowych lub wyjściowych albo danych wejściowych lub wyjściowych, gdzie wystąpił błąd. Wartość tych właściwości powinna być domyślnie ustawiona na RD_NotUsedwartość . Gdy dane wyjściowe błędu składnika są połączone ze składnikiem podrzędnym, ta właściwość jest ustawiana przez użytkownika składnika i umożliwia użytkownikowi kontrolowanie sposobu obsługi błędu lub obcięcia składnika.

Wypełnianie kolumn błędów

Po utworzeniu danych wyjściowych błędu zadanie przepływu danych automatycznie dodaje dwie kolumny do kolekcji kolumn wyjściowych. Te kolumny są używane przez składniki do określenia identyfikatora kolumny, która spowodowała błąd lub obcięcie, oraz w celu dostarczenia kodu błędu specyficznego dla składnika. Te kolumny są generowane automatycznie, ale wartości zawarte w kolumnach muszą być ustawiane przez składnik.

Metoda używana do ustawiania wartości tych kolumn zależy od tego, czy dane wyjściowe błędu są synchroniczne, czy asynchroniczne. Składniki z synchronicznymi danymi wyjściowymi wywołają metodę DirectErrorRow , omówionych bardziej szczegółowo w następnej sekcji i podają kod błędu i wartości kolumn błędu jako parametry. Składniki z asynchronicznymi danymi wyjściowymi mają dwie opcje ustawiania wartości tych kolumn. Mogą wywołać metodę SetErrorInfo buforu wyjściowego i podać wartości lub zlokalizować kolumny błędów w buforze przy użyciu metody FindColumnByLineageID i ustawić wartości kolumn bezpośrednio dla kolumn. Jednak ze względu na to, że nazwy kolumn mogły zostać zmienione lub ich lokalizacja w kolekcji kolumn wyjściowych mogła zostać zmodyfikowana, ta ostatnia metoda może nie być niezawodna. Metoda SetErrorInfo automatycznie ustawia wartości w tych kolumnach błędów bez konieczności ręcznego lokalizowania ich.

Jeśli musisz uzyskać opis błędu odpowiadający określonemu kodowi błędu, możesz użyć GetErrorDescription metody interfejsu IDTSComponentMetaData100 dostępnej za pośrednictwem właściwości składnika ComponentMetaData .

W poniższych przykładach kodu pokazano składnik, który zawiera dane wejściowe i dwa dane wyjściowe, w tym dane wyjściowe błędu. W pierwszym przykładzie pokazano, jak utworzyć dane wyjściowe błędu synchroniczne dla danych wejściowych. W drugim przykładzie pokazano, jak utworzyć dane wyjściowe błędu, które są asynchroniczne.

public override void ProvideComponentProperties()  
{  
    // Specify that the component has an error output.  
    ComponentMetaData.UsesDispositions = true;  
    // Create the input.  
    IDTSInput100 input = ComponentMetaData.InputCollection.New();  
    input.Name = "Input";  
    input.ErrorRowDisposition = DTSRowDisposition.RD_NotUsed;  
    input.ErrorOrTruncationOperation = "A string describing the possible error or truncation that may occur during execution.";  
  
    // Create the default output.  
    IDTSOutput100 output = ComponentMetaData.OutputCollection.New();  
    output.Name = "Output";  
    output.SynchronousInputID = input.ID;  
    output.ExclusionGroup = 1;  
  
    // Create the error output.  
    IDTSOutput100 errorOutput = ComponentMetaData.OutputCollection.New();  
    errorOutput.IsErrorOut = true;  
    errorOutput.Name = "ErrorOutput";  
    errorOutput.SynchronousInputID = input.ID;  
    errorOutput.ExclusionGroup = 1;  
  
}  
Public  Overrides Sub ProvideComponentProperties()   
  
 ' Specify that the component has an error output.  
 ComponentMetaData.UsesDispositions = True   
  
 Dim input As IDTSInput100 = ComponentMetaData.InputCollection.New   
  
 ' Create the input.  
 input.Name = "Input"   
 input.ErrorRowDisposition = DTSRowDisposition.RD_NotUsed   
 input.ErrorOrTruncationOperation = "A string describing the possible error or truncation that may occur during execution."   
  
 ' Create the default output.  
 Dim output As IDTSOutput100 = ComponentMetaData.OutputCollection.New   
 output.Name = "Output"   
 output.SynchronousInputID = input.ID   
 output.ExclusionGroup = 1   
  
 ' Create the error output.  
 Dim errorOutput As IDTSOutput100 = ComponentMetaData.OutputCollection.New   
 errorOutput.IsErrorOut = True   
 errorOutput.Name = "ErrorOutput"   
 errorOutput.SynchronousInputID = input.ID   
 errorOutput.ExclusionGroup = 1   
  
End Sub  

Poniższy przykład kodu tworzy dane wyjściowe błędu, które są asynchroniczne.

public override void ProvideComponentProperties()  
{  
    // Specify that the component has an error output.  
    ComponentMetaData.UsesDispositions = true;  
  
    // Create the input.  
    IDTSInput100 input = ComponentMetaData.InputCollection.New();  
    input.Name = "Input";  
    input.ErrorRowDisposition = DTSRowDisposition.RD_NotUsed;  
    input.ErrorOrTruncationOperation = "A string describing the possible error or truncation that may occur during execution.";  
  
    // Create the default output.  
    IDTSOutput100 output = ComponentMetaData.OutputCollection.New();  
    output.Name = "Output";  
  
    // Create the error output.  
    IDTSOutput100 errorOutput = ComponentMetaData.OutputCollection.New();  
    errorOutput.Name = "ErrorOutput";  
    errorOutput.IsErrorOut = true;  
}  
Public  Overrides Sub ProvideComponentProperties()   
  
 ' Specify that the component has an error output.  
 ComponentMetaData.UsesDispositions = True   
  
 ' Create the input.  
 Dim input As IDTSInput100 = ComponentMetaData.InputCollection.New   
  
 ' Create the default output.  
 input.Name = "Input"   
 input.ErrorRowDisposition = DTSRowDisposition.RD_NotUsed   
 input.ErrorOrTruncationOperation = "A string describing the possible error or truncation that may occur during execution."   
  
 ' Create the error output.  
 Dim output As IDTSOutput100 = ComponentMetaData.OutputCollection.New   
 output.Name = "Output"   
 Dim errorOutput As IDTSOutput100 = ComponentMetaData.OutputCollection.New   
 errorOutput.Name = "ErrorOutput"   
 errorOutput.IsErrorOut = True   
  
End Sub  

Przekierowywanie wiersza do danych wyjściowych błędu

Po dodaniu danych wyjściowych błędu do składnika należy podać kod, który obsługuje warunki błędu lub obcinania specyficzne dla składnika i przekierowuje błędy lub obcięte wiersze do danych wyjściowych błędu. Można to zrobić na dwa sposoby, w zależności od tego, czy dane wyjściowe błędu są synchroniczne, czy asynchroniczne.

Przekierowywanie wiersza za pomocą synchronicznych danych wyjściowych

Wiersze są wysyłane do synchronicznych danych wyjściowych przez wywołanie DirectErrorRow metody PipelineBuffer klasy. Wywołanie metody zawiera jako parametry identyfikatora danych wyjściowych błędu, kodu błędu zdefiniowanego przez składnik i indeksu kolumny, którą składnik nie może przetworzyć.

W poniższym przykładzie kodu pokazano, jak kierować wiersz w buforze do synchronicznych danych wyjściowych błędu przy użyciu DirectErrorRow metody .

public override void ProcessInput(int inputID, PipelineBuffer buffer)  
{  
        IDTSInput100 input = ComponentMetaData.InputCollection.GetObjectByID(inputID);  
  
        // This code sample assumes the component has two outputs, one the default,  
        // the other the error output. If the errorOutputIndex returned from GetErrorOutputInfo  
        // is 0, then the default output is the second output in the collection.  
        int defaultOutputID = -1;  
        int errorOutputID = -1;  
        int errorOutputIndex = -1;  
  
        GetErrorOutputInfo(ref errorOutputID,ref errorOutputIndex);  
  
        if (errorOutputIndex == 0)  
            defaultOutputID = ComponentMetaData.OutputCollection[1].ID;  
        else  
            defaultOutputID = ComponentMetaData.OutputCollection[0].ID;  
  
        while (buffer.NextRow())  
        {  
            try  
            {  
                // TODO: Implement code to process the columns in the buffer row.  
  
                // Ideally, your code should detect potential exceptions before they occur, rather  
                // than having a generic try/catch block such as this.   
                // However, because the error or truncation implementation is specific to each component,  
                // this sample focuses on actually directing the row, and not a single error or truncation.  
  
                // Unless an exception occurs, direct the row to the default   
                buffer.DirectRow(defaultOutputID);  
            }  
            catch  
            {  
                // Yes, has the user specified to redirect the row?  
                if (input.ErrorRowDisposition == DTSRowDisposition.RD_RedirectRow)  
                {  
                    // Yes, direct the row to the error output.  
                    // TODO: Add code to include the errorColumnIndex.  
                    buffer.DirectErrorRow(errorOutputID, 0, errorColumnIndex);  
                }  
                else if (input.ErrorRowDisposition == DTSRowDisposition.RD_FailComponent || input.ErrorRowDisposition == DTSRowDisposition.RD_NotUsed)  
                {  
                    // No, the user specified to fail the component, or the error row disposition was not set.  
                    throw new Exception("An error occurred, and the DTSRowDisposition is either not set, or is set to fail component.");  
                }  
                else  
                {  
                    // No, the user specified to ignore the failure so   
                    // direct the row to the default output.  
                    buffer.DirectRow(defaultOutputID);  
                }  
  
            }  
        }  
}  
Public  Overrides Sub ProcessInput(ByVal inputID As Integer, ByVal buffer As PipelineBuffer)   
   Dim input As IDTSInput100 = ComponentMetaData.InputCollection.GetObjectByID(inputID)   
  
   ' This code sample assumes the component has two outputs, one the default,  
   ' the other the error output. If the errorOutputIndex returned from GetErrorOutputInfo  
   ' is 0, then the default output is the second output in the collection.  
   Dim defaultOutputID As Integer = -1   
   Dim errorOutputID As Integer = -1   
   Dim errorOutputIndex As Integer = -1   
  
   GetErrorOutputInfo(errorOutputID, errorOutputIndex)   
  
   If errorOutputIndex = 0 Then   
     defaultOutputID = ComponentMetaData.OutputCollection(1).ID   
   Else   
     defaultOutputID = ComponentMetaData.OutputCollection(0).ID   
   End If   
  
   While buffer.NextRow   
     Try   
       ' TODO: Implement code to process the columns in the buffer row.  
  
       ' Ideally, your code should detect potential exceptions before they occur, rather  
       ' than having a generic try/catch block such as this.   
       ' However, because the error or truncation implementation is specific to each component,  
       ' this sample focuses on actually directing the row, and not a single error or truncation.  
  
       ' Unless an exception occurs, direct the row to the default   
       buffer.DirectRow(defaultOutputID)   
     Catch   
       ' Yes, has the user specified to redirect the row?  
       If input.ErrorRowDisposition = DTSRowDisposition.RD_RedirectRow Then   
         ' Yes, direct the row to the error output.  
         ' TODO: Add code to include the errorColumnIndex.  
         buffer.DirectErrorRow(errorOutputID, 0, errorColumnIndex)   
       Else   
         If input.ErrorRowDisposition = DTSRowDisposition.RD_FailComponent OrElse input.ErrorRowDisposition = DTSRowDisposition.RD_NotUsed Then   
           ' No, the user specified to fail the component, or the error row disposition was not set.  
           Throw New Exception("An error occurred, and the DTSRowDisposition is either not set, or is set to fail component.")   
         Else   
           ' No, the user specified to ignore the failure so   
           ' direct the row to the default output.  
           buffer.DirectRow(defaultOutputID)   
         End If   
       End If   
     End Try   
   End While   
End Sub  

Przekierowywanie wiersza przy użyciu danych wyjściowych asynchronicznych

Zamiast kierować wiersze do danych wyjściowych, podobnie jak w przypadku synchronicznych danych wyjściowych błędów, składniki z danymi wyjściowymi asynchronicznymi wysyłają wiersz do danych wyjściowych błędu, jawnie dodając wiersz do danych wyjściowych PipelineBuffer. Zaimplementowanie składnika korzystającego z danych wyjściowych błędu asynchronicznego wymaga dodania kolumn do danych wyjściowych błędu dostarczonych do składników podrzędnych oraz buforowania buforu wyjściowego dla danych wyjściowych błędu dostarczonych do składnika podczas PrimeOutput metody. Szczegółowe informacje na temat implementowania składnika z asynchronicznymi danymi wyjściowymi zostały szczegółowo omówione w temacie Tworzenie składnika transformacji niestandardowej przy użyciu danych wyjściowych asynchronicznych. Jeśli kolumny nie są jawnie dodawane do danych wyjściowych błędu, wiersz buforu dodany do buforu wyjściowego zawiera tylko dwie kolumny błędów.

Aby wysłać wiersz do danych wyjściowych błędu asynchronicznego, należy dodać wiersz do buforu wyjściowego błędu. Czasami wiersz mógł zostać już dodany do buforu wyjściowego bez błędów i musisz usunąć ten wiersz przy użyciu RemoveRow metody . Następnie należy ustawić wartości kolumn buforu wyjściowego, a na koniec wywołać metodę SetErrorInfo w celu podania kodu błędu specyficznego dla składnika i wartości kolumny błędu.

W poniższym przykładzie pokazano, jak używać danych wyjściowych błędu dla składnika z asynchronicznymi danymi wyjściowymi. Gdy wystąpi symulowany błąd, składnik dodaje wiersz do buforu wyjściowego błędu, kopiuje wartości, które zostały wcześniej dodane do buforu wyjściowego bez błędu do buforu wyjściowego błędu, usuwa wiersz dodany do buforu wyjściowego bez błędów, a na koniec ustawia kod błędu i wartości kolumny błędów przez wywołanie SetErrorInfo metody .

int []columnIndex;  
int errorOutputID = -1;  
int errorOutputIndex = -1;  
  
public override void PreExecute()  
{  
    IDTSOutput100 defaultOutput = null;  
  
    this.GetErrorOutputInfo(ref errorOutputID, ref errorOutputIndex);  
    foreach (IDTSOutput100 output in ComponentMetaData.OutputCollection)  
    {  
        if (output.ID != errorOutputID)  
            defaultOutput = output;  
    }  
  
    columnIndex = new int[defaultOutput.OutputColumnCollection.Count];  
  
    for(int col =0 ; col < defaultOutput.OutputColumnCollection.Count; col++)  
    {  
        IDTSOutputColumn100 column = defaultOutput.OutputColumnCollection[col];  
        columnIndex[col] = BufferManager.FindColumnByLineageID(defaultOutput.Buffer, column.LineageID);  
    }  
}  
  
public override void PrimeOutput(int outputs, int[] outputIDs, PipelineBuffer[] buffers)  
{  
    for( int x=0; x < outputs; x++ )  
    {  
        if (outputIDs[x] == errorOutputID)  
            this.errorBuffer = buffers[x];  
        else  
            this.defaultBuffer = buffers[x];  
    }  
  
    int rows = 100;  
  
    Random random = new Random(System.DateTime.Now.Millisecond);  
  
    for (int row = 0; row < rows; row++)  
    {  
        try  
        {  
            defaultBuffer.AddRow();  
  
            for (int x = 0; x < columnIndex.Length; x++)  
                defaultBuffer[columnIndex[x]] = random.Next();  
  
            // Simulate an error.  
            if ((row % 2) == 0)  
                throw new Exception("A simulated error.");  
        }  
        catch  
        {  
            // Add a row to the error buffer.  
            errorBuffer.AddRow();  
  
            // Get the values from the default buffer  
            // and copy them to the error buffer.  
            for (int x = 0; x < columnIndex.Length; x++)  
                errorBuffer[columnIndex[x]] = defaultBuffer[columnIndex[x]];  
  
            // Set the error information.  
            errorBuffer.SetErrorInfo(errorOutputID, 1, 0);  
  
            // Remove the row that was added to the default buffer.  
            defaultBuffer.RemoveRow();  
        }  
    }  
  
    if (defaultBuffer != null)  
        defaultBuffer.SetEndOfRowset();  
  
    if (errorBuffer != null)  
        errorBuffer.SetEndOfRowset();  
}  
Private columnIndex As Integer()   
Private errorOutputID As Integer = -1   
Private errorOutputIndex As Integer = -1   
  
Public  Overrides Sub PreExecute()   
 Dim defaultOutput As IDTSOutput100 = Nothing   
 Me.GetErrorOutputInfo(errorOutputID, errorOutputIndex)   
 For Each output As IDTSOutput100 In ComponentMetaData.OutputCollection   
   If Not (output.ID = errorOutputID) Then   
     defaultOutput = output   
   End If   
 Next   
 columnIndex = New Integer(defaultOutput.OutputColumnCollection.Count) {}   
 Dim col As Integer = 0   
 While col < defaultOutput.OutputColumnCollection.Count   
   Dim column As IDTSOutputColumn100 = defaultOutput.OutputColumnCollection(col)   
   columnIndex(col) = BufferManager.FindColumnByLineageID(defaultOutput.Buffer, column.LineageID)   
   System.Math.Min(System.Threading.Interlocked.Increment(col),col-1)   
 End While   
End Sub   
  
Public  Overrides Sub PrimeOutput(ByVal outputs As Integer, ByVal outputIDs As Integer(), ByVal buffers As PipelineBuffer())   
 Dim x As Integer = 0   
 While x < outputs   
   If outputIDs(x) = errorOutputID Then   
     Me.errorBuffer = buffers(x)   
   Else   
     Me.defaultBuffer = buffers(x)   
   End If   
   System.Math.Min(System.Threading.Interlocked.Increment(x),x-1)   
 End While   
 Dim rows As Integer = 100   
 Dim random As Random = New Random(System.DateTime.Now.Millisecond)   
 Dim row As Integer = 0   
 While row < rows   
   Try   
     defaultBuffer.AddRow   
     Dim x As Integer = 0   
     While x < columnIndex.Length   
       defaultBuffer(columnIndex(x)) = random.Next   
       System.Math.Min(System.Threading.Interlocked.Increment(x),x-1)   
     End While   
     ' Simulate an error.  
     If (row Mod 2) = 0 Then   
       Throw New Exception("A simulated error.")   
     End If   
   Catch   
     ' Add a row to the error buffer.  
     errorBuffer.AddRow   
     ' Get the values from the default buffer  
     ' and copy them to the error buffer.  
     Dim x As Integer = 0   
     While x < columnIndex.Length   
       errorBuffer(columnIndex(x)) = defaultBuffer(columnIndex(x))   
       System.Math.Min(System.Threading.Interlocked.Increment(x),x-1)   
     End While   
     ' Set the error information.  
     errorBuffer.SetErrorInfo(errorOutputID, 1, 0)   
     ' Remove the row that was added to the default buffer.  
     defaultBuffer.RemoveRow   
   End Try   
   System.Math.Min(System.Threading.Interlocked.Increment(row),row-1)   
 End While   
 If Not (defaultBuffer Is Nothing) Then   
   defaultBuffer.SetEndOfRowset   
 End If   
 If Not (errorBuffer Is Nothing) Then   
   errorBuffer.SetEndOfRowset   
 End If   
End Sub  

Zobacz też

Obsługa błędów w danych
Korzystanie z danych wyjściowych błędów