DataverseのテーブルをSQL検索して、データを取得する方法

こんなお悩みはございませんか？

Dataverseのデータを抽出するのにSQLを利用したい

Dataverseの大量にあるデータを抽出したい

Dataverseのデータを一括して更新したい

簡単に解決できます！

XrmToolBox というオープンソースのツールを利用することで上記悩みを解決できます。
XrmToolBox のプラグインである「SQL 4 CDS」を使うと、SQL文を書いてデータを検索したり、レコードを編集することができます。
データの検索自体は Dataverse のテーブルの列フィルター機能を使って取得できますが、 SQL文に慣れている人や大量にデータを抽出する必要がある際は「SQL 4 CDS」を使うととても便利です。
では、XrmToolBox の「SQL 4 CDS」を利用方法について、具体的にご紹介していきますね。

1. 事前準備​

1-1. XrmToolBox をインストールする​

公式サイト (https://www.xrmtoolbox.com/) からダウンロードし、ローカルPCにインストールします。

ダウンロードが完了したらzipファイルを展開します。

1-2. XrmToolBox を起動する​

XrmToolBox.exe ファイルをダブルクリックして XrmToolBox を起動します。​​

「Connect」ボタンを押下します。​​

1-3. Dataverse 環境に接続する​​

「New」ボタンを押下します。 ​​​

「Connection Wizard」ボタンを押下します 。​​​

「Environment url」に接続したいPower Apps環境のURLを入力します。​​​​

※環境URLは以下で確認できます。​
Power Platform 管理センター → 環境 → 環境URL

「Username」と「Password」を入力します ​​​​。

接続自体は成功しました。​​​​

「Name」に接続情報の名前等（今回は “test” ）を入力して、「Finish」ボタンを押下するとダイアログが閉じます。​​​​

「Connect」ボタンを押下後、“test” を押下します。​​​​

Dataverse 環境に接続できました。​​​​

「Open Tool Library」を押下します。​​​​

1-4. プラグインをインストールする​​

Tool Library タブが開きます。​​​​

「Search」枠に ”SQL” と入力すると、いくつかプラグインの候補が出ます。​​​​

「SQL 4 CDS」にチェックを入れて、「Install」ボタンを押下します。​​​​

プラグインのインストールが成功しました。​​​​

1-5. SQL 4 CDS を起動する​​

Tools タブに戻り、「SQL 4 CDS」を押下します。​​​​

「SQL 4 CDS」が起動しました。​​​​

2. Dateverseにデータを作成​

2-1. Dateverseにテーブル作成する

Dataverseにテーブルを作成します。（今回は届出テーブルを作成します） ​​​​

2-2. テーブルに列を作成する

届出テーブルに、届出年月日と備考のカラムを作成します。​​​​

2-3. テーブルにデータを投入する

届出テーブルに、データを投入します。（今回はサンプルとして10件投入します）​​

3. テスト​

3-1. SQL文を作成する

1-5. で起動したSQLエディタにSQL文を入力します。​​​​

■SQL文の意味 ​​​​

届出テーブルから、届出年月日が 2025/02/06 以降の「届出年月日」と「備考」のデータを取得します。 ​​​​

■補足 ​​​​

・テーブル名、カラム名等の記載は、Dataverseに設定したカラムの論理名を記載してください。 ​​​​

・例えば ”crf6e_todokede_ymd” を入力中、文字補完してくれるため論理名を覚えていなくても大丈夫です。 ​​​​

■その他​​​​

・今回はSELECT文の例ですが、UPDATE文を使えば一括でデータを変更できます。 ​​​​

・複数行のINSERT文で複数件のデータ追加可能で、DELETE文で一括削除も可能です。 ​​​​

・SQL文はSQLファイルとして保存でき、随時呼び出すことができます。 ​​​​

3-2. SQL文を実行する

「Execute」ボタンを押下すると、Resultsに抽出結果が表示されます。​​​​

取得結果のResultsの部分を右クリックすると、CSVやEXCELに出力結果を保存できて便利です。​​​​

まとめ

いかかだったでしょうか？​​​​

XrmToolBox のプラグインである「SQL 4 CDS」を使うと、SQL文を書いてデータを検索することができました。 ​​​​

SQL文に慣れている人や大量にデータを抽出する必要がある際はとても便利です。 ​​​​

但し、あまりに大量のデータを抽出する場合、高負荷によるタイムアウトが発生する可能性があります。 ​​​​

その際はSQL文の抽出条件を追加するなど行い、取得件数を減らして、複数回に分けてSQLを実行してください。 ​​​​

最後までご精読いただき、ありがとうございました。 ​​​​