[PowerApps]CDSのプライマリ名フィールドとキーについて

こんにちは。sinyです。

この記事ではPowerAppsのCommon Data Service(2020/8時点ではDataFlexと呼ぶ）におけるエンティティの標準フィールド、プライマリー名フィールド、キーの仕組みについてまとめてみました。

CDSのエンティティで自動生成されるフィールドについて

CDSでエンティティを作成すると自動的に生成されるフィールドがあります。

エンティティを作成した後に「種類」タブでソートすると確認しやすいです。

例えば、以下のようなエンティティを登録するとします。

種類タブで並び替えると以下の様に「カスタムと標準」があることがわかります。
「カスタム」は自分で定義したフィールドで、「標準」がCDSが自動的に生成してくれるフィールドです。

標準＆必須で生成されるフィールド

CDSが自動的に生成するフィールドはたくさんありますが、その中で表示名を除いて設定変更も削除もできないフィールドが３つあります。

これらはCDSで標準で実装される＆設定変更できないフィールドのようです。

3つ目の一意識別子フィールドはエンティティ登録時の一番上の「表示名」に指定した名称で自動的にエンティティのレコードを一意に特定するためのキーフィールドが生成されます。

もう１つ標準で生成されるフィールドが１つあります。
それがプライマリー名フィールドです。

プライマリー名フィールドは必須として自動生成されますが、データ型と必須の設定は後から変更できます。

プライマリフィールドはキーではない

既に説明した通りエンティティを作成するとプライマリーフィールドというフィールドが生成されます。

名前だけ見るとこれがエンティティのレコードを一意に識別するためのキーフィールド(いわゆる主キーにあたるもの）のように思ってしまいますがそうではないようです。

以下の記事が大変参考になりましたが、プライマリーフィールドはキーではなく他のエンティティとの関係を確立する際の検索処理に使用されるもののようです。

IT長のネタ帳

 

1 Pocket

CDSのエンティティのキーを設定する | IT長のネタ帳

https://www.d3654.be/cds-entity-key-setting/

CDSのエンティティのキーについて色々と調査・検証してみました。結論を3行で書くと、 ・プライマリフィールドは（そのままでは）キーではない。 ・カスタムエンティティ作成時に自動で作成される、データ型＝「一意識別子」の項目がデフォルトのキーである。 ・それとは別に、一つないし複数の項目をキーとして定義できる。 前提条件 ・CDSのカスタムエンティティを作成できる環境（こちらの記事を参照） 詳細手順

エンティティの個別のキーを設定する