Upstash Documentation

Range

2 min read

Range Command for Python SDK#

The range method is used to retrieve documents in chunks with pagination.

Arguments#

Payloaddictrequired#
Show properties
cursorstringrequired#

The cursor to the last retrieved document. Should be set to "" in the initial range request.

limitintrequired#

The number of maximum documents wanted in the response of range. (page size)

Response#

Responsedictrequired#
Show properties
DocumentsList[Document]required#

This field is null if no document with the specified ID is found.

Show properties
idstring | numberrequired#

The ID of the resulting document.

contentRecord<string, unknown>#

The main content of the document.

metadataRecord<string, unknown>#

Additional metadata for the document.

next_cursorstring#

The cursor for the next page of documents.