With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our CockroachDB Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site.

Install-Module CockroachDBCmdlets

The following line is then added to your profile, loading the cmdlets on the next session:

Import-Module CockroachDBCmdlets;

You can then use the Connect-CockroachDB cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-CockroachDB -User 'root' -Password 'root' -Server 'localhost' -Port '26257' -Database 'system'

Connecting to CockroachDB

Set the following to connect to data.

• Server: The host name or IP address of the server.
• Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
• Database: The name of the Cockroach database. If not specified, the cmdlet connects to the user's default database.
• User: The Cockroach DB user account used to authenticate.
• Password: The password used to authenticate the user.

Retrieving Data

After you have created a connection, you can use the other cmdlets to perform operations that you would normally expect to be able to perform against a relational database. The Select-CockroachDB cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-CockroachDB -Connection $conn -Table ""defaultdb"."public".Orders" -Columns @("ShipName, ShipCity") -Where "ShipCountry='USA'"

The Invoke-CockroachDB cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Where "ShipCountry = 'USA'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\my"defaultdb"."public".OrdersData.csv -NoTypeInformation

You will notice that we piped the results from Select-CockroachDB 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 object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

 
PS C:\> $conn  = Connect-CockroachDB -User 'root' -Password 'root' -Server 'localhost' -Port '26257' -Database 'system'
PS C:\> $row = Select-CockroachDB -Connection $conn -Table ""defaultdb"."public".Orders" -Columns (ShipName, ShipCity) -Where "ShipCountry = 'USA'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  ""defaultdb"."public".Orders",
  "Columns":  [

  ],
  "ShipName":  "MyShipName",
  "ShipCity":  "MyShipCity"
} 

Deleting Data

The following line deletes any records that match the criteria:

Select-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Where "ShipCountry = 'USA'" | Remove-CockroachDB

Modifying Data

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

Import-Csv -Path C:\My"defaultdb"."public".OrdersUpdates.csv | %{
  $record = Select-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Columns @("ShipName","ShipCity") -Values @($_.ShipName, $_.ShipCity) -Where "Id  = `'$_.Id`'"
  }else{
    Add-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Columns @("ShipName","ShipCity") -Values @($_.ShipName, $_.ShipCity)
  }
}