diff --git a/singer_sdk/streams/core.py b/singer_sdk/streams/core.py index c588a9729..ed9052ae0 100644 --- a/singer_sdk/streams/core.py +++ b/singer_sdk/streams/core.py @@ -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) @@ -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)