Set up Prisma

Goals

On this page, you will learn how to:

• Install the Prisma CLI
• Set up Prisma using Docker
• Introspect your existing database and derive a datamodel
• Use the datamodel to configure your Prisma API
• Generate a 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:

brew tap prisma/prisma
brew install prisma
Copy
 

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.

Set up Prisma

Run the following command to connect Prisma to your existing database:

prisma1 init hello-world
Copy
 

This launches an interactive wizard. Here's what you need to do:

1. Select Use existing database
2. Select your database, either MySQL, PostgreSQL or MongoDB
3. Provide the connection details for your database (see below for more info)
4. Select the Prisma Go client

Launch Prisma

To start Prisma and connect it to your database, run the following commands:

cd hello-world
docker-compose up -d
Copy
 

Prisma is now connected to your database and runs on http://localhost:4466.

Deploy the Prisma datamodel

You now have the minimal setup ready to deploy your Prisma datamodel. Run the following command (this does not change anything in your database):

prisma1 deploy
Copy
 

View and edit your data in Prisma Admin

If you want to view and edit the data in your database, you can use Prisma Admin. To access Prisma Admin, you need to append /_admin to your Prisma endpoint, for example: http://localhost:4466/_admin.

Prepare Go application

touch index.go
Copy
 

You'll be using dep for dependency management in this tutorial. Run the following command to create the required setup:

dep init
Copy
 

Great, you're now ready to write some code and talk to your database programmatically!

Read and write data using the Prisma client

The API operations of the Prisma client depend on the datamodel that was generated from the database introspection. The following sample queries assume there is a User type in the datamodel defined as follows:

type User {
  id: ID! @id
  name: String!
}

If you don't have such a User type, you need to adjust the following code snippets with a type that matches your datamodel.

Add the following code in index.go:

package main

import (
    "context"
    "fmt"
    prisma "hello-world/generated/prisma-client"
)

func main() {
    client := prisma.New(nil)
    ctx := context.TODO()

    // Create a new user
    name := "Alice"
    newUser, err := client.CreateUser(prisma.UserCreateInput{
        Name: name,
    }).Exec(ctx)
    if err != nil {
        panic(err)
    }
    fmt.Printf("Created new user: %+v\n", newUser)

  // Fetch all users
    users, err := client.Users(nil).Exec(ctx)
    if err != nil {
        panic(err)
    }
    fmt.Printf("%+v\n", users)
}
Copy
 

Before executing the script, you need to ensure all dependencies are available. Run the following command:

dep ensure
Copy
 

Now execute the script with the following command:

go run index.go
Copy
 

Whenever you run the 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:

id := "__USER_ID__"
userById, err := client.User(prisma.UserWhereUniqueInput{
  ID: &id,
}).Exec(ctx)
Copy
 

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