Back Up Cosmos DB data to SQL Server through SSIS

This article illustrates using the Cosmos DB ADO.NET Data Provider within a SQL Server SSIS workflow for the direct transfer of Cosmos DB data to a Microsoft SQL Server database. It's worth noting that the identical process detailed below is applicable to any CData ADO.NET Data Providers, enabling the direct connection of SQL Server with remote data through SSIS.

1. Open Visual Studio and create a new Integration Services project.
2. Add a new Data Flow task from the toolbox onto the Control Flow screen.

3. In the Data Flow screen, add an ADO.NET Source and an OLE DB Destination from the toolbox.

   👁 The components used in the data task in this example.
   
4. Add a new connection and select .NET Providers\CData ADO.NET Provider for Cosmos DB.

5. In the connection manager, enter the connection details for Cosmos DB data.

   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.
   👁 Connection properties in the Connection Manager dialog. (Salesforce is shown.)
   

6. Open the DataReader editor and set the following information:

   • ADO.NET connection manager: In the Connection Managers menu, select the Data Connection you just created.
   • Data access mode: Select 'SQL command'.
   • SQL command text: In the DataReader Source editor, open the Component Properties tab and enter a SELECT command, such as the one below:

     SELECT City, CompanyName FROM Customers

   👁 The connection and query specified in the source component properties. (Salesforce is shown.)
   
7. Close the DataReader editor and drag the arrow below the DataReader Source to connect it to the OLE DB Destination.

8. Open the OLE DB Destination and enter the following information in the Destination Component Editor.

   • Connection manager: Add a new connection. Enter your server and database information here. In this example, SQLExpress is running on a separate machine.
   • Data access mode: Set your data access mode to "table or view" and select the table or view to populate in your database.

9. Configure any properties you wish on the Mappings screen.

   👁 Input and destination columns in the OLE DB Destination Editor.
   
10. Close the OLE DB Destination Editor and run the project. After the SSIS task has finished executing, your database will be populated with data obtained from Cosmos DB data.