Delete - Upstash Documentation

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

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

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

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

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

string[] | number[] | string | number

required

One or more document IDs to delete.

object

required

Hide child attributes

string[] | number[] | string | number

One or more document IDs to delete.

string

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

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

number

required

The number of documents that were successfully deleted.

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

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

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

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

​Arguments

​Response

Arguments

Response