Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs]: Add usage example of Stream.get_starting_timesamp() #1372

Closed
edgarrmondragon opened this issue Jan 31, 2023 · 2 comments · Fixed by #1390
Closed

[Docs]: Add usage example of Stream.get_starting_timesamp() #1372

edgarrmondragon opened this issue Jan 31, 2023 · 2 comments · Fixed by #1390
Labels
Accepting Pull Requests Documentation Improvements or additions to documentation valuestream/SDK

Comments

@edgarrmondragon
Copy link
Collaborator

Documentation type

How-to guides

Description

https://meltano.slack.com/archives/C01PKLU5D1R/p1675116342431159?thread_ts=1674850558.848759&cid=C01PKLU5D1R

I think a bit more documentation in the Meltano Singer SDK would be a great improvement to the user experience. I think either sometime in the SDK Code Samples with example of an implementation of get_starting_timesamp() or a dedicated section similar to Parent-Child Streams would be awesome.

@edgarrmondragon edgarrmondragon added Documentation Improvements or additions to documentation valuestream/SDK labels Jan 31, 2023
@flexponsive
Copy link
Contributor

I just worked with get_starting_replication_key_value() and would be happy to contribute a section to the docs like the parent-child streams example.

Topics I would include based on my experience:

  • how to register the replication method and key in the stream
  • using starting key/timestamp to adapt the query in a REST tap
  • how create a state.json file for testing the tap and manually run an incremental replication

(From my project, here is an example of get_starting_replication_key_value() in action)

@edgarrmondragon
Copy link
Collaborator Author

Hey @flexponsive! We'd welcome your contribution, let me know if you have any questions and https://sdk.meltano.com/en/latest/CONTRIBUTING.html should help you get started 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepting Pull Requests Documentation Improvements or additions to documentation valuestream/SDK
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants