Ready to get started?

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

 Download Now

Learn more:

Kintone  Icon Kintone Cmdlets

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

PowerShell Scripting to Replicate Kintone Data to MySQL

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

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

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

In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

  • Url: The URL of your account.
  • GuestSpaceId: Optional. Set this when using a guest space.

Authenticating with Kintone

Kintone supports the following authentication methods.

Using Password Authentication

You must set the following to authenticate:

  • User: The username of your account.
  • Password: The password of your account.

Using Basic Authentication

If the basic authentication security feature is set on the domain, supply the additional login credentials with BasicAuthUser and BasicAuthPassword. Basic authentication requires these credentials in addition to User and Password.

Using Client SSL

Instead of basic authentication, you can specify a client certificate to authenticate. Set SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword. Additionally, set User and Password to your login credentials.

Collecting Kintone Data

  1. Install the module:

    Install-Module KintoneCmdlets
  2. Connect to Kintone:

    $kintone = Connect-Kintone -User $User -Password $Password -Url $Url -GuestSpaceId $GuestSpaceId
  3. Retrieve the data from a specific resource:

    $data = Select-Kintone -Connection $kintone -Table "Comments"

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

    $data = Invoke-Kintone -Connection $kintone -Query 'SELECT * FROM Comments WHERE AppId = @AppId' -Params @{'@AppId'='1354841'}
  4. Save a list of the column names from the returned data.

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

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

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

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

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