Directus / @directus/sdk / rest / updateRelation
Function: updateRelation() ​
updateRelation<
Schema,TQuery>(collection,field,item,query?):RestCommand<IfAny<Schema,Record<string,any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusRelation<Schema>> extends FF ? MapFlatFields<DirectusRelation<Schema>, FieldsWildcard<DirectusRelation<Schema>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof DirectusRelation<Schema> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>,Schema>
Update an existing relation.
Type Parameters ​
• Schema
• TQuery extends Query<Schema, DirectusRelation<Schema>>
Parameters ​
• collection: string
• field: string
• item
• 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
• query?: TQuery
Returns ​
RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusRelation<Schema>> extends FF ? MapFlatFields<DirectusRelation<Schema>, FieldsWildcard<DirectusRelation<Schema>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof DirectusRelation<Schema> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>
Returns the relation object for the created relation.