asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: fix step detection of useQueryGraphStep (#12842)

Browse Source
This commit is contained in:
Shahed Nasser
2025-06-26 19:02:27 +03:00
committed by GitHub
parent f7e4a80c30
commit 2005188192
3 changed files with 194 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx
+75 -6
View File
@@ -12,14 +12,83 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `useQueryGraphStep`. It belongs to the `@medusajs/medusa/core-flows` package.
## Type Parameters
This step fetches data across modules using the Query.
<TypeList types={[{"name":"TEntry","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
Learn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).
## Parameters
## Example
<TypeList types={[{"name":"input","type":"[UseQueryGraphStepInput](../../../../types/core_flows.UseQueryGraphStepInput/page.mdx)&#60;TEntry&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"options","type":"[RemoteJoinerOptions](../../../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"throwIfKeyNotFound","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throwIfRelationNotFound","type":"`boolean` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialData","type":"`object` \\| `object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialDataOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
To retrieve a list of records of a data model:
## Returns
```ts
const { data: products } = useQueryGraphStep({
entity: "product",
fields: [
"*",
"variants.*"
]
})
```
<TypeList types={[{"name":"ReturnType","type":"ReturnType&#60;[StepFunction](../../../../../workflows/types/workflows.StepFunction/page.mdx)&#60;[UseQueryGraphStepInput](../../../../types/core_flows.UseQueryGraphStepInput/page.mdx)&#60;TEntry&#62;, [GraphResultSet](../../../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)&#60;TEntry&#62;&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UseQueryGraphStepInput","type":"[UseQueryGraphStepInput](../../../../types/core_flows.UseQueryGraphStepInput/page.mdx)&#60;TEntry&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"GraphResultSet","type":"[GraphResultSet](../../../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)&#60;TEntry&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
To retrieve a single item instead of a an array:
```ts
const { data: products } = useQueryGraphStep({
entity: "product",
fields: [
"*",
"variants.*"
],
filters: {
id: "123"
}
})
```
To throw an error if a record isn't found matching the specified ID:
```ts
const { data: products } = useQueryGraphStep({
entity: "product",
fields: [
"*",
"variants.*"
],
filters: {
id: "123"
},
options: {
throwIfKeyNotFound: true
}
})
```
To set pagination configurations:
```ts
const { data: products } = useQueryGraphStep({
entity: "product",
fields: [
"*",
"variants.*"
],
filters: {
id: "123"
},
pagination: {
take: 10,
skip: 10,
order: {
created_at: "DESC"
}
}
})
```
## Input
<TypeList types={[{"name":"UseQueryGraphStepInput","type":"[UseQueryGraphStepInput](../../../../types/core_flows.UseQueryGraphStepInput/page.mdx)&#60;TEntry&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="useQueryGraphStep"/>
## Output
<TypeList types={[{"name":"GraphResultSet","type":"[GraphResultSet](../../../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)&#60;TEntry&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="useQueryGraphStep"/>
www/apps/resources/references/helper_steps/functions/helper_steps.useQueryGraphStep/page.mdx
+75 -6
View File
@@ -9,14 +9,83 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the `useQueryGraphStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
## Type Parameters
This step fetches data across modules using the Query.
<TypeList types={[{"name":"TEntry","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
Learn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).
## Parameters
## Example
<TypeList types={[{"name":"input","type":"[UseQueryGraphStepInput](../../types/helper_steps.UseQueryGraphStepInput/page.mdx)&#60;TEntry&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"options","type":"[RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
To retrieve a list of records of a data model:
## Returns
```ts
const { data: products } = useQueryGraphStep({
entity: "product",
fields: [
"*",
"variants.*"
]
})
```
<TypeList types={[{"name":"ReturnType","type":"ReturnType&#60;[StepFunction](../../../workflows/types/workflows.StepFunction/page.mdx)&#60;[UseQueryGraphStepInput](../../types/helper_steps.UseQueryGraphStepInput/page.mdx)&#60;TEntry&#62;, [GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)&#60;TEntry&#62;&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
To retrieve a single item instead of a an array:
```ts
const { data: products } = useQueryGraphStep({
entity: "product",
fields: [
"*",
"variants.*"
],
filters: {
id: "123"
}
})
```
To throw an error if a record isn't found matching the specified ID:
```ts
const { data: products } = useQueryGraphStep({
entity: "product",
fields: [
"*",
"variants.*"
],
filters: {
id: "123"
},
options: {
throwIfKeyNotFound: true
}
})
```
To set pagination configurations:
```ts
const { data: products } = useQueryGraphStep({
entity: "product",
fields: [
"*",
"variants.*"
],
filters: {
id: "123"
},
pagination: {
take: 10,
skip: 10,
order: {
created_at: "DESC"
}
}
})
```
## Input
<TypeList types={[{"name":"UseQueryGraphStepInput","type":"[UseQueryGraphStepInput](../../types/helper_steps.UseQueryGraphStepInput/page.mdx)&#60;TEntry&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="useQueryGraphStep"/>
## Output
<TypeList types={[{"name":"GraphResultSet","type":"[GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)&#60;TEntry&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="useQueryGraphStep"/>