neon-object-storage

Provide S3-compatible object storage synced with Neon Postgres branches.

78|38|Updated Oct 20, 2022
One-click install
npx skills add https://github.com/neondatabase/examples --skill neon-object-storage
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: neon-object-storage
Source: https://github.com/neondatabase/examples/tree/main/with-ai-sdk/.agents/skills/neon-object-storage
Command: npx skills add https://github.com/neondatabase/examples --skill neon-object-storage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When building applications with Neon Postgres, using a separate third-party object storage provider creates a disconnect between your database records and stored files across development, preview, and production branches, requiring extra work to keep them in sync and manage two separate systems.

Core Features & Use Cases

  • S3-compatible API: Works with existing AWS SDKs, boto3, AWS CLI, and presigned URLs with no proprietary client required.
  • Branch-synced storage: Every Neon branch gets its own isolated, copy-on-write storage state, so files and database rows stay perfectly in sync across all environments, with no data duplication when forking branches.
  • Preview feature for Neon projects: Currently only available for new Neon projects in the us-east-2 region, with the same credential system used for Neon Functions and the AI Gateway.
  • Ideal for file-heavy apps: Perfect for storing user uploads, images, documents, avatars, and generated assets when you already use Neon and want to avoid managing a separate storage provider.

Quick Start

Use the neon-object-storage skill to configure a branch-synced S3-compatible bucket for your Neon project and implement a working upload and presigned download flow for user-generated files.

Frequently Asked Questions about neon-object-storage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep S3 object storage in sync with my Neon Postgres database branches?

Branch-synced S3-compatible storage automatically mirrors your Neon Postgres database branches, giving each branch an isolated, copy-on-write storage state so files and rows stay aligned without third-party providers.

Can I use AWS SDKs and presigned URLs with Neon object storage?

Yes, Neon object storage is fully S3-compatible, supporting standard AWS SDKs, boto3, AWS CLI, and presigned URL generation for object upload, download, and bucket management without any proprietary client required.

What's the best way to handle user file uploads in a Neon Postgres application?

Using branch-synced S3-compatible storage lets you store user uploads, images, and documents with consistent state between stored objects and database records across development, preview, and production environments.

Does Neon object storage work with my existing AWS CLI and boto3 tooling?

Yes, Neon object storage uses the standard S3 API, allowing you to perform object upload, download, presigned URL generation, and bucket management using existing AWS SDKs, boto3, and AWS CLI tooling without proprietary clients.

What are the limitations of branch-synced object storage for Neon projects?

Currently, Neon object storage is a preview feature available only for new Neon projects in the us-east-2 region, using the same credential system as Neon Functions and the AI Gateway.