Ready to get started?

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

 Download Now

Learn more:

Basecamp Icon Basecamp Cmdlets

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

PowerShell Scripting to Replicate Basecamp Data to MySQL



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

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

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

Basecamp uses basic or OAuth 2.0 authentication. To use basic authentication you will need the user and password that you use for logging in to Basecamp. To authenticate to Basecamp via OAuth 2.0, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with Basecamp.

See the Getting Started section in the help documentation for a connection guide.

Additionally, you will need to specify the AccountId connection property. This can be copied from the URL after you log in.

Collecting Basecamp Data

  1. Install the module:

    Install-Module BasecampCmdlets
  2. Connect to Basecamp:

    $basecamp = Connect-Basecamp -User $User -Password $Password
  3. Retrieve the data from a specific resource:

    $data = Select-Basecamp -Connection $basecamp -Table "Projects"

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

    $data = Invoke-Basecamp -Connection $basecamp -Query 'SELECT * FROM Projects WHERE Drafts = @Drafts' -Params @{'@Drafts'='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 Basecamp 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 Basecamp 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 Basecamp resource (Projects) and to exist in the database.

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

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

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