스크립트 태스크 코딩 및 디버깅

아티클
05/07/2013

스크립트 태스크 편집기에서 스크립트 태스크를 구성한 후에는 스크립트 태스크 개발 환경에서 사용자 지정 코드를 작성합니다.

스크립트 태스크 개발 환경

스크립트 태스크에서는 스크립트의 개발 환경으로 Microsoft VSTA(Visual Studio Tools for Applications)를 사용합니다.

스크립트 코드는 Microsoft Visual Basic 또는 Microsoft Visual C#으로 작성됩니다. 스크립트 태스크 편집기에서 ScriptLanguage 속성을 설정하여 스크립트 언어를 지정합니다. 다른 프로그래밍 언어를 사용하고 싶으면 원하는 언어로 사용자 지정 어셈블리를 개발하고 스크립트 태스크의 코드에서 해당 기능을 호출할 수 있습니다.

스크립트 태스크에서 작성하는 스크립트는 패키지 정의에 저장되며 별도의 스크립트 파일은 없습니다. 따라서 스크립트 태스크를 사용해도 패키지 배포에 영향을 주지 않습니다.

[!참고]

패키지를 디자인하고 스크립트를 디버깅할 때 스크립트 코드는 임시로 프로젝트 파일에 기록됩니다. 중요한 정보를 파일에 저장하면 보안상 위험할 수 있으므로 암호와 같은 중요한 정보는 스크립트 코드에 포함하지 않는 것이 좋습니다.

기본적으로 Option Strict는 IDE에서 비활성화되어 있습니다.

스크립트 태스크 프로젝트 구조

스크립트 태스크에 포함되는 스크립트를 만들거나 수정할 경우 VSTA에서는 빈 새 프로젝트가 열리거나 기존 프로젝트가 다시 열립니다. 이 프로젝트는 패키지 파일 내에 저장되며 스크립트 태스크에서는 추가 파일을 만들지 않으므로 이 VSTA 프로젝트를 만들어도 패키지의 배포에는 영향이 없습니다.

스크립트 태스크 프로젝트의 프로젝트 항목 및 클래스

기본적으로 VSTA 프로젝트 탐색기 창에 표시되는 스크립트 태스크 프로젝트에는 ScriptMain이라는 단일 항목이 포함되어 있으며, 이 ScriptMain 항목에는 역시 ScriptMain이라는 단일 클래스가 포함되어 있습니다. 클래스의 코드 요소는 스크립트 태스크용으로 선택한 프로그래밍 언어에 따라 다릅니다.

스크립트 태스크가 Visual Basic 2010 프로그래밍 언어를 사용하도록 구성된 경우 ScriptMain 클래스에는 Main이라는 공용 서브루틴이 있습니다. ScriptMain.Main 서브루틴은 개발자가 스크립트 태스크를 실행할 때 런타임에서 호출하는 메서드입니다.

기본적으로 새 스크립트의 Main 서브루틴에 있는 유일한 코드는 Dts.TaskResult = ScriptResults.Success 줄뿐입니다. 이 줄은 태스크가 작업에 성공했음을 런타임에 알립니다. Dts.TaskResult 속성에 대한 자세한 내용은 스크립트 태스크에서 결과 반환에서 설명합니다.
스크립트 태스크가 Visual C# 프로그래밍 언어를 사용하도록 구성된 경우 ScriptMain 클래스에는 Main이라는 공용 메서드가 있습니다. 이 메서드는 스크립트 태스크가 실행될 때 호출됩니다.

기본적으로 Main 메서드에는 Dts.TaskResult = (int)ScriptResults.Success 줄이 포함되어 있습니다. 이 줄은 태스크가 작업에 성공했음을 런타임에 알립니다.

ScriptMain 항목에는 ScriptMain 이외의 클래스가 포함될 수 있습니다. 클래스는 해당 클래스가 있는 스크립트 태스크에서만 사용할 수 있습니다.

기본적으로 ScriptMain 프로젝트 항목에는 다음과 같은 자동 생성 코드가 포함됩니다. 코드 템플릿은 또한 스크립트 태스크에 대한 개요와 SSIS 개체(예: 변수, 이벤트 및 연결)를 검색 및 조작하는 방법에 대한 추가 정보를 제공합니다.

' Microsoft SQL Server Integration Services Script Task
' Write scripts using Microsoft Visual Basic 2008.
' The ScriptMain is the entry point class of the script.

Imports System
Imports System.Data
Imports System.Math
Imports Microsoft.SqlServer.Dts.Runtime.VSTAProxy

<System.AddIn.AddIn("ScriptMain", Version:="1.0", Publisher:="", Description:="")> _
Partial Class ScriptMain

Private Sub ScriptMain_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup

End Sub

Private Sub ScriptMain_Shutdown(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Shutdown
Try
' Unlock variables from the read-only and read-write variable collection properties
If (Dts.Variables.Count <> 0) Then
Dts.Variables.Unlock()
End If
Catch ex As Exception
        End Try
End Sub

Enum ScriptResults
Success = DTSExecResult.Success
Failure = DTSExecResult.Failure
End Enum


' The execution engine calls this method when the task executes.
' To access the object model, use the Dts property. Connections, variables, events,
' and logging features are available as members of the Dts property as shown in the following examples.
'
' To reference a variable, call Dts.Variables("MyCaseSensitiveVariableName").Value
' To post a log entry, call Dts.Log("This is my log text", 999, Nothing)
' To fire an event, call Dts.Events.FireInformation(99, "test", "hit the help message", "", 0, True)
'
' To use the connections collection use something like the following:
' ConnectionManager cm = Dts.Connections.Add("OLEDB")
' cm.ConnectionString = "Data Source=localhost;Initial Catalog=AdventureWorks;Provider=SQLNCLI10;Integrated Security=SSPI;Auto Translate=False;"
'
' Before returning from this method, set the value of Dts.TaskResult to indicate success or failure.
' 
' To open Help, press F1.

Public Sub Main()
'
' Add your code here
'
Dts.TaskResult = ScriptResults.Success
End Sub

End Class

/*
   Microsoft SQL Server Integration Services Script Task
   Write scripts using Microsoft Visual C# 2008.
   The ScriptMain is the entry point class of the script.
*/

using System;
using System.Data;
using Microsoft.SqlServer.Dts.Runtime.VSTAProxy;
using System.Windows.Forms;

namespace ST_1bcfdbad36d94f8ba9f23a10375abe53.csproj
{
    [System.AddIn.AddIn("ScriptMain", Version = "1.0", Publisher = "", Description = "")]
    public partial class ScriptMain
    {
        private void ScriptMain_Startup(object sender, EventArgs e)
        {

        }

        private void ScriptMain_Shutdown(object sender, EventArgs e)
        {
            try
            {
                // Unlock variables from the read-only and read-write variable collection properties
                if (Dts.Variables.Count != 0)
                {
                    Dts.Variables.Unlock();
                }
            }
            catch
            {
            }
        }

        #region VSTA generated code
        private void InternalStartup()
        {
            this.Startup += new System.EventHandler(ScriptMain_Startup);
            this.Shutdown += new System.EventHandler(ScriptMain_Shutdown);
        }
        enum ScriptResults
        {
            Success = DTSExecResult.Success,
            Failure = DTSExecResult.Failure
        };

        #endregion

        /*
The execution engine calls this method when the task executes.
To access the object model, use the Dts property. Connections, variables, events,
and logging features are available as members of the Dts property as shown in the following examples.

To reference a variable, call Dts.Variables["MyCaseSensitiveVariableName"].Value;
To post a log entry, call Dts.Log("This is my log text", 999, null);
To fire an event, call Dts.Events.FireInformation(99, "test", "hit the help message", "", 0, true);

To use the connections collection use something like the following:
ConnectionManager cm = Dts.Connections.Add("OLEDB");
cm.ConnectionString = "Data Source=localhost;Initial Catalog=AdventureWorks;Provider=SQLNCLI10;Integrated Security=SSPI;Auto Translate=False;";

Before returning from this method, set the value of Dts.TaskResult to indicate success or failure.

To open Help, press F1.
*/

        public void Main()
        {
            // TODO: Add your code here
            Dts.TaskResult = (int)ScriptResults.Success;
        }
    }

스크립트 태스크 프로젝트의 추가 프로젝트 항목

스크립트 태스크 프로젝트는 기본 ScriptMain 항목 외에 다른 항목을 포함할 수 있습니다. 이 프로젝트에는 클래스, 모듈 및 코드 파일을 추가할 수 있습니다. 폴더를 사용하여 항목 그룹을 구성할 수도 있습니다. 추가하는 모든 항목은 패키지 내부에 지속됩니다.

스크립트 태스크 프로젝트의 참조

프로젝트 탐색기에서 스크립트 태스크 프로젝트를 마우스 오른쪽 단추로 클릭하고 참조 추가를 클릭하여 관리되는 어셈블리에 대한 참조를 추가할 수 있습니다. 자세한 내용은 스크립팅 솔루션에서 다른 어셈블리 참조를 참조하십시오.

[!참고]

VSTA IDE의 프로젝트 참조를 클래스 뷰 또는 프로젝트 탐색기에서 볼 수 있습니다. 보기 메뉴에서 이들 창 중 하나를 엽니다. 프로젝트 메뉴, 프로젝트 탐색기 또는 클래스 뷰에서 새 참조를 추가할 수 있습니다.

스크립트 태스크에서 패키지와 상호 작용

스크립트 태스크에서는 ScriptObjectModel 클래스의 인스턴스인 전역 Dts 개체와 해당 멤버를 사용하여 포함하는 패키지 및 Integration Services 런타임과 상호 작용합니다.

다음 표에서는 전역 Dts 개체를 통해 스크립트 태스크 코드에 제공되는 ScriptObjectModel 클래스의 주요 공용 멤버를 보여 줍니다. 이 섹션의 항목에서는 이러한 멤버의 사용 방법을 보다 자세히 설명합니다.

멤버	용도
Connections	패키지에 정의된 연결 관리자에 액세스할 수 있게 해 줍니다.
Events	스크립트 태스크에서 오류, 경고 및 정보 메시지를 발생시킬 수 있게 해 주는 이벤트 인터페이스를 제공합니다.
ExecutionValue	TaskResult 외에도 간단한 방법으로 런타임에 단일 개체를 반환할 수 있게 해 줍니다. 반환된 단일 개체는 워크플로 분기에도 사용할 수 있습니다.
Log	사용하도록 설정된 로그 공급자에 태스크 진행률 및 결과 등의 정보를 로깅합니다.
TaskResult	태스크의 성공 또는 실패를 보고합니다.
Transaction	태스크의 컨테이너가 실행 중인 트랜잭션을 제공합니다.
Variables	스크립트 내에서 사용하기 위해 ReadOnlyVariables 및 ReadWriteVariables 태스크 속성에 나열된 변수에 액세스할 수 있게 해 줍니다.

ScriptObjectModel 클래스에는 대개 사용하지 않는 공용 멤버도 일부 포함되어 있습니다.

멤버	설명
VariableDispenser	Variables 속성은 변수에 보다 편리하게 액세스할 수 있게 해 줍니다. VariableDispenser를 사용할 수도 있지만 읽기 및 쓰기를 위해 변수를 잠그거나 잠금 해제하려면 명시적으로 메서드를 호출해야 합니다. 스크립트 태스크에서는 개발자가 Variables 속성을 사용할 때 잠금 의미 체계를 자동으로 처리합니다.

스크립트 태스크 디버깅

스크립트 태스크의 코드를 디버깅하려면 코드에 하나 이상의 중단점을 설정한 다음 VSTA IDE를 닫고 SQL Server Data Tools(SSDT)에서 패키지를 실행합니다. 패키지 실행 중 스크립트 태스크 실행이 시작되면 VSTA IDE가 다시 열리고 코드가 읽기 전용 모드에서 열립니다. 중단점에 도달한 후에는 변수 값을 검사하고 나머지 코드를 단계별로 실행할 수 있습니다.

주의
64비트 모드로 패키지를 실행할 때 스크립트 태스크를 디버깅할 수 있습니다.

[!참고]

스크립트 태스크를 디버깅하려면 패키지를 실행해야 합니다. 개별 태스크만 실행하면 스크립트 태스크 코드의 중단점이 무시됩니다.

[!참고]

스크립트 태스크를 패키지 실행 태스크에서 실행된 자식 패키지의 일부로 실행할 경우에는 스크립트 태스크를 디버깅할 수 없습니다. 이러한 경우에는 자식 패키지에서 스크립트 태스크에 설정한 중단점이 무시됩니다. 자식 패키지는 별도로 실행하여 정상적으로 디버깅할 수 있습니다.