Find and delete a document (HTTP)
|
For details about additional languages, see: |
Finds a single document in a collection using filter and sort clauses, and then deletes that document.
This method and the method to delete a document have the same database effect but differ in their return value. This method returns the document that was found and deleted. The method to delete a document returns details about the success of the deletion.
|
Ready to write code? See the examples for this method to get started. |
Result
Deletes a document that matches the specified parameters, and returns a dictionary representation of the document.
If no document was found, returns null instead of a dictionary representation of the document.
The fields included in the returned document depend on the projection specified in the method.
The response also includes details about the operation, such as the number of documents that were deleted.
Example response:
{
"data": {
"document": {
"_id":"101",
"name":"John Doe"
}
},
"status":{
"deletedCount": 1
}
}Example response if no document was found:
{
"data":{
"document":null
},
"status":{
"deletedCount": 0
}
}Signature
Use the findOneAndDelete command.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndDelete": {
"filter": FILTER,
"sort": SORT,
"projection": PROJECTION
}
}'Parameters
| 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 (HTTP). 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. Sorts documents by one or more fields, or performs a vector search. You must use For more information, see Sort clauses for collections (HTTP). 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 either |
|
|
Optional. Controls which fields are included or excluded in the returned document. You must use For more information, see Projections for collections (HTTP). Default: The default projection for the collection.
All fields prefixed with For examples, see Include only specific fields in the response and Exclude specific fields from the response. |
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.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndDelete": {
"filter": {
"_id": "101"
}
}
}'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 (HTTP).
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.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndDelete": {
"filter": {"$and": [
{"is_checked_out": false},
{"number_of_pages": {"$lt": 300}}
]}
}
}'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 (HTTP).
You can provide the search vector as an array of floats, or you can use $binary to provide the search vector as a Base64-encoded string.
$binary can be more performant.
For more information about how to convert an array of floats to a Base64-encoded string, see Binary encoding of vector embeddings.
- Array of floats
-
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \ --header "Token: APPLICATION_TOKEN" \ --header "Content-Type: application/json" \ --data '{ "findOneAndDelete": { "filter": {}, "sort": { "$vector": [0.08, -0.62, 0.39] } } }' - $binary
-
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \ --header "Token: APPLICATION_TOKEN" \ --header "Content-Type: application/json" \ --data '{ "findOneAndDelete": { "filter": {}, "sort": { "$vector": {"$binary": "PaPXCr8euFI+x64U"} } } }'
Delete a document that is most similar to a search string
To find the document whose $vector value is most similar to the $vector value of a given search string, use a sort with the search string that you want to vectorize and match. For more information, see Find data with vector search.
Vector search with vectorize is only available for collections that have vectorize enabled.
For more information, see Create a collection that can automatically generate vector embeddings and $vectorize in collections (HTTP).
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndDelete": {
"filter": {},
"sort": { "$vectorize": "Text to vectorize" }
}
}'Delete a document based on lexicographical matching
There are two ways to use lexicographical matching to find documents with the Data API:
-
Sort on the
$lexicalfield to find the documents whose$lexicalfield value is most relevant to a given string of space-separated keywords or terms -
Filter on the
$lexicalfield with the$matchoperator to find the documents whose$lexicalfield value is a lexicographical match to the specified string of space-separated keywords or terms
You can use these strategies together or separately.
You can only use lexicographical matching on collections that have lexical enabled. For more information, see Create a collection that supports lexicographical matching.
Documents must have the $lexical field populated to be included in lexicographical matching.
For examples, see Insert a document for retrieval with lexicographical matching and Insert documents for retrieval with lexicographical matching.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndDelete": {
"filter": {"$lexical": {"$match": "tree hill"}},
"sort": { "$lexical": "tree hill grassy" }
}
}'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 (HTTP).
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.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndDelete": {
"filter": { "metadata.language": "English" },
"sort": {
"rating": 1,
"title": -1
}
}
}'Include only specific fields in the response
To specify which fields to include or exclude in the returned document, use a projection.
All fields prefixed with $ are excluded by default and will only be returned if you include them in the projection.
_id is included by default and will always be returned unless you exclude it from the projection.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndDelete": {
"filter": {"metadata.language": "English"},
"projection": {"is_checked_out": true, "title": true}
}
}'Exclude specific fields from the response
To specify which fields to include or exclude in the returned document, use a projection.
All fields prefixed with $ are excluded by default and will only be returned if you include them in the projection.
_id is included by default and will always be returned unless you exclude it from the projection.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndDelete": {
"filter": {"metadata.language": "English"},
"projection": {"is_checked_out": false, "title": false}
}
}'