Build Cosmos DB-Connected ETL Processes in Google Data Fusion

Google Data Fusion allows users to perform self-service data integration to consolidate disparate data. Uploading the CData JDBC Driver for Cosmos DB enables users to access live Cosmos DB data from within their Google Data Fusion pipelines. While the CData JDBC Driver enables piping Cosmos DB data to any data source natively supported in Google Data Fusion, this article walks through piping data from Cosmos DB to Google BigQuery,

Upload the CData JDBC Driver for Cosmos DB to Google Data Fusion

Upload the CData JDBC Driver for Cosmos DB to your Google Data Fusion instance to work with live Cosmos DB data. Due to the naming restrictions for JDBC drivers in Google Data Fusion, create a copy or rename the JAR file to match the following format driver-version.jar. For example: cdatacosmosdb-2020.jar

1. Open your Google Data Fusion instance
2. Click the to add an entity and upload a driver
3. On the "Upload driver" tab, drag or browse to the renamed JAR file.
4. On the "Driver configuration" tab:
   • Name: Create a name for the driver (cdata.jdbc.cosmosdb) and make note of the name
   • Class name: Set the JDBC class name: (cdata.jdbc.cosmosdb.CosmosDBDriver)
5. Click "Finish"

Connect to Cosmos DB Data in Google Data Fusion

With the JDBC Driver uploaded, you are ready to work with live Cosmos DB data in Google Data Fusion Pipelines.

1. Navigate to the Pipeline Studio to create a new Pipeline
2. From the "Source" options, click "Database" to add a source for the JDBC Driver
3. Click "Properties" on the Database source to edit the properties

   NOTE: To use the JDBC Driver in Google Data Fusion, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

   • Set the Label
   • Set Reference Name to a value for any future references (i.e.: cdata-cosmosdb)
   • Set Plugin Type to "jdbc"
   • Set Connection String to the JDBC URL for Cosmos DB. For example:
     
     jdbc:cosmosdb:RTK=5246...;AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;

     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.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Cosmos DB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.cosmosdb.jar

     Fill in the connection properties and copy the connection string to the clipboard.

   • Set Import Query to a SQL query that will extract the data you want from Cosmos DB, i.e.:
     SELECT * FROM Customers
4. From the "Sink" tab, click to add a destination sink (we use Google BigQuery in this example)
5. Click "Properties" on the BigQuery sink to edit the properties
   • Set the Label
   • Set Reference Name to a value like cosmosdb-bigquery
   • Set Project ID to a specific Google BigQuery Project ID (or leave as the default, "auto-detect")
   • Set Dataset to a specific Google BigQuery dataset
   • Set Table to the name of the table you wish to insert Cosmos DB data into

With the Source and Sink configured, you are ready to pipe Cosmos DB data into Google BigQuery. Save and deploy the pipeline. When you run the pipeline, Google Data Fusion will request live data from Cosmos DB and import it into Google BigQuery.

While this is a simple pipeline, you can create more complex Cosmos DB pipelines with transforms, analytics, conditions, and more. Download a free, 30-day trial of the CData JDBC Driver for Cosmos DB and start working with your live Cosmos DB data in Google Data Fusion today.