PowerShell Scripting to Replicate Bitbucket Data to MySQL

The CData Cmdlets for Bitbucket offer live access to Bitbucket data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for Bitbucket and the CData Cmdlets for MySQL in PowerShell to replicate Bitbucket data to a MySQL database.

After obtaining the needed connection properties, accessing Bitbucket data in PowerShell and preparing for replication consists of four basic steps.

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.

Collecting Bitbucket Data

1. Install the module:

   Install-Module BitbucketCmdlets

2. Connect to Bitbucket:

    $bitbucket = Connect-Bitbucket -Workspace $Workspace -Schema $Schema -InitiateOAuth $InitiateOAuth
    

3. Retrieve the data from a specific resource:

    $data = Select-Bitbucket -Connection $bitbucket -Table "Issues"
    

   You can also use the Invoke-Bitbucket cmdlet to execute pure SQL-92 statements:

    $data = Invoke-Bitbucket -Connection $bitbucket -Query 'SELECT * FROM Issues WHERE Id = @Id' -Params @{'@Id'='1'}
    

4. Save a list of the column names from the returned data.

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name
    

Inserting Bitbucket Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

1. Install the module:

   Install-Module MySQLCmdlets

2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
    

3. Loop through the Bitbucket data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the Bitbucket resource (Issues) and to exist in the database.

    $data | % {
    $row = $_
    $values = @()
    $columns | % {
    $col = $_
    $values += $row.$($col)
    }
    Add-MySQL -Connection $mysql -Table "Issues" -Columns $columns -Values $values
    }
    

You have now replicated your Bitbucket data to a MySQL database. This gives you freedom to work with Bitbucket data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

• Once you have connected to Bitbucket and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

   Select-Bitbucket -Connection $bitbucket -Table "Issues" | % {
   $row = $_
   $values = @()
   $columns | % {
   $col = $_
   $values += $row.$($col)
   }
   Add-MySQL -Connection $mysql -Table "Issues" -Columns $columns -Values $values
   }
   

• If you wish to replicate the Bitbucket data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-Bitbucket cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

   $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}