Ready to get started?

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

Download Now

PowerShell Scripting to Replicate Office 365 Data to MySQL

Write a simple PowerShell script to replicate Office 365 data to a MySQL database.

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

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

Office 365 uses the OAuth authentication standard. To authenticate requests, you will need to obtain the OAuthClientId, OAuthClientSecret, and OAuthCallbackURL by registering an app with Office 365. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Collecting Office 365 Data

  1. Install the module:

    Install-Module Office365Cmdlets
  2. Connect to Office 365:

    $office365 = Connect-Office365 -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -OAuthCallbackURL $OAuthCallbackURL
  3. Retrieve the data from a specific resource:

    $data = Select-Office365 -Connection $office365 -Table "Files"

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

    $data = Invoke-Office365 -Connection $office365 -Query 'SELECT * FROM Files WHERE UserId = @UserId' -Params @{'@UserId'='54f34750-0d34-47c9-9949-9fac4791cddb'}
  4. Save a list of the column names from the returned data.

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

Inserting Office 365 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 Office 365 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 Office 365 resource (Files) and to exist in the database.

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

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

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