Directus / @directus/sdk / rest / createCollection
Function: createCollection() ​
createCollection<
Schema
,TQuery
>(item
,query
?):RestCommand
<IfAny
<Schema
,Record
<string
,any
>,Merge
<MappedFunctionFields
<Schema
,DirectusCollection
<Schema
>> extendsFF
?MapFlatFields
<DirectusCollection
<Schema
>,FieldsWildcard
<DirectusCollection
<Schema
>,Exclude
<UnpackList
<Mutable
<TQuery
["fields"
]>>,PickRelationalFields
<UnpackList
<Mutable
<...>>> extendsnever
?never
:AllKeys
<UnpackList
<...> extendsField
? ... extends ... ? ... : ... :never
>>>,FF
extendsRecord
<string
,string
> ?FF
<FF
> :Record
<string
,string
>> :never
,PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extendsnever
?never
:{ [Field in string | number | symbol]: Field extends keyof DirectusCollection<Schema> ? Extract<DirectusCollection<Schema>[Field<Field>], ItemType<Schema>> extends RelatedCollection ? IsNullable<DirectusCollection<Schema>[Field<Field>], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>,Schema
>
Create a new Collection. This will create a new table in the database as well.
Type parameters ​
• Schema
• TQuery extends Query
<Schema
, DirectusCollection
<Schema
>>
Parameters ​
• item: NestedPartial
<DirectusCollection
<Schema
>>
This endpoint doesn't currently support any query parameters.
• query?: TQuery
Optional return data query
Returns ​
RestCommand
<IfAny
<Schema
, Record
<string
, any
>, Merge
<MappedFunctionFields
<Schema
, DirectusCollection
<Schema
>> extends FF
? MapFlatFields
<DirectusCollection
<Schema
>, FieldsWildcard
<DirectusCollection
<Schema
>, Exclude
<UnpackList
<Mutable
<TQuery
["fields"
]>>, PickRelationalFields
<UnpackList
<Mutable
<...>>> extends never
? never
: AllKeys
<UnpackList
<...> extends Field
? ... extends ... ? ... : ... : never
>>>, 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 DirectusCollection<Schema> ? Extract<DirectusCollection<Schema>[Field<Field>], ItemType<Schema>> extends RelatedCollection ? IsNullable<DirectusCollection<Schema>[Field<Field>], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>, Schema
>
The collection object for the collection created in this request.