各製品の資料を入手。
詳細はこちら →
freee のデータをPowerShell でMySQL にレプリケーションする方法
PowerShell のシンプルなスクリプトで、freee のデータ をMySQL データベースにレプリケーション（複製）する方法を紹介します。
最終更新日：2023-09-26
この記事で実現できるfreee 連携のシナリオ
こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。
CData Cmdlets for API を使えば、PowerShell からfreee のデータ データにリアルタイムで連携できます。データ同期などのタスクの連携にぴったりの製品です。 本記事では、PowerShell からCData Cmdlets for API およびCData Cmdlets for MySQL を使って、同期スクリプトを作成して実行します。
まずは、PowerShell でfreee への接続を行います。レプリケーションは4つのステップがあります。
まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。
次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。
その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。
- AuthScheme：OAuth に設定します。
- OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
- OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
- CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
freee のデータの取得
-
モジュールのインストール:
Install-Module APICmdlets -
freee への接続:
$api = Connect-Freee -Profile $Profile -ProfileSettings $ProfileSettings -' $' -Authscheme $Authscheme -InitiateOAuth $InitiateOAuth -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackUrl $CallbackUrl -
取得ターゲットのリソースの取得:
$data = Select-Freee -Connection $api -Table "Deals"Invoke-Freee cmdlet を使って、SQL-92 クエリを使用することもできます:
$data = Invoke-Freee -Connection $api -Query 'SELECT * FROM Deals WHERE Id = @Id' -Params @{'@Id'='1'} -
戻り値からカラム名のリストを保存します。
$columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name
freee のデータをMySQL データベースにレプリケーション
カラム名を指定できるようにして、データをMySQL データベースにレプリケーションします。
-
モジュールのインストール:
Install-Module MySQLCmdlets -
MySQL DB に、MySQL Server 名、ユーザー、パスワード、レプリケーション先のデータベース名を指定して、接続します:
$mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port -
freee、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、freee のリソース（Deals）と同じテーブル名を持っている必要があります。
$data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Deals" -Columns $columns -Values $values }
次回以降のレプリケーションをシンプルに実現
-
一度PowerShell でfreee とMySQL に接続したら、次からは1行のコマンドでレプリケーションを実施できます:
Select-Freee -Connection $api -Table "Deals" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Deals" -Columns $columns -Values $values } -
別のPowerShell モジュールで、freee を別のデータベースに複製する場合、Select-Freee cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。
$columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}
おわりに
これで、freee のデータをMySQL に複製できました。分析、BI などでfreee のデータをMySQL から使うことができるようになります。
関連コンテンツ
