各製品の資料を入手。
詳細はこちら →ShipStation のデータをPowerShell でMySQL にレプリケーションする方法
PowerShell のシンプルなスクリプトで、ShipStation のデータ をMySQL データベースにレプリケーション(複製)する方法を紹介します。
最終更新日:2023-09-26
この記事で実現できるShipStation 連携のシナリオ
こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。
CData Cmdlets for ShipStation を使えば、PowerShell からShipStation のデータ データにリアルタイムで連携できます。データ同期などのタスクの連携にぴったりの製品です。 本記事では、PowerShell からCData Cmdlets for ShipStation およびCData Cmdlets for MySQL を使って、同期スクリプトを作成して実行します。
まずは、PowerShell でShipStation への接続を行います。レプリケーションは4つのステップがあります。
ShipStation 接続プロパティの取得・設定方法
ShipStation への接続には、BASIC 認証標準を使います。
- ShipStation アカウントにログインします。
- 右上隅にある[設定]アイコンをクリックします。左側にカラムメニューが表示されます。
- [アカウント]->[API 設定]をクリックします。
- [API 設定]ページで、API Key とAPI Secret を書き留めます。
ShipStation への認証
- APIKey:[API 設定]ページのAPI Key に設定します。
- APISecret:[API 設定]ページのSecret key に設定します。
ShipStation のデータの取得
-
モジュールのインストール:
Install-Module ShipStationCmdlets
-
ShipStation への接続:
$shipstation = Connect-ShipStation -APIKey $APIKey -APISecret $APISecret
-
取得ターゲットのリソースの取得:
$data = Select-ShipStation -Connection $shipstation -Table "Tags"
Invoke-ShipStation cmdlet を使って、SQL-92 クエリを使用することもできます:
$data = Invoke-ShipStation -Connection $shipstation -Query 'SELECT * FROM Tags WHERE CustomerId = @CustomerId' -Params @{'@CustomerId'='1368175'}
-
戻り値からカラム名のリストを保存します。
$columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name
ShipStation のデータをMySQL データベースにレプリケーション
カラム名を指定できるようにして、データをMySQL データベースにレプリケーションします。
-
モジュールのインストール:
Install-Module MySQLCmdlets
-
MySQL DB に、MySQL Server 名、ユーザー、パスワード、レプリケーション先のデータベース名を指定して、接続します:
$mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
-
ShipStation、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、ShipStation のリソース(Tags)と同じテーブル名を持っている必要があります。
$data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Tags" -Columns $columns -Values $values }
次回以降のレプリケーションをシンプルに実現
-
一度PowerShell でShipStation とMySQL に接続したら、次からは1行のコマンドでレプリケーションを実施できます:
Select-ShipStation -Connection $shipstation -Table "Tags" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Tags" -Columns $columns -Values $values }
-
別のPowerShell モジュールで、ShipStation を別のデータベースに複製する場合、Select-ShipStation cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。
$columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}
おわりに
これで、ShipStation のデータをMySQL に複製できました。分析、BI などでShipStation のデータをMySQL から使うことができるようになります。