Zhuoxi2000 opened a new pull request, #3647:
URL: https://github.com/apache/iceberg-python/pull/3647
Closes #1008
# Rationale for this change
#1008 asks for the write documentation to describe each operation and API
mode "explicitly in detail as separate subsections". The current "Write to
a table" section is a single narrative: delete is buried mid-flow, the
Transaction API is never mentioned for writes, and several parameters
(`branch`, `snapshot_properties`, `case_sensitive`) are undocumented.
# What changes are included in this PR?
- New subsection **"Write API modes: `Table` and `Transaction`"** — documents
that every Table-API write is a single-operation transaction, and shows
multi-operation atomic commits (`delete` + `append` in one snapshot chain,
schema evolution + write in one commit).
- Explicit subsections per operation: **Append**, **Overwrite** (full +
partial), **Dynamic partition overwrite** (split out of "Partial
overwrites"), **Delete** (new — previously inline prose), **Upsert**
(unchanged).
- Pads missing details: the `snapshot_properties` / `branch` kwargs accepted
by every write, `case_sensitive` on filtered operations, the
DELETE/OVERWRITE/APPEND snapshots an overwrite/delete may produce, the
"did not match any records" warning, and the copy-on-write fallback when
`write.delete.mode=merge-on-read`.
No code changes; prose and structure only. Existing anchors are preserved
("Partial overwrites" survives as an h4; "Streaming writes from a
`RecordBatchReader`" untouched).
# Are these changes tested?
`markdownlint` (repo config) passes. Internal anchors verified against the
generated heading ids.
# Are there any user-facing changes?
Docs only.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
