Delete - Upstash Documentation

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

IDsstring[] | number[] | string | numberrequired

One or more document IDs to delete.

DeletePayloadobjectrequired

idsstring[] | number[] | string | number

One or more document IDs to delete.

prefixstring

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

filterstring

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

ResponseDeleteResultrequired

deletednumberrequired

The number of documents that were successfully deleted.

Delete by IDs Array

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

Delete Single ID

const response = await index.delete("star-wars");// { deleted: 1 }

Delete by Prefix

const response = await index.delete({  prefix: "star-",});// { deleted: 3 }

Delete with Filter

const response = await index.delete({  filter: "age > 30",});// { deleted: 3 }