useCreateMany
useCreateMany
is used for creating multiple 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 createMany
method as the mutation function from the dataProvider
which is passed to <Refine>
.
If your data provider does not have a createMany
method, useCreateMany
will use the create
method instead. This is not recommended, since it will make requests one by one for each record.
It is better to implement the createMany
method in the data provider.
Basic Usage
The useCreateMany
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 createMany
method from the dataProvider
as parameters.
import { useCreateMany } from "@refinedev/core";
const { mutate } = useCreateMany();
mutate({
resource: "products",
values: [
{
name: "Product 1",
material: "Wood",
},
{
name: "Product 2",
material: "Metal",
},
],
});
Realtime Updates
This feature is only available if you use a Live Provider.
When the useCreateMany
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 useCreateMany
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 in 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 →
Audit Logs
This feature is only available if you use a Audit Log Provider.
When the useCreateMany
mutation runs successfully, it will call the log
method from auditLogProvider
with some parameters such as resource
, action
, data
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.
Refer to the useMutation
documentation for more information →
useCreateMany({
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 } = useCreateMany();
mutate(
{
resource: "products",
values: [
{
name: "Product 1",
material: "Wood",
},
{
name: "Product 2",
material: "Metal",
},
],
},
{
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 } = useCreateMany({
//...
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 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 } = useCreateMany();
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 →
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 } = useCreateMany();
mutate({
values: [
{
name: "Product 1",
material: "Wood",
},
{
name: "Product 2",
material: "Metal",
},
],
});
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 useCreateMany
calls the open
function from NotificationProvider
:
const { mutate } = useCreateMany();
mutate({
successNotification: (data, values, 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 useCreateMany
calls the open
function from NotificationProvider
const { mutate } = useCreateMany();
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 } = useCreateMany();
mutate({
meta: {
headers: { "x-meta-data": "true" },
},
});
const myDataProvider = {
//...
createMany: 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 } = useCreateMany();
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 } = useCreateMany();
mutate({
invalidates: ["list", "many"],
});
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 } = useCreateMany();
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 | |
values Required | Values for mutation function | TVariables[] | [{}] |
successNotification | Successful Mutation notification | SuccessErrorNotification | "Successfully created resource s" |
errorNotification | Unsuccessful Mutation notification | SuccessErrorNotification | "There was an error creating 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"] |
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; values: TVariables[]; }, unknown> |
overtime | { elapsedTime?: number } |