apache / apache/iceberg

Docs: Clarify Spark branch write precedence over WAP branch

Open Beginner friendly
#15,916 5 comments 0 reactions 0 assignees View on GitHub
docs good first issue improvement
Dominant language
Java
Stars
9.2k
Forks
3.5k
Avg merge
2d 11h
Merged PRs (30d)
132

Description

### Feature Request / Improvement

After https://github.com/apache/iceberg/pull/15288, [Spark Writing to Branches doc](https://iceberg.apache.org/docs/nightly/spark-writes/#writing-to-branches) (`docs/docs/spark-writes.md`) no longer matches that in codes.

```
*

The target branch can be specified via table identifier, write option, or in SQL:
*
*


    *
  • The identifier and option branches can't conflict. If both are set, they must match.
    *
  • Identifier and option branches take priority over the session WAP branch.
    *
  • If neither the option nor the identifier branch is set and WAP is enabled for this table,
    * use the WAP branch from the session SQL config.
    *

*
*

Note: WAP ID and WAP branch cannot be set at the same time.
*
*

Note: The target branch may be created during the write operation if it does not exist.
```

### Query engine

Spark

### Willingness to contribute

- [ ] I can contribute this improvement/feature independently
- [ ] I would be willing to contribute this improvement/feature with guidance from the Iceberg community
- [ ] I cannot contribute this improvement/feature at this time

Contributor guide

Open the contributing guide

Research direction

Start with the Writing to Branches section in docs/docs/spark-writes.md and compare it with the precedence described in the issue. Update the documentation so identifier and write-option branches are documented as taking priority over the session WAP branch, and ensure the listed fallback behavior matches the referenced code.

Written by the indexing model from the issue text.

Assessment

Tech stack
spark
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.