Cmdlets for Bitbucket

Build 24.0.9060

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our Bitbucket 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 BitbucketCmdlets

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

Import-Module BitbucketCmdlets;

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

$conn = Connect-Bitbucket -Workspace 'myworkspaceslug' -Schema 'Information'

Connecting to Bitbucket

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.
    To query the Workspaces table, set Schema to Information and execute: 
    SELECT * FROM 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.

The following subsections describe how to authenticate to Bitbucket from three common authentication flows.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Bitbucket, see Connection.

Desktop Applications

To connect via a desktop application, you must set and refresh the OAuth acess token.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId: The Key displayed when you created your custom OAuth application.
  • OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
  • CallbackURL: The Callback URL defined when you registered your application. This is typically set to http://localhost:33333.

When you connect, the cmdlet opens Bitbucket's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the cmdlet refreshes it automatically.

Automatic Refresh of the OAuth Access Token

To have the cmdlet automatically refresh the OAuth access token:

  1. Before connecting to data for the first time, set these connection parameters:

    • InitiateOAuth: REFRESH.
    • OAuthClientId: The Key displayed when you created your custom OAuth application.
    • OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
    • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
    • OAuthSettingsLocation: The path where you want the cmdlet to save the OAuth values, which persist across connections.

  2. On subsequent data connections, set:

    • InitiateOAuth
    • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set these connection properties:

    • OAuthClientId: The Client Id in your custom OAuth application settings.
    • OAuthClientSecret: The Client Secret in your custom OAuth application settings.

  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

Note: Depending on whether AuthScheme is set to code or client, authentication is performed with either an authorization code or a client credentials grant type.

You can do this in either of the following ways:

  • Option 1: Obtain the OAuthVerifier value.
  • Option 2: Install the cmdlet on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the cmdlet to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL as follows:

  1. Authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

    Set these properties:

    • InitiateOAuth: OFF.
    • OAuthClientId: The Key displayed when you created your custom OAuth application.
    • OAuthClientSecret: The Secret displayed when you created your custom OAuth application.

  2. Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)

    Copy this URL and paste it into a new browser tab.

  3. Log in and grant permissions to the cmdlet. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.

  4. Exchange the OAuth verifier code for OAuth refresh and access tokens.

    On the headless machine, to obtain the OAuth authentication values, set these properties:

    • InitiateOAuth: REFRESH.
    • OAuthVerifier: The verifier code (the value of the code parameter in the Callback URL).
    • OAuthClientId: The Key displayed when you created your custom OAuth application.
    • OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
    • OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified location.

  5. Test the connection to generate the OAuth settings file.

  6. You are ready to connect after you re-set these properties:

    • InitiateOAuth: REFRESH.
    • OAuthClientId: The Key displayed when you created your custom OAuth application.
    • OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
    • OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the cmdlet.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set these connection properties:

  • InitiateOAuth: REFRESH.
  • OAuthClientId: The Secret displayed when you created your custom OAuth application.
  • OAuthSettingsLocation: The location of the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the cmdlet.

Retrieving Data

The Select-Bitbucket cmdlet provides a native PowerShell interface for retrieving data: 

$results = Select-Bitbucket -Connection $conn -Table "Issues" -Columns @("Title, ContentRaw") -Where "ContentRaw='Bug'"
The Invoke-Bitbucket 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-Bitbucket -Connection $conn -Table Issues -Where "ContentRaw = 'Bug'" | 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 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-Bitbucket -Workspace 'myworkspaceslug' -Schema 'Information'
PS C:\> $row = Select-Bitbucket -Connection $conn -Table "Issues" -Columns (Title, ContentRaw) -Where "ContentRaw = 'Bug'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Issues",
  "Columns":  [

  ],
  "Title":  "MyTitle",
  "ContentRaw":  "MyContentRaw"
}

Deleting Data

The following line deletes any records that match the criteria: 

Select-Bitbucket -Connection $conn -Table Issues -Where "ContentRaw = 'Bug'" | Remove-Bitbucket

Modifying 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 $conn -Table Issues -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Bitbucket -Connection $conn -Table Issues -Columns @("Title","ContentRaw") -Values @($_.Title, $_.ContentRaw) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Bitbucket -Connection $conn -Table Issues -Columns @("Title","ContentRaw") -Values @($_.Title, $_.ContentRaw)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060