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 find and update a document have the same database effect but differ in their return value. This method returns details about the success of the update. The method to find and update a document returns the document that was found and updated.

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

Python
TypeScript
Java
C#
curl

Updates a document that matches the specified parameters and returns a CollectionUpdateResult object that includes details about the operation.

Example response:

CollectionUpdateResult(update_info={'n': 1, 'updatedExisting': True, 'ok': 1.0, 'nModified': 1}, raw_results=...)

Updates a document that matches the specified parameters and returns a promise that resolves to a CollectionUpdateOneResult<Schema> object that includes details about the operation.

Example resolved response:

{ modifiedCount: 1, matchedCount: 1, upsertedCount: 0 }

Updates a document that matches the specified parameters and returns CollectionUpdateResult that includes details about the operation.

Updates a document that matches the specified parameters and returns an UpdateResult object that includes details about the operation.

Updates a document that matches the specified parameters and returns an object that includes details about the operation.

Example response:

{
  "status": {
    "matchedCount": 1,
    "modifiedCount": 1
  }
}

Parameters

Python
TypeScript
Java
C#
curl

Use the update_one method, which belongs to the astrapy.Collection class.

Method signature

update_one(
  filter: Dict[str, Any],
  update: Dict[str, Any],
  *,
  sort: Dict[str, Any],
  upsert: bool,
  general_method_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> CollectionUpdateResult:

Name Type Summary

Name	Type	Summary
`filter`	`Dict[str, Any]`	Optional. 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 `&` to escape any `.` or `&` in field names in the filter clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For a list of available filter operators and more examples, see Filter operators for collections. 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 Update a document that matches a filter.
`update`	`object`	An object that defines the updates using Data API operators. For a list of available operators and more examples, see Update operators for collections. You must use `&` to escape any `.` or `&` in field names in the update clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names.
`sort`	`Dict[str, Any]`	Optional. Sorts documents by one or more fields, or performs a vector search. You must use `&` to escape any `.` or `&` in field names in the sort clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For more information, see Sort clauses for collections. 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 `$vector`.
`upsert`	`bool`	Optional. Whether to insert a new document if no document matches the filter criteria. For an example, see Insert a new document if no matching document exists. Default: False
`general_method_timeout_ms`	`int`	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 `Collection` or `DataAPIClient` object. For more information, see Timeout options.
`request_timeout_ms`	`int`	Optional. An alias for `general_method_timeout_ms`. Since this method issues a single HTTP request, `general_method_timeout_ms` and `request_timeout_ms` are equivalent.
`timeout_ms`	`int`	Optional. An alias for `general_method_timeout_ms`.

filter

Dict[str, Any]

Optional. 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 & to escape any . or & in field names in the filter clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

For a list of available filter operators and more examples, see Filter operators for collections.

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 Update a document that matches a filter.

update

object

An object that defines the updates using Data API operators.

For a list of available operators and more examples, see Update operators for collections.

You must use & to escape any . or & in field names in the update clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

sort

Dict[str, Any]

Optional. Sorts documents by one or more fields, or performs a vector search.

You must use & to escape any . or & in field names in the sort clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

For more information, see Sort clauses for collections.

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 $vector.

upsert

bool

Optional. Whether to insert a new document if no document matches the filter criteria.

For an example, see Insert a new document if no matching document exists.

Default: False

general_method_timeout_ms

int

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 Collection or DataAPIClient object. For more information, see Timeout options.

request_timeout_ms

int

Optional. An alias for general_method_timeout_ms. Since this method issues a single HTTP request, general_method_timeout_ms and request_timeout_ms are equivalent.

timeout_ms

int

Optional. An alias for general_method_timeout_ms.

Use the updateOne method, which belongs to the Collection class.

Method signature

async updateOne(
  filter: CollectionFilter<Schema>,
  update: CollectionUpdateFilter<Schema>,
  options?: {
    upsert?: boolean,
    sort?: Sort,
    timeout?: number | TimeoutDescriptor,
  },
): CollectionUpdateOneResult<Schema>

Name Type Summary

Name	Type	Summary
`filter`	`CollectionFilter<Schema>`	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 `&` to escape any `.` or `&` in field names in the filter clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For a list of available filter operators and more examples, see Filter operators for collections. 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 Update a document that matches a filter.
`update`	`CollectionUpdateFilter<Schema>`	An object that defines the updates using Data API operators. For a list of available operators and more examples, see Update operators for collections. You must use `&` to escape any `.` or `&` in field names in the update clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names.
`options`	`CollectionUpdateOneOptions`	Optional. The options for this operation. See Properties of `options` for more details.

filter

CollectionFilter<Schema>

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 & to escape any . or & in field names in the filter clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

For a list of available filter operators and more examples, see Filter operators for collections.

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 Update a document that matches a filter.

update

CollectionUpdateFilter<Schema>

An object that defines the updates using Data API operators.

For a list of available operators and more examples, see Update operators for collections.

You must use & to escape any . or & in field names in the update clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

options

CollectionUpdateOneOptions

Optional. The options for this operation. See Properties of options for more details.

Properties of `options`
Name	Type	Summary
`upsert`	`boolean`	Optional. Whether to insert a new document if no document matches the filter criteria. For an example, see Insert a new document if no matching document exists. Default: False
`sort`	`Sort`	Optional. Sorts documents by one or more fields, or performs a vector search. You must use `&` to escape any `.` or `&` in field names in the sort clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For more information, see Sort clauses for collections. 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 `$vector`.
`timeout`	`number` \| `TimeoutDescriptor`	Optional. The timeout(s) to apply to this method. You can specify `requestTimeoutMs` and `generalMethodTimeoutMs`. Since this method issues a single HTTP request, these timeouts are equivalent. Details about the `timeout` parameter The `TimeoutDescriptor` object can contain these properties: `requestTimeoutMs` (`number`): The maximum time, in milliseconds, that the client should wait for each underlying HTTP request. Default: The default value for the collection. This default is 10 seconds unless you specified a different default when you initialized the `Collection` or `DataAPIClient` object. `generalMethodTimeoutMs` (`number`): The maximum time, in milliseconds, that the whole operation can take. Since this method issues a single HTTP request, `generalMethodTimeoutMs` and `requestTimeoutMs` are equivalent. If you specify both, the minimum of the two will be used. Default: The default value for the collection. This default is 30 seconds unless you specified a different default when you initialized the `Collection` or `DataAPIClient` object. If you specify a number instead of a `TimeoutDescriptor` object, that number will be applied to both `requestTimeoutMs` and `generalMethodTimeoutMs`.

Use the updateOne method, which belongs to the com.datastax.astra.client.Collection class.

Method signature

CollectionUpdateResult updateOne(
  Filter filter,
  Update update
)

CollectionUpdateResult updateOne(
  Filter filter,
  Update update,
  CollectionUpdateOneOptions options
)

Name Type Summary

Name	Type	Summary
`filter`	`Filter`	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 `&` to escape any `.` or `&` in field names in the filter clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For a list of available filter operators and more examples, see Filter operators for collections. 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 Update a document that matches a filter.
`update`	`Update`	An object that defines the updates using Data API operators. For a list of available operators and more examples, see Update operators for collections. You must use `&` to escape any `.` or `&` in field names in the update clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names.
`options`	`CollectionUpdateOneOptions`	Optional. The options for this operation. See Methods of the `CollectionUpdateOneOptions` class for more details.

filter

Filter

You must use & to escape any . or & in field names in the filter clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

For a list of available filter operators and more examples, see Filter operators for collections.

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 Update a document that matches a filter.

update

Update

An object that defines the updates using Data API operators.

For a list of available operators and more examples, see Update operators for collections.

You must use & to escape any . or & in field names in the update clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

options

CollectionUpdateOneOptions

Optional. The options for this operation. See Methods of the CollectionUpdateOneOptions class for more details.

Methods of the `CollectionUpdateOneOptions` class
Method	Parameters	Summary
`sort()`	`float[] \| String \| Sort \| Map<String, Object>`	Optional. Sorts documents by one or more fields, or performs a vector search. You must use `&` to escape any `.` or `&` in field names in the sort clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For more information, see Sort clauses for collections. 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 `$vector`.
`upsert()`	`boolean`	Optional. Whether to insert a new document if no document matches the filter criteria. For an example, see Insert a new document if no matching document exists. Default: False

Use the UpdateOneAsync method, which belongs to the Collection class. You can also use UpdateOne, which is the synchronous version of the method.

Method signature

public Task<UpdateResult> UpdateOneAsync(
  CollectionFilter<T> filter,
  UpdateBuilder<T> update,
  CollectionUpdateOneOptions<T> options = null
);

Name Type Summary

Name	Type	Summary
`filter`	`CollectionFilter`	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 `&` to escape any `.` or `&` in field names in the filter clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For a list of available filter operators and more examples, see Filter operators for collections. 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 Update a document that matches a filter.
`update`	`UpdateBuilder`	Defines the updates using Data API operators. For a list of available operators and more examples, see Update operators for collections.
`updateOptions`	`CollectionUpdateOneOptions`	Optional. Options for this operation. For more information and examples for general options such as timeout, see Customize API interaction. For options specific to this method, see Method-specific properties of the `CollectionUpdateOneOptions` class.

filter

CollectionFilter

You must use & to escape any . or & in field names in the filter clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

For a list of available filter operators and more examples, see Filter operators for collections.

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 Update a document that matches a filter.

update

UpdateBuilder

Defines the updates using Data API operators.

For a list of available operators and more examples, see Update operators for collections.

updateOptions

CollectionUpdateOneOptions

Optional. Options for this operation. For more information and examples for general options such as timeout, see Customize API interaction. For options specific to this method, see Method-specific properties of the CollectionUpdateOneOptions class.

Method-specific properties of the `CollectionUpdateOneOptions` class
Name	Type	Summary
`Upsert`	`bool`	Optional. Whether to insert a new document if no document matches the filter criteria. For an example, see Insert a new document if no matching document exists. Default: false
`Sort`	`SortBuilder<T>`	Optional. Sorts documents by one or more fields, or performs a vector search. You must use `&` to escape any `.` or `&` in field names in the sort clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For more information, see Sort clauses for collections. 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 `$vector`.

Use the updateOne command.

Command signature

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "updateOne": {
    "filter": FILTER,
    "update": UPDATE,
    "sort": SORT,
    "options": {
      "upsert": BOOLEAN
    }
  }
}'

Name Type Summary

Name	Type	Summary
`filter`	`object`	Optional. 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 `&` to escape any `.` or `&` in field names in the filter clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For a list of available filter operators and more examples, see Filter operators for collections. 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 Update a document that matches a filter.
`sort`	`object`	Optional. Sorts documents by one or more fields, or performs a vector search. You must use `&` to escape any `.` or `&` in field names in the sort clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names. For more information, see Sort clauses for collections. 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 `$vector`.
`update`	`object`	An object that defines the updates using Data API operators. For a list of available operators and more examples, see Update operators for collections. You must use `&` to escape any `.` or `&` in field names in the update clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names.
`options`	`object`	Optional. The options for this operation. See Properties of `options` for more details.

filter

object

You must use & to escape any . or & in field names in the filter clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

For a list of available filter operators and more examples, see Filter operators for collections.

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 Update a document that matches a filter.

sort

object

Optional. Sorts documents by one or more fields, or performs a vector search.

You must use & to escape any . or & in field names in the sort clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

For more information, see Sort clauses for collections.

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 $vector.

update

object

An object that defines the updates using Data API operators.

For a list of available operators and more examples, see Update operators for collections.

You must use & to escape any . or & in field names in the update clause. You cannot use & to escape any other characters. For more information, see Work with . and & in field names.

options

object

Optional. The options for this operation. See Properties of options for more details.

Properties of `options`
Name	Type	Summary
`upsert`	`boolean`	Optional. Whether to insert a new document if no document matches the filter criteria. For an example, see Insert a new document if no matching document exists. Default: False

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
C#
curl

The following example uses untyped documents or rows, but you can define a client-side type for your collection to help statically catch errors. For examples, see Typing support.

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Update a document
result = collection.update_one(
    {"_id": "101"}, {"$set": {"color": "blue"}}
)

print(result)

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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Update a document
(async function () {
  const result = await collection.updateOne(
    { _id: "101" },
    { $set: { color: "blue" } },
  );

  console.log(result);
})();

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.commands.Update;
import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.core.query.Filters;

public class Example {

  public static void main(String[] args) {
    // Get an existing collection
    Collection<Document> collection =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
            .getCollection("COLLECTION_NAME");

    // Update a document
    Filter filter = Filters.eq("_id", "101");
    Update update = Update.create().set("color", "blue");
    CollectionUpdateResult result = collection.updateOne(filter, update);
    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
  }
}

The following example uses untyped documents, but you can use strongly-typed classes for compile-time checks and IntelliSense. For more information and examples, see Custom typing for collections.

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var filter = Builders<Document>.CollectionFilter.Eq("_id", "101");
    var update = Builders<Document>.CollectionUpdate.Set("color", "blue");
    var result = await collection.UpdateOneAsync(filter, update);

    Console.WriteLine(result.MatchedCount);
    Console.WriteLine(result.ModifiedCount);
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "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 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.

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.

Python
TypeScript
Java
C#
curl

The following example uses untyped documents or rows, but you can define a client-side type for your collection to help statically catch errors. For examples, see Typing support.

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Update a document
result = collection.update_one(
    {
        "$and": [
            {"is_checked_out": False},
            {"number_of_pages": {"$lt": 300}},
        ]
    },
    {"$set": {"color": "blue"}},
)

print(result)

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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Update a document
(async function () {
  const result = await collection.updateOne(
    {
      $and: [{ is_checked_out: false }, { number_of_pages: { $lt: 300 } }],
    },
    { $set: { color: "blue" } },
  );

  console.log(result);
})();

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.commands.Update;
import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.core.query.Filters;

public class Example {

  public static void main(String[] args) {
    // Get an existing collection
    Collection<Document> collection =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
            .getCollection("COLLECTION_NAME");

    // Update a document
    Filter filter =
        Filters.and(Filters.eq("is_checked_out", false), Filters.lt("number_of_pages", 300));
    Update update = Update.create().set("color", "blue");
    CollectionUpdateResult result = collection.updateOne(filter, update);
    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
  }
}

The following example uses untyped documents, but you can use strongly-typed classes for compile-time checks and IntelliSense. For more information and examples, see Custom typing for collections.

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var filterBuilder = Builders<Document>.CollectionFilter;
    var filter = filterBuilder.And(
      filterBuilder.Eq("is_checked_out", false),
      filterBuilder.Lt("number_of_pages", 300)
    );
    var update = Builders<Document>.CollectionUpdate.Set("color", "blue");
    var result = await collection.UpdateOneAsync(filter, update);

    Console.WriteLine(result.MatchedCount);
    Console.WriteLine(result.ModifiedCount);
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "filter": {"$and": [
      {"is_checked_out": false},
      {"number_of_pages": {"$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 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.

Python
TypeScript
Java
C#
curl

The following example uses untyped documents or rows, but you can define a client-side type for your collection to help statically catch errors. For examples, see Typing support.

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Update a document
result = collection.update_one(
    {},
    {"$set": {"color": "blue"}},
    sort={"$vector": [0.08, -0.62, 0.39]},
)

print(result)

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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Update a document
(async function () {
  const result = await collection.updateOne(
    {},
    { $set: { color: "blue" } },
    { sort: { $vector: [0.08, -0.62, 0.39] } },
  );

  console.log(result);
})();

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.commands.Update;
import com.datastax.astra.client.collections.commands.options.CollectionUpdateOneOptions;
import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.query.Sort;

public class Example {

  public static void main(String[] args) {
    // Get an existing collection
    Collection<Document> collection =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
            .getCollection("COLLECTION_NAME");

    // Update a document
    CollectionUpdateOneOptions options =
        new CollectionUpdateOneOptions().sort(Sort.vector(new float[] {0.08f, -0.62f, 0.39f}));

    Update update = Update.create().set("color", "blue");

    CollectionUpdateResult result = collection.updateOne(null, update, options);

    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
  }
}

The following example uses untyped documents, but you can use strongly-typed classes for compile-time checks and IntelliSense. For more information and examples, see Custom typing for collections.

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Core.Query;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var embeddings = new float[] { 0.08f, -0.62f, 0.39f };
    var updateOptions = new CollectionUpdateOneOptions<Document>()
    {
      Sort = Builders<Document>.CollectionSort.Vector(embeddings),
    };
    var update = Builders<Document>.CollectionUpdate.Set("color", "blue");
    var result = await collection.UpdateOneAsync(
      null,
      update,
      updateOptions
    );

    Console.WriteLine(result.MatchedCount);
    Console.WriteLine(result.ModifiedCount);
  }
}

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.

Vector binary encodings specification

A d-dimensional vector is a list of d floating-point numbers that can be binary encoded.

To prepare for encoding, the list must be transformed into a sequence of bytes where each float is represented as four bytes in big-endian format. Then, the byte sequence is Base64-encoded, with = padding, if needed. For example, here are some vectors and their resulting Base64 encoded strings:

[0.1, -0.2, 0.3] = "PczMzb5MzM0+mZma"
[0.1, 0.2] = "PczMzT5MzM0="
[10, 10.5, 100, -91.19] = "QSAAAEEoAABCyAAAwrZhSA=="

Once encoded, you use $binary to pass the Base64 string to the Data API:

{ "$binary": "BASE64_STRING" }

You can use a script to encode your vectors, for example:

python
import base64
import struct

input_vector = [0.1, -0.2, 0.3]
d = len(input_vector)
pack_format = ">" + "f" * d
binary_encode = base64.b64encode(struct.pack(pack_format, *input_vector)).decode()

Array of floats
$binary

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "sort": {
      "$vector": [0.08, -0.62, 0.39]
    },
    "update": { "$set": { "color": "blue" } }
  }
}'

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "sort": {
      "$vector": {"$binary": "PaPXCr8euFI+x64U"}
    },
    "update": { "$set": { "color": "blue" } }
  }
}'

Update a document based on lexicographical matching

Lexicographical matching is currently in public preview. Development is ongoing, and the features and functionality are subject to change. Hyper-Converged Database (HCD), and the use of such, is subject to the DataStax Preview Terms.

There are two ways to use lexicographical matching to find documents with the Data API:

Sort on the $lexical field to find the documents whose $lexical field value is most relevant to a given string of space-separated keywords or terms
Filter on the $lexical field with the $match operator to find the documents whose $lexical field 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.

Python
TypeScript
Java
C#
curl

The following example uses untyped documents or rows, but you can define a client-side type for your collection to help statically catch errors. For examples, see Typing support.

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Update a document
result = collection.update_one(
    {"$lexical": {"$match": "tree hill"}},
    {"$set": {"color": "blue"}},
    sort={"$lexical": "tree hill grassy"},
)

print(result)

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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Update a document
(async function () {
  const result = await collection.updateOne(
    { $lexical: { $match: "tree hill" } },
    { $set: { color: "blue" } },
    {
      sort: {
        $lexical: "tree hill grassy",
      },
    },
  );

  console.log(result);
})();

import com.datastax.astra.client.DataAPIClients; import com.datastax.astra.client.collections.Collection; import com.datastax.astra.client.collections.commands.Update; import com.datastax.astra.client.collections.commands.options.CollectionUpdateOneOptions; import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult; import com.datastax.astra.client.collections.definition.documents.Document; import com.datastax.astra.client.core.query.Filter; import com.datastax.astra.client.core.query.Filters; import com.datastax.astra.client.core.query.Sort;

public class Example {

public static void main(String[] args) {
  // Get an existing collection
  Collection<Document> collection =
      DataAPIClients.clientHCD("**USERNAME**", "**PASSWORD**")
          .getDatabase("**API_ENDPOINT**", "**KEYSPACE_NAME**")
          .getCollection("**COLLECTION_NAME**");

    // Update a document
    Filter filter = Filters.match("tree hill");
    CollectionUpdateOneOptions options =
        new CollectionUpdateOneOptions().sort(Sort.lexical("tree hill grassy"));
    Update update = Update.create().set("color", "blue");
    CollectionUpdateResult result = collection.updateOne(filter, update, options);
    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
  }
}

The following example uses untyped documents, but you can use strongly-typed classes for compile-time checks and IntelliSense. For more information and examples, see Custom typing for collections.

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Core.Query;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var filter = Builders<Document>.CollectionFilter.LexicalMatch(
      "tree hill"
    );

    var updateOptions = new CollectionUpdateOneOptions<Document>()
    {
      Sort = Builders<Document>.CollectionSort.Lexical(
        "tree hill grassy"
      ),
    };

    var update = Builders<Document>.CollectionUpdate.Set("color", "blue");
    var result = await collection.UpdateOneAsync(
      filter,
      update,
      updateOptions
    );

    Console.WriteLine(result.MatchedCount);
    Console.WriteLine(result.ModifiedCount);
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "filter": {"$lexical": {"$match": "tree hill"}},
    "sort": { "$lexical": "tree hill grassy" },
    "update": { "$set": { "color": "blue" } }
  }
}'

Update multiple properties

You can combine multiple operators and properties in a single call. For the full list of operators, see Update operators for collections.

Python
TypeScript
Java
C#
curl

The following example uses untyped documents or rows, but you can define a client-side type for your collection to help statically catch errors. For examples, see Typing support.

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Update a document
result = collection.update_one(
    {"_id": "101"},
    {
        "$set": {
            "color": "blue",
            "classes": ["biology", "algebra", "swimming"],
        },
        "$unset": {"phone": ""},
        "$inc": {"age": 1},
    },
)

print(result)

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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Update a document
(async function () {
  const result = await collection.updateOne(
    { _id: "101" },
    {
      $set: {
        color: "blue",
        classes: ["biology", "algebra", "swimming"],
      },
      $unset: {
        phone: "",
      },
      $inc: {
        age: 1,
      },
    },
  );

  console.log(result);
})();

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.commands.Update;
import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.core.query.Filters;
import java.util.Arrays;

public class Example {

  public static void main(String[] args) {
    // Get an existing collection
    Collection<Document> collection =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
            .getCollection("COLLECTION_NAME");

    // Update a document
    Filter filter = Filters.eq("_id", "101");
    Update update =
        Update.create()
            .set("color", "blue")
            .set("classes", Arrays.asList("biology", "algebra", "swimming"))
            .unset("phone")
            .inc("age", 1.0);
    CollectionUpdateResult result = collection.updateOne(filter, update);
    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
  }
}

The following example uses untyped documents, but you can use strongly-typed classes for compile-time checks and IntelliSense. For more information and examples, see Custom typing for collections.

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var filter = Builders<Document>.CollectionFilter.Eq("_id", "101");
    var updater = Builders<Document>.CollectionUpdate;
    var update = updater
      .Set("color", "blue")
      .Set("classes", new[] { "biology", "algebra", "swimming" })
      .Unset("phone")
      .Increment("age", 1);
    var result = await collection.UpdateOneAsync(filter, update);

    Console.WriteLine(result.MatchedCount);
    Console.WriteLine(result.ModifiedCount);
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "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
C#
curl

The following example uses untyped documents or rows, but you can define a client-side type for your collection to help statically catch errors. For examples, see Typing support.

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Update a document
result = collection.update_one(
    {"_id": "101"},
    {
        "$set": {
            "color": "blue",
            "address.city": "Austin",
            "classes.2": "biology",
        }
    },
)

print(result)

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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Update a document
(async function () {
  const result = await collection.updateOne(
    { _id: "101" },
    {
      $set: {
        color: "blue",
        "address.city": "Austin",
        "classes.2": "biology",
      },
    },
  );

  console.log(result);
})();

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.commands.Update;
import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.core.query.Filters;

public class Example {

  public static void main(String[] args) {
    // Get an existing collection
    Collection<Document> collection =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
            .getCollection("COLLECTION_NAME");

    // Update a document
    Filter filter = Filters.eq("_id", "101");
    Update update =
        Update.create()
            .set("color", "blue")
            .set("address.city", "Austin")
            .set("classes.2", "biology");
    CollectionUpdateResult result = collection.updateOne(filter, update);
    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
  }
}

The following example uses untyped documents, but you can use strongly-typed classes for compile-time checks and IntelliSense. For more information and examples, see Custom typing for collections.

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var filter = Builders<Document>.CollectionFilter.Eq("_id", "101");
    var updater = Builders<Document>.CollectionUpdate;
    var update = updater
      .Set("color", "blue")
      .Set("address.city", "Austin")
      .Set("classes.2", "biology");
    var result = await collection.UpdateOneAsync(filter, update);

    Console.WriteLine(result.MatchedCount);
    Console.WriteLine(result.ModifiedCount);
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "filter": {
      "_id": "101"
    },
    "update": {
      "$set": {
        "color": "blue",
        "address.city": "Austin",
        "classes.2": "biology"
      }
    }
  }
}'

Insert a new document if no matching document exists

You can use upsert to insert a new document if no document matches the filter criteria.

The new document includes any equality conditions from the filter parameter, as well as any fields you explicitly set in the update parameter. If a field is defined both in the filter and in the update, the explicitly set value takes precedence.

Python
TypeScript
Java
C#
curl

The following example uses untyped documents or rows, but you can define a client-side type for your collection to help statically catch errors. For examples, see Typing support.

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Update a document
result = collection.update_one(
    {
        "$and": [
            {"is_checked_out": False},
            {"number_of_pages": {"$lt": 300}},
        ]
    },
    {"$set": {"color": "blue"}},
    upsert=True,
)

print(result)

You can also use the setOnInsert operator to specify additional fields to set if a new document is created:

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Update a document
result = collection.update_one(
    {
        "$and": [
            {"is_checked_out": False},
            {"number_of_pages": {"$lt": 300}},
        ]
    },
    {
        "$set": {"color": "blue"},
        "$setOnInsert": {"customer.name": "James"},
    },
    upsert=True,
)

print(result)

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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Update a document
(async function () {
  const result = await collection.updateOne(
    {
      $and: [{ is_checked_out: false }, { number_of_pages: { $lt: 300 } }],
    },
    { $set: { color: "blue" } },
    { upsert: true },
  );

  console.log(result);
})();

You can also use the setOnInsert operator to specify additional fields to set if a new document is created:

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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Update a document
(async function () {
  const result = await collection.updateOne(
    {
      $and: [{ is_checked_out: false }, { number_of_pages: { $lt: 300 } }],
    },
    {
      $set: { color: "blue" },
      $setOnInsert: {
        "customer.name": "James",
      },
    },
    { upsert: true },
  );

  console.log(result);
})();

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.commands.Update;
import com.datastax.astra.client.collections.commands.options.CollectionUpdateOneOptions;
import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.core.query.Filters;

public class Example {

  public static void main(String[] args) {
    // Get an existing collection
    Collection<Document> collection =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
            .getCollection("COLLECTION_NAME");

    // Update a document
    Filter filter =
        Filters.and(Filters.eq("is_checked_out", false), Filters.lt("number_of_pages", 300));
    Update update = Update.create().set("color", "blue");
    CollectionUpdateOneOptions options = new CollectionUpdateOneOptions().upsert(true);
    CollectionUpdateResult result = collection.updateOne(filter, update, options);
    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
    System.out.println(result.getUpsertedId());
  }
}

You can also use the setOnInsert operator to specify additional fields to set if a new document is created:

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.commands.Update;
import com.datastax.astra.client.collections.commands.options.CollectionUpdateOneOptions;
import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.core.query.Filters;
import java.util.Map;

public class Example {

  public static void main(String[] args) {
    // Get an existing collection
    Collection<Document> collection =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
            .getCollection("COLLECTION_NAME");

    // Update a document
    Filter filter =
        Filters.and(Filters.eq("is_checked_out", false), Filters.lt("number_of_pages", 300));
    Update update =
        Update.create().set("color", "blue").setOnInsert(Map.of("customer.name", "James"));
    CollectionUpdateOneOptions options = new CollectionUpdateOneOptions().upsert(true);
    CollectionUpdateResult result = collection.updateOne(filter, update, options);
    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
    System.out.println(result.getUpsertedId());
  }
}

The following example uses untyped documents, but you can use strongly-typed classes for compile-time checks and IntelliSense. For more information and examples, see Custom typing for collections.

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Core.Query;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var filterBuilder = Builders<Document>.CollectionFilter;
    var filter = filterBuilder.And(
      filterBuilder.Eq("is_checked_out", false),
      filterBuilder.Lt("number_of_pages", 300)
    );
    var update = Builders<Document>.CollectionUpdate.Set("color", "blue");
    var updateOptions = new CollectionUpdateOneOptions<Document>()
    {
      Upsert = true,
    };
    var result = await collection.UpdateOneAsync(
      filter,
      update,
      updateOptions
    );

    Console.WriteLine(result.MatchedCount);
    Console.WriteLine(result.ModifiedCount);
    Console.WriteLine(result.UpsertedId);
  }
}

You can also use the setOnInsert operator to specify additional fields to set if a new document is created:

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Core.Query;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var filterBuilder = Builders<Document>.CollectionFilter;
    var filter = filterBuilder.And(
      filterBuilder.Eq("is_checked_out", false),
      filterBuilder.Lt("number_of_pages", 300)
    );
    var update = Builders<Document>
      .CollectionUpdate.Set("color", "blue")
      .SetOnInsert("customer.name", "James");
    var updateOptions = new CollectionUpdateOneOptions<Document>()
    {
      Upsert = true,
    };
    var result = await collection.UpdateOneAsync(
      filter,
      update,
      updateOptions
    );

    Console.WriteLine(result.MatchedCount);
    Console.WriteLine(result.ModifiedCount);
    Console.WriteLine(result.UpsertedId);
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "filter": {"$and": [
      {"is_checked_out": false},
      {"number_of_pages": {"$lt": 300}}
    ]},
    "update": { "$set": { "color": "blue" } },
    "options": { "upsert": true }
  }
}'

You can also use the setOnInsert operator to specify additional fields to set if a new document is created:

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "filter": {"$and": [
      {"is_checked_out": false},
      {"number_of_pages": {"$lt": 300}}
    ]},
    "update": {
      "$set": { "color": "blue" },
      "$setOnInsert": {
        "customer.name": "James"
      }
    },
    "options": { "upsert": true }
  }
}'

Work with `.` and `&` in field names

You must use & to escape any . or & in field names when the field is used in a filter, sort, projection, update, or indexing clause. Dot notation, which is used to reference nested fields, should not be escaped. For more information, see Work with . and & in field names.

For example, in the following document, you would use escaping like this: areas.r&&d, costs.price&.usd, and costs.price&.cad.

{
  "areas": {
    "r&d": true,
    "design": false
  },
  "costs": {
    "price.usd": 100,
    "price.cad": 90
  }
}

Python
TypeScript
Java
C#
curl

The following example uses untyped documents or rows, but you can define a client-side type for your collection to help statically catch errors. For examples, see Typing support.

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Find a document
result = collection.update_one(
    {
        "$and": [
            {"areas.r&&d": False},
            {"costs.price&.usd": {"$lt": 300}},
        ]
    },
    {"$set": {"areas.r&&d": True, "costs.price&.usd": 310}},
)

print(result)

You can also use the escape_field_names function provided by the client:

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.utils.document_paths import escape_field_names

# Get an existing collection
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection = database.get_collection(
    "COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)

# Find a document
result = collection.update_one(
    {
        "$and": [
            {escape_field_names("areas", "r&d"): False},
            {escape_field_names("costs", "price.usd"): {"$lt": 300}},
        ]
    },
    {
        "$set": {
            escape_field_names("areas", "r&d"): True,
            escape_field_names("costs", "price.usd"): 310,
        }
    },
)

print(result)

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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Find a document
(async function () {
  const result = await collection.updateOne(
    {
      $and: [{ "areas.r&&d": false }, { "costs.price&.usd": { $lt: 300 } }],
    },
    {
      $set: {
        "areas.r&&d": true,
        "costs.price&.usd": 310,
      },
    },
  );

  console.log(result);
})();

You can also use the escapeFieldNames function provided by the client:

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
  escapeFieldNames,
} 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"),
});
const collection = database.collection("COLLECTION_NAME", {
  keyspace: "KEYSPACE_NAME",
});

// Find a document
(async function () {
  const result = await collection.updateOne(
    {
      $and: [
        { [escapeFieldNames("areas", "r&d")]: false },
        { [escapeFieldNames("costs", "price.usd")]: { $lt: 300 } },
      ],
    },
    {
      $set: {
        [escapeFieldNames("areas", "r&d")]: true,
        [escapeFieldNames("costs", "price.usd")]: 310,
      },
    },
  );

  console.log(result);
})();

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.commands.Update;
import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.core.query.Filters;

public class Example {

  public static void main(String[] args) {
    // Get an existing collection
    Collection<Document> collection =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
            .getCollection("COLLECTION_NAME");

    // Find a document
    Filter filter =
        Filters.and(Filters.eq("areas.r&&d", false), Filters.lt("costs.price&.usd", 300));
    Update update = Update.create().set("areas.r&&d", true).set("costs.price&.usd", 310);
    CollectionUpdateResult result = collection.updateOne(filter, update);
    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
  }
}

You can also use the escapeFieldNames function provided by the client:

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.commands.Update;
import com.datastax.astra.client.collections.commands.results.CollectionUpdateResult;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.core.query.Filters;
import com.datastax.astra.internal.utils.EscapeUtils;

public class Example {

  public static void main(String[] args) {
    // Get an existing collection
    Collection<Document> collection =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
            .getCollection("COLLECTION_NAME");

    // Find a document
    Filter filter =
        Filters.and(
            Filters.eq(EscapeUtils.escapeFieldNames("areas", "r&d"), false),
            Filters.lt(EscapeUtils.escapeFieldNames("costs", "price.usd"), 300));
    Update update =
        Update.create()
            .set(EscapeUtils.escapeFieldNames("areas", "r&d"), true)
            .set(EscapeUtils.escapeFieldNames("costs", "price.usd"), 310);
    CollectionUpdateResult result = collection.updateOne(filter, update);
    System.out.println(result.getMatchedCount());
    System.out.println(result.getModifiedCount());
  }
}

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var filterBuilder = Builders<Document>.CollectionFilter;
    var filter = filterBuilder.And(
      filterBuilder.Eq("areas.r&&d", false),
      filterBuilder.Lt("costs.price&.usd", 300)
    );
    var updater = Builders<Document>.CollectionUpdate;
    var update = updater
      .Set("areas.r&&d", true)
      .Set("costs.price&.usd", 310);
    var result = await collection.UpdateOneAsync(filter, update);

    Console.WriteLine(JsonSerializer.Serialize(result));
  }
}

You can also use the EscapeFieldNames function provided by the client:

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Collections;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Utils;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing collection
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    var collection = database.GetCollection("COLLECTION_NAME");

    // Update a document
    var filterBuilder = Builders<Document>.CollectionFilter;
    var filter = filterBuilder.And(
      filterBuilder.Eq(
        FieldEscaping.EscapeFieldNames("areas", "r&d"),
        false
      ),
      filterBuilder.Lt(
        FieldEscaping.EscapeFieldNames("costs", "price.usd"),
        300
      )
    );
    var updater = Builders<Document>.CollectionUpdate;
    var update = updater
      .Set(FieldEscaping.EscapeFieldNames("areas", "r&d"), true)
      .Set(FieldEscaping.EscapeFieldNames("costs", "price.usd"), 310);
    var result = await collection.UpdateOneAsync(filter, update);

    Console.WriteLine(JsonSerializer.Serialize(result));
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/COLLECTION_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "filter": {"$and": [
      {"areas.r&&d": false},
      {"costs.price&.usd": {"$lt": 300}}
    ]},
    "update": {
      "$set": {
        "areas.r&&d": true,
        "costs.price&.usd": 310
      }
    }
  }
}'

Client reference

Python
TypeScript
Java
C#
curl

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

Update a document

Result

Parameters

Examples

Update a document by ID

Update a document that matches a filter

Update a document that is most similar to a search vector

Update a document based on lexicographical matching

Update multiple properties

Update nested properties

Insert a new document if no matching document exists

Work with `.` and `&` in field names

Client reference

Was this helpful?

Give Feedback