How to pipe Bitbucket Data to CSV in PowerShell

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

Creating a Connection to Your Bitbucket Data

For most queries, you must set the Workspace. The only exception to this is the Workspaces table, which does not require this property to be set, as querying it provides a list of workspace slugs that can be used to set Workspace. To query this table, you must set Schema to 'Information' and execute the query SELECT * FROM Workspaces>.

Setting Schema to 'Information' displays general information. To connect to Bitbucket, set these parameters:

• Schema: To show general information about a workspace, such as its users, repositories, and projects, set this to Information. Otherwise, set this to the schema of the repository or project you are querying. To get a full set of available schemas, query the sys_schemas table.
• Workspace: Required if you are not querying the Workspaces table. This property is not required for querying the Workspaces table, as that query only returns a list of workspace slugs that can be used to set Workspace.

Authenticating to Bitbucket

Bitbucket supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

Creating a custom OAuth application

From your Bitbucket account:

1. Go to Settings (the gear icon) and select Workspace Settings.
2. In the Apps and Features section, select OAuth Consumers.
3. Click Add Consumer.
4. Enter a name and description for your custom application.
5. Set the callback URL:
   • For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
   • For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
6. If you plan to use client credentials to authenticate, you must select This is a private consumer. In the driver, you must set AuthScheme to client.
7. Select which permissions to give your OAuth application. These determine what data you can read and write with it.
8. To save the new custom application, click Save.
9. After the application has been saved, you can select it to view its settings. The application's Key and Secret are displayed. Record these for future use. You will use the Key to set the OAuthClientId and the Secret to set the OAuthClientSecret.

$conn = Connect-Bitbucket -Workspace "$Workspace" -Schema "$Schema" -InitiateOAuth "$InitiateOAuth"

Selecting Data

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

Select-Bitbucket -Connection $conn -Table Issues | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myIssuesData.csv -NoTypeInformation

You will notice that we piped the results from Select-Bitbucket 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-Bitbucket -Connection $conn -Table Issues -Where "Id = 1" | Remove-Bitbucket

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

Import-Csv -Path C:\MyIssuesUpdates.csv | %{
 $record = Select-Bitbucket -Connection $Bitbucket -Table Issues -Where ("Id = `'"+$_.Id+"`'")
 if($record){
 Update-Bitbucket -Connection $bitbucket -Table Issues -Columns ("Title","ContentRaw") -Values ($_.Title, $_.ContentRaw) -Where ("Id = `'"+$_.Id+"`'")
 }else{
 Add-Bitbucket -Connection $bitbucket -Table Issues -Columns ("Title","ContentRaw") -Values ($_.Title, $_.ContentRaw)
 }
}

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!