import { TypeList } from "docs-ui"

JoinerServiceConfig

<TypeList types={[{"name":"serviceName","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"string[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"JoinerServiceConfigAlias \| JoinerServiceConfigAlias[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"string \| string[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filterable","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"Record<string, any>","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fieldAlias","type":"Record<string, string \\| object>","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\_price\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"path","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"forwardArgumentsOnPath","type":"string[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"relationships","type":"JoinerRelationship[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"boolean","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"boolean","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"Record<string, any>","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"extends","type":"object[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"JoinerRelationship","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"string","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"boolean","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"boolean","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"Record<string, any>","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"entity","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"args","type":"Record<string, any>","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="JoinerServiceConfig"/>