Delete a row

This Astra DB Serverless feature is currently in public preview. Development is ongoing, and the features and functionality are subject to change. Astra DB Serverless, and the use of such, is subject to the DataStax Preview Terms.

The Data API tables commands are available through HTTP and the clients.

If you use a client, tables commands are available only in client versions 2.0-preview or later. For more information, see Data API client upgrade guide.

Finds a single row in a table using filter and sort clauses, and then deletes that row.

For general information about working with tables and rows, see About tables.

Method signature

  • Python

  • TypeScript

  • Java

  • curl

The following method belongs to the astrapy.Table class.

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

The following method belongs to the Table class.

async deleteOne(
  filter: TableFilter<WSchema>,
  timeout?: number | TimeoutDescriptor,
): void

The following methods belong to the com.datastax.astra.client.tables.Table class.

void deleteOne(Filter filter)
void deleteOne(
  Filter filter,
  TableDeleteOneOptions options
)
curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_TABLE" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "deleteOne": {
    "filter": FILTER,
  }
}'

Result

  • Python

  • TypeScript

  • Java

  • curl

Deletes a row that matches the specified parameters. If no rows match the specified parameters, this method does not delete any rows.

Does not return anything.

Deletes a row that matches the specified parameters. If no rows match the specified parameters, this method does not delete any rows.

Returns a promise that resolves once the operation completes.

Deletes a row that matches the specified parameters. If no rows match the specified parameters, this method does not delete any rows.

Does not return anything.

Deletes a row that matches the specified parameters. If no rows match the specified parameters, this method does not delete any rows.

Always returns a status.deletedCount of -1, regardless of whether a row was found and deleted.

Example response:

{
  "status": {
    "deletedCount": -1
  }
}

Parameters

  • Python

  • TypeScript

  • Java

  • curl

Name Type Summary

filter

dict

Describes the full primary key of the row. The row matching that primary key will be deleted.

Only the the $eq operator is allowed in delete_one.

general_method_timeout_ms

int | None

A timeout, in milliseconds, to impose on the underlying API request. If not provided, the Table defaults apply. This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

Name Type Summary

filter

TableFilter

Describes the full primary key of the row. The row matching that primary key will be deleted.

Only the the $eq operator is allowed in deleteOne.

timeout?

WithTimeout

The client-side timeout for this operation.

Name Type Summary

filter

Filter

Describes the row to delete by its primary key values.

You cannot filter on non-primary keys.

Only the the $eq operator is allowed in deleteOne.

Filters can be instantiated with its constructor and specialized with method where(..) or leverage the class Filters

options

TableDeleteOneOptions

Operations to be applied to the delete operation like (mostly) timeout.

Name Type Summary

deleteOne

command

The Data API command to find and delete the first row in a table that matches the given filter criteria. If there is no match, then no action is taken.

filter

object

Key-value pairs describing the full primary key of the row to delete.

Only the the $eq operator is allowed in deleteOne.

Examples

  • Python

  • TypeScript

  • Java

  • curl

Find a row by its primary key, and then delete it:

my_table.delete_one({"match_id": "fight7", "round": 2})
Full example script
from astrapy import DataAPIClient
client = DataAPIClient("TOKEN")
database = client.get_database("API_ENDPOINT")

from astrapy.constants import SortMode
from astrapy.info import (
    CreateTableDefinition,
    ColumnType,
)

my_table = database.create_table(
    "games",
    definition=(
        CreateTableDefinition.builder()
        .add_column("match_id", ColumnType.TEXT)
        .add_column("round", ColumnType.TINYINT)
        .add_vector_column("m_vector", dimension=3)
        .add_column("score", ColumnType.INT)
        .add_column("when", ColumnType.TIMESTAMP)
        .add_column("winner", ColumnType.TEXT)
        .add_set_column("fighters", ColumnType.UUID)
        .add_partition_by(["match_id"])
        .add_partition_sort({"round": SortMode.ASCENDING})
        .build()
    ),
)

insert_result = my_table.insert_many(
    [
        {"match_id": "fight7", "round": 1, "winner": "Joy"},
        {"match_id": "fight7", "round": 2, "winner": "Kevin"},
        {"match_id": "fight7", "round": 3, "winner": "Lauretta"},
    ],
)

# Count the rows matching a certain filter
len(my_table.find({"match_id": "fight7"}).to_list())
# 3

# Delete a row belonging to the group
my_table.delete_one({"match_id": "fight7", "round": 2})

# Count again
len(my_table.find({"match_id": "fight7"}).to_list())
# 2

# Attempt the delete again (nothing to delete)
my_table.delete_one({"match_id": "fight7", "round": 2})

# The count is unchanged
len(my_table.find({"match_id": "fight7"}).to_list())
# 2

Example:

# Count the rows matching a certain filter
len(my_table.find({"match_id": "fight7"}).to_list())
# 3

# Delete a row belonging to the group
my_table.delete_one({"match_id": "fight7", "round": 2})

# Count again
len(my_table.find({"match_id": "fight7"}).to_list())
# 2

# Attempt the delete again (nothing to delete)
my_table.delete_one({"match_id": "fight7", "round": 2})

# The count is unchanged
len(my_table.find({"match_id": "fight7"}).to_list())
# 2

Find a row by its primary key, and then delete it:

await table.deleteOne({ matchId: 'fight7', round: 2 });

Example:

Full script
import { CreateTableDefinition, DataAPIClient, InferTablePrimaryKey, InferTableSchema, timestamp, uuid, vector } from '@datastax/astra-db-ts';

// Instantiate the client and connect to the database
const client = new DataAPIClient();
const db = client.db(process.env.CLIENT_DB_URL!, { token: process.env.CLIENT_DB_TOKEN! });

// Create table schema using bespoke Data API table definition syntax, and then infer the type.
// For information about table typing and definitions, see the documentation for createTable.
const TableDefinition = <const>{
  columns: {
    matchId: 'text'
    round: 'tinyint',
    mVector: { type: 'vector', dimension: 3 },
    score: 'int',
    when: 'timestamp',
    winner: 'text',
    fighters: { type: 'set', valueType: 'uuid' },
  },
  primaryKey: {
    partitionBy: ['matchId'],
    partitionSort: { round: 1 },
  },
} satisfies CreateTableDefinition;

type TableSchema = InferTableSchema<typeof TableDefinition>;

(async function () {
  // Create a table with the given TableSchema type if a 'games' table doesn't already exist
  const table = await db.createTable<TableSchema>('games', { definition: TableDefinition, ifNotExists: true });

  // Insert some rows in an unordered fashion.
  await table.insertMany([
    { matchId: 'fight4', round: 1, winner: 'Victor' },
    { matchId: 'fight5', round: 1, winner: 'Adam' },
    { matchId: 'fight5', round: 2, winner: 'Betta' },
    { matchId: 'fight5', round: 3, winner: 'Caio' },
    { matchId: 'fight7', round: 1, winner: 'Joy' },
    { matchId: 'fight7', round: 2, winner: 'Kevin' },
    { matchId: 'fight7', round: 3, winner: 'Lauretta' },
  ]);

// Use deleteOne and deleteMany to remove rows from a table.

// deleteOne examples (with 'find' to demonstrate that the row was deleted)

  // Find rows where 'matchId' is 'fight7'
  await table.find({ matchId: 'fight7' }).toArray().then(rs => console.log(rs.length));

  // Delete one of the 'fight7' rows
  await table.deleteOne({ matchId: 'fight7', round: 2 });

  // Find the 'fight7' rows again
  // The deleted row should not be returned
  await table.find({ matchId: 'fight7' }).toArray().then(rs => console.log(rs.length));

  // Attempt to delete the same 'fight7' row again
  // Although the operation succeeds, nothing happens if the row was already deleted
  await table.deleteOne({ matchId: 'fight7', round: 2 });

  // Find the 'fight7' rows once again
  // The same rows are returned as the previous attempt because the row was already deleted
  await table.find({ matchId: 'fight7' }).toArray().then(rs => console.log(rs.length));

// deleteMany examples

  // To use deleteMany to delete one row, specify the full primary key
  await table.deleteMany({ matchId: 'fight4', round: 1 });

  // To delete part of a partition, use an inequality operator on the table's final 'partitionSort' column
  // This example deletes all rows where 'matchId' is 'fight5' and 'round' is greater than or equal to 5
  await table.deleteMany({ matchId: 'fight5', round: { $gte: 5 } });

  // To delete an entire partition, do not specify 'partitionSort' columns
  // This example deletes all rows where 'matchId' is 'fight6'
  await table.deleteMany({ matchId: 'fight7' });

  // To delete all rows in the table, pass an empty filter
  await table.deleteMany({});

  // Uncomment the following line to drop the table and any related indexes.
  // await table.drop();
})();
// Find rows where 'matchId' is 'fight7'
await table.find({ matchId: 'fight7' }).toArray().then(rs => console.log(rs.length));

// Delete one of the 'fight7' rows
await table.deleteOne({ matchId: 'fight7', round: 2 });

// Find the 'fight7' rows again
// The deleted row should not be returned
await table.find({ matchId: 'fight7' }).toArray().then(rs => console.log(rs.length));

// Attempt to delete the same 'fight7' row again
// Although the operation succeeds, nothing happens if the row was already deleted
await table.deleteOne({ matchId: 'fight7', round: 2 });

// Find the 'fight7' rows once again
// The same rows are returned as the previous attempt because the row was already deleted
await table.find({ matchId: 'fight7' }).toArray().then(rs => console.log(rs.length));

Find a row by its primary key, and then delete it:

Filter filter = and(
   eq("match_id", "fight7"),
   eq("round", 2));

// No options
tableRow.deleteOne(filter);

// Using Options
tableRow.deleteOne(filter, new TableDeleteOneOptions()
  .timeout(1000));

Example:

package com.datastax.astra.client.tables;

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.commands.TableUpdateOperation;
import com.datastax.astra.client.tables.commands.options.TableDeleteOneOptions;
import com.datastax.astra.client.tables.commands.options.TableUpdateOneOptions;
import com.datastax.astra.client.tables.definition.rows.Row;

import java.util.Set;

import static com.datastax.astra.client.core.query.Filters.and;
import static com.datastax.astra.client.core.query.Filters.eq;

public class DeleteOne {
 public static void main(String[] args) {
  Database db = new DataAPIClient("token").getDatabase("endpoint");

  Table<Row> tableRow = db.getTable("games");

  // Update
  Filter filter = and(
    eq("match_id", "fight7"),
    eq("round", 2));

  tableRow.deleteOne(filter);
  tableRow.deleteOne(filter, new TableDeleteOneOptions()
          .timeout(1000));

 }

}

Find a row by its primary key, and then delete it:

curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_TABLE" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "deleteOne": {
    "filter": {
      "PRIMARY_KEY_COLUMN": "PRIMARY_KEY_VALUE"
    }
  }
}' | jq

Client reference

  • Python

  • TypeScript

  • Java

  • curl

For more information, see the client reference.

For more information, see the client reference.

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2025 DataStax | 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: +1 (650) 389-6000, info@datastax.com