Update operators for tables (HTTP)

For details about additional languages, see:

Some Data API commands, like Update a row (HTTP), use update operators to modify rows in a table.

Set

The $set operator sets the value of the specified column to the specified value.

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

The $unset operator sets the specified column’s value to null or the equivalent empty form, such as [] or {} for map, list, and set types.

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

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": {
        "$unset": {
            "genres": ""
        }
    }
  }
}'

Combine operators

You can use multiple update operators in a single 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": ""
        }
    }
  }
}'

Unsupported operators

$rename isn’t supported. Instead, use alterTable to add and drop columns.
$currentDate isn’t supported.
The array operators $push, $each, $pullAll, $addToSet, $pop, and $position aren’t supported.

Update operators for tables (HTTP)

Set

Unset

Combine operators

Unsupported operators

Was this helpful?

Give Feedback