Readme_ADO Source Component Sample

Article
08/31/2009

This sample works only with SQL Server 2005 and SQL Server 2008. It will not work with any version of SQL Server earlier than SQL Server 2005.

The ADO Source Component sample demonstrates how to implement a source component that can be used as a data source in the Data Flow task. This component uses the ADO.NET connection manager to acquire a connection to a database, and runs the SQL statement provided by the user. The rows obtained by running the statement are added to a PipelineBuffer that is provided to the component by the Data Flow task, and subsequently made available to downstream components.

Note

For more information about source components, see the topic, "Creating a Source Component", in SQL Server Books Online.

This sample is not supported on Itanium-based operating systems.

Important

The Integration Services Data Flow Programming code samples are intended to demonstrate the core functionality that you must implement to create a custom data flow component. The samples do not include full support for customization in the Advanced Editor. For example, you cannot use the Advanced Editor to add or remove inputs and outputs or to configure columns.

Samples are provided for educational purposes only. They are not intended to be used in a production environment and have not been tested in a production environment. Microsoft does not provide technical support for these samples.

Running the Sample

If you already know how to locate, build, and install code samples, you can go directly to the section, Testing the Sample, and read about how to configure and run the code sample.

Prerequisites

This sample requires that the following components are installed.

Microsoft Visual Studio
Microsoft SQL Server Integration Services

Location

If the code sample was installed to the default location, the sample is located in the following directory:

C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Programming Samples\Data Flow\Ado Source Component Sample

The C# solution for the code sample is located in the CS directory, and the Visual Basic solution is located in the VB directory.

For information about the two-step process required to install the samples, see Considerations for Installing SQL Server Samples and Sample Databases.

Building the Sample

If you have not already generated a strong name key file in the Samples folder, use the following procedure to generate this key file. The sample projects are configured to sign assemblies at build time with this key file. You can view the signing properties on the Signing tab of the Project Properties dialog box.

To generate a strong name key file

To open a Microsoft Visual Studio command prompt, click Start, point to All Programs, point to Microsoft Visual Studio 2008, point to Visual Studio Tools, and then click Visual Studio 2008 Command Prompt.

- or -

To open a Microsoft .NET Framework command prompt, click Start, point to All Programs, point to Microsoft .NET Framework SDK 2.0, and then click SDK Command Prompt.
At the command prompt, use the change directory (CD) command to change the current folder of the Command Prompt window to the Samples folder. The key file that you create in this folder will be used by all SQL Server code samples.

Note

To determine the folder where samples are located, click Start, point to All Programs, point to Microsoft SQL Server 2008, point to Documentation and Tutorials, and then click Samples Directory. If the default installation location was used, the samples are located in <drive>:\Program Files\Microsoft SQL Server\100\Samples.
At the command prompt, run the following command to generate the key file:
```
sn -k SampleKey.snk
```
Important

For more information about the strong-name key pair, see "Security Briefs: Strong Names and Security in the .NET Framework " in the .NET Development Center on MSDN.

To build the sample in Microsoft Visual Studio 2008

From the File | Open menu, click Project and open the solution file AdoSource.sln in your preferred programming language.
From the Build menu, click Build AdoSource to build the project.

Installing the Sample

This sample is provided in both Visual Basic and C#. To distinguish the assemblies for each version of the sample, the name of the output assembly has CS or VB appended. After successfully building the component, follow these steps to use the component in Business Intelligence Development Studio.

To copy the component to the PipelineComponents folder

Open Windows Explorer or your preferred application for working in the file system.
Copy the assembly (AdoSourceCS.dll or AdoSourceVB.dll) to the PipelineComponents folder located at %system%\Program Files\Microsoft SQL Server\100\DTS.

To install the component into the global assembly cache (GAC) by dragging the assembly

Open Windows Explorer or your preferred application for working in the file system.
Drag the assembly from the PipelineComponents folder to the folder where the global assembly cache (GAC) is located, at %system%\assembly.

To install the component into the global assembly cache (GAC) by using gacutil.exe

Open a Command Prompt window.
Type the following command to run gacutil.exe and install the C# version of the component into the global assembly cache:

gacutil.exe -iF "c:\Program Files\Microsoft Sql Server\100\DTS\PipelineComponents\AdoSourceCS.dll"

- or -
Type the following command to run gacutil.exe and install the Visual Basic version of the component into the GAC:

gacutil.exe -iF "c:\Program Files\Microsoft Sql Server\100\DTS\PipelineComponents\AdoSourceVB.dll"

To add the component to the Toolbox

Open Business Intelligence Development Studio.
Right-click the toolbox and then click Choose Items.
In the Choose Toolbox Items dialog box, click the SSIS Data Flow Items tab.
Click the check box next to your component, and then click OK.

Note

If the component is not displayed in the list, you can click Browse to locate the component yourself. However in this case it may not be installed correctly.

After you complete these steps, the component is visible in the Data Flow Sources section of the Toolbox, and can be added to the Data Flow task in the designer.

Testing the Sample

After you have added the sample component to a Data Flow task in a package, you can configure it as follows in SSIS Designer.

To configure the sample component in a package

Add an ADO.NET connection manager to the package and select the Microsoft OLE DB Provider for SQL Server. Configure the sample component to use this connection manager.
On the Component Properties page of the Advanced Editor, under Custom Properties, configure the SqlStatement custom property of the component by entering a valid SQL query against tables or views in the database to which the connection manager connects.

Share via