Skip to main content
Prisma Documentation Docs

Search documentation

Type to search this documentation.

On this pageOverview

Getting Started (/docs/console/getting-started)

For the complete Prisma documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL.

Quick start guide for setting up and using the Prisma Console

Location: Console > Getting Started

This guide walks you through setting up your Console account and creating your first project.

  • A GitHub account (for authentication)
  • A Prisma project (optional, but recommended)
  1. Go to console.prisma.io/login
  2. Click Sign in with GitHub
  3. Authorize Prisma Console to access your GitHub account

You now have a Console account with a default workspace.

When you create an account, a default workspace is automatically created for you. You can create additional workspaces for different teams or organizations.

To create an additional workspace:

  1. Click the workspace dropdown in the top navigation
  2. Click Create Workspace
  3. Enter a name for your workspace
  4. Click Create

Projects organize your databases and environments within a workspace.

  1. Navigate to your workspace
  2. Click Create Project
  3. Enter a project name
  4. Click Create

Resources are the actual databases or environments within your project.

  1. Navigate to your project
  2. Click Create Database
  3. Enter a database name
  4. Select a region
  5. Click Create

[!WARNING] Accelerate retirement

Prisma Accelerate will be retired on December 1, 2026, so new Accelerate environments are not recommended. Create a Prisma Postgres database instead, as described above. If you already run Accelerate, choose the path that matches your setup:

  1. Navigate to your project
  2. Click Create Environment
  3. Enter an environment name (e.g., "production")
  4. Click Create

Connection strings authenticate your application's requests to Prisma products.

  1. Navigate to your resource (database or environment)
  2. Click Connection Strings tab
  3. Click Create Connection String
  4. Enter a name for the connection string
  5. Copy the connection string and store it securely
  6. Click Done

Step 6: Use the connection string in your application

Section titled “Step 6: Use the connection string in your application”

Add the connection string to your .env file. For Prisma Postgres, use the pooled connection string for application queries and the direct connection string for migrations, introspection and Prisma Studio:

Bash
# Application traffic over pooled TCP
DATABASE_URL="postgres://USER:PASSWORD@pooled.db.prisma.io:5432/postgres?sslmode=require"

# Prisma CLI commands and administrative tooling
DIRECT_URL="postgres://USER:PASSWORD@db.prisma.io:5432/postgres?sslmode=require"

In a Node.js runtime, pass the pooled connection string to Prisma Client through the @prisma/adapter-pg driver adapter. In an edge or TCP-constrained runtime, use the Prisma Postgres serverless driver with the direct connection string instead.

[!WARNING] Accelerate retirement

Prisma Accelerate will be retired on December 1, 2026. This covers both the Accelerate environments from Step 4, which use prisma://accelerate.prisma-data.net/?api_key=YOUR_API_KEY connection strings, and hosted Accelerate connections for Prisma Postgres, which use prisma+postgres://accelerate.prisma-data.net/?api_key=YOUR_API_KEY. Choose the path that matches your setup:

  • Concepts: Understand the core concepts of the Prisma Console: user accounts, workspaces, projects, and resources
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu