useDeleteMany
useDeleteMany
is used when you want to delete multiple records at once. It is an extended version of TanStack Query's useMutation
and not only supports all features of the mutation but also adds some extra features.
It uses the deleteMany
method as the mutation function from the dataProvider
which is passed to <Refine>
.
If your data provider does not have a deleteMany
method, useDeleteMany
will use the deleteOne
method instead. This is not recommended since it will make requests one by one for each id.
It is better to implement the deleteMany
method in the data provider.
Basic Usage
The useDeleteMany
hook returns many useful properties and methods. One of them is the mutate
method which expects resource
and ids
as parameters. These parameters will be passed to the deleteMany
method from the dataProvider
as parameters.
import { useDeleteMany } from "@refinedev/core";
const { mutate } = useDeleteMany();
mutate({
resource: "products",
ids: [1, 2, 3],
});
Realtime Updates
This feature is only available if you use a Live Provider.
When the useDeleteMany
mutation runs successfully, it will call the publish
method from liveProvider
with some parameters such as channel
, type
etc. This is useful when you want to publish the changes to the subscribers on the client side.
For more information, refer to the
liveProvider
documentation →
Invalidating Queries
When the useDeleteMany
mutation runs successfully, it will invalidate the following queries from the current resource
: "list"
and "many"
by default. Which means that, if you use useList
or useMany
hooks on the same page, they will refetch the data after the mutation is completed. You can change this behavior by passing invalidates
prop.
For more information, refer to the invalidation documentation →
Properties
mutationOptions
mutationOptions
is used to pass options to the useMutation
hook. It is useful when you want to pass additional options to the useMutation
hook.
Refer to the useMutation
documentation for more information →
useDeleteMany({
mutationOptions: {
retry: 3,
},
});
mutationOptions
does not support onSuccess
and onError
props because they override the default onSuccess
and onError
functions. If you want to use these props, you can pass them to mutate functions like this:
const { mutate } = useDeleteMany();
mutate(
{
resource: "products",
ids: [1, 2, 3],
},
{
onError: (error, variables, context) => {
// An error occurred!
},
onSuccess: (data, variables, context) => {
// Let's celebrate!
},
},
);
overtimeOptions
If you want loading overtime for the request, you can pass the overtimeOptions
prop to the this hook. It is useful when you want to show a loading indicator when the request takes too long.
interval
is the time interval in milliseconds. onInterval
is the function that will be called on each interval.
Return overtime
object from this hook. elapsedTime
is the elapsed time in milliseconds. It becomes undefined
when the request is completed.
const { overtime } = useDeleteMany({
//...
overtimeOptions: {
interval: 1000,
onInterval(elapsedInterval) {
console.log(elapsedInterval);
},
},
});
console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...
// You can use it like this:
{elapsedTime >= 4000 && <div>this takes a bit longer than expected</div>}
Mutation Parameters
resource
required
This parameter will be passed to the deleteMany
method from the dataProvider
as a parameter. It is usually used as an API endpoint path but it all depends on how you handle the resource
in the deleteMany
method.
const { mutate } = useDeleteMany();
mutate({
resource: "categories",
});
For more information, refer to the creating a data provider tutorial →
If you have multiple resources with the same name, you can pass the identifier
instead of the name
of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name
of the resource defined in the <Refine/>
component.
For more information, refer to the
identifier
of the<Refine/>
component documentation →
ids
required
This parameter will be passed to the deleteMany
method from the dataProvider
as a parameter. It is used to determine which records to deleted.
const { mutate } = useDeleteMany();
mutate({
ids: [1, 2, 3],
});
mutationMode
Mutation mode determines which mode the mutation runs with. Mutations can run under three different modes: pessimistic
, optimistic
, and undoable
. The default mode is pessimistic
.
Each mode corresponds to a different type of user experience.
For more information, refer to the mutation mode documentation →
const { mutate } = useDeleteMany();
mutate({
mutationMode: "undoable",
});
undoableTimeout
When mutationMode
is set to undoable
, undoableTimeout
is used to determine the duration to wait before executing the mutation. The default value is 5000
milliseconds.
const { mutate } = useDeleteMany();
mutate({
mutationMode: "undoable",
undoableTimeout: 10000,
});
onCancel
The onCancel
property can be utilized when the mutationMode
is set to "undoable"
. It provides a function that can be used to cancel the ongoing mutation.
By defining onCancel
, undoable notification will not be shown automatically. This gives you the flexibility to handle the cancellation process in your own way, such as showing a custom notification or implementing any other desired behavior to allow users to cancel the mutation.
import { useRef } from "react";
import { useDeleteMany } from "@refinedev/core";
const MyComponent = () => {
const { mutate } = useDeleteMany();
const cancelRef = useRef<(() => void) | null>(null);
const deleteItems = () => {
mutate({
//...
mutationMode: "undoable",
onCancel: (cancelMutation) => {
cancelRef.current = cancelMutation;
},
});
};
const cancelDelete = () => {
cancelRef.current?.();
};
return (
<>
<button onClick={deleteItems}>Delete</button>
<button onClick={cancelDelete}>Cancel</button>
</>
);
};
successNotification
NotificationProvider
is required for this prop to work.
This prop allows you to customize the success notification that shows up when the data is fetched successfully and useDeleteMany
calls open
function from NotificationProvider
:
const { mutate } = useDeleteMany();
mutate({
successNotification: (data, ids, resource) => {
return {
message: `${data.title} Successfully fetched.`,
description: "Success with no errors",
type: "success",
};
},
});
errorNotification
NotificationProvider
is required for this prop to work.
This prop allows you to customize the error notification that shows up when the data fetching fails and the useDeleteMany
calls open
function from NotificationProvider
:
const { mutate } = useDeleteMany();
mutate({
errorNotification: (data, ids, resource) => {
return {
message: `Something went wrong when getting ${data.id}`,
description: "Error",
type: "error",
};
},
});
meta
meta
is a special property that can be used to pass additional information to data provider methods for the following purposes:
- Customizing the data provider methods for specific use cases.
- Generating GraphQL queries using plain JavaScript Objects (JSON).
In the following example, we pass the headers
property in the meta
object to the deleteMany
method. You can pass any properties to specifically handle the data provider methods with similar logic.
const { mutate } = useDeleteMany();
mutate({
meta: {
headers: { "x-meta-data": "true" },
},
});
const myDataProvider = {
//...
deleteMany: async ({
resource,
ids,
meta,
}) => {
const headers = meta?.headers ?? {};
const url = `${apiUrl}/${resource}`;
//...
//...
const { data } = await httpClient.delete(url, { ids }, { headers });
return {
data,
};
},
//...
};
For more information, refer to the
meta
section of the General Concepts documentation→
dataProviderName
This prop allows you to specify which dataProvider
if you have more than one. Just pass it like in the example:
const { mutate } = useDeleteMany();
mutate({
dataProviderName: "second-data-provider",
});
invalidates
invalidates
is used to specify which queries should be invalidated after the mutation is completed.
By default, it invalidates the following queries from the current resource
: "list"
and "many"
. That means, if you use useList
or useMany
hooks on the same page, they will refetch the data after the mutation is completed.
const { mutate } = useDeleteMany();
mutate({
invalidates: ["list", "many", "detail"],
});
Return Values
Returns an object with TanStack Query's useMutation
return values.
For more information, refer to the
useMutation
documentation →
Additional Values
overtime
overtime
object is returned from this hook. elapsedTime
is the elapsed time in milliseconds. It becomes undefined
when the request is completed.
const { overtime } = useDeleteMany();
console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...
API
Mutation Parameters
Property | Description | Type | Default |
---|---|---|---|
resource Required | Resource name for API data interactions | string | |
ids Required | ids for mutation function | BaseKey[] | |
mutationMode | Determines when mutations are executed | "pessimistic | "optimistic | "undoable" | "pessimistic" * |
undoableTimeout | Duration to wait before executing the mutation when mutationMode = "undoable" | number | 5000ms * |
onCancel | Provides a function to cancel the mutation when mutationMode = "undoable" | (cancelMutation: () => void) => void | |
successNotification | Successful Mutation notification | SuccessErrorNotification | "Successfully deleted resource " |
errorNotification | Unsuccessful Mutation notification | SuccessErrorNotification | "Error when updating resource (status code: statusCode )" |
meta | Meta data query for dataProvider | MetaDataQuery | {} |
dataProviderName | If there is more than one dataProvider , you should use the dataProviderName that you will use. | string | default |
invalidates | You can use it to manage the invalidations that will occur at the end of the mutation. | all , resourceAll , list , many , detail , false | ["list", "many"] |
These props have default values in RefineContext
and can also be set on <Refine>
component. useDeleteMany
will use what is passed to <Refine>
as default but a local value will override it.
Type Parameters
Property | Desription | Type | Default |
---|---|---|---|
TData | Result data of the mutation. Extends BaseRecord | BaseRecord | BaseRecord |
TError | Custom error object that extends HttpError | HttpError | HttpError |
TVariables | Values for mutation function | {} | {} |
Return value
Description | Type |
---|---|
Result of the TanStack Query's useMutation | UseMutationResult<{ data: TData }, TError, { resource: string; ids: BaseKey[]; }, DeleteContext> * |
overtime | { elapsedTime?: number } |
- Basic Usage
- Realtime Updates
- Invalidating Queries
- Properties
mutationOptions
overtimeOptions
- Mutation Parameters
resource
ids
mutationMode
undoableTimeout
onCancel
successNotification
errorNotification
meta
dataProviderName
invalidates
- Return Values
- Additional Values
overtime
- API
- Mutation Parameters
- Type Parameters
- Return value