Directus / @directus/sdk / rest / createRelation
Function: createRelation() ​
createRelation<
Schema>(item):RestCommand<IfAny<Schema,Record<string,any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusRelation<Schema>> extends FF ? MapFlatFields<DirectusRelation<Schema>, keyof DirectusRelation<Schema>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, Object>[K] }>,Schema>
Create a new relation.
Type Parameters ​
• Schema
Parameters ​
• item
The relation to create
• item.collection?: string
• item.field?: string
• item.meta?: NestedUnion<IfAny<Schema, object, "directus_relations" extends keyof Schema ? UnpackList<Schema[keyof Schema & "directus_relations"]> extends Item ? { [Field in string | number | symbol]: Item[Field] } & object : never : object>>
• item.related_collection?: string
• item.schema?
• item.schema.column?: string
• item.schema.constraint_name?: string
• item.schema.foreign_key_column?: string
• item.schema.foreign_key_schema?: string
• item.schema.foreign_key_table?: string
• item.schema.on_delete?: string
• item.schema.on_update?: string
• item.schema.table?: string
Returns ​
RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusRelation<Schema>> extends FF ? MapFlatFields<DirectusRelation<Schema>, keyof DirectusRelation<Schema>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, Object>[K] }>, Schema>
Returns the relation object for the created relation.