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

Компонент преобразования имеет один вход.

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

Дополнительные сведения о странице Входные столбцыредактора преобразования «Сценарий» см. в разделе Редактор преобразования «Сценарий» (страница «Входные столбцы»).

Компонент преобразования поддерживает один или несколько выходов.

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

• Создайте один или несколько дополнительных выходов, например, имитацию вывода ошибок для строк, содержащих непредвиденные значения. Используйте кнопки Добавить выход и Удалить выход для управления выходами компонента синхронного преобразования. Все входные строки направляются во все доступные выходы, если не указано, что необходимо перенаправлять каждую строку в тот или иной определенный выход. Чтобы указать на необходимость перенаправления строк, следует присвоить свойству ExclusionGroup для выходов ненулевое целочисленное значение. Конкретное целочисленное значение, заданное для свойства ExclusionGroup, не имеет принципиальной важности, однако необходимо использовать одно и то же число последовательно в указанной группе выходов.

  Примечание
  Также можно использовать ненулевое значение для свойства ExclusionGroup с единственным выходом, если не нужно выводить все строки. Однако в данном случае необходимо явным образом вызвать метод DirectRowTo<outputbuffer> для каждой строки, которая должна быть направлена в выход.

• Присвойте как можно более описательные имена входу и выходам. Компонент сценария использует эти имена для создания типизированных свойств метода доступа, с помощью которых в сценарии выполняется обращение к входам и выходам.

• Для синхронных преобразований оставьте столбцы без изменения. Обычно синхронное преобразование не добавляет столбцы в поток данных. Данные изменяются на месте, прямо в буфере, который передается в следующий компонент потока данных. В подобной ситуации нет необходимости добавлять и настраивать выходные столбцы явным образом для выходов преобразования. Выходы отображаются в редакторе без явно определенных столбцов.

• Добавьте новые столбцы для имитации вывода ошибок для ошибок на уровне строк. Обычно несколько выходов в одной и той же группе ExclusionGroup имеют один и тот же набор выходных столбцов. Однако при создании имитации вывода ошибок может оказаться целесообразным добавление нескольких столбцов, содержащих сведения об ошибках. Сведения об обработке ошибочных строк в подсистеме обработки потока данных см. в разделе Использование выводов ошибок в компоненте потока данных. Обратите внимание на то, что в компоненте сценария необходимо написать собственный код для заполнения дополнительных столбцов соответствующими сведениями об ошибках. Дополнительные сведения см. в разделе Имитация вывода ошибок для компонента сценария.

Дополнительные сведения о странице Входы и выходыредактора преобразования «Сценарий» см. в разделе Редактор преобразования «Сценарий» (страница «Входы и выводы»).

Если нужно использовать в сценарии существующие переменные, их можно добавить в поля свойств ReadOnlyVariables и ReadWriteVariables на странице Сценарий в редакторе преобразования «Сценарий».

Если в поле свойства добавляются несколько переменных, их имена нужно разделять запятыми. Также можно выбрать несколько переменных, нажав кнопку с многоточием (…), расположенную рядом с полями свойств ReadOnlyVariables и ReadWriteVariables, а затем выбрав переменные в диалоговом окне Выбор переменные.

Общие сведения об использовании переменных в компоненте сценария см. в разделе Использование переменных в компоненте сценария.

Дополнительные сведения о странице Сценарийредактора преобразования «Сценарий» см. в разделе Редактор преобразования «Сценарий» (страница «Сценарий»).

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

Есть открыть окно Обозреватель объектов в средствах VSTA, можно увидеть, что для компонента сценария были созданы элементы проекта BufferWrapper и ComponentWrapper, доступные только для чтения. Класс ScriptMain наследует класс UserComponent в элементе проекта ComponentWrapper.

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

Компонент преобразования с синхронными выходами является наиболее простым для написания компонентом потока данных. Например, в образце с единственным выходом, который приведен далее в этом разделе, содержится следующий пользовательский код:

    Row.City = UCase(Row.City)

    Row.City = (Row.City).ToUpper();

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

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

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

 [Visual Basic]
    Row.City = UCase(Row.City)
    If Row.City = "REDMOND" Then
        Row.DirectRowToMyRedmondAddresses()
    Else
        Row.DirectRowToMyOtherAddresses()
    End If

 [C#]
        Row.City = (Row.City).ToUpper();

        if (Row.City=="REDMOND")
        {
            Row.DirectRowToMyRedmondAddresses();
        }
        else
        {
            Row.DirectRowToMyOtherAddresses();
        }

В этом примере компонент сценария формирует методы DirectRowTo<OutputBufferX> на основе имен выходов, настроенных пользователем. Можно использовать аналогичный код для направления строк ошибок в имитированный вывод ошибок.

В этом примере демонстрируется компонент синхронного преобразования с единственным выходом. Это преобразование передает столбец AddressID без обработки, а столбец City преобразует к верхнему регистру.

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

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

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

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

4. На странице Входы и выходы переименуйте вход и выход, дав им более описательные имена, например, MyAddressInput и MyAddressOutput. Обратите внимание, что идентификатор SynchronousInputID выхода соответствует идентификатору ID входа. Таким образом, нет необходимости добавлять и настраивать выходные столбцы.

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

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

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

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

Public Class ScriptMain
    Inherits UserComponent

    Public Overrides Sub MyAddressInput_ProcessInputRow(ByVal Row As MyAddressInputBuffer)

        Row.City = UCase(Row.City)

    End Sub

End Class

 [C#]
public class ScriptMain:
    UserComponent

{
    public override void MyAddressInput_ProcessInputRow(MyAddressInputBuffer Row)
    {

        Row.City = (Row.City).ToUpper();

    }

}

В этом примере демонстрируется компонент синхронного преобразования с двумя выходами. Это преобразование передает столбец AddressID без обработки, а столбец City преобразует к верхнему регистру. Если названием города является «Redmond», строка направляется в один выход. Все остальные строки направляются в другой выход.

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

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

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

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

4. На странице Входы и выходы создайте второй выход. После создания нового выхода убедитесь в том, что идентификатору SynchronousInputID присвоено значение, совпадающее с идентификатором ID входа. Это свойство уже задано для первого выхода, создаваемого по умолчанию. Для каждого выхода присвойте свойству ExclusionGroup одно и то же ненулевое значение, чтобы предписать распределение входных строк между двумя взаимоисключающими выходами. Нет необходимости добавлять какие-либо выходные столбцы в выходы.

5. Переименуйте вход и выходы, дав им более описательные имена, например, MyAddressInput, MyRedmondAddresses и MyOtherAddresses.

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

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

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

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

Public Class ScriptMain
    Inherits UserComponent

    Public Overrides Sub MyAddressInput_ProcessInputRow(ByVal Row As MyAddressInputBuffer)

        Row.City = UCase(Row.City)

        If Row.City = "REDMOND" Then
            Row.DirectRowToMyRedmondAddresses()
        Else
            Row.DirectRowToMyOtherAddresses()
        End If

    End Sub

End Class

public class ScriptMain:
    UserComponent

public override void MyAddressInput_ProcessInputRow(MyAddressInputBuffer Row)
    {

        Row.City = (Row.City).ToUpper();

        if (Row.City == "REDMOND")
        {
            Row.DirectRowToMyRedmondAddresses();
        }
        else
        {
            Row.DirectRowToMyOtherAddresses();
        }

    }
}