apache / apache/beam

BigQueryIO WRITE_TRUNCATE documentation is out of date

Open
#18,977 0 comments 0 reactions 0 assignees View on GitHub
core gcp improvement io java P3 python
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
1d 20h
Merged PRs (30d)
196

Description

Apache Beam 2.5 documentation ([https://beam.apache.org/documentation/sdks/javadoc/2.5.0/](https://beam.apache.org/documentation/sdks/javadoc/2.5.0/)), states that
 
"WRITE_TRUNCATE
public static final BigQueryIO.Write.WriteDisposition WRITE_TRUNCATE
Specifies that write should replace a table.
The replacement *may occur in multiple steps* - for instance by first removing the existing table, then creating a replacement, then filling it in. *This is not an atomic operation*, and external programs may see the table in any of these intermediate steps."
 
However WRITE_TRUNCATE is an atomic BigQuery operation. The documentation needs to be updated.

Imported from Jira [BEAM-4789](https://issues.apache.org/jira/browse/BEAM-4789). Original Jira may contain additional context.
Reported by: altay.

Contributor guide

Open the contributing guide

Research direction

Start with the Apache Beam 2.5 Javadoc entry for BigQueryIO.Write.WriteDisposition and inspect the WRITE_TRUNCATE documentation. Update the statement that replacement may occur in multiple steps so it reflects atomic BigQuery behavior, then verify the Javadoc contains the corrected wording.

Written by the indexing model from the issue text.

Assessment

Tech stack
google-cloud, java
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.