Update a row

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.

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
curl

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.

Does not return anything.

A rare edge case, related to underlying Apache Cassandra® functionality, can cause rows 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.

Updates the specified row.

Returns a promise that resolves once the operation completes.

A rare edge case, related to underlying Apache Cassandra® functionality, can cause rows 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.

Updates the specified row.

Does not return anything.

A rare edge case, related to underlying Apache Cassandra® functionality, can cause rows 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.

Updates the specified row.

A rare edge case, related to underlying Apache Cassandra® functionality, can cause rows 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.

Always returns a status.matchedCount of 1, a status.modifiedCount of 1, and a status.upsertCount of 0, regardless of the outcome.

Example response:

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

Parameters

Python
TypeScript
Java
curl

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

Method signature

update_one(
  filter: Dict[str, Any],
  update: Dict[str, Any],
  *,
  general_method_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> None

Name Type Summary

Name	Type	Summary
`filter`	`Dict[str, Any]`	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`	`Dict[str, Any]`	Defines the update using Data API operators. For a list of available operators and more examples, see Update operators for tables. 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.
`general_method_timeout_ms`	`int`	Optional. The maximum time, in milliseconds, that the client should wait for the underlying HTTP request. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience. Default: The default value for the table. This default is 30 seconds unless you specified a different default when you initialized the `Table` or `DataAPIClient` object. For more information, see Timeout options.

filter

Dict[str, Any]

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

Dict[str, Any]

Defines the update using Data API operators.

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

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.

general_method_timeout_ms

int

Optional. The maximum time, in milliseconds, that the client should wait for the underlying HTTP request.

This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

Default: The default value for the table. This default is 30 seconds unless you specified a different default when you initialized the Table or DataAPIClient object. For more information, see Timeout options.

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

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.

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

Method signature

void updateOne(
  Filter filter,
  TableUpdateOperation update
)

void updateOne(
  Filter filter,
  TableUpdateOperation update,
  TableUpdateOneOptions options
)

Name Type Summary

Name	Type	Summary
`filter`	`Filter`	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`	`TableUpdateOperation`	Defines the update using Data API operators. For a list of available operators and more examples, see Update operators for tables. 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`	`TableUpdateOneOptions`	General API options for this operation, including the timeout.

filter

Filter

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

TableUpdateOperation

Defines the update using Data API operators.

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

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

TableUpdateOneOptions

General API options for this operation, including the timeout.

Use the updateOne command.

Command signature

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

Name Type Summary

Name	Type	Summary
`filter`	`object`	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`	`object`	Defines the update using Data API operators. For a list of available operators and more examples, see Update operators for tables. 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.

filter

object

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

object

Defines the update using Data API operators.

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

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.

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.

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

Python
TypeScript
Java
curl

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

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

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

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"),
});
const table = database.table("TABLE_NAME", {
  keyspace: "KEYSPACE_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: "",
      },
    },
  );
})();

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.commands.TableUpdateOperation;
import com.datastax.astra.client.tables.definition.rows.Row;
import java.util.Arrays;
import java.util.Map;

public class Example {

  public static void main(String[] args) {
    // Get an existing table
    DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
    Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
    Table<Row> table = database.getTable("TABLE_NAME");

    // Update a row
    Filter filter =
        new Filter(
            Map.of(
                "title", "Hidden Shadows of the Past",
                "author", "John Anthony"));
    TableUpdateOperation update =
        new TableUpdateOperation()
            .set("rating", 4.5)
            .set("genres", Arrays.asList("Fiction", "Drama"))
            .unset("borrower");
    table.updateOne(filter, update);
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/TABLE_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "filter": {
      "title": "Hidden Shadows of the Past",
      "author": "John Anthony"
    },
    "update": {
        "$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 will produce a tombstone. Excessive tombstones can impact query performance. For more information, see What are tombstones.

Python
TypeScript
Java
curl

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

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

# Update a row
table.update_one({"id": "1013dr3"}, {"$unset": {"genres": ""}})

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

// Update a row
(async function () {
  await table.updateOne(
    {
      id: "1013dr3",
    },
    {
      $unset: {
        genres: "",
      },
    },
  );
})();

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.commands.TableUpdateOperation;
import com.datastax.astra.client.tables.definition.rows.Row;
import java.util.Map;

public class Example {

  public static void main(String[] args) {
    // Get an existing table
    DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
    Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
    Table<Row> table = database.getTable("TABLE_NAME");

    // Update a row
    Filter filter =
        new Filter(
            Map.of(
                "title", "Hidden Shadows of the Past",
                "author", "John Anthony"));
    TableUpdateOperation update = new TableUpdateOperation().unset("genres");
    table.updateOne(filter, update);
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/TABLE_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "updateOne": {
    "filter": {
      "id": "1013dr3"
    },
    "update": {
        "$unset": {
            "genres": ""
        }
    }
  }
}'

Client reference

Python
TypeScript
Java
curl

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

Update a row

Result

Parameters

Examples

Update multiple columns

Unset columns

Client reference

Was this helpful?

Give Feedback