Delete - Upstash Documentation

const response = await index.delete(["star-wars", "inception"]);
// { deleted: 2 }

const response = await index.delete(["star-wars", "inception"]);
// { deleted: 2 }

The delete method allows you to delete documents from your index using various criteria. You can delete documents by their IDs, by ID prefix or with metadata filter.

Arguments

IDs

string[] | number[] | string | number

required

One or more document IDs to delete.

DeletePayload

object

required

Hide child attributes

ids

string[] | number[] | string | number

One or more document IDs to delete.

prefix

string

A string prefix to match document IDs for deletion. All documents with IDs starting with this prefix will be deleted.

filter

string

A filter to delete documents based on content fields.

Deleting document with filter is a O(N) operation that performs a full scan. Therefore, it might be slow for large indexes.

Response

DeleteResult

required

Hide child attributes

deleted

number

required

The number of documents that were successfully deleted.

const response = await index.delete(["star-wars", "inception"]);
// { deleted: 2 }

Fetch Range

​Arguments

​Response

Arguments

Response