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

古川えりか
古川えりか
コンテンツスペシャリスト
PowerShell のシンプルなスクリプトで、Procore のデータ をMySQL データベースにレプリケーション(複製)する方法を紹介します。

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

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

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

Procore API プロファイル設定

Procore に認証し、自分のデータに接続したり、他のユーザーが自分のデータに接続できるようにするには、OAuth 標準を使用できます。

まず、Procore にOAuth アプリケーションを登録します。Developer Account にログインし、Create New App に移動することで登録できます。アプリを登録するために必要なすべてのステップに従います。まずSandbox Manifest の新しいバージョンを作成し、Production に昇格させてProduction Credentials を取得します。OAuth アプリケーションにはclient id とclient secret が割り当てられます。

以下の接続プロパティを設定すると、接続の準備が整います:

  • AuthScheme:OAuth に設定します。
  • InitiateOAuthGETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId:アプリ設定で指定されているclient_id を設定します。
  • OAuthClientSecret:アプリ設定で指定されているclient_secret を設定します。
  • CallbackURL:アプリ設定で指定されているRedirect URI を設定します。

Procore のデータの取得

  1. モジュールのインストール:

    Install-Module APICmdlets
  2. Procore への接続:

      $api = Connect-API  -Profile $Profile -Authscheme $Authscheme -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackUrl $CallbackUrl
      
  3. 取得ターゲットのリソースの取得:

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

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

      $data = Invoke-API -Connection $api -Query 'SELECT * FROM Companies WHERE IsActive = @IsActive' -Params @{'@IsActive'='true'}
      
  4. 戻り値からカラム名のリストを保存します。

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

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

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

  1. モジュールのインストール:

    Install-Module MySQLCmdlets
  2. MySQL DB に、MySQL Server 名、ユーザー、パスワード、レプリケーション先のデータベース名を指定して、接続します:

      $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
      
  3. Procore、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、Procore のリソース(Companies)と同じテーブル名を持っている必要があります。

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

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

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

      Select-API -Connection $api -Table "Companies" | % {
        $row = $_
        $values = @()
        $columns | % {
          $col = $_
          $values += $row.$($col)
        }
        Add-MySQL -Connection $mysql -Table "Companies" -Columns $columns -Values $values
      }
      
  • 別のPowerShell モジュールで、Procore を別のデータベースに複製する場合、Select-API cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。

      $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}
      

おわりに

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

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

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

Procore に接続 お問い合わせ