Ready to get started?

Download a free trial of the Highrise Cmdlets to get started:

 Download Now

Learn more:

Highrise Icon Highrise Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to Highrise data. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

PowerShell Scripting to Replicate Highrise Data to MySQL

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

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

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

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in the help documentation for a guide to using OAuth.

Collecting Highrise Data

  1. Install the module:

    Install-Module HighriseCmdlets
  2. Connect to Highrise:

    $highrise = Connect-Highrise -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackURL $CallbackURL -AccountId $AccountId
  3. Retrieve the data from a specific resource:

    $data = Select-Highrise -Connection $highrise -Table "Deals"

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

    $data = Invoke-Highrise -Connection $highrise -Query 'SELECT * FROM Deals WHERE GroupId = @GroupId' -Params @{'@GroupId'='MyGroupId'}
  4. Save a list of the column names from the returned data.

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

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

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

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


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

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