useUpdate

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 "@pankod/refine-core";

const { mutate } = useUpdate();

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

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.

Refer to the liveProvider documentation for more information →

When the useUpdate mutation runs successfully, by default it will invalidate 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. You can change this behavior by passing invalidates prop.

Refer to the query invalidation documentation for more information →

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.

Refer to the auditLogProvider documentation for more information →

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 →

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

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!
    },
  },
);

It will be passed to the update method from the dataProvider as a parameter. The parameter is usually used as an API endpoint path. It all depends on how to handle the resource in the update method. See the creating a data provider section for an example of how resources are handled.

const { mutate } = useUpdate();

mutate({
  resource: "categories",
});

It 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,
});

It will be passed to the update method from the dataProvider as a parameter. The parameter is usually used as the data to be updated. It contains the new values of the record.

const { mutate } = useUpdate();

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

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.

Refer to the mutation mode documentation for more information →

const { mutate } = useUpdate();

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

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,
});

When mutationMode is set to undoable, onCancel is used to determine what to do when the user cancels the mutation.

const { mutate } = useUpdate();

mutate({
  mutationMode: "undoable",
  onCancel: (cancelMutation) => {
    cancelMutation();
    // you can do something else here
  },
});

NotificationProvider is required for this prop to work.

After data is fetched successfully, useUpdate can call open function from NotificationProvider to show a success notification. With this prop, you can customize the success notification.

const { mutate } = useUpdate();

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

NotificationProvider is required for this prop to work.

After data fetching is failed, useUpdate will call the open function from NotificationProvider to show an error notification. With this prop, you can customize the error notification.

const { mutate } = useUpdate();

mutate({
  errorNotification: (data, values, resource) => {
    return {
      message: `Something went wrong when getting ${data.id}`,
      description: "Error",
      type: "error",
    };
  },
});

metaData is used following two purposes:

• To pass additional information to data provider methods.
• Generate GraphQL queries using plain JavaScript Objects (JSON). Please refer GraphQL for more information.

In the following example, we pass the headers property in the metaData object to the update method. With similar logic, you can pass any properties to specifically handle the data provider methods.

const { mutate } = useUpdate();

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

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

    //...
    //...

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

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

If there is more than one dataProvider, you can specify which one to use by passing the dataProviderName prop. It is useful when you have a different data provider for different resources.

const { mutate } = useUpdate();

mutate({
  dataProviderName: "second-data-provider",
});

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"],
});

Returns an object with TanStack Query's useMutation return values.

Refer to the useMutation documentation for more information →

*: 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.

* UpdateContext is an internal type.