3.1 KiB
3.1 KiB
What is Neon
Neon is a serverless Postgres platform designed to help you build reliable and scalable applications faster. It separates compute and storage to offer modern developer features such as autoscaling, branching, instant restore, and scale-to-zero.
For the full introduction, fetch the official docs:
curl -H "Accept: text/markdown" https://neon.com/docs/introduction
Core Concepts
Understanding Neon's resource hierarchy is essential for working with the platform effectively.
| Concept | Description | Key Relationship |
|---|---|---|
| Organization | Highest-level container for billing, users, and projects | Contains Projects |
| Project | Primary container for all database resources for an application | Contains Branches |
| Branch | Lightweight, copy-on-write clone of database state | Contains Databases, Roles |
| Compute Endpoint | Running PostgreSQL instance (CPU/RAM for queries) | Attached to a Branch |
| Database | Logical container for data (tables, schemas, views) | Exists within a Branch |
| Role | PostgreSQL role for authentication and authorization | Belongs to a Branch |
| Operation | Async action by the control plane (creating branch, starting compute) | Associated with Project |
Key Differentiators
- Serverless Architecture: Compute scales automatically and can suspend when idle
- Branching: Create instant database copies without duplicating storage
- Separation of Compute and Storage: Pay for compute only when active
- Postgres Compatible: Works with any Postgres driver, ORM, or tool
Documentation Resources
| Topic | Documentation URL |
|---|---|
| Introduction | https://neon.com/docs/introduction |
| Architecture | https://neon.com/docs/introduction/architecture-overview |
| Plans & Billing | https://neon.com/docs/introduction/about-billing |
| Regions | https://neon.com/docs/introduction/regions |
| Postgres Compatibility | https://neon.com/docs/reference/compatibility |
# Fetch architecture docs
curl -H "Accept: text/markdown" https://neon.com/docs/introduction/architecture-overview
# Fetch plans and billing
curl -H "Accept: text/markdown" https://neon.com/docs/introduction/about-billing
When to Use Neon
Neon is ideal for:
- Serverless applications: Functions that need database access without managing connections
- Development workflows: Branch databases like code for isolated testing
- Variable workloads: Auto-scale during traffic spikes, scale to zero when idle
- Cost optimization: Pay only for active compute time and storage used