`deleteDataset`

Deletes a specific CRM Analytics dataset by ID or developer name.

Syntax

1import { deleteDataset } from 'lightning/analyticsWaveApi';
2deleteDataset({ datasetIdOrApiName: string }): Promise<void>

CRM Analytics API Resource

1DELETE /wave/datasets/${datasetIdOrApiName}

deleteDataset uses this CRM Analytics API resource.

Parameters

Parameter Name	Type	Description	Required?
`datasetIdOrApiName`	String	The ID or developer name of the dataset.

Returns

The return type is void.

Usage

There are several ways to use deleteDataset. For example, you can display a list of datasets and enable delete on each dataset on the list.

This example adds a delete button to a page with datasets. Deleting a dataset displays a toast message using the lightning/platformShowToastEvent module.

1import { LightningElement, api } from "lwc";
2import { deleteDataset } from "lightning/analyticsWaveApi";
3import { ShowToastEvent } from "lightning/platformShowToastEvent";
4
5export default class DeleteDataset extends LightningElement {
6  @api idOrApiName; // or fetch the ID or developer name
7
8  delete(event) {
9    deleteDataset({ datasetIdOrApiName: this.idOrApiName })
10      .then(() => {
11        this.dispatchEvent(
12          new ShowToastEvent({
13            title: "Success",
14            message: "Dataset Deleted",
15            variant: "success",
16          }),
17        );
18      })
19      .catch((error) => {
20        this.dispatchEvent(
21          new ShowToastEvent({
22            title: "Error deleting dataset",
23            message: error.body.message,
24            variant: "error",
25          }),
26        );
27      });
28  }
29}

This button calls the deleteDataset() method.

1<template>
2  <lightning-button
3    label="Delete"
4    icon-name="utility:delete"
5    icon-position="right"
6    onclick={delete}
7  >
8  </lightning-button>
9</template>