tables.update_column / update_columns: update existing column constraints (retrieve -> PUT + @odata.type) -- no metadata-write path exists today

オープン
#202 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
68/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
api, backend

調査の方向性

data/_odata.py と _odata_base.py::_attribute_payload から始め、続いて operations/tables.py と aio/operations/async_tables.py のテーブル操作を調査します。派生した @odata.type を含め、override の適用と送信される PUT リクエストをユニットテストで検証します。必要に応じて README と CHANGELOG を更新します。実装が #194 の override スキーマを共有し、verb と discriminator を内部に保持していることを確認します。

索引モデルが issue の本文から書いたものです。

説明

enhancement

Summary

client.tables can create, add_columns, and remove_columns, but there is no way to update an existing column's definition -- MaxLength, MinValue/MaxValue, RequiredLevel, DisplayName, Format, etc. Today a caller who needs to widen a text column or change a required level must drop to the raw Web API PUT EntityDefinitions({id})/Attributes({id}) and hand-build the payload, including the derived @odata.type discriminator.

This is also the only place the counter-intuitive PUT-not-PATCH metadata-update contract is exposed to users. Metadata updates go over PUT with merge semantics (partial payloads are honored), which reads like PATCH behavior on the PUT verb. The right fix is not a platform verb change (that is a long pole) -- it is to hide the verb inside the SDK so users never choose it.

Context: parity with the .NET modern client

Microsoft.PowerPlatform.Dataverse.Client.ServiceClient never hits this, because it rides the Organization Service message contracts (Execute(new UpdateAttributeRequest { Attribute = new StringAttributeMetadata { MaxLength = 4000 } })) -- a typed message, no HTTP verb. The Python SDK is Web-API-bound and cannot borrow those contracts, so it should own the retrieve -> modify -> PUT (+ @odata.type) sequence internally to give the same UX (typed fields in, no verb visible).

Proposed change (backward-compatible)

Add update_column (+ update_columns) that accepts the same dict override schema proposed in #194, so create and update share one spec shape:

client.tables.update_column("cfb_CustomerFeedback", "cfb_Comment",
                            {"max_length": 4000, "display_name": "Customer Comment"})

Internally: GET the existing typed attribute -> apply overrides -> PUT back with the correct derived @odata.type. Never expose PUT/PATCH/@odata.type to the caller.

Touchpoints

  • data/_odata.py -- new _update_attribute (retrieve-then-PUT with @odata.type); reuse _odata_base.py::_attribute_payload override-building from #194.
  • operations/tables.py + aio/operations/async_tables.py -- new update_column / update_columns.
  • Unit tests: override application + correct verb / @odata.type on the outbound request.
  • README + CHANGELOG per repo maintenance rules.

Acceptance

  • update_column(..., {"max_length": 4000}) issues a PUT to EntityDefinitions({id})/Attributes({id}) with MaxLength: 4000 and the correct derived @odata.type.
  • Caller never passes a verb or @odata.type.
  • Depends on / shares the override-spec schema from #194.

Related

  • #194 -- create-time column constraints (in progress).
  • microsoft/Dataverse-skills#119 -- documents the raw Web API metadata contract this method replaces.
主要言語
Python
スター
60
フォーク
23
平均マージ
13時間 53分
マージ済み PR(30日)
3

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

microsoft/PowerPlatform-DataverseClient-Python のほかの issue

microsoft/PowerPlatform-DataverseClient-Python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。