Update Documentation of BigQuery source/sink to include the exact format of data read/written
- Dominant language
- Java
- Stars
- 8.7k
- Forks
- 4.7k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 205
Description
Currently documentation at following location simply mentions that BigQuery source/sink reads/writes dictionaries. This documentation should be updated to include examples.
https://github.com/apache/beam/blob/master/sdks/python/apache_beam/io/gcp/bigquery.py#L22
Imported from Jira [BEAM-3090](https://issues.apache.org/jira/browse/BEAM-3090). Original Jira may contain additional context.
Reported by: chamikara.
Contributor guide
Research direction
Start with the documentation near the BigQuery source/sink definitions in sdks/python/apache_beam/io/gcp/bigquery.py, especially the section linked in the issue. Inspect the surrounding source and sink behavior to determine the dictionary formats and add representative examples. Done means the documentation clearly shows the exact data read and written by both components.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- google-cloud, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100