01 Setting Up Prisma New Database A002

import QueryChooser from 'components/Markdown/QueryChooser' import Code from 'components/Markdown/Code'

export const meta = { title: 'Setting up Prisma', position: 1, gettingStartedOrder: 1, gettingStartedTitle: 'New database', nextText: 'Great work! 👏 Move on to learn how you can change your datamodel and (re-)generate your Prisma client.', technology: 'node', technologyOrder: 1, articleGroup: 'Setting up Prisma', }

Goals

On this page, you will learn how to:

• Install the Prisma CLI
• Setup Prisma using Docker
• Configure your Prisma API
• Generate the Prisma client
• 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:

<Code languages={["Homebrew", "NPM"]}>

brew tap prisma/prisma
brew install prisma

npm install -g prisma

Install Docker

To use Prisma locally, you need to have Docker installed on your machine. If you don't have Docker yet, you can download the Docker Community Edition for your operating system here.

Don't want to use Docker? You can also get started with a demo database for now.

Set up database and Prisma server

Create new directory

mkdir hello-world
cd hello-world

Create Docker Compose file

To launch Prisma on your machine, you need a Docker Compose file that configures Prisma and specifies the database it can connect to.

touch docker-compose.yml

Add Prisma and database Docker images

Paste the following contents into the Docker Compose file you just created:

<Code languages={["MySQL", "PostgreSQL"]}>

version: '3'
services:
  prisma:
    image: prismagraphql/prisma:1.17
    restart: always
    ports:
    - "4466:4466"
    environment:
      PRISMA_CONFIG: |
        port: 4466
        databases:
          default:
            connector: mysql
            host: mysql
            port: 3306
            user: root
            password: prisma
            migrations: true
  mysql:
    image: mysql:5.7
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: prisma
    volumes:
      - mysql:/var/lib/mysql
volumes:
  mysql: ~

version: '3'
services:
  prisma:
    image: prismagraphql/prisma:1.17
    restart: always
    ports:
    - "4466:4466"
    environment:
      PRISMA_CONFIG: |
        port: 4466
        databases:
          default:
            connector: postgres
            host: postgres
            port: 5432
            user: prisma
            password: prisma
            migrations: true
  postgres:
    image: postgres:10.5
    restart: always
    environment:
      POSTGRES_USER: prisma
      POSTGRES_PASSWORD: prisma
    volumes:
      - postgres:/var/lib/postgresql/data
volumes:
  postgres: ~

You can switch between MySQL and PostgreSQL by using the tabs above the code block.

Start database and Prisma server

To start Prisma and launch the connected database, run the following command:

docker-compose up -d

Your local Prisma server is now running on http://localhost:4466.

Configure your Prisma API

To bootstrap the configuration files for your Prisma client run the following command:

prisma init --endpoint http://localhost:4466

The endpoint needs to match the URL of a running Prisma server.

Deploy the Prisma API

The prisma init command created the minimal setup needed to deploy the Prisma API: prisma.yml and datamodel.prisma.

With these configuration files, you can now deploy the Prisma API:

prisma deploy

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

Generate your Prisma client

The Prisma client is a custom, auto-generated library that connects to your Prisma API. Append the following lines to the end of your prisma.yml:

generate:
  - generator: javascript-client
    output: ./generated/prisma-client/

Now generate the client with this command:

prisma generate

The CLI now stored your Prisma client inside the prisma-client directory as specified in prisma.yml.

Prepare Node application

Run the following command to create an empty Node script:

touch index.js

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

npm init -y
npm install --save prisma-client-lib [email protected]

Read and write data using the Prisma client

Now add the following code to index.js and save it afterwards:

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

// 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))

Execute the script with the following command:

node index.js

Whenever you run this script with that command, a new user record is created in the 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:

<QueryChooser titles={["Fetch single user", "Filter user list", "Update a user's name", "Delete user"]}>

const user = await prisma
  .user({ id: '__USER_ID__' })

const usersCalledAlice = await prisma
  .users({
    where: {
      name: 'Alice'
    }
  })

 const updatedUser = await prisma
  .updateUser({
    where: { id: '__USER_ID__' },
    data: { name: 'Bob' }
  })

 const deletedUser = await prisma
  .deleteUser({ id: '__USER_ID__' })

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