Get Started / Setting up Prisma

Setting up Prisma

Goals

On this page, you will learn how to:

  • Install the Prisma CLI
  • Setup Prisma with a sandboxed demo database
  • Read and write data using the Prisma client

Install the Prisma CLI

The Prisma CLI is used for various Prisma workflows. You can install it using Homebrew or NPM:

Homebrew
NPM
brew tap prisma/prisma
brew install prisma
Copy

Setup Prisma

To bootstrap the configuration files for your Prisma setup, create a new directory and initalize it using the prisma init command:

mkdir hello-world
cd hello-world
prisma init
Copy

After running prisma init, the Prisma CLI prompts you to select how you want to deploy Prisma:

  1. Select Demo server from the list.
  2. When your browser opens, register with Prisma Cloud. This is needed because that's where the Demo server is hosted.
  3. Go back to your terminal.
  4. Confirm the suggested values for the following questions with Return:

    1. The region where Prisma service should be hosted
    2. The name for Prisma service
    3. The stage for Prisma service
  5. Select Prisma JavaScript Client to generate Prisma client for Node.js.
  • prisma.yml: The root configuration file for your Prisma setup.
  • datamodel.prisma: Specifies the datamodel for your application that will be mapped to the database (it basically defines your database schema).

Deploy Prisma

The interactive wizard created the minimal Prisma configuration based on a hosted demo database: prisma.yml and datamodel.prisma. Prisma now needs to be deployed so you can use the Prisma API:

prisma deploy
Copy

Congratulations, you have successfully deployed Prisma. You can now start using the Prisma client to talk to your database from code.

Prepare Node application

Run the following command to create an empty Node script:

touch index.js
Copy

Next, initialize an empty NPM project in the current directory and install the required dependencies:

npm init -y
npm install --save prisma-client-lib graphql@0.13
Copy

Read and write data using the Prisma client

Add the following code in index.js and save it afterwards:

const { prisma } = require('./generated/prisma')

// A `main` function so that we can use async/await
async function main() {

  // Create a new user called `Alice`
  const newUser = await prisma.createUser({ name: 'Alice' })
  console.log(`Created new user: ${newUser.name} (ID: ${newUser.id})`)

  // Read all users from the database and print them to the console
  const allUsers = await prisma.users()
  console.log(allUsers)
}

main().catch(e => console.error(e))
Copy

Execute the script with the following command:

node index.js
Copy

Whenever you run the script with that command, a new user record is created in the demo database (because of the call to createUser).

Feel free to play around with the Prisma client API and try out some of the following operations by adding the following code snippets to the file (at the end of the main function) and re-executing the script:

Fetch single user
Filter user list
Update a user's name
Delete user
const user = await prisma
  .user({ id: '__USER_ID__' })
Copy

In some snippets, you need to replace the __USER__ID__ placeholder with the ID of an actual user.

Great work! 👏 Move on to learn how you can change your datamodel and regenerate your Prisma client.