Range - Upstash Documentation

const responseRange = await index.range({
  cursor: "0",
  limit: 2,
});

/*
{
  nextCursor: '2',
  documents: [
    { id: "doc1", content: { ... }, metadata: { ... } },
    { id: "doc2", content: { ... }, metadata: { ... } }
  ]
}
*/

const responseRange = await index.range({
  cursor: "0",
  limit: 2,
  prefix: "test-",
});

/*
{
  nextCursor: '2',
  documents: [
    { id: "test-1", content: { ... }, metadata: { ... } },
    { id: "test-2", content: { ... }, metadata: { ... } }
  ]
}
*/

The range method is used to retrieve documents in chunks with pagination. This method supports a variety of options to configure the query to your needs.

The range command is stateless, meaning you need to pass all of the parameters in each subsequent request.

Arguments

string

required

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

string

A string prefix to match document IDs. All documents with IDs that start with this prefix will be retrieved.

number

required

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

Response

Object

required

Hide child attributes

string

The cursor for the next set of documents. When it becomes "", it means all documents were retrieved.

Document[]

The list of documents retrieved in this range.

const responseRange = await index.range({
  cursor: "0",
  limit: 2,
});

/*
{
  nextCursor: '2',
  documents: [
    { id: "doc1", content: { ... }, metadata: { ... } },
    { id: "doc2", content: { ... }, metadata: { ... } }
  ]
}
*/

const responseRange = await index.range({
  cursor: "0",
  limit: 2,
  prefix: "test-",
});

/*
{
  nextCursor: '2',
  documents: [
    { id: "test-1", content: { ... }, metadata: { ... } },
    { id: "test-2", content: { ... }, metadata: { ... } }
  ]
}
*/

Delete Reset

⌘I

​Arguments

​Response

Arguments

Response