apache/iceberg

Docs: Clarify Spark branch write precedence over WAP branch

Open

#15 916 ouverte le 9 avr. 2026

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Java (5 146 stars) (1 915 forks)batch import
docsgood first issueimprovement

Description

Feature Request / Improvement

After https://github.com/apache/iceberg/pull/15288, Spark Writing to Branches doc (docs/docs/spark-writes.md) no longer matches that in codes.

   * <p>The target branch can be specified via table identifier, write option, or in SQL:
   *
   * <ul>
   *   <li>The identifier and option branches can't conflict. If both are set, they must match.
   *   <li>Identifier and option branches take priority over the session WAP branch.
   *   <li>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.
   * </ul>
   *
   * <p>Note: WAP ID and WAP branch cannot be set at the same time.
   *
   * <p>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

Guide contributeur

Stack technique
java
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Review linked PR #15288 for contextUnderstand current branch precedence logic
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
Start by reading the current documentation at docs/docs/spark writes.md and compare it with the code comments, especially those updated in PR #15288. The key point is that identifier and option branches take priority over the WAP branch. Identify where the documentation diverges and rewrite the relevant section to match the code. Ensure the updated doc explains the precedence clearly and concisely.