Developer Platform
Database contract lock files
Generate, diff, and verify safe schema signatures without exposing tables, stored procedures, DSNs, or database credentials.
Database contract discovery helps an integration detect a reviewed application-contract change before deployment. It returns safe logical signatures for the tenant planes; it does not turn the Developer API into a database browser.
API and CLI
GET /v1/apps/{saasAppId}/db/contracts
bwhq db contracts generate --output ./bwhq-contract.lock.json
bwhq db contracts diff --file ./bwhq-contract.lock.json
bwhq db contracts verify --file ./bwhq-contract.lock.json
Recommended CI pattern
- Generate and review a lock file for the target application environment.
- Commit the lock file with the integration that depends on it.
- Run
diffwhen evaluating an environment change. - Run
verifybefore deployment and stop if reviewed signatures differ.
The response intentionally omits physical database names, DSNs, server addresses, table browsing, and procedure source. Application code continues to use REST/SDK resources; the lock file is compatibility evidence, not a query interface.
Treat contract drift like an API change: review it deliberately, update tests, and record the new lock only after the integration is compatible.