Delete a document (TypeScript)
Finds a single document in a collection using filter and sort clauses, and then deletes that document.
This method and the method to find and delete a document have the same database effect but differ in their return value. This method returns details about the success of the deletion. The method to find and delete a document returns the document that was found and deleted.
|
Ready to write code? See the examples for this method to get started. If you are new to the Data API, check out the quickstart. |
Result
Deletes a document that matches the specified parameters and returns a promise that resolves to a CollectionDeleteOneResult object that includes details about the operation.
Example resolved response:
{ deletedCount: 1 }Parameters
Use the deleteOne method, which belongs to the Collection class.
Method signature
async deleteOne(
filter: CollectionFilter<Schema>,
options?: {
sort?: Sort,
timeout?: number | TimeoutDescriptor,
},
): CollectionDeleteOneResult| Name | Type | Summary |
|---|---|---|
|
An object that defines filter criteria using the Data API filter syntax. The method only finds documents that match the filter criteria. Filters can improve performance by reducing the number of documents that the Data API processes. You must use For a list of available filter operators and more examples, see Filter operators for collections (TypeScript). Filters can use only indexed fields. If you apply selective indexing when you create a collection, you cannot reference non-indexed fields in a filter. For an example, see Delete a document that matches a filter. |
|
|
Optional.
The options for this operation. See Properties of |
| Name | Type | Summary |
|---|---|---|
|
Optional. Sorts documents by one or more fields, or performs a vector search. You must use For more information, see Sort clauses for collections (TypeScript). Sort clauses can use only indexed fields. If you apply selective indexing when you create a collection, you cannot reference non-indexed fields in sort queries. For vector searches, this parameter can use |
|
|
|
Optional. The timeout(s) to apply to this method.
You can specify For more information about the |
Examples
The following examples demonstrate how to delete a document in a collection.
Delete a document by ID
All documents have a unique _id property. You can use a filter to find a document with a specific _id, and then delete that document.
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");
// Delete a document
(async function () {
const result = await collection.deleteOne({ _id: "101" });
console.log(result);
})();Delete a document that matches a filter
You can use a filter to find a document that matches specific criteria.
For example, you can find a document with an is_checked_out value of false and a number_of_pages value less than 300.
For a list of available filter operators and more examples, see Filter operators for collections (TypeScript).
Filters can use only indexed fields. If you apply selective indexing when you create a collection, you cannot reference non-indexed fields in a filter.
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");
// Delete a document
(async function () {
const result = await collection.deleteOne({
$and: [{ is_checked_out: false }, { number_of_pages: { $lt: 300 } }],
});
console.log(result);
})();Delete a document that is most similar to a search vector
To find the document whose $vector value is most similar to a given vector, use a sort with the vector embeddings that you want to match. For more information, see Find data with vector search.
Vector search is only available for vector-enabled collections.
For more information, see Create a collection that can store vector embeddings and $vector in collections (TypeScript).
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");
// Delete a document
(async function () {
const result = await collection.deleteOne(
{},
{ sort: { $vector: [0.08, -0.62, 0.39] } },
);
console.log(result);
})();Delete a document after applying a non-vector sort
You can use a sort clause to sort documents by one or more fields.
For more information, see Sort clauses for collections (TypeScript).
Sort clauses can use only indexed fields. If you apply selective indexing when you create a collection, you cannot reference non-indexed fields in sort queries.
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");
// Find a document
(async function () {
const result = await collection.deleteOne(
{ "metadata.language": "English" },
{
sort: {
rating: 1, // ascending
title: -1, // descending
},
},
);
console.log(result);
})();Client reference
For more information, see the client reference.
