Neon helps teams ship with confidence without compromising development velocity. One of its features that contributes to that is database branching. In this post, we will explore two new features related to database branching: schema diff and protected branches.
Database branches in Neon are copy-on-write clones of your database that you can use for development, testing, or experimentation without compromising the original database.
Ever since we introduced the database branching feature to Neon, developers have asked for ways to set permission rules on individual branches and identify differences between parent and child branches. And here it is.
Today, we’ll explore two of our newest features, which will provide you with greater confidence.
Schema Diff
Similar to diffs in Git, the Neon schema diff feature compares schemas between the current and past state of the branch. Schema diffs are important to development workflows as they allow you to easily track how your database schema has evolved for better debugging, code review, and cross-team collaboration. For example, you can compare schemas after your peer has merged their PR and applied migrations.
Join us on Discord and let us know what you think and how you use schema diff in your workflows.
We detailed how Neon storage and ephemeral branches work in the Point In Time Recovery Under the Hood in Serverless Postgres article. In short, Neon’s storage engine saves Write-Ahead-Log records and can reconstruct a Postgres page at any given timestamp or Log-Sequence Number, allowing for time travel queries.
Under the hood, schema diff creates short-lived, ephemeral branches (TTL=10 seconds) set at a specific time (and LSN), then queries the Pageservers to retrieve the past schema, and then compares it with the current one to effectively display the changes.
Let’s see an example of schema diff on the Console. For that, we will create a Neon project and run the following query to create a user table:
CREATE TABLE users (
user_id SERIAL PRIMARY KEY,
first_name VARCHAR(50),
last_name VARCHAR(50),
email VARCHAR(100) UNIQUE NOT NULL,
created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
);Once done, we can compare the current state of the database with the user table to its previous state, where I had no tables. To do so, we first need to navigate to the Restore page, select a branch, and click on Schema Diff.
Below is what the result will look like:
As expected, the previous state of my database is empty because I had just created the project. Let’s now modify my schema by adding a new phone_number column:
ALTER TABLE users
ADD COLUMN phone_number VARCHAR(20);Let’s compare again with the state of my database at 10:52 PM, the time after I ran the schema changes. The result should look like this:
We can observe that lines 60 and 61 were modified as a result of the schema change.
Protected branches
Protected branches prevent unauthorized applications, users, and roles from accessing personally identifiable information (PII) or other sensitive data within your branch. This feature is available for users who are on the Scale plan
The first feature that’s available in this release is “IP Allow”, which restricts database access exclusively to trusted IP addresses. We plan on introducing more rules in the future.
If there are other ways we can protect your database branches, let us know on Discord or X.
You have a limit of 5 protected branches in your project. To set your branch as protected, simply follow these steps:
- Go to the branches page.
- Find the database branch you wish to protect.
- Click on “More” and then select “Set as protected.”
Check out the documentation for more details on protected branches.
Conclusion
The addition of Schema Diff and Protected Branches to Neon allows developers to easily identify schema changes and safeguard sensitive data, and equipped to build with confidence.
You can try Schema Diff and Protected Branches on Neon today. Join us on Discord, and let us know how we can help you build better and ship faster with Neon.
