A plan compiled to statements, recording nothing

POST

/provision/databases/{id}/migrations/preview

What POST /migrations would run, for a reviewer — or prorm db push --dry-run — that wants to see the statements first. Column types may be engine types (VARCHAR(200)) or the ORM's own (STRING(200), BOOLEAN, ENUM('a','b')), which are rendered for this database's engine; that is also true of POST /migrations itself.

Capability: migration:write (area resource, on the database).

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The statements

Bodyapplication/json

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.prod-orm.io/provision/databases//migrations/preview' \
--header 'Content-Type: application/json' \
--data '{
    "operations": [
        {
            "op": "createTable",
            "table": "string",
            "name": "string",
            "columns": {},
            "definition": {},
            "fields": [
                "string"
            ]
        }
    ]
}'

Response Example

{
    "dialect": "string",
    "statements": [
        "string"
    ]
}

Modified at 2026-10-05 14:01:12

The extensions installed in it

The migrations recorded for it