Project

Source: src/Neon/Project.ts

A Neon serverless Postgres project.

Creating a project also provisions the project’s default branch (named “main” by default), an initial role, an initial database, and a read-write compute endpoint, exposed as connectionUri.

Creating a Project

Basic project

const project = yield* Neon.Project("my-project");

Project with explicit region and PG version

const project = yield* Neon.Project("my-project", {
  region: "aws-eu-central-1",
  pgVersion: 17,
});

Migrations and seed data

const project = yield* Neon.Project("my-project", {
  migrationsDir: "./migrations",
  importFiles: ["./seed/users.sql"],
});

Branching

const project = yield* Neon.Project("my-project");
const dev = yield* Neon.Branch("dev-branch", { project });