singer_sdk.pagination.BaseAPIPaginator¶

class singer_sdk.pagination.BaseAPIPaginator[source]¶

An API paginator object.

__init__(start_value)[source]¶

Create a new paginator.

advance(response)[source]¶

Get a new page value and advance the current one.

Parameters:: response (requests.Response) – API response object.
Raises:: RuntimeError – If a loop in pagination is detected. That is, when two consecutive pagination tokens are identical.
Return type:: None

continue_if_empty(response)[source]¶

Check if pagination should continue even if the response is empty.

Override this method to keep the pagination going even if the page retrieved from the API is empty but the next one may have records.

abstractmethod get_next(response)[source]¶

Get the next pagination token or index from the API response.

Parameters:

response (requests.Response) – API response object.

Returns:

The next page token or index. Return None from this method to indicate: the end of pagination.

Return type:

TPageToken | None

has_more(response)[source]¶

Override this method to check if the endpoint has any pages left.

property count: int[source]¶

Count the number of pages traversed so far.

property current_value: TPageToken[source]¶

Get the current pagination value.

property finished: bool[source]¶

Get a flag that indicates if the last page of data has been reached.