Delete rows (TypeScript)

Finds rows in a table using filter clauses, and then deletes those rows.

If you don’t use a filter, or if you use an empty filter, then this method deletes all rows in the table.

Deleting rows produces tombstones. Excessive tombstones can impact query performance.

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

Deletes rows that match 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.

Parameters

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

Method signature

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

Name Type Summary

filter

TableFilter

The filter criteria, defined using the Data API filter syntax.

If not empty, the filter depends on the table’s primary key definition:

For tables with a single-column primary key: the filter must include the primary key, and it cannot include any other columns.
For tables with a composite primary key: the filter must include all partition keys, and it cannot include any columns outside of the primary key definition.
For tables with a compound primary key: the filter must include all partition keys. It can include optional clustering keys, but it cannot include columns outside of the primary key definition.

If you include clustering keys, you must include them in the order specified in the primary key definition. You can omit clustering keys, but you cannot skip any clustering keys. For example, if you have three clustering keys, a, b, and c, then you can include a and omit b and c. However, if you include b, then you must also include a.

Additionally, clustering keys allow only the $eq operator, with the exception of the last clustering key in the table’s primary key definition, which allows $eq, $ne, or range operators ($gt, $gte, $lt, and $lte). For example, if your table has three clustering keys, a, b, and c, then you can only use range operators with c.

If you don’t use a filter, or if you use an empty filter, then this method deletes all rows in the table.

options.timeout

number | TimeoutDescriptor

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

Examples

The following examples demonstrate how to delete rows in a table.

Delete a row by primary key

If the filter specifies the full primary key, only the row matching that full primary key is deleted.

In the following example, the table has a composite primary key with the columns title and author.

For more information, see Primary keys in tables (TypeScript) and Filter operators for tables (TypeScript).

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

// Delete rows
(async function () {
  const result = await table.deleteMany({
    title: "Hidden Shadows of the Past",
    author: "John Anthony",
  });

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

Delete rows in a table with a single-column primary key

If the table has a single-column primary key, the filter must include the column in the primary key, and it cannot include any other columns.

In the following example, the table has a single-column primary key with the column title.

For more information, see Primary keys in tables (TypeScript) and Filter operators for tables (TypeScript).

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

// Delete rows
(async function () {
  const result = await table.deleteMany({
    title: "Hidden Shadows of the Past",
  });

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

Delete rows in a table with a composite primary key

If the table has a composite primary key, the filter must include all columns in the primary key definition (all partition keys), and it cannot include any other columns.

In the following example, the table has a composite primary key with the columns title and author.

For more information, see Primary keys in tables (TypeScript) and Filter operators for tables (TypeScript).

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

// Delete rows
(async function () {
  const result = await table.deleteMany({
    title: "Hidden Shadows of the Past",
    author: "John Anthony",
  });

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

Delete rows in a table with a compound primary key

If the table has a compound primary key, the filter must include all of the partition (grouping) columns in the primary key.

The filter can also include clustering (sorting) columns from the primary key:

The order of the clustering columns in the filter must match the order in the primary key definition. You can omit clustering keys, but you cannot skip any clustering keys. For example, if you have three clustering keys, a, b, and c, then you can include a and omit b and c. However, if you include b, then you must also include a.
The last clustering column can use range operators ($gt, $gte, $lt, and $lte) or the $eq operator. All other clustering columns can only use the $eq operator. For example, if your table has three clustering keys, a, b, and c, then you can only use range operators with c.

The filter cannot include any other columns.

In the following example, the table has a compound primary key with the partition column title and the clustering column rating.

For more information, see Primary keys in tables (TypeScript) and Filter operators for tables (TypeScript).

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

// Delete rows
(async function () {
  const result = await table.deleteMany({
    title: "Hidden Shadows of the Past",
    rating: 4,
  });

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

Delete all rows

To delete all rows, use an empty filter.

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

// Delete rows
(async function () {
  const result = await table.deleteMany({});

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

Client reference

For more information, see the client reference.

Delete rows (TypeScript)

Result

Parameters

Examples

Delete a row by primary key

Delete rows in a table with a single-column primary key

Delete rows in a table with a composite primary key

Delete rows in a table with a compound primary key

Delete all rows

Client reference

Was this helpful?

Give Feedback