Clio のデータをPowerShell でMySQL にレプリケーションする方法

古川えりか
コンテンツスペシャリスト

PowerShell のシンプルなスクリプトで、Clio のデータをMySQL データベースにレプリケーション（複製）する方法を紹介します。

CData Cmdlets for API を使えば、PowerShell からClio のデータデータにリアルタイムで連携できます。データ同期などのタスクの連携にぴったりの製品です。本記事では、PowerShell からCData Cmdlets for API およびCData Cmdlets for MySQL を使って、同期スクリプトを作成して実行します。

まずは、PowerShell でClio への接続を行います。レプリケーションは4つのステップがあります。

まず、Profile 接続プロパティをディスク上のClio プロファイルの場所に設定します（例：C:\profiles\Clio.apip）。次に、ProfileSettings 接続プロパティをClio の接続文字列に設定します（以下を参照）。

Clio API プロファイル設定

Clio はOAuth ベースの認証を使用します。

まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id（キー）とclient secret（シークレット）が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。

以下の接続プロパティを設定すると、接続できるようになります。

AuthScheme：OAuth に設定します。
InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
OAuthClientId：アプリ設定で指定されたclient_id に設定します。
OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
CallbackURL：アプリ設定で指定されたRedirect URI に設定します。
Region：ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。

Clio のデータの取得

モジュールのインストール:
```
Install-Module APICmdlets
```

Clio への接続:

  $api = Connect-API  -Profile $Profile -ProfileSettings $ProfileSettings -Authscheme $Authscheme -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackUrl $CallbackUrl

取得ターゲットのリソースの取得:

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

Invoke-API cmdlet を使って、SQL-92 クエリを使用することもできます:

  $data = Invoke-API -Connection $api -Query 'SELECT * FROM Bills WHERE State = @State' -Params @{'@State'='awaiting_payment'}

戻り値からカラム名のリストを保存します。

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

Clio のデータをMySQL データベースにレプリケーション

カラム名を指定できるようにして、データをMySQL データベースにレプリケーションします。

モジュールのインストール:
```
Install-Module MySQLCmdlets
```
MySQL DB に、MySQL Server 名、ユーザー、パスワード、レプリケーション先のデータベース名を指定して、接続します:
```
  $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  
```
Clio、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、Clio のリソース（Bills）と同じテーブル名を持っている必要があります。
```
  $data | % {
    $row = $_
    $values = @()
    $columns | % {
      $col = $_
      $values += $row.$($col)
    }
    Add-MySQL -Connection $mysql -Table "Bills" -Columns $columns -Values $values
  }
  
```

次回以降のレプリケーションをシンプルに実現

一度PowerShell でClio とMySQL に接続したら、次からは1行のコマンドでレプリケーションを実施できます:

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

別のPowerShell モジュールで、Clio を別のデータベースに複製する場合、Select-API cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。
```
  $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}
  
```

おわりに

これで、Clio のデータをMySQL に複製できました。分析、BI などでClio のデータをMySQL から使うことができるようになります。

はじめる準備はできましたか？

API Driver で Clio のライブデータに接続

Clio に接続お問い合わせ