Find and update a document
Finds a single document in a collection using filter and sort clauses, and then updates properties in that document. Optionally, if no document matches the filter, inserts a new document.
This method and the method to update a document have the same database effect but differ in their return value. This method returns the document that was found and updated. The method to update a document returns details about the success of the update.
Method signature
-
Python
-
TypeScript
-
Java
-
curl
collection.find_one_and_update(
filter: Dict[str, Any],
update: Dict[str, Any],
*,
projection: Iterable[str] | Dict[str, bool],
sort: Dict[str, Any],
upsert: bool,
return_document: str,
max_time_ms: int,
) -> Dict[str, Any]
collection.findOneAndUpdate(
filter: Filter<Schema>,
update: UpdateFilter<Schema>,
options?: {
returnDocument?: 'before' | 'after',
upsert?: boolean,
sort?: Sort,
projection?: Projection,
includeResultMetadata?: boolean,
maxTimeMS?: number,
},
): Promise<ModifyResult<Schema>>
Optional<T> findOneAndUpdate(
Filter filter,
Update update
)
Optional<T> findOneAndUpdate(
Filter filter,
Update update,
FindOneAndUpdateOptions options
)
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/COLLECTION_NAME" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": FILTER,
"update": UPDATE,
"sort": SORT,
"projection": PROJECTION,
"options": {
"upsert": BOOLEAN,
"returnDocument": RETURN_DOCUMENT_DIRECTIVE
}
}
}'
Result
-
Python
-
TypeScript
-
Java
-
curl
Updates a document that matches the specified parameters, and returns a dictionary representation of the document.
If no document was found, returns None
.
The method parameters control whether the returned document reflects the original or updated values.
The fields included in the returned document depend on the projection specified in the method.
If an upsert is requested, the method inserts a new document if no document matches the filter.
Example response:
{'_id': 101, 'name': 'John Doe'}
Updates a document that matches the specified parameters, and returns a promise that resolves to the document (WithId<Schema>
).
If no document was found, returns returns a promise that resolves to null
.
The method parameters control whether the returned document reflects the original or updated values.
The fields included in the returned document depend on the projection specified in the method.
If an upsert is requested, the method inserts a new document if no document matches the filter.
Example resolved response:
{_id: 101, name: 'John Doe'}
Updates a document that matches the specified parameters, and returns the document (Optional<T>
).
If no document was found, returns returns Optional.empty()
.
The method parameters control whether the returned document reflects the original or updated values.
The fields included in the returned document depend on the projection specified in the method.
If an upsert is requested, the method inserts a new document if no document matches the filter.
Updates 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 method parameters control whether the returned document reflects the original or updated values.
The fields included in the returned document depend on the projection specified in the method.
The response also includes details about the success of the operation, such as the number of documents that were modified.
If an upsert is requested, the method inserts a new document if no document matches the filter.
Example response:
{
"data": {
"document": {
"_id":"101",
"name":"John Doe"
}
},
"status":{
"matchedCount":1,
"modifiedCount":1
}
}
Example response if no document was found:
{
"data":{
"document":null
},
"status":{
"matchedCount":0,
"modifiedCount":0
}
}
Example response if a new document was inserted:
{
"data":{
"document":null
},
"status":{
"upsertedId":"7d690267-28f5-47e8-a902-6728f587e84e",
"matchedCount":0,
"modifiedCount":0
}
}
Parameters
-
Python
-
TypeScript
-
Java
-
curl
Name | Type | Summary |
---|---|---|
|
|
An object that defines filter criteria using the Data API filter syntax. The method only finds documents that match this filter criteria. For a list of available filter operators and more examples, see Data API operators. Filters can use only indexed fields. If you apply selective indexing when you create a collection, you can’t reference non-indexed fields in a filter. |
|
|
An object that defines the updates using Data API operators. For a list of available operators and more examples, see Data API operators. |
|
|
Optional. Controls which fields are included or excluded in the returned document. For more information, see Projection operations. Default: The default projection for the collection.
Certain fields, like |
|
|
Optional. Sorts documents by one or more fields, or performs a vector search. For more information, see Sort clauses. Sort clauses can use only indexed fields. If you apply selective indexing when you create a collection, you can’t reference non-indexed fields in sort queries. |
|
|
Optional. Whether a new document should be inserted if no document matches the filter criteria. Default: False |
|
|
Optional. Controls whether the response reflects the document before or after the update. Can be one of:
Default: |
|
|
Optional. The maximum time, in milliseconds, that the client should wait for the underlying HTTP request. Default: The default value for the collection. This default is 30 seconds unless you specified a different default when you initialized the |
Name | Type | Summary |
---|---|---|
|
An object that defines filter criteria using the Data API filter syntax. The method only finds documents that match this filter criteria. For a list of available filter operators and more examples, see Data API operators. Filters can use only indexed fields. If you apply selective indexing when you create a collection, you can’t reference non-indexed fields in a filter. |
|
|
An object that defines the updates using Data API operators. For a list of available operators and more examples, see Data API operators. |
|
|
Optional.
The options for this operation. See the |
Name | Type | Summary |
---|---|---|
|
Optional. Controls whether the response reflects the document before or after the update. Can be one of:
Default: |
|
|
Optional. Whether a new document should be inserted if no document matches the filter criteria. Default: False |
|
Optional. Controls which fields are included or excluded in the returned document. For more information, see Projection operations. Default: The default projection for the collection.
Certain fields, like |
||
Optional. Sorts documents by one or more fields, or performs a vector search. For more information, see Sort clauses. Sort clauses can use only indexed fields. If you apply selective indexing when you create a collection, you can’t reference non-indexed fields in sort queries. For vector searches, this parameter can use either |
||
|
Whether to include details about the success of the operation in the response. Default: False |
|
|
Optional. The maximum time, in milliseconds, that the client should wait for the underlying HTTP request. Default: The default value for the collection. This default is 30 seconds unless you specified a different default when you initialized the |
Name | Type | Summary |
---|---|---|
|
An object that defines filter criteria using the Data API filter syntax. The method only finds documents that match this filter criteria. For a list of available filter operators and more examples, see Data API operators. Filters can use only indexed fields. If you apply selective indexing when you create a collection, you can’t reference non-indexed fields in a filter. |
|
|
An object that defines the updates using Data API operators. For a list of available operators and more examples, see Data API operators. |
|
|
Optional.
The options for this operation. See the methods of the |
Method | Parameters | Summary |
---|---|---|
|
|
Optional. Sorts documents by one or more fields, or performs a vector search. For more information, see Sort clauses. Sort clauses can use only indexed fields. If you apply selective indexing when you create a collection, you can’t 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. For more information, see Projection operations. Default: The default projection for the collection.
Certain fields, like |
|
|
Optional. Whether a new document should be inserted if no document matches the filter criteria. Default: False |
|
None |
Optional. The response reflects the document after the update. |
|
None |
Optional. The response reflects the document before the update. This is the default unless |
Use the findOneAndUpdate
command with these parameters:
Name | Type | Summary |
---|---|---|
|
|
An object that defines filter criteria using the Data API filter syntax. The method only finds documents that match this filter criteria. For a list of available filter operators and more examples, see Data API operators. Filters can use only indexed fields. If you apply selective indexing when you create a collection, you can’t reference non-indexed fields in a filter. |
|
|
Optional. Sorts documents by one or more fields, or performs a vector search. For more information, see Sort clauses. Sort clauses can use only indexed fields. If you apply selective indexing when you create a collection, you can’t reference non-indexed fields in sort queries. For vector searches, this parameter can use either |
|
|
An object that defines the updates using Data API operators. For a list of available operators and more examples, see Data API operators. |
|
|
Optional. Controls which fields are included or excluded in the returned document. For more information, see Projection operations. Default: The default projection for the collection.
Certain fields, like |
|
|
Optional.
The options for this operation. See the |
|
|
Optional. Whether a new document should be inserted if no document matches the filter criteria. Default: False |
|
|
Optional. Controls whether the response reflects the document before or after the update. Can be one of:
Default: |
Examples
The following examples demonstrate how to update a document in a collection.
Update 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 update that document.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Update a document
result = collection.find_one_and_update(
{"_id": "101"},
{"$set": {"color": "blue"}}
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Update a document
(async function () {
const result = await collection.findOneAndUpdate(
{ _id: "101" },
{$set: {color: "blue"}}
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Update a document
Filter filter = Filters.eq("_id", "101");
Update update = Updates.set("color", "blue");
Optional<Document> result = collection.findOneAndUpdate(filter, update);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": {
"_id": "101"
},
"update": { "$set": { "color": "blue" } }
}
}'
Update 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 isCheckedOut
value of false
and a numberOfPages
value less than 300.
For a list of available filter operators and more examples, see Data API operators.
Filters can use only indexed fields. If you apply selective indexing when you create a collection, you can’t reference non-indexed fields in a filter.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Update a document
result = collection.find_one_and_update(
{
"$and": [
{"isCheckedOut": False},
{"numberOfPages": {"$lt": 300}},
]
},
{"$set": {"color": "blue"}}
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Update a document
(async function () {
const result = await collection.findOneAndUpdate(
{
$and: [
{ isCheckedOut: false },
{ numberOfPages: { $lt: 300 } }
],
},
{$set: {color: "blue"}}
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Update a document
Filter filter = Filters.and(
Filters.eq("isCheckedOut", false),
Filters.lt("numberOfPages", 300));
Update update = Updates.set("color", "blue");
Optional<Document> result = collection.findOneAndUpdate(filter, update);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": {"$and": [
{"isCheckedOut": false},
{"numberOfPages": {"$lt": 300}}
]},
"update": { "$set": { "color": "blue" } }
}
}'
Update 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 Perform a vector search.
Vector search is only available for vector-enabled collections. For more information, see Vector and vectorize.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Update a document
result = collection.find_one_and_update(
{},
{"$set": {"color": "blue"}},
sort={"$vector": [0.1, 0.2, 0.3]},
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Update a document
(async function () {
const result = await collection.findOneAndUpdate(
{},
{$set: {color: "blue"}},
{ sort: { $vector: [0.1, 0.2, 0.3] } },
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.FindOneAndUpdateOptions;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Update a document
Filter filter = Filters.and(
Filters.eq("isCheckedOut", false),
Filters.lt("numberOfPages", 300));
Update update = Updates.set("color", "blue");
FindOneAndUpdateOptions options = new FindOneAndUpdateOptions()
.sort(new float[] {0.12f, 0.52f, 0.32f});
Optional<Document> result = collection.findOneAndUpdate(filter, update, options);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"sort": {
"$vector": [0.1, 0.2, 0.3]
},
"update": { "$set": { "color": "blue" } }
}
}'
Update 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 Perform a vector search.
Vector search with vectorize is only available for collections that have vectorize enabled. For more information, see Vector and vectorize.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Update a document
result = collection.find_one_and_update(
{},
{"$set": {"color": "blue"}},
sort={"$vectorize": "Text to vectorize"}
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Update a document
(async function () {
const result = await collection.findOneAndUpdate(
{},
{$set: {color: "blue"}},
{ sort: { $vectorize: "Text to vectorize" } }
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.FindOneAndUpdateOptions;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Update a document
Filter filter = Filters.and(
Filters.eq("isCheckedOut", false),
Filters.lt("numberOfPages", 300));
Update update = Updates.set("color", "blue");
FindOneAndUpdateOptions options = new FindOneAndUpdateOptions()
.sort("Text to vectorize");
Optional<Document> result = collection.findOneAndUpdate(filter, update, options);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"sort": { "$vectorize": "Text to vectorize" },
"update": { "$set": { "color": "blue" } }
}
}'
Update 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.
Sort clauses can use only indexed fields. If you apply selective indexing when you create a collection, you can’t reference non-indexed fields in sort queries.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
from astrapy.constants import SortDocuments
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Find a document
result = collection.find_one_and_update(
{"metadata.language": "English"},
{"$set": {"color": "blue"}},
sort={
"rating": SortDocuments.ASCENDING,
"title": SortDocuments.DESCENDING,
}
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Find a document
(async function () {
const result = await collection.findOneAndUpdate(
{ "metadata.language": "English" },
{$set: {color: "blue"}},
{ sort: {
rating: 1, // ascending
title: -1 // descending
} }
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.FindOneAndUpdateOptions;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Find a document
Filter filter = Filters.eq("metadata.language", "English");
FindOneAndUpdateOptions options = new FindOneAndUpdateOptions()
.sort(Sorts.ascending("rating"))
.sort(Sorts.descending("title"));
Update update = Updates.set("color", "blue");
Optional<Document> result = collection.findOneAndUpdate(filter, update, options);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": { "metadata.language": "English" },
"update": { "$set": { "color": "blue" } },
"sort": {
"rating": 1,
"title": -1
}
}
}'
Update multiple properties
You can combine multiple operators and properties in a single request. For the full list of operators, see Data API operators.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Update a document
result = collection.find_one_and_update(
{"_id": "101"},
{
"$set": {
"color": "blue",
"classes": ["biology", "algebra", "swimming"]
},
"$unset": {
"phone": ""
},
"$inc": {
"age": 1
}
}
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Update a document
(async function () {
const result = await collection.findOneAndUpdate(
{ _id: '101' },
{
$set: {
color: "blue",
classes: ["biology", "algebra", "swimming"]
},
$unset: {
phone: ""
},
$inc: {
age: 1
}
}
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Arrays;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Update a document
Filter filter = Filters.eq("_id", "101");
Update update = Updates
.set("color", "blue")
.set("classes", Arrays.asList("biology", "algebra", "swimming"))
.unset("phone")
.inc("age", 1.0);
Optional<Document> result = collection.findOneAndUpdate(filter, update);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": {
"_id": "101"
},
"update": {
"$set": {
"color": "blue",
"classes": ["biology", "algebra", "swimming"]
},
"$unset": {
"phone": ""
},
"$inc": {
"age": 1
}
}
}
}'
Update nested properties
To update a nested property, use dot notation.
For example, field.subfield.subsubfield
.
To update an item in a list, specify a numeric index.
For example, listProperty.3
.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Update a document
result = collection.find_one_and_update(
{"_id": "101"},
{
"$set": {
"color": "blue",
"address.city": "Austin",
"classes.2": "biology"
}
}
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Update a document
(async function () {
const result = await collection.findOneAndUpdate(
{ _id: '101' },
{
$set: {
color: "blue",
"address.city": "Austin",
"classes.2": "biology"
}
}
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Update a document
Filter filter = Filters.eq("_id", "101");
Update update = Updates
.set("color", "blue")
.set("address.city", "Austin")
.set("classes.2", "biology");
Optional<Document> result = collection.findOneAndUpdate(filter, update);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": {
"_id": "101"
},
"update": {
"$set": {
"color": "blue",
"address.city": "Austin",
"classes.2": "biology"
}
}
}
}'
Insert a new document if no matching document exists
If no document matches the filter criteria, you can use upsert
to specify that a new document should be created.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Update a document
result = collection.find_one_and_update(
{
"$and": [
{"isCheckedOut": False},
{"numberOfPages": {"$lt": 300}},
]
},
{"$set": {"color": "blue"}},
upsert=True,
)
print(result)
You can also use the setOnInsert
operator specify additional fields to set if a new document is created:
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Update a document
result = collection.find_one_and_update(
{
"$and": [
{"isCheckedOut": False},
{"numberOfPages": {"$lt": 300}},
]
},
{
"$set": {"color": "blue"},
"$setOnInsert": {
"customer.name": "James"
}
},
upsert=True,
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Update a document
(async function () {
const result = await collection.findOneAndUpdate(
{
$and: [
{ isCheckedOut: false },
{ numberOfPages: { $lt: 300 } }
],
},
{ $set: {color: "blue"} },
{ upsert: true },
);
console.log(result);
})();
You can also use the setOnInsert
operator specify additional fields to set if a new document is created:
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Update a document
(async function () {
const result = await collection.findOneAndUpdate(
{
$and: [
{ isCheckedOut: false },
{ numberOfPages: { $lt: 300 } }
],
},
{
$set: {color: "blue"},
$setOnInsert: {
"customer.name": "James"
}
},
{ upsert: true },
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.FindOneAndUpdateOptions;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Update a document
Filter filter = Filters.and(
Filters.eq("isCheckedOut", false),
Filters.lt("numberOfPages", 300));
Update update = Updates.set("color", "blue");
FindOneAndUpdateOptions options = new FindOneAndUpdateOptions().upsert(true);
Optional<Document> result = collection.findOneAndUpdate(filter, update, options);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": {"$and": [
{"isCheckedOut": false},
{"numberOfPages": {"$lt": 300}}
]},
"update": { "$set": { "color": "blue" } },
"options": { "upsert": true }
}
}'
You can also use the setOnInsert
operator specify additional fields to set if a new document is created:
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": {"$and": [
{"isCheckedOut": false},
{"numberOfPages": {"$lt": 300}}
]},
"update": {
"$set": { "color": "blue" },
"$setOnInsert": {
"customer.name": "James"
}
},
"options": { "upsert": true }
}
}'
Include the updated values in the response
By default, the response reflects the document before the update. You can specify that you want the response to use the updated values instead.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
from astrapy.constants import ReturnDocument
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Update a document
result = collection.find_one_and_update(
{"_id": "101"},
{"$set": {"color": "blue"}},
return_document=ReturnDocument.AFTER
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Update a document
(async function () {
const result = await collection.findOneAndUpdate(
{ _id: "101" },
{$set: {color: "blue"}},
{returnDocument: 'after'}
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.FindOneAndUpdateOptions;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Update a document
Filter filter = Filters.eq("_id", "101");
Update update = Updates.set("color", "blue");
FindOneAndUpdateOptions options = new FindOneAndUpdateOptions().returnDocumentAfter();
Optional<Document> result = collection.findOneAndUpdate(filter, update, options);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": {
"_id": "101"
},
"update": { "$set": { "color": "blue" } },
"options": { "returnDocument": "after" }
}
}'
Include only specific fields in the response
To specify which fields to include or exclude in the returned document, use a projection.
Certain fields, like $vector
and $vectorize
, are excluded by default and will only be returned if you specify that they should be included. Certain fields, like _id
, are included by default.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Find a document
result = collection.find_one_and_update(
{"metadata.language": "English"},
{"$set": {"color": "blue"}},
projection={"isCheckedOut": True, "title": True}
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Find a document
(async function () {
const result = await collection.findOneAndUpdate(
{ "metadata.language": "English" },
{$set: {color: "blue"}},
{ projection: { isCheckedOut: true, title: true} },
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.FindOneAndUpdateOptions;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Find a document
Filter filter = Filters.eq("metadata.language", "English");
Update update = Updates.set("color", "blue");
FindOneAndUpdateOptions options = new FindOneAndUpdateOptions()
.projection(Projections.include("isCheckedOut", "title"));
Optional<Document> result = collection.findOneAndUpdate(filter, update, options);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": {"metadata.language": "English"},
"update": { "$set": { "color": "blue" } },
"projection": {"isCheckedOut": true, "title": true}
}
}'
Exclude specific fields from the response
To specify which fields to include or exclude in the returned document, use a projection.
Certain fields, like $vector
and $vectorize
, are excluded by default and will only be returned if you specify that they should be included. Certain fields, like _id
, are included by default.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
# Get an existing collection
client = DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
database = client.get_database("ASTRA_DB_API_ENDPOINT")
collection = database.get_collection("COLLECTION_NAME")
# Find a document
result = collection.find_one_and_update(
{"metadata.language": "English"},
{"$set": {"color": "blue"}},
projection={"isCheckedOut": False, "title": False}
)
print(result)
import { DataAPIClient } from '@datastax/astra-db-ts';
// Get an existing collection
const client = new DataAPIClient('ASTRA_DB_APPLICATION_TOKEN');
const database = client.db('ASTRA_DB_API_ENDPOINT');
const collection = database.collection('COLLECTION_NAME');
// Find a document
(async function () {
const result = await collection.findOneAndUpdate(
{ "metadata.language": "English" },
{$set: {color: "blue"}},
{ projection: { isCheckedOut: false, title: false} },
);
console.log(result);
})();
package com.datastax.astra.client.collection;
import com.datastax.astra.client.Collection;
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.model.Document;
import com.datastax.astra.client.model.Filter;
import com.datastax.astra.client.model.Filters;
import com.datastax.astra.client.model.FindOneAndUpdateOptions;
import com.datastax.astra.client.model.Update;
import com.datastax.astra.client.model.Updates;
import java.util.Optional;
public class FindOneAndUpdate {
public static void main(String[] args) {
// Get an existing collection
Collection<Document> collection = new DataAPIClient("ASTRA_DB_APPLICATION_TOKEN")
.getDatabase("ASTRA_DB_API_ENDPOINT")
.getCollection("COLLECTION_NAME");
// Find a document
Filter filter = Filters.eq("metadata.language", "English");
Update update = Updates.set("color", "blue");
FindOneAndUpdateOptions options = new FindOneAndUpdateOptions()
.projection(Projections.exclude("isCheckedOut", "title"));
Optional<Document> result = collection.findOneAndUpdate(filter, update, options);
System.out.println(result);
}
}
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_COLLECTION" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findOneAndUpdate": {
"filter": {"metadata.language": "English"},
"update": { "$set": { "color": "blue" } },
"projection": {"isCheckedOut": false, "title": false}
}
}'
Client reference
-
Python
-
TypeScript
-
Java
-
curl
For more information, see the client reference.
For more information, see the client reference.
For more information, see the client reference.
Client reference documentation is not applicable for HTTP.