Snaplet for VS Code

The Snaplet VS Code Extension is the fastest and easiest way to use Snaplet.

Description

Snaplet is a tool that captures safe snapshots of your PostgreSQL database you can easily code against. It enables you to identify and mask sensitive information via data transformations, and reduce database size through subsetting, all using TypeScript functions. With Snaplet, coding against production-like data becomes both safer and more efficient, enhancing code quality and accuracy.

Snaplet's VS Code extension integrates Snaplet's functionality into your VS Code environment. With the extension, your Git branches are automatically synced with Snaplet preview databases; instant, ephemeral databases created from your snapshots. No more manual switching or updating connection URLs every time you checkout a different branch in your code - just let Snaplet handle it, and enjoy a safe, seamless, frictionless coding experience against production-like data.

Key Features

Up to date: Keep your Postgres database up to date with your latest Snaplet snapshot, so you're always coding against the latest data in production. This makes reproducing bugs easier, and ensures you and your team are coding against the same data and schema.

Branchable: Fits directly into your development workflow - Snaplet creates a database that automatically branches when you branch your code. This means that your features and bug-fixes are isolated, so you never have to worry about schema or data drift.

Shareable: Coding against the same data and schema has never been easier. Just get your teammates to checkout the same branch, and our extension ensures that they're coding against the same database. This makes reproducing bugs and sharing context effortless.

Moves your local database to the cloud: Putting your database in the cloud means it's easy to branch and share! Snaplet integrates into your development workflow by tracking the active git branch you're working on. We give you a static connection string to a proxy that redirects to the current preview database. When you create a new git branch, Snaplet seeds your latest snapshot into a preview database, and redirects the proxy.

Installation

1. Install this extension to your VS Code editor.
2. Create a (free) Snaplet account and capture a snapshot. Follow the getting started guide if you need help.
3. Tag your snapshot with main from within Snaplet Cloud.
4. Modify the local development database connection string in your code to point to the Snaplet proxy: postgresql://snaplet@localhost:2345/snaplet.
5. You’re done! Enjoy coding against production-like data that branches when you branch your code!

Additional Resources

We have a full Installation Guide if you’re stuck installing or configuring the Snaplet VS Code extension.

Need more help? Come join us on Discord for real-time troubleshooting.

Feedback

We value your feedback! If you come across any issues or have suggestions, don't hesitate to reach out to us through the Q&A section, or leave a review.

We’d also love you to come join our community on Discord, where we’re most active. We give out swag!