Update a document (TypeScript)

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

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 }

Parameters

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

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 (TypeScript).

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

Filters can use only indexed fields. If you apply selective indexing when you create a collection, you cannot reference non-indexed fields in a filter.

For an example, see 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 (TypeScript).

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 (TypeScript).

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 (TypeScript).

For more information, see Sort clauses for collections (TypeScript).

Sort clauses can use only indexed fields. If you apply selective indexing when you create a collection, you cannot reference non-indexed fields in sort queries.

For vector searches, this parameter can use $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. If you specify both, the minimum of the two will be used.

For more information about the TimeoutDescriptor, see TypeScript client internals: TimeoutDescriptor. If you specify a number instead of a TimeoutDescriptor object, that number will be applied to both requestTimeoutMs and generalMethodTimeoutMs.

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.

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
  keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");

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

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

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 (TypeScript).

Filters can use only indexed fields. If you apply selective indexing when you create a collection, you cannot reference non-indexed fields in a filter.

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
  keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");

// 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);
})();

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 (TypeScript).

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
  keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");

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

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

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:

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.

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
  keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");

// 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);
})();

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 (TypeScript).

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
  keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");

// 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);
})();

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.

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
  keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");

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

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

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.

In addition to any fields you explicitly set in the update parameter, the new document also includes any top-level equality conditions from the filter parameter. Equality conditions that are nested within $and from the filter parameter are not included. If a field is defined both in the filter and in the update, the explicitly set value takes precedence.

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
  keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");

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

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 (TypeScript).

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
  }
}
import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
  keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");

// Find a document
(async function () {
  const result = await collection.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"),
  keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_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);
})();

Client reference

For more information, see the client reference.

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2026 | Privacy policy | Terms of use |  Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM