From cd94335777ba5d65532d1e28703049af7fb31483 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20Ram=C3=ADrez-Mondrag=C3=B3n?= Date: Fri, 19 Jul 2024 18:21:07 -0600 Subject: [PATCH] docs: Document that `get_starting_timestamp` requires setting a non-null replication_key --- singer_sdk/streams/core.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/singer_sdk/streams/core.py b/singer_sdk/streams/core.py index c588a9729..9dd394a5d 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. + + .. warning:: + + This method requires :meth:`~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. + + .. warning:: + + This method requires :meth:`~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)