Automate Cloudant Integration Tasks from PowerShell

The CData Cmdlets for Cloudant are standard PowerShell cmdlets that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time and bidirectional access to Cloudant.

PowerShell Cmdlets or ADO.NET Provider?

The Cmdlets are not only a PowerShell interface to Cloudant, but also an SQL interface; this tutorial shows how to use both to create, retrieve, update, and delete Cloudant data. We also show examples of the ADO.NET equivalent, which is possible with the CData ADO.NET Provider for IBM Cloudant. To access Cloudant data from other .NET applications, like LINQPad, use the CData ADO.NET Provider for IBM Cloudant.

Once you have acquired the necessary connection properties, accessing Cloudant data in PowerShell can be enabled in three steps.

Set the following connection properties to connect to Cloudant:

• : Set this to your username.
• : Set this to your password.

PowerShell

1. Install the module:

   Install-Module CloudantCmdlets

2. Connect:

   $cloudant = Connect-Cloudant -User "$User" -Password "$Password"
   

3. Search for and retrieve data:

   $movierating = "R"
   $movies = Select-Cloudant -Connection $cloudant -Table "Movies" -Where "MovieRating = `'$MovieRating`'"
   $movies
   

   You can also use the Invoke-Cloudant cmdlet to execute SQL commands:

   $movies = Invoke-Cloudant -Connection $cloudant -Query 'SELECT * FROM Movies WHERE MovieRating = @MovieRating' -Params @{'@MovieRating'='R'}
   

ADO.NET

1. Load the provider's assembly:

   [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData ADO.NET Provider for IBM Cloudant\lib\System.Data.CData.Cloudant.dll")
    

2. Connect to Cloudant:

    
   $conn= New-Object System.Data.CData.Cloudant.CloudantConnection("User=abc123; Password=abcdef;")
   $conn.Open()
   

3. Instantiate the CloudantDataAdapter, execute an SQL query, and output the results:

   $sql="SELECT MovieRuntime, MovieRating from Movies"
   
   $da= New-Object System.Data.CData.Cloudant.CloudantDataAdapter($sql, $conn)
   $dt= New-Object System.Data.DataTable
   $da.Fill($dt)
   
   $dt.Rows | foreach {
   	Write-Host $_.movieruntime $_.movierating
   }
    

Update Cloudant Data

PowerShell

Update-Cloudant -Connection $Cloudant -Columns @('MovieRuntime','MovieRating') -Values @('MyMovieRuntime', 'MyMovieRating') -Table Movies -Id "MyId"

ADO.NET

$cmd = New-Object System.Data.CData.Cloudant.CloudantCommand("UPDATE Movies SET MovieRating='R' WHERE Id = @myId", $conn)
$cmd.Parameters.Add((New-Object System.Data.CData.Cloudant.CloudantParameter("@myId","10456255-0015501366")))
$cmd.ExecuteNonQuery()

Insert Cloudant Data

PowerShell

Add-Cloudant -Connection $Cloudant -Table Movies -Columns @("MovieRuntime", "MovieRating") -Values @("MyMovieRuntime", "MyMovieRating") 

ADO.NET

$cmd = New-Object System.Data.CData.Cloudant.CloudantCommand("INSERT INTO Movies (MovieRating) VALUES (@myMovieRating)", $conn)
$cmd.Parameters.Add((New-Object System.Data.CData.Cloudant.CloudantParameter("@myMovieRating","R")))
$cmd.ExecuteNonQuery()

Delete Cloudant Data

PowerShell

Remove-Cloudant -Connection $Cloudant -Table "Movies" -Id "MyId"

ADO.NET

$cmd = New-Object System.Data.CData.Cloudant.CloudantCommand("DELETE FROM Movies WHERE Id=@myId", $conn)
$cmd.Parameters.Add((New-Object System.Data.CData.Cloudant.CloudantParameter("@myId","001d000000YBRseAAH")))
$cmd.ExecuteNonQuery()