PowerShell Scripting to Replicate SendGrid Data to MySQL

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SendGrid Cmdlets

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

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

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

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

To make use of all the available features, provide the User and Password connection properties.

To connect with limited features, you can set the APIKey connection property instead. See the "Getting Started" chapter of the help documentation for a guide to obtaining the API key.

Collecting SendGrid Data

  1. Install the module:

    Install-Module SendGridCmdlets
  2. Connect to SendGrid:

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

    $data = Select-SendGrid -Connection $sendgrid -Table "AdvancedStats"

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

    $data = Invoke-SendGrid -Connection $sendgrid -Query 'SELECT * FROM AdvancedStats WHERE Type = @Type' -Params @{'@Type'='Device'}
  4. Save a list of the column names from the returned data.

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

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

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

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

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