A fresh version of the project Quickstart is now available. Use this interactive quickstart as a tutorial to see how branches work to keep your development changes isolated from main, and how easy it is to reset your dev branch whenever you need to.
The Branching workflows tab also gives you a summary of how you can leverage Neon's instant branching in your CI/CD automation.
To launch the Quickstart from the Dashboard, click Show Quickstart at the top of the page.
New Consumption API for accounts
To help Scale plan users get granular consumption metrics for your account as a whole for individual projects, we've added two new endpoints dedicated to the task:
Metrics are available starting March 1st, 2024 for existing Scale plan users. You'll need to specify from and to timestamp parameters that match the selected level of granularity: hourly, daily, or monthly.
Improved navigation for Project pages
We've improved how you move between the different pages in the Neon Console.
The sidebar navigation is re-ordered to help you switch between pages more intuitively.
We moved Operations from a dedicated page to a tab on the Monitoring page called System operations.
Notice that the Compute column is now made up of clickable links, letting you open the side drawer to edit any endpoint's compute settings from this view.
Expect to see more observability-related tabs appear on the Monitoring page in upcoming releases.
Fixes & improvements
We've made it easier for you to properly copy connection strings from the Neon Console. For safety, your password is not revealed directly in the browser but is replaced with ****. When you manually copy the connection string from the text window, the actual password is now included in the clipboard. Previously, copying the connection string directly from the window included the obscured password instead of the actual one.
Using the dedicated copy button continues to work as expected: perfectly!
An issue with the SQL Editor compute endpoint selector has been fixed. The selected endpoint is now correctly used for all of your queries.
When you encounter a project error, you now properly see an error screen. Previously, you were sometimes redirected to the Projects page without adequate explanation.
We fixed an issue where setting the history retention for a Neon project to 0 and removing data did not reduce the project’s storage size as expected. Previously, a 64 MiB data change threshold had to be met before retained history was removed.
Database name validation was added to the Neon CLI connection-string command to ensure the correct database name is used in a generated connection string. This improvement resolves an issue with the neondatabase/create-branch-action GitHub Action, which uses the connection-string command to set the db_url for a newly created branch.
Neon CLI updates
We've added two new capabilities to our CLI:
You can now establish time travel connections to a particular point in a branch's history. When using the neonctl connnection-string {branch} command, simply append the timestamp or LSN to the specified branch and an ephmeral endpoint is created for that point-in-time connection.
The Neon CLI now also includes shared projects when you request a list of all projects using the command neonctl projects list.
Example:
Projects┌────────────────────────┬────────────────────┬───────────────┬──────────────────────┐│ Id │ Name │ Region Id │ Created At │├────────────────────────┼────────────────────┼───────────────┼──────────────────────┤│ crimson-voice-99897020 │ frontend │ aws-us-east-2 │ 2024-04-15T11:17:30Z │├────────────────────────┼────────────────────┼───────────────┼──────────────────────┤│ calm-thunder-11283270 │ backend │ aws-us-east-2 │ 2024-04-10T15:21:01Z │└────────────────────────┴────────────────────┴───────────────┴──────────────────────┘Shared with me┌───────────────────┬────────────────────┬──────────────────┬──────────────────────┐│ Id │ Name │ Region Id │ Created At │├───────────────────┼────────────────────┼──────────────────┼──────────────────────┤│ noisy-fire-516816 │ API │ aws-eu-central-1 │ 2023-04-22T18:41:13Z │└───────────────────┴────────────────────┴──────────────────┴──────────────────────┘
For Launch and Scale plan users, we've added more detail and better visual cues to help you understand your current consumption against your plan's allowances. This includes displaying your peak usage to illustrate any extra charges that might be applied for the current billing period.
Usage widget in the project dashboard
We've also added some polish to the Usage widget on the project dashboard, with tooltips to explain key metrics.
For more information about reading these metrics, see:
Starting May 1, 2024, we're defining 'reasonable usage' for egress on Neon's Free Tier plan as a 5 GB per month limit.
We're updating our status page to provide per-region metrics, letting you view events and history specific to the region where your databases are running. Coming soon!
What's new in docs?
Learn how to sync data from platforms like Stripe, Linear, and GitHub into your Neon database in real time with Sequin.
Neon is Now Generally Available
April 15th, 2024 was a landmark day for us at Neon as we announced our move to General Availability.
Read more about how Neon is transforming database development, supporting business-critical workloads, and innovating in database scaling and branching in the announcement from our CEO, Nikita Shamgunov.
A New Approach to Database Development
Learn about our journey to General Availability and how Neon is redefining database development.
Available from the Neon Console, the Monitoring dashboard provides several graphs to help you monitor both system and database metrics, updated in real time based on your usage data. You can access the Monitoring dashboard from the sidebar in the Neon Console. Metrics include:
We've added a Schema Diff tool that lets you precisely compare database schemas between different branches for better debugging, code review, and team collaboration.
Available from the Branches detail page as well as part of Time Travel Assist from the Restore page, you can use Schema Diff to compare a branch's schema to its parent or compare any two branches during a branch restore operation.
To help with data recovery workflows, we've made our Time Travel feature available in the SQL Editor in the Neon Console. Time Travel Assist is also available now on the Restore page, but it's a great feature and we wanted to make it more convenient for you to use, wherever you might need it in the console.
We added support for psql meta-commands to the SQL Editor in the Neon Console. Meta-commands can significantly speed up your workflow by providing quick access to database schemas and other critical information without needing to write full SQL queries. They are especially useful for database management tasks, making it easier to handle administrative duties directly from the Neon Console.
Here are some of the meta-commands that you can use within the Neon SQL Editor:
\dt — List all tables in the current database.
\d [table_name] — Describe a table's structure.
\l — List all databases.
\? - A cheat sheet of available meta-commands
\h [NAME] - Get help for any Postgres command. For example, try \h SELECT.
Note that not all meta-commands are supported in the SQL Editor. To get a list of supported commands, use \?.
Be among the first to explore new features by signing up for the Neon Early Access Program.
Benefits of joining:
Exclusive early access: Get a first look at upcoming features before they go live.
Private community: Gain access to a dedicated Discord channel to connect with the Neon team and provide feedback to help shape what comes next.
Weekly insights: Receive updates on Neon's latest developments and future plans.
Sign Up Now and start influencing the future of Neon!
Protected branches
Users of the Neon Scale plan can now designate a branch as "protected". This status restricts branch access based on IP addresses — only IPs on your project’s allowlist can access a protected branch. Typically, branches containing production or sensitive data are designated as protected.
For details on configuring a protected branch, please refer to our Protected branches guide.
Large database support (beta)
We are currently testing architecture changes to support large databases from 300 GiB to 2 TiB. Access to this feature is limited to paying users by request. If you want to try it out, you can request access from the Beta tab under Project Settings, or use this direct link:
The JavaScript Registry (JSR) is a package registry for JavaScript and TypeScript. JSR works with many runtimes (Node.js, Deno, browsers, and more) and is backward compatible with npm. For example, to install using npm:
You can now view the last active time for a compute endpoint associated with your branch, which is useful for determining which branches you have accessed recently. In the Neon Console, you can view the Last active time on the Branches page or in the Computes section on individual branch pages. Additionally, the Neon API Get a compute endpoint method response now includes a last_active field.
The Neon SQL Editor now uses the Neon serverless driver for database connections. If you utilize the Neon IP Allow feature and your public IP address isn't currently on the allowlist, you may encounter a pop-up when you next query your database through the Neon SQL Editor. This pop-up requests permission to add your IP address to the allowlist.
Resolved a problem with the Neon Vercel Integration where enabling automatic branch deletion resulted in the unintended removal of the vercel-dev branch after it was renamed.
Resolved an issue where database connections could remain open longer than necessary. We now ensure that connections are forcibly closed if the client has disconnected.
Fixed a table and selector display issue in the Neon console for long branch names.
Fixed an SQL Editor issue that occurred when using the project breadcrumb selector from the SQL Editor page.
Fixed an error in the message displayed after a successful branch reset operation in the console. The "reset from" branch name was not shown.
Fixes & improvements
Based on user feedback, we've changed the Storage metric on the Billing page in the Neon Console to display the current total storage size across all of your projects and branches. Previously, the Storage metric reported the peak storage size for the current billing period.
You can now access integration documentation directly from the Integrations page in the Neon Console. A Read button, available on several integration cards, opens a documentation side drawer where you can learn how to integrate the selected platform or service with Neon.
If you previously signed up for Neon using your Hasura account and now want to use your personal email instead, you can make this change under Profile → Account Settings → Personal Information. You must log out and back into the Neon console before doing so. For more information, see Change your email.
We added a new Restart compute endpoint method to the Neon API. This method suspends the specified compute endpoint and restarts it immediately. It's sometimes necessary to restart a compute endpoint to enable new features or apply new limits. This method makes that task easier and enables us to add a restart compute option to the Neon Console, which you'll see in an upcoming release.
Fixed an issue that prevented preview branches from being shown on the Neon Vercel Integration drawer in the Neon Console.
Added an alert to the Neon Vercel Integration for older Neon projects that do not store role passwords. Neon projects created after March 2023 store role passwords in a secure storage vault associated with the project, allowing passwords to be retrieved from the Connection Details widget and by features such as the Vercel integration that require a password. Projects created before March 2023 do not store role passwords.
Fixed an error message on the Create a new branch page for the Include data up to time selector. The date format in the error message was incorrect.
What's new in docs?
We have three new authentication guides for you to check out this week. Learn how to authenticate users to access your Neon database with Auth0, Clerk, or Okta.
We've added a Monitoring widget to the Neon Dashboard, giving you an easy way to check CPU and RAM usage for your Neon projects. The display defaults to your primary branch but you can switch to view usage details for any branch in your project.
We're committed to improving observability for your Neon projects and databases. To learn more about monitoring in Neon, see Monitoring.
A teaser for organizations
You might notice a new addition to our breadcrumb navigation: Create organization under your account selector. It's greyed out and inactive for now, but we've included it here as a reminder: organization support is coming soon!
Check our roadmap to see what else is coming next.
PostgreSQL Partition Manager extension
Neon now supports the pg_partman partition manager extension, which enables creating and managing time and number-based table partition sets in Postgres.
Local File Cache (LFC) statistics and working set size function
You can now view Local File Cache (LFC) statistics for your Neon compute. The statistics include a cache hit ratio, which can help you determine if your data is being accessed from memory or the Neon storage layer.
The Local File Cache (LFC) stores frequently accessed data in the local memory of your Neon compute instance, which helps reduce latency and improve query performance by minimizing fetches from storage. The LFC acts as an add-on or extension of Postgres shared_buffers, which is set to 128 MB in Neon, regardless of compute size. The LFC extends cache memory to as much as 80% of your compute's RAM.
Local File Cache (LFC) statistics are exposed through a neon_stat_file_cache view, provided by the neon extension. To access the view, install the neon extension on a preferred database or connect to the Neon-managed postgres database where it's preinstalled. For instructions, see The neon extension.
You can retrieve LFC stats with the following query:
For the Neon serverless driver, the 15-second proxy timeout for SQL requests over HTTP has been removed.
Neon Vercel integration enhancements
We've introduced a few enhancements to help you manage preview branches created by the Neon Vercel integration:
There is now a drop-down menu on the Branches tab in the Vercel integration drawer where you can delete all preview branches or those marked as Obsolete. Obsolete branches are those without an associated git branch. For more information, see Manage branches created by the integration.
The integration now supports automatic deletion of obsolete preview branches. You can enable this feature by selecting Automatically delete obsolete Neon branches when installing the integration. We'll soon add an option to the Vercel integration drawer that lets you enable and disable automatic branch deletion for new and existing integrations. Deletion occurs when the git branch that triggered a branch's creation is deleted.
We now show a branch creation date for each preview branch listed on the Branches tab in the Vercel integration drawer.
Fixes & improvements
Corrected an issue that prevented Free Tier users from creating a new read-write compute for a primary branch after deleting the one created with their Neon project.
Updated the content displayed on the Projects page in the Neon Console when all projects are removed.
Adjusted copy and links on the connection details modal that's displayed after creating a new project.
What's new in docs?
We have new schema migration guides for you to check out this week:
We're also excited to share a new Postgres Documentation Page, a central hub for all things Postgres. This includes the latest topics listed below. As Neon is Postgres, we encourage you to consult both our Neon-specific guides and the official PostgreSQL documentation.
As our list of integrations continues to grow, we've added categorized navigation, making it easier to explore what's offered. Click a category heading and then Add or Request the integrations you're interested in.
Extra storage option for the Launch plan
Based on the feedback we've received, Neon's Launch plan has been enhanced to offer an "extra storage" option. If you require more than the 10 GiB storage allowance included with the Launch plan but aren’t ready for the Scale plan, you can now purchase additional storage in 2 GiB increments. For a detailed comparison of Neon's pricing plans, please refer to our Pricing page.
Neon Vercel Integration enhancements
The Neon Vercel Integration now adds a /preview prefix to the names of preview branches. You can view preview branches on the Branches page in the Neon Console or on the Vercel integration drawer, which you can access on the Integrations page.
Improved the sort order of preview branches listed in the Vercel integration drawer. The most recently created branches are now listed first.
Fixed an issue that marked the Vercel deployment status as successful while the preview deployment was still in progress.
Fixes & improvements
To make it easier to share your project with other users, we've added a Sharing button to the project dashboard. The button is located at the top right corner of the console, next to your profile avatar.
The Consumption API endpoint is now fully available and no longer in Preview status. You can use this endpoint to get a full list of key consumption metrics for all the projects in your Neon account in a single API request. For more info:
We've added a new Get URI API endpoint, which you can use to retrieve a database connection string programmatically.
You are now able to downgrade directly from Scale to Launch when that fits your usage needs. Previously, you needed to downgrade to the Free Tier first before moving back up to Launch.
The Neon CLI now offers a Linux ARM64 binary, which you can find here. For Neon CLI installation instructions, see Neon CLI — Install and connect.
For the Neon serverless driver, a cancellation command is now triggered in Postgres for queries over HTTP that exceed the 15-second timeout for long-running queries. Additionally, user-facing error classification names were added to make it easier to identify error types for queries over HTTP.
Added a Suggest an integration button to the Integrations page in the Neon Console, where you can share your feedback about the integrations Neon should add next. The button replaces a suggestion card.
Fixed the Revoke access confirmation modal that is displayed when revoking access to a shared project. The modal appeared blank.
Improved the field validation on the registration form on the Neon Sign Up page.
Fixed an issue that prevented changing the email address of a Neon account.
Corrected an issue that occurred when accessing Neon as a new user via the Neon CLI. After registering for a Neon account, the registering user was not directed back to the correct page to complete the authentication process.
Changed the "Storage" label on the Branches widget and Branches page to "Data size" to avoid confusion with the Storage label on the Usage widget. "Data size" refers to your logical data size, while "Storage" is the data size and history for all branches in your project. For more information about Storage in Neon, see Usage metrics.
Neon Vercel Integration enhancements
Manage branches created by the integration: The Neon Vercel Integration creates a branch for each preview deployment. To avoid using up your storage or branch allowances, we recommend removing old or obsolete branches regularly. You can now do this from the Vercel integration drawer in the Neon Console. See Manage branches created by the integration.
Change the database and role for preview branches: When you install the integration, you select a database and role for your Neon project. The integration uses these details to define database connection variables for your preview branches. You can now change the database and role for new preview branches from the Vercel integration drawer in the Neon Console. See Change the database and role for preview branches.
Fixed an issue that prevented Vercel environment variables created by the integration from being removed when deleting the associated Neon project.
Fixes & improvements
You can now view the sign-in methods configured for your Neon account from the Profile page under Account Settings. The Profile page also supports unlinking social accounts such as Google or GitHub from your Neon account.
When creating a project, the default Postgres role created with your project is now named for the database using the following naming scheme: dbname_owner, where dbname is the name of the database. This change reflects that the default Postgres role is the owner of the initial database that is created with the project.
The Neon Vercel Integration is now GA
After several improvements and enhancements, we're excited to announce that the Neon Vercel Integration is now officially out of beta and has entered General Availability (GA). Thank you to all our early adopters for your valuable feedback.
Using Neon with Vercel enables you to deploy a managed Postgres backend in seconds and automatically create a database branch for each preview deployment. To learn more, see Connect with the Neon Vercel Integration.
Fixed an issue that prevented a Scale plan user from submitting a support ticket from the Create Support Ticket form in the Neon Console.
Added alert messages that appear in the Usage section on the Billing page when approaching or exceeding your plan allowances. For information about Neon plans and allowances, see Neon plans.
Added a confirmation dialog showing the selected plan and payment method when a user selects Upgrade to Launch plan or Upgrade to Scale plan on the Billing page in the Neon Console.
Removed a redundant Close button from the Edit compute endpoint drawer on the Free Tier.
Fixed an issue that caused project creation limits to be ignored when creating a new project before the previous project creation operation was finished.
Fixed an issue that incorrectly permitted a Neon account to share a project with the owner of the project.
What's new in docs?
We have a few new guides for you to check out this week:
The Neon Vercel Integration now displays a message on the Deployment Details page in Vercel under Running checks if you exceed the branch limit for your Neon project.
Added Application-Layer Protocol Negotiation (ALPN) to the Neon Proxy, enabling the serverless driver to prefer HTTP/2 connections.
The IP Allow feature now supports specifying IPv6 addresses.
Improved error messaging for connection failures when IP Allow is enabled and the IP address of the connecting client is not on the allowlist.
The neon_superuser role now has full privileges on tables and sequences created in the public schema and can grant those privileges to other roles. This change ensures that tables and sequences created under a Postgres superuser role during extension installation are fully accessible to a neon_superuser.
A connection dropped by the Neon SQL Editor while running a query now cancels the query process in Postgres. Previously, the query process was left running.
Adjusted the Usage section on the Billing page, including changing the way extra usage is displayed for Scale plan accounts. Instead of showing extra usage separately, the displayed limits are increased.
The Get projects and Get shared projects APIs now fetch all projects when using the search parameter. If a limit value is specified, it is applied after the fetch to limit displayed results.
Improved the error code and message displayed when a user reaches the compute-hour limit for non-primary branch computes.
Fixed issues with the Branch selector in the Connection Details widget that occurred when switching projects using the project breadcrumb selector.
Adjusted the behavior of the project breadcrumb selector in the Neon Console to accommodate slow network connections. A "loading" icon is now displayed while the project menu is loaded, and a link to the currently loaded project is displayed until the project menu is ready.
Improved the Django settings.py connection snippet and added a .env connection snippet to the Connection Details widget in the Neon Console.
The Feedback link found in the sidebar of the Neon Console can now be accessed via a direct link, which we've incorporated into the documentation and elsewhere.
