/projects/{project_id}/branches/{branch_id}/compare_schemaCompare database schema
Compares the schema from the specified database with another branch's schema.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/compare_schema?db_name=$DB_NAME" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createApiClient } from '@neondatabase/api-client';
const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.getProjectBranchSchemaComparison({ projectId: process.env.PROJECT_ID, branchId: process.env.BRANCH_ID, db_name: process.env.DB_NAME, timestamp: "2022-11-30T20:09:48Z", base_timestamp: "2022-11-30T20:09:48Z" });Parameters
project_idThe Neon project ID
branch_idThe branch ID
base_branch_idThe branch ID to compare the schema with
db_nameName of the database for which the schema is retrieved
lsnThe Log Sequence Number (LSN) for which the schema is retrieved
timestampThe point in time for which the schema is retrieved
base_lsnThe Log Sequence Number (LSN) for the base branch schema
base_timestampThe point in time for the base branch schema
Response
200Difference between the schemas
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.