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

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

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

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

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

ClickUp API プロファイル設定

ClickUp に認証するには、API キーを提供する必要があります。このトークンは、ユーザー設定のApps セクションで確認できます。ページ上部にパーソナルトークンを生成するオプションがあります。ProfileSettings プロパティにAPI Key をパーソナルトークンに設定して接続します。

ClickUp のデータの取得

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

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

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

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

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

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

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

ClickUp のデータを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. ClickUp、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、ClickUp のリソース(Tasks)と同じテーブル名を持っている必要があります。

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

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

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

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

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

おわりに

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

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

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

ClickUp に接続 お問い合わせ