Replace a document (TypeScript)

Finds a single document in a collection using filter and sort clauses, and then replaces that document. Optionally, if no document matches the filter, inserts a new document.

This method and the method to find and replace a document have the same database effect but differ in their return value. This method returns details about the operation. The method to find and replace a document returns the document that was found and replaced.

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

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

Example resolved response:

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

Example resolved response if a new document was inserted:

{
  modifiedCount: 0,
  matchedCount: 0,
  upsertedId: '837b054d-4a8b-4458-bb05-4d4a8b0458b7',
  upsertedCount: 1
}

Parameters

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

Method signature 
async replaceOne(
  filter: CollectionFilter<Schema>,
  replacement: NoId<Schema>,
  options?: {
    upsert?: boolean,
    sort?: Sort,
    timeout?: number | TimeoutDescriptor,
  },
): CollectionReplaceOneResult<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 Replace a document that matches a filter.

replacement

NoId<Schema>

An object describing the replacement document.

The replacement document should not include _id. The _id of the replaced document will be retained.

Field names in the replacement document must follow the same rules as when inserting a document.

See the examples for usage.

options

CollectionReplaceOneOptions

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 either $vector or $vectorize.

For examples, see Replace a document after applying a non-vector sort, Replace a document that is most similar to a search vector, and Replace a document that is most similar to a search string.

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 replace a document in a collection.

Replace 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 replace that document.

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

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

// Replace a document
(async function () {
  const result = await collection.replaceOne(
    { _id: "101" },
    {
      name: "Jane Doe",
      age: 42,
    },
  );

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

Replace 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 } from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

// Replace a document
(async function () {
  const result = await collection.replaceOne(
    {
      $and: [{ is_checked_out: false }, { number_of_pages: { $lt: 300 } }],
    },
    {
      is_checked_out: true,
      borrower: "Brook Reed",
    },
  );

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

Replace 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 } from "@datastax/astra-db-ts";

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

// Replace a document
(async function () {
  const result = await collection.replaceOne(
    {},
    {
      name: "Jane Doe",
      age: 42,
    },
    { sort: { $vector: [0.08, -0.62, 0.39] } },
  );

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

Replace a document that is most similar to a search string

To find the document whose $vector value is most similar to the $vector value of a given search string, use a sort with the search string that you want to vectorize and match. For more information, see Find data with vector search.

Vector search with vectorize is only available for collections that have vectorize enabled. For more information, see Create a collection that can automatically generate vector embeddings and $vectorize in collections (TypeScript).

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

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

// Replace a document
(async function () {
  const result = await collection.replaceOne(
    {},
    {
      name: "Jane Doe",
      age: 42,
    },
    { sort: { $vectorize: "Text to vectorize" } },
  );

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

Replace a document after applying a non-vector sort

You can use a sort clause to sort documents by one or more fields.

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

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

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

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

// Replace a document
(async function () {
  const result = await collection.replaceOne(
    { "metadata.language": "English" },
    {
      is_checked_out: false,
      number_of_pages: 400,
    },
    {
      sort: {
        rating: 1, // ascending
        title: -1, // descending
      },
    },
  );

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

Use nested fields in the replacement document

Although you can use dot notation in the filter to find a document, you cannot use dot notation in the replacement document. To specify nested fields in the replacement document, you must build a map, list, or set.

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

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

// Replace a document
(async function () {
  const result = await collection.replaceOne(
    { "metadata.language": "English" },
    {
      title: "Hidden Shadows of the Past",
      number_of_pages: 481,
      genres: ["Biography", "Graphic Novel", "Dystopian", "Drama"],
      metadata: {
        isbn: "978-1-905585-40-3",
        language: "French",
        edition: "Anniversary Edition",
      },
    },
  );

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

Use vector embeddings in the replacement document

Use the reserved $vector field to insert a document with pregenerated vector embeddings.

Only vector-enabled collections support the $vector field. For more information, see Create a collection that can store vector embeddings and $vector in collections (TypeScript).

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

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

// Replace a document
(async function () {
  const result = await collection.replaceOne(
    { _id: "101" },
    {
      name: "Jane Doe",
      $vector: [0.08, -0.62, 0.39],
    },
  );

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

Use vectorize to generate vector embeddings in the replacement document

Use the reserved $vectorize field to generate a vector embedding automatically. The value of $vectorize can be any string.

Only collections that have vectorize enabled support the $vectorize field. For more information, see Create a collection that can automatically generate vector embeddings and $vectorize in collections (TypeScript).

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

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

// Replace a document
(async function () {
  const result = await collection.replaceOne(
    { _id: "101" },
    {
      name: "Jane Doe",
      $vectorize: "Text to vectorize",
    },
  );

  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.

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

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

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

// Replace a document
(async function () {
  const result = await collection.replaceOne(
    {
      $and: [{ is_checked_out: false }, { number_of_pages: { $lt: 300 } }],
    },
    {
      is_checked_out: true,
      borrower: "Brook Reed",
    },
    { 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).

You should not use & to escape any . or & in field names in the replacement document.

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

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

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

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

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

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

// Get an existing collection
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});
const collection = database.collection("COLLECTION_NAME");

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

  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