Ready to get started?

Download a free trial of the Couchbase Cmdlets to get started:

 Download Now

Learn more:

Couchbase Icon Couchbase Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to Couchbase data. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

Pipe Couchbase Data to CSV in PowerShell



Use standard PowerShell cmdlets to access Couchbase tables.

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

Creating a Connection to Your Couchbase Data

To connect using the Login method, set User, Password, and Server to the credentials for the account and the address of the server you want to connect to.

$conn = Connect-Couchbase  -User "$User" -Password "$Password" -Server "$Server"

Selecting Data

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

Select-Couchbase -Connection $conn -Table Customer | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomerData.csv -NoTypeInformation

You will notice that we piped the results from Select-Couchbase 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-Couchbase -Connection $conn -Table Customer -Where "FirstName = Bob" | Remove-Couchbase

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 Couchbase, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyCustomerUpdates.csv | %{
  $record = Select-Couchbase -Connection $Couchbase -Table Customer -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Couchbase -Connection $couchbase -Table Customer -Columns ("FirstName","TotalDue") -Values ($_.FirstName, $_.TotalDue) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Couchbase -Connection $couchbase -Table Customer -Columns ("FirstName","TotalDue") -Values ($_.FirstName, $_.TotalDue)
  }
}

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!