Check for and resolve schema changes
Included in the Basic API.
Before you start a data generation job, we recommend that you check for and resolve any schema changes on the source database.
In the Tonic Structural application, you can use the Schema Changes view to review and resolve any changes.
From the API, you can:
Retrieve a list of schema changes
Resolve schema changes
Retrieve the list of schema changes
To view the list of schema changes, use GET /api/SchemaDiff.
In the results, each schema change uses the following format:
Where:
Resolve selected schema changes
You can use the API to resolve specified schema changes.
When you use the API to resolve schema changes:
For non-conflicting schema changes (new tables and columns), Structural does not make any changes to the configuration.
For information on how Structural resolves conflicting schema changes, see How Structural resolves conflicting issues.
To resolve a single schema change, use POST /api/SchemaDiff/resolve. The request body provides the details for a single schema change.
To resolve multiple changes, use POST /api/SchemaDiff/resolve_multiple. The request body provides the details for each schema change.
In the request body, each schema change has the following format:
Where:
Resolving all schema changes for a workspace
To resolve all schema changes for a workspace, use:
POST /api/SchemaDiff/{workspaceId}/resolve_all
The resolutionOption
parameter identifies the types of schema changes to resolve. The options are:
All
- Indicates to resolve all of the schema changes.Actions
- Indicates to only resolve conflicting schema changes.Notifications
- Indicates to only resolve non-conflicting schema changes.
Last updated