microsoft / microsoft/PowerPlatform-DataverseClient-Python
tables.update_column / update_columns: update existing column constraints (retrieve -> PUT + @odata.type) -- no metadata-write path exists today
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 60
- Forks
- 23
- Avg merge
- 13h 53m
- Merged PRs (30d)
- 3
Description
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-PUTwith@odata.type); reuse_odata_base.py::_attribute_payloadoverride-building from #194.operations/tables.py+aio/operations/async_tables.py-- newupdate_column/update_columns.- Unit tests: override application + correct verb /
@odata.typeon the outbound request. - README + CHANGELOG per repo maintenance rules.
Acceptance
update_column(..., {"max_length": 4000})issues aPUTtoEntityDefinitions({id})/Attributes({id})withMaxLength: 4000and 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with data/_odata.py and _odata_base.py::_attribute_payload, then inspect the table operations in operations/tables.py and aio/operations/async_tables.py. Verify the override application and outbound PUT request in unit tests, including the derived @odata.type; update the README and CHANGELOG as required. Confirm the implementation shares the override schema from #194 and keeps the verb and discriminator internal.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100