Build Data Flows from Cosmos DB to SQL Server using SSIS

Using SQL Server as a backup for critical business data provides an essential safety net against loss. Backing up data to SQL Server enables business users to more easily connect that data with features like reporting, analytics, and more.

This example demonstrates how to use the CData SSIS Tasks for Cosmos DB inside of a SQL Server SSIS workflow to transfer Cosmos DB data into a Microsoft SQL Server database.

Add the Components

To get started, add a new Cosmos DB source and SQL Server ADO.NET destination to a new data flow task.

Create a New Connection Manager

Follow the steps below to save Cosmos DB connection properties in a connection manager.

1. In the Connection Manager window, right-click and then click New Connection. The Add SSIS Connection Manager dialog is displayed.
2. In the Connection Manager type menu, select CosmosDB. The CData Cosmos DB Connection Manager is displayed.
3. Configure connection properties.

   To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

   • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
   • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
   👁 Configuring a connection (Salesforce is shown).
   

Configure the Cosmos DB Source

Follow the steps below to specify the query to be used to extract Cosmos DB data.

1. Double-click the Cosmos DB source to open the source component editor.
2. In the Connection Manager menu, select the connection manager previously created.
3. Specify the query to use for the data extraction. For example:

   SELECT City, CompanyName FROM Customers
   

   👁 The SQL query to retrieve records. (Salesforce is shown.)
   
4. Close the Cosmos DB Source control and connect it to the ADO.NET Destination.

Configure the SQL Server Destination

Follow the steps below to specify the SQL server table to load the Cosmos DB data into.

1. Open the ADO.NET Destination and add a New Connection. Enter your server and database information here.
2. In the Data access mode menu, select "table or view".
3. In the Table Or View menu, select the table or view to populate.
4. Configure any properties you wish to on the Mappings screen. 👁 The mappings from the SSIS source component to SQL Server. (Salesforce is shown.)
   

Run the Project

You can now run the project. After the SSIS Task has finished executing, your database will be populated with Cosmos DB data.