import { TypeList } from "docs-ui" # GraphQLUtils ## Classes - [GraphQLParser](../GraphQLUtils/classes/utils.GraphQLUtils.GraphQLParser/page.mdx) ## Functions - [cleanGraphQLSchema](page.mdx#cleangraphqlschema) - [extractRelationsFromGQL](page.mdx#extractrelationsfromgql) - [gqlGetFieldsAndRelations](page.mdx#gqlgetfieldsandrelations) - [gqlSchemaToTypes](page.mdx#gqlschematotypes) - [graphqlSchemaToFields](page.mdx#graphqlschematofields) ___ ## Functions ### cleanGraphQLSchema #### Parameters #### Returns `","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cleanGraphQLSchema"/> `","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cleanGraphQLSchema"/> ### extractRelationsFromGQL Extracts only the relation fields from the GraphQL type map. #### Parameters #### Returns ### gqlGetFieldsAndRelations Generate a list of fields and fields relations for a given type with the requested relations #### Parameters #### Returns ### gqlSchemaToTypes #### Parameters `","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"interfaceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlSchemaToTypes"/> #### Returns ### graphqlSchemaToFields From graphql schema get all the fields for the requested type and relations #### Example ```ts const userModule = ` type User { id: ID! name: String! blabla: WHATEVER } type Post { author: User! } ` const postModule = ` type Post { id: ID! title: String! date: String } type User { posts: [Post!]! } type WHATEVER { random_field: String post: Post } ` const mergedSchema = mergeTypeDefs([userModule, postModule]) const schema = makeExecutableSchema({ typeDefs: mergedSchema, }) const fields = graphqlSchemaToFields(types, "User", ["posts"]) console.log(fields) // [ // "id", // "name", // "posts.id", // "posts.title", // "posts.date", // ] ``` #### Parameters #### Returns