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

useCreate

useCreate is used when creating new records. 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 create method as the mutation function from the dataProvider which is passed to <Refine>.

Basic Usage​

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

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

const { mutate } = useCreate();

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

Realtime Updates​

caution

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

When the useCreate 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 useCreate 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 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 useCreate mutation runs successfully, it will call the log method from auditLogProvider with some parameters such as resource, action, data etc. This 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.

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

mutate(
{
resource: "products",
values: {
name: "New Product",
material: "Wood",
},
},
{
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 create 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 create method.

const { mutate } = useCreate();

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

For more information, refer to the creating a data provider tutorial β†’

values
required
​

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

const { mutate } = useCreate();

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

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

const { mutate } = useCreate();

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

const { mutate } = useCreate();

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 create method. You can pass any properties to specifically handle the data provider methods with similar logic.

const { mutate } = useCreate();

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

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

//...
//...

const { data } = await httpClient.post(url, variables, { 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 } = useCreate();

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

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

Return Values​

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

For more information, refer to the useMutation documentation β†’

API​

Mutation Parameters​

PropertyDescriptionTypeDefault
resource
Required
Resource name for API data interactionsstring
values
Required
Values for mutation functionTVariables{}
successNotificationSuccessful Mutation notificationSuccessErrorNotification"Successfully created resource"
errorNotificationUnsuccessful Mutation notificationSuccessErrorNotification"There was an error creating 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"]

Type Parameters​

PropertyDesriptionTypeDefault
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; values: TVariables; },
unknown>