Skip to content

Commit

Permalink
docs: Document that get_starting_timestamp requires setting a non-n…
Browse files Browse the repository at this point in the history
…ull replication_key (#2557)

* docs: Document that `get_starting_timestamp` requires setting a non-null replication_key

* Use `note` admonition

* Reference as attribute
  • Loading branch information
edgarrmondragon authored Jul 20, 2024
1 parent 4ace75a commit 9c97d4a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions singer_sdk/streams/core.py
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

0 comments on commit 9c97d4a

Please sign in to comment.