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.

Sign up for GitHub

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: Document that get_starting_timestamp requires setting a non-null replication_key #2557

Merged
merged 3 commits into from
Jul 20, 2024
Merged

docs: Document that get_starting_timestamp requires setting a non-null replication_key #2557

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd94335
docs: Document that `get_starting_timestamp` requires setting a non-n…
edgarrmondragon Jul 20, 2024
b7e50ca
Use `note` admonition
edgarrmondragon Jul 20, 2024
66c8046
Reference as attribute
edgarrmondragon Jul 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions singer_sdk/streams/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,11 @@ def get_starting_replication_key_value(

Returns:
Starting replication value.

.. note::

This method requires :attr:`~singer_sdk.Stream.replication_key` to be set
to a non-null value, indicating the stream should be synced incrementally.
"""
state = self.get_context_state(context)

Expand Down Expand Up @@ -280,6 +285,11 @@ def get_starting_timestamp(

Raises:
ValueError: If the replication value is not a valid timestamp.

.. note::

This method requires :attr:`~singer_sdk.Stream.replication_key` to be set
to a non-null value, indicating the stream should be synced incrementally.
"""
value = self.get_starting_replication_key_value(context)

Expand Down
Loading