Sign in
Branch

Compare database schema

Compares the schema from the specified database with another branch's schema.

get/projects/{project_id}/branches/{branch_id}/compare_schema

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/compare_schema
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Path parameters

project_idstring required

The Neon project ID

branch_idstring required

The branch ID

Query parameters

base_branch_idstring

The branch ID to compare the schema with

db_namestring required

Name of the database for which the schema is retrieved

lsnstring

The Log Sequence Number (LSN) for which the schema is retrieved

timestampstring date-time
Example:2022-11-30T20:09:48Z

The point in time for which the schema is retrieved

base_lsnstring

The Log Sequence Number (LSN) for the base branch schema

base_timestampstring date-time
Example:2022-11-30T20:09:48Z

The point in time for the base branch schema

Response

Difference between the schemas

diffstring

Unified diff of the SQL schema changes between the compared branches.

Changes

No recorded changes to this operation across all 15 revisions of this API.