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, {}>[K] }>, Schema>

Defined in: rest/commands/create/relations.ts:20

Create a new relation.

Type Parameters ​

• Schema

Parameters ​

item ​

The relation to create

collection? ​

string

field? ​

string

meta? ​

NestedUnion<IfAny<Schema, { id: number; junction_field: null | string; many_collection: null | string; many_field: null | string; one_allowed_collections: null | string; one_collection: null | string; one_collection_field: null | string; one_deselect_action: string; one_field: null | string; sort_field: null | string; system: null | boolean; }, "directus_relations" extends keyof Schema ? UnpackList<Schema[keyof Schema & "directus_relations"]> extends Item ? { [Field in string | number | symbol]: Item[Field] } & object : never : object>>

related_collection? ​

string

schema? ​

{ column: string; constraint_name: string; foreign_key_column: string; foreign_key_schema: string; foreign_key_table: string; on_delete: string; on_update: string; table: string; }

schema.column? ​

string

schema.constraint_name? ​

string

schema.foreign_key_column? ​

string

schema.foreign_key_schema? ​

string

schema.foreign_key_table? ​

string

schema.on_delete? ​

string

schema.on_update? ​

string

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, {}>[K] }>, Schema>

Returns the relation object for the created relation.