Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / schemaDiff

Function: schemaDiff() ​

schemaDiff<Schema>(snapshot, force): RestCommand<SchemaDiffOutput, Schema>

Defined in: rest/commands/schema/diff.ts:17

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

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.