PowerShell Scripting to Replicate Klipfolio Data to MySQL

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

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

Start by setting the Profile connection property to the location of the Klipfolio Profile on disk (e.g. C:\profiles\Klipfolio.apip). Next, set the ProfileSettings connection property to the connection string for Klipfolio (see below).

Klipfolio API Profile Settings

In order to authenticate to Klipfolio, you'll need to provide your API Key. You can generate an API key from the Klipfolio Dashboard app through either the My Profile page or from Users if you are an administrator (you must have the user.manage permission). Set the API Key in the ProfileSettings property to connect.

Collecting Klipfolio Data

1. Install the module:

   Install-Module APICmdlets

2. Connect to Klipfolio:

   $api = Connect-API -Profile $Profile -ProfileSettings $ProfileSettings

3. Retrieve the data from a specific resource:

   $data = Select-API -Connection $api -Table "DataSources"

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

   $data = Invoke-API -Connection $api -Query 'SELECT * FROM DataSources WHERE IsDynamic = @IsDynamic' -Params @{'@IsDynamic'='true'}

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

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

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

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

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

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

• If you wish to replicate the Klipfolio 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-API 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')}