Ready to get started?

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

Download Now

PowerShell Scripting to Replicate Smartsheet Data to MySQL

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

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

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

Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.

Collecting Smartsheet Data

  1. Install the module:

    Install-Module SmartsheetCmdlets
  2. Connect to Smartsheet:

    $smartsheet = Connect-Smartsheet -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackURL $CallbackURL
  3. Retrieve the data from a specific resource:

    $data = Select-Smartsheet -Connection $smartsheet -Table "Sheet_Event_Plan_Budget"

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

    $data = Invoke-Smartsheet -Connection $smartsheet -Query 'SELECT * FROM Sheet_Event_Plan_Budget WHERE Assigned = @Assigned' -Params @{'@Assigned'='Ana Trujilo'}
  4. Save a list of the column names from the returned data.

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

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

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

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

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