Update a row (TypeScript)

Tables with the Data API are 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.

Updates a single row in a table.

If the row does not already exist and the update includes at least one non-null or non-empty value, creates a new row.

For general information about working with tables and rows, see About tables with the Data API (TypeScript).

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 the specified row.

If no row matches the specified primary key and the update includes at least one non-null or non-empty value, then a new row is created with the values specified $set values and primary key values. Any omitted or $unset columns are set to null in the new row.

Returns a promise that resolves once the operation completes.

A rare edge case, related to underlying Apache Cassandra® functionality, can cause a row to disappear altogether when all of its columns are set to null.

This happens if the row was previously created from an update operation that had no pre-existing row to modify.

Parameters

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

Method signature

async updateOne(
  filter: TableFilter<Schema>,
  update: TableUpdateFilter<Schema>,
  options?: {
    timeout?: number | TimeoutDescriptor,
  },
): void

Name Type Summary

Name	Type	Summary
`filter`	`TableFilter`	Describes the full primary key of the row to update. For this method, the filter can only use the `$eq` operator and columns in the primary key.
`update`	`TableUpdateFilter`	Defines the update using Data API operators. For a list of available operators and more examples, see Update operators for tables (TypeScript). You cannot update primary key values. If you need to modify a row’s primary key, delete the row and then insert a new row with the desired primary key values.
`options.timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout to impose on the underlying API request.

filter

TableFilter

Describes the full primary key of the row to update.

For this method, the filter can only use the $eq operator and columns in the primary key.

update

TableUpdateFilter

Defines the update using Data API operators.

For a list of available operators and more examples, see Update operators for tables (TypeScript).

You cannot update primary key values. If you need to modify a row’s primary key, delete the row and then insert a new row with the desired primary key values.

options.timeout

number | TimeoutDescriptor

Optional. A timeout to impose on the underlying API request.

Examples

The following examples demonstrate how to update a row in a table.

Update multiple columns

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

If the row does not already exist and the update includes at least one non-null or non-empty value, creates a new row.

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

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

// Update a row
(async function () {
  await table.updateOne(
    {
      title: "Hidden Shadows of the Past",
      author: "John Anthony",
    },
    {
      $set: {
        rating: 4.5,
        genres: ["Fiction", "Drama"],
      },
      $unset: {
        borrower: "",
      },
    },
  );
})();

Unset columns

To unset a column, you can use the $unset operator, or you can use the $set operator and an empty value. Either operation will delete the value in the specified column.

Unsetting a column produces a tombstone. Excessive tombstones can impact query performance.

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

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

// Update a row
(async function () {
  await table.updateOne(
    {
      title: "Hidden Shadows of the Past",
      author: "John Anthony",
    },
    {
      $unset: {
        genres: "",
      },
    },
  );
})();

Client reference

For more information, see the client reference.

Update a row (TypeScript)

Result

Parameters

Examples

Update multiple columns

Unset columns

Client reference

Was this helpful?

Give Feedback