Source design pattern: option to retain metadata
- Dominant language
- Java
- Stars
- 8.7k
- Forks
- 4.7k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 196
Description
* FileBasedSource: user may want to know original path, directory, line number, byte offset, etc.
* PubSubIO: user may want to know things about the originating message (such as metadata attributes), not just they payload. BEAM-53
* etc.
We should have a standard pattern for this that provides a good guideline for implementing sources.
Imported from Jira [BEAM-72](https://issues.apache.org/jira/browse/BEAM-72). Original Jira may contain additional context.
Reported by: dhalperi.
Contributor guide
Research direction
Start by comparing the FileBasedSource and PubSubIO source entry points, including the metadata examples described in BEAM-53 and the linked BEAM-72 context. Define what a standard source metadata pattern should cover and document the guideline for retaining file or message metadata; done means the pattern is agreed and clearly specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend-api-design, data-engineering, distributed-systems
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100