Ready to get started?

Learn more about the Confluence PowerShell Cmdlets or download a free trial:

Download Now

PowerShell Scripting to Replicate Confluence Data to MySQL

Write a simple PowerShell script to replicate Confluence data to a MySQL database.

The CData Cmdlets for Confluence offer live access to Confluence 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 Confluence and the CData Cmdlets for MySQL in PowerShell to replicate Confluence data to a MySQL database.

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

Obtaining an API Token

An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Connect Using a Confluence Cloud Account

To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

  • User: The user which will be used to authenticate with the Confluence server.
  • APIToken: The API Token associated with the currently authenticated user.
  • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

Connect Using a Confluence Server Instance

To connect to a Server instance, provide the following:

  • User: The user which will be used to authenticate with the Confluence instance.
  • Password: The password which will be used to authenticate with the Confluence server.
  • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

Collecting Confluence Data

  1. Install the module:

    Install-Module ConfluenceCmdlets
  2. Connect to Confluence:

    $confluence = Connect-Confluence -User $User -APIToken $APIToken -Url $Url -Timezone $Timezone
  3. Retrieve the data from a specific resource:

    $data = Select-Confluence -Connection $confluence -Table "Pages"

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

    $data = Invoke-Confluence -Connection $confluence -Query 'SELECT * FROM Pages WHERE Id = @Id' -Params @{'@Id'='10000'}
  4. Save a list of the column names from the returned data.

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

Inserting Confluence 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 Confluence 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 Confluence resource (Pages) and to exist in the database.

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

You have now replicated your Confluence data to a MySQL database. This gives you freedom to work with Confluence 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 Confluence and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-Confluence -Connection $confluence -Table "Pages" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Pages" -Columns $columns -Values $values }
  • If you wish to replicate the Confluence 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-Confluence 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')}