Ready to get started?

Connect to live data from Drift with the API Driver

Connect to Drift

PowerShell Scripting to Replicate Drift Data to MySQL



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

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

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

Start by setting the Profile connection property to the location of the Drift Profile on disk (e.g. C:\profiles\Drift.apip). Next, set the ProfileSettings connection property to the connection string for Drift (see below).

Drift API Profile Settings

Drift uses OAuth-based authentication.

You must first register an application here: https://dev.drift.com. Your app will be assigned a client ID and a client secret. Set these in your connection string via the OAuthClientId and OAuthClientSecret properties. More information on setting up an OAuth application can be found at https://devdocs.drift.com/docs/.

After setting the following options in the ProfileSettings connection property, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: Set this to the Client Id that is specified in your app settings.
  • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.

Collecting Drift Data

  1. Install the module:

    Install-Module APICmdlets
  2. Connect to Drift:

    $api = Connect-API -Profile $Profile -Authscheme $Authscheme -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackUrl $CallbackUrl
  3. Retrieve the data from a specific resource:

    $data = Select-API -Connection $api -Table "Contacts"

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

    $data = Invoke-API -Connection $api -Query 'SELECT * FROM Contacts WHERE LastName = @LastName' -Params @{'@LastName'='Stark'}
  4. Save a list of the column names from the returned data.

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

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

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

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

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