Создание асинхронного преобразования с помощью компонента сценария

Приступая к работе с компонентом асинхронного преобразования

При добавлении компонента сценария на вкладке «Поток данных» конструктора служб SSIS открывается диалоговое окно Выбор типа компонента сценария с приглашением настроить компонент в качестве источника, преобразования или назначения. В этом диалоговом окне выберите пункт Преобразование.

Настройка компонента асинхронного преобразования в режиме конструктора метаданных

После выбора варианта для создания компонента преобразования выполняется настройка компонента с помощью редактора преобразования «Сценарий». Дополнительные сведения см. в разделе Настройка компонента сценария в редакторе компонента сценария.

Чтобы выбрать язык сценария в компоненте сценария, нужно задать свойство ScriptLanguage на странице Сценарий диалогового окна Редактор преобразования «Сценарий».

Примечание
Чтобы установить язык сценария по умолчанию для компонента сценария, воспользуйтесь параметром Язык сценария страницы Общие диалогового окна Параметры. Дополнительные сведения см. в разделе Страница «Общие».

Компонент преобразования потока данных имеет один вход и поддерживает один или несколько выходов. Настройка входа и выходов компонента — это один из шагов, которые необходимо выполнить в режиме конструктора метаданных с помощью редактора преобразования «Сценарий», прежде чем писать пользовательский сценарий.

Настройка входных столбцов

Настройка входов, выходов и выходных столбцов

Добавление переменных

Создание сценария компонента асинхронного преобразования в режиме конструктора кода

После настройки всех метаданных компонента можно написать пользовательский сценарий. В редакторе преобразования «Сценарий» на странице Сценарий нажмите кнопку Изменить сценарий, чтобы открыть интегрированную среду разработки средств MicrosoftVisual Studio для приложений (VSTA), где можно добавить пользовательский сценарий. Используемый язык сценария зависит от значения свойства ScriptLanguage на странице Сценарий. Для него можно выбрать язык MicrosoftVisual Basic 2008 или MicrosoftVisual C# 2008.

Важные сведения, относящиеся ко всем типам компонентов, создаваемых с помощью компонента сценария, см. в разделе Кодирование и отладка компонента сценария.

Основные сведения об автоматически формируемом коде

Написание пользовательского кода

Для завершения создания пользовательского компонента асинхронного преобразования необходимо использовать переопределенный метод ProcessInputRow для обработки данных в каждой строке входного буфера. Поскольку выходы асинхронны по отношению к входу, необходимо явно указать строки данных для выходов.

При асинхронном преобразовании можно использовать метод AddRow для добавления строк к выходу по мере необходимости из методов ProcessInputRow или ProcessInput. Не нужно использовать метод CreateNewOutputRows. При записи одной строки результатов, например результатов статистической обработки, в определенный выход можно создать выходную строку заранее с помощью метода CreateNewOutputRows и заполнить ее значениями позже, после обработки всех входных строк. Однако создавать много строк в методе CreateNewOutputRows не имеет смысла, поскольку компонент сценария позволяет использовать только текущую строку входных или выходных данных. Метод CreateNewOutputRows более важен в компоненте источника, где нет входных строк для обработки.

Может также потребоваться переопределить сам метод ProcessInput, чтобы можно было выполнять дополнительную предварительную или финальную обработку перед или после циклической обработки данных из входного буфера и вызывать метод ProcessInputRow для каждой строки. Например, в одном из примеров кода в этом разделе метод ProcessInput переопределяется для подсчета количества адресов в определенном городе при циклической обработке методом ProcessInputRow строк. В примере суммарное значение записывается на второй выход после обработки всех строк. В примере выход совершается в ProcessInput, поскольку выходные буферы недоступны после вызова PostExecute.

В зависимости от требований можно также создать сценарий в методах PreExecute и PostExecute, доступных в классе ScriptMain для выполнения предварительной или окончательной обработки.

Примечание
При разработке пользовательского компонента потока данных с нуля было бы важно переопределить метод PrimeOutput для кэширования ссылок на выходные буферы, чтобы можно было добавлять строки данных в буферы позднее. В компоненте сценария это необязательно, так как существует автоматически создаваемый класс, представляющий каждый выходной буфер в элементе проекта BufferWrapper.

Примеры

В этом примере показан пользовательский код, который требуется классу ScriptMain для создания компонента асинхронного преобразования.

Примечание
В этих примерах используется таблица Person.Address из образца базы данных AdventureWorks и в поток данных передаются ее первый и четвертый столбец — intAddressID и nvarchar(30)City. Эти же данные используются в образцах источника, преобразования и назначения, приведенных в этом разделе. Для каждого примера приведены необходимые дополнительные условия и принимаемые предположения.

В данном примере показан компонент асинхронного преобразования с двумя выходами. Это преобразование передает столбцы AddressID и City на один выход и в то же время вычисляет количество адресов в определенном городе (Редмонд, Вашингтон, США), а затем передает результирующее значение на второй выход.

Чтобы запустить этот образец кода, необходимо настроить пакет и компонент следующим образом.

1. Добавьте новый компонент сценария в область конструктора потока данных и настройте его в качестве преобразования.

2. Подсоедините в конструкторе выход источника или другого преобразования к новому компоненту преобразования. Этот выход должен содержать данные из таблицы Person.Address образца базы данных AdventureWorks, которая содержит по крайней мере столбцы AddressID и City.

3. Откройте Редактор преобразования «Сценарий». На странице Входные столбцы выберите столбцы AddressID и City.

4. На странице Входы и выходы добавьте и настройте выходные столбцы AddressID и City для первого выхода. Добавьте второй выход и добавьте выходной столбец для суммарного значения на втором выходе. Задайте для свойства SynchronousInputID первого выхода значение 0, так как в этом примере каждая входящая строка явно копируется на первый выход. Для свойства SynchronousInputID созданного выхода уже задано значение 0.

5. Переименуйте вход, выходы и новый выходной столбец, присвоив им более понятные имена. В примере используются следующие имена: MyAddressInput для входа, MyAddressOutput и MySummaryOutput для выходов и MyRedmondCount для выходного столбца на втором выходе.

6. На странице Сценарий нажмите кнопку Изменить сценарий и введите следующий сценарий. Затем закройте среду разработки сценариев и редактор преобразования «Сценарий».

7. Создайте и настройте компонент назначения для первого выхода, ожидающего столбцов AddressID и City, например назначение SQL Server или образец компонента назначения, показанный в разделе Создание назначения с помощью компонента сценария. Затем подсоедините первый выход преобразования, MyAddressOutput, к компоненту назначения. Можно создать целевую таблицу, запустив команду Transact-SQL в базе данных AdventureWorks.

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

8. Создайте и настройте другой компонент назначения для второго выхода. Затем подсоедините второй выход преобразования, MySummaryOutput, к компоненту назначения. Поскольку второй выход записывает только одну строку с одним значением, можно легко настроить компонент назначения с помощью диспетчера соединений с плоскими файлами, подключающегося к новому файлу с единственным столбцом. В примере этот целевой столбец называется MyRedmondCount.

9. Запустите образец.

Public Class ScriptMain
    Inherits UserComponent

    Private myRedmondAddressCount As Integer

    Public Overrides Sub CreateNewOutputRows()

        MySummaryOutputBuffer.AddRow()

    End Sub

    Public Overrides Sub MyAddressInput_ProcessInput(ByVal Buffer As MyAddressInputBuffer)

        While Buffer.NextRow()
            MyAddressInput_ProcessInputRow(Buffer)
        End While

        If Buffer.EndOfRowset Then
            MyAddressOutputBuffer.SetEndOfRowset()
            MySummaryOutputBuffer.MyRedmondCount = myRedmondAddressCount
            MySummaryOutputBuffer.SetEndOfRowset()
        End If

    End Sub

    Public Overrides Sub MyAddressInput_ProcessInputRow(ByVal Row As MyAddressInputBuffer)

        With MyAddressOutputBuffer
            .AddRow()
            .AddressID = Row.AddressID
            .City = Row.City
        End With

        If Row.City.ToUpper = "REDMOND" Then
            myRedmondAddressCount += 1
        End If

    End Sub

End Class

public class ScriptMain:
    UserComponent

{
    private int myRedmondAddressCount;

    public override void CreateNewOutputRows()
    {

        MySummaryOutputBuffer.AddRow();

    }

    public override void MyAddressInput_ProcessInput(MyAddressInputBuffer Buffer)
    {

        while (Buffer.NextRow())
        {
            MyAddressInput_ProcessInputRow(Buffer);
        }

        if (Buffer.EndOfRowset())
        {
            MyAddressOutputBuffer.SetEndOfRowset();
            MySummaryOutputBuffer.MyRedmondCount = myRedmondAddressCount;
            MySummaryOutputBuffer.SetEndOfRowset();
        }

    }

    public override void MyAddressInput_ProcessInputRow(MyAddressInputBuffer Row)
    {

        {
            MyAddressOutputBuffer.AddRow();
            MyAddressOutputBuffer.AddressID = Row.AddressID;
            MyAddressOutputBuffer.City = Row.City;
        }

        if (Row.City.ToUpper() == "REDMOND")
        {
            myRedmondAddressCount += 1;
        }

    }

}

См. также

Основные понятия