Find and 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 replace a document have the same database effect but differ in their return value. This method returns the document that was found and replaced. The method to replace a document returns details about the operation.

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 the document. If no document was found, returns returns a promise that resolves to null.

The method parameters control whether the returned document reflects the original or updated values.

The fields included in the returned document depend on the projection specified in the method.

If an upsert is requested, the method inserts a new document if no document matches the filter.

Example resolved response:

{_id: 101, name: 'John Doe'}

Parameters

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

Method signature

async findOneAndReplace(
  filter: CollectionFilter<Schema>,
  replacement: NoId<Schema>,
  options?: {
    returnDocument?: 'before' | 'after',
    upsert?: boolean,
    sort?: Sort,
    projection?: Projection,
    includeResultMetadata?: boolean,
    timeout?: number | TimeoutDescriptor,
  },
): TRaw | null

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 (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`	`CollectionFindOneAndReplaceOptions`	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 (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

CollectionFindOneAndReplaceOptions

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

Properties of `options`
Name	Type	Summary
returnDocument	`string`	Optional. Controls whether the response reflects the document before or after the replacement. Can be one of: `"before"` `"after"` For an example, see Include the new document in the response. Default: `"before"`
upsert	`boolean`	Optional. Whether to insert a new document if no document matches the filter criteria. Default: False
projection	`Projection`	Optional. Controls which fields are included or excluded in the returned document. You must use `&` to escape any `.` or `&` in field names in the projection clause. You cannot use `&` to escape any other characters. For more information, see Work with `.` and `&` in field names (TypeScript). For more information, see Projections for collections (TypeScript). Default: The default projection for the collection. All fields prefixed with `$` are excluded by default and will only be returned if you include them in the projection. `_id` is included by default and will always be returned unless you exclude it from the projection. For examples, see Include only specific fields in the response and Exclude specific fields from the response.
`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`. For examples, see Replace a document after applying a non-vector sort and Replace a document that is most similar to a search vector.
`includeResultMetadata`	`boolean`	Whether to include details about the operation in the response.
`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`. Default: False

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,
  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");

// Replace a document
(async function () {
  const result = await collection.findOneAndReplace(
    { _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,
  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");

// Replace a document
(async function () {
  const result = await collection.findOneAndReplace(
    {
      $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,
  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");

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

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

Replace 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.

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 and replace a document
(async function () {
  const result = await collection.findOneAndReplace(
    { $lexical: { $match: "tree hill" } },
    {
      is_checked_out: true,
      borrower: "Brook Reed",
    },
    {
      sort: {
        $lexical: "tree hill grassy",
      },
    },
  );

  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,
  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");

// Replace a document
(async function () {
  const result = await collection.findOneAndReplace(
    { "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,
  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");

// Replace a document
(async function () {
  const result = await collection.findOneAndReplace(
    { "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,
  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");

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

  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,
  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");

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

Include the new document in the response

By default, the response will reflect the document before the replacement. You can specify that you want the response to use the replacement document instead.

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");

// Replace a document
(async function () {
  const result = await collection.findOneAndReplace(
    { _id: "101" },
    {
      is_checked_out: true,
      borrower: "Brook Reed",
    },
    { returnDocument: "after" },
  );

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

Include only specific fields in the response

To specify which fields to include or exclude in the returned document, use a projection.

All fields prefixed with $ are excluded by default and will only be returned if you include them in the projection. _id is included by default and will always be returned unless you exclude it from the projection.

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.findOneAndReplace(
    { "metadata.language": "English" },
    {
      is_checked_out: true,
      borrower: "Brook Reed",
    },
    { projection: { is_checked_out: true, title: true } },
  );

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

Exclude specific fields from the response

To specify which fields to include or exclude in the returned document, use a projection.

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.findOneAndReplace(
    { "metadata.language": "English" },
    {
      is_checked_out: true,
      borrower: "Brook Reed",
    },
    { projection: { is_checked_out: false, title: false } },
  );

  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,
  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.findOneAndReplace(
    {
      $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,
  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.findOneAndReplace(
    {
      $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.

Find and replace a document (TypeScript)

Result

Parameters

Examples

Replace a document by ID

Replace a document that matches a filter

Replace a document that is most similar to a search vector

Replace a document based on lexicographical matching

Replace a document after applying a non-vector sort

Use nested fields in the replacement document

Use vector embeddings in the replacement document

Insert a new document if no matching document exists

Include the new document in the response

Include only specific fields in the response

Exclude specific fields from the response

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

Client reference

Was this helpful?

Give Feedback