Directus / @directus/sdk / rest / schemaDiff
Function: schemaDiff()
schemaDiff<
Schema
>(snapshot
,force
):RestCommand
<SchemaDiffOutput
,Schema
>
Compare the current instance's schema against the schema snapshot in JSON request body and retrieve the difference. This endpoint is only available to admin users.
Type parameters
• Schema extends object
Parameters
• snapshot: SchemaSnapshotOutput
JSON object containing collections, fields, and relations to apply.
• force: boolean
= false
Bypass version and database vendor restrictions.
Returns
RestCommand
<SchemaDiffOutput
, Schema
>
Returns the differences between the current instance's schema and the schema passed in the request body.