How to pipe Cosmos DB Data to CSV in PowerShell

The CData Cmdlets Module for Cosmos DB is a standard PowerShell module offering straightforward integration with Cosmos DB. Below, you will find examples of using our CosmosDB Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your 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.

$conn = Connect-CosmosDB -AccountEndpoint "$AccountEndpoint" -AccountKey "$AccountKey"

Selecting Data

Follow the steps below to retrieve data from the Customers table and pipe the result into to a CSV file:

Select-CosmosDB -Connection $conn -Table Customers | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

You will notice that we piped the results from Select-CosmosDB into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-CosmosDB -Connection $conn -Table Customers -Where "Name = Morris Park Bake Shop" | Remove-CosmosDB

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Cosmos DB, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyCustomersUpdates.csv | %{
 $record = Select-CosmosDB -Connection $CosmosDB -Table Customers -Where ("id = `'"+$_.id+"`'")
 if($record){
 Update-CosmosDB -Connection $cosmosdb -Table Customers -Columns ("City","CompanyName") -Values ($_.City, $_.CompanyName) -Where ("id = `'"+$_.id+"`'")
 }else{
 Add-CosmosDB -Connection $cosmosdb -Table Customers -Columns ("City","CompanyName") -Values ($_.City, $_.CompanyName)
 }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!