Ready to get started?

Connect to live data from Invoiced with the API Driver

Connect to Invoiced

PowerShell Scripting to Replicate Invoiced Data to MySQL



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

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

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

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

Invoiced API Profile Settings

In order to authenticate to Invoiced, you'll need to provide your API Key. An API key can be obtained by signing in to your account, and then going to Settings > Developers > API Keys. Set the API Key in the ProfileSettings property to connect.

Collecting Invoiced Data

  1. Install the module:

    Install-Module APICmdlets
  2. Connect to Invoiced:

    $api = Connect-API -Profile $Profile -ProfileSettings $ProfileSettings
  3. Retrieve the data from a specific resource:

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

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

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

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

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

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

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

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