Skip to main content
Version: 4.xx.xx
Source Code

useUpdate

useUpdate is used when you want to update a record. It is an extended version of TanStack Query's useMutation that supports all of its features and adds some more.

It uses the update method as the mutation function from the dataProvider which is passed to <Refine>.

Basic Usage​

The useUpdate hook returns many useful properties and methods. One of them is the mutate method which expects values, resource, and id as parameters. These parameters will be passed to the update method from the dataProvider as parameters.

import { useUpdate } from "@refinedev/core";

const { mutate } = useUpdate();

mutate({
resource: "products",
values: {
name: "New Product",
material: "Wood",
},
id: 1,
});

Realtime Updates​

CAUTION

This feature is only available if you use a Live Provider.

When the useUpdate mutation runs successfully, it will call the publish method from liveProvider with some parameters such as channel, type etc. It 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 useUpdate mutation runs successfully, it will invalidate the following queries from the current resource: "list", "many", and "detail" by default. Which means that, if you use useList, useMany, or useOne hooks on the same page, they will refetch the data after the mutation is completed. You can change this behavior by passing the invalidates prop.

For more information, refer to the query invalidation documentation→

Audit Logs​

CAUTION

This feature is only available if you use a Audit Log Provider.

When the useUpdate mutation runs successfully, it will call the log method from auditLogProvider with some parameters such as resource, action, data, previousData etc. It is useful when you want to log the changes to the database.

For more information, refer to the auditLogProvider 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.

useUpdate({
mutationOptions: {
retry: 3,
},
});
TIP

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 } = useUpdate();

mutate(
{
resource: "products",
values: {
name: "New Product",
material: "Wood",
},
id: 1,
},
{
onError: (error, variables, context) => {
// An error occurred!
},
onSuccess: (data, variables, context) => {
// Let's celebrate!
},
},
);

Refer to the useMutation documentation for more information β†’

Mutation Parameters​

resource
required
​

This parameter will be passed to the update 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 update method.

const { mutate } = useUpdate();

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 β†’

id
required
​

This prop will be passed to the update method from the dataProvider as a parameter. It is used to determine which record to update.

const { mutate } = useUpdate();

mutate({
id: 123,
});

values
required
​

This prop will be passed to the update method from the dataProvider as a parameter. It is usually used as the data to be updated and contains the data that will be sent to the server.

const { mutate } = useUpdate();

mutate({
values: {
name: "New Category",
description: "New Category Description",
},
});

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.

const { mutate } = useUpdate();

mutate({
mutationMode: "undoable",
});

For more information, refer to the mutation mode documentation β†’

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 } = useUpdate();

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 { useUpdate } from "@refinedev/core";

const MyComponent = () => {
const { mutate } = useUpdate();
const cancelRef = useRef<(() => void) | null>(null);

const updateItem = () => {
mutate({
//...
mutationMode: "undoable",
onCancel: (cancelMutation) => {
cancelRef.current = cancelMutation;
},
});
};

const cancelUpdate = () => {
cancelRef.current?.();
};

return (
<>
<button onClick={updateItem}>Update</button>
<button onClick={cancelUpdate}>Cancel</button>
</>
);
};

successNotification​

CAUTION

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 useUpdate can calls open function from NotificationProvider:

const { mutate } = useUpdate();

mutate({
successNotification: (data, values, resource) => {
return {
message: `${data.title} Successfully fetched.`,
description: "Success with no errors",
type: "success",
};
},
});

errorNotification​

CAUTION

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 useUpdate calls the open function from NotificationProvider:

const { mutate } = useUpdate();

mutate({
errorNotification: (data, values, 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 update method. You can pass any properties to specifically handle the data provider methods with similar logic.

const { mutate } = useUpdate();

mutate({
meta: {
headers: { "x-meta-data": "true" },
},
});

const myDataProvider = {
//...
update: async ({
resource,
id,
variables,
meta,
}) => {
const headers = meta?.headers ?? {};
const url = `${apiUrl}/${resource}/${id}`;

//...
//...

const { data } = await httpClient.patch(url, variables, { headers });

return {
data,
};
},
//...
};

Refer to the meta section of the General Concepts documentation for more information β†’

dataProviderName​

This prop allows you to specify which dataProvider if you have more than one. Just pass it like in the example:

const { mutate } = useUpdate();

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", "many" and "detail". That means, if you use useList, useMany, or useOne hooks on the same page, they will refetch the data after the mutation is completed.

const { mutate } = useUpdate();

mutate({
invalidates: ["list", "many", "detail"],
});

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 } = useUpdate({
//...
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>;
}

optimisticUpdateMap​

If the mutation mode is defined as optimistic or undoable the useUpdate hook will automatically update the cache without waiting for the response from the server. You may want to disable or customize this behavior. You can do this by passing the optimisticUpdateMap prop.

When the mutation mode is set to optimistic or undoable, the useUpdate hook will automatically update the cache without waiting for a server response. If you need to customize update logic, you can achieve it by using the optimisticUpdateMap prop.

CAUTION

This feature only works when mutationMode is set to optimistic or undoable.

list, many and detail are the keys of the optimisticUpdateMap object. To automatically update the cache, you should pass true. If you don't want to update the cache, you should pass false.

const { mutate } = useUpdate();

mutate({
//...
mutationMode: "optimistic",
optimisticUpdateMap: {
list: true,
many: true,
detail: false,
},
});

In the scenario mentioned above, the list and many queries will receive automatic cache updates, whereas the detail query cache will remain unaffected.

If you wish to customize the cache update, you have the option to provide functions for the list, many, and detail keys. These functions will be invoked with the previous data, values, and id parameters. Your responsibility is to return the updated data within these functions.

const { mutate } = useUpdate();

mutate({
//...
mutationMode: "optimistic",
optimisticUpdateMap: {
list: (previous, values, id) => {
if (!previous) {
return null;
}

const data = previous.data.map((record) => {
if (record.id === id) {
return {
foo: "bar",
...record,
...values,
};
}
return record;
});

return {
...previous,
data,
};
},
many: (previous, values, id) => {
if (!previous) {
return null;
}

const data = previous.data.map((record) => {
if (record.id === id) {
return {
foo: "bar",
...record,
...values,
};
}
return record;
});

return {
...previous,
data,
};
},
detail: (previous, values) => {
if (!previous) {
return null;
}

return {
...previous,
data: {
foo: "bar",
...previous.data,
...values,
},
};
},
},
});

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 } = useUpdate();

console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...

API​

Mutation Parameters​

PropertyDescriptionTypeDefault
resource
Required
Resource name for API data interactionsstring
id
Required
id for mutation functionBaseKey
values
Required
Values for mutation functionTVariables{}
mutationModeDetermines when mutations are executed "pessimistic | "optimistic | "undoable""pessimistic"*
undoableTimeoutDuration to wait before executing the mutation when mutationMode = "undoable"number5000ms*
onCancelProvides a function to cancel the mutation when mutationMode = "undoable"(cancelMutation: () => void) => void
successNotificationSuccessful Mutation notificationSuccessErrorNotification"Successfully updated resource"
errorNotificationUnsuccessful Mutation notificationSuccessErrorNotification"Error when updating resource (status code: statusCode)"
metaMeta data query for dataProviderMetaDataQuery{}
dataProviderNameIf there is more than one dataProvider, you should use the dataProviderName that you will use.stringdefault
invalidatesYou can use it to manage the invalidations that will occur at the end of the mutation.all, resourceAll, list, many, detail, false["list", "many", "detail"]
NOTE

These props have default values in RefineContext and can also be set on <Refine> component. useUpdate will use what's passed to <Refine> as default, but a local value will override it.


Type Parameters​

PropertyDescriptionTypeDefault
TDataResult data of the mutation. Extends BaseRecordBaseRecordBaseRecord
TErrorCustom error object that extends HttpErrorHttpErrorHttpError
TVariablesValues for mutation function{}{}

Return value​

DescriptionType
Result of the TanStack Query's useMutationUseMutationResult<{ data: TData }, TError, { resource:string; id: BaseKey; values: TVariables; }, UpdateContext>*
overtime{ elapsedTime?: number }

* UpdateContext is an internal type.