VOOZH about

URL: https://www.cdata.com/kb/tech/mysql-powershell-replicate.rst

⇱ PowerShell Scripting to Replicate MySQL Data to MySQL


PowerShell Scripting to Replicate MySQL Data to MySQL

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Write a simple PowerShell script to replicate MySQL data to a MySQL database.

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

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

The CData Provider supports connecting to on-premises and cloud-hosted versions of MySQL such as Amazon RDS for MySQL, Google Cloud SQL for MySQL, Azure Database for MySQL, or Oracle MySQL HeatWave. The Server and Port properties must be set to a MySQL server. If IntegratedSecurity is set to false, then User and Password must be set to valid user credentials. Optionally, Database can be set to connect to a specific database. If not set, tables from all databases will be returned.

SSH Connectivity for MySQL

You can use SSH (Secure Shell) to authenticate with MySQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

SSH Connections to MySQL in Password Auth Mode

To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

  • User: MySQL User name
  • Password: MySQL Password
  • Database: MySQL database name
  • Server: MySQL Server name
  • Port: MySQL port number like 3306
  • UserSSH: "true"
  • SSHAuthMode: "Password"
  • SSHPort: SSH Port number
  • SSHServer: SSH Server name
  • SSHUser: SSH User name
  • SSHPassword: SSH Password

SSH Connections to MySQL in Public Key Auth Mode

To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

  • User: MySQL User name
  • Password: MySQL Password
  • Database: MySQL database name
  • Server: MySQL Server name
  • Port: MySQL port number like 3306
  • UserSSH: "true"
  • SSHAuthMode: "Public_Key"
  • SSHPort: SSH Port number
  • SSHServer: SSH Server name
  • SSHUser: SSH User name
  • SSHClientCret: the path for the public key certificate file

Collecting MySQL Data

  1. Install the module:

    Install-Module MySQLCmdlets
  2. Connect to MySQL:

     $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
     
  3. Retrieve the data from a specific resource:

     $data = Select-MySQL -Connection $mysql -Table "Orders"
     

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

     $data = Invoke-MySQL -Connection $mysql -Query 'SELECT * FROM Orders WHERE ShipCountry = @ShipCountry' -Params @{'@ShipCountry'='USA'}
     
  4. Save a list of the column names from the returned data.

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

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

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

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

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

Ready to get started?

Download a free trial of the MySQL Cmdlets to get started:

 Download Now

Learn more:

👁 MySQL Icon
MySQL Cmdlets

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