@prisma/debug

Today we release the first patch release 2.0.1. This is the first time that we run our new patch process! And it looks like everything went well 🤗.

Improvements

• The database detection in prisma introspect got improved so there are fewer false positives that tell users their database is Prisma 1.

🎉 Today, we are launching Prisma 2.0 for General Availability! Read the announcement to learn more.

---

💡 What is Prisma 2.0?

Today's General Availability release features Prisma Client, a type-safe and auto-generated query builder for your database. Thanks to introspection, Prisma Client can be used for existing databases as well.

Note: Prisma Migrate and Prisma Studio are not part of today's release. They're still experimental.

🚀 Getting started

The easiest way to get started is by following the Quickstart (5 min). It is based on a SQLite demo database and doesn't require any setup!

You can also connect Prisma to your own PostgreSQL or MySQL database, either in an existing project or when starting from scratch.

✉️ Let us know what you think

As always, we very much appreciate your feedback! Please don't hesitate to reach out here on GitHub or on Slack if you have any questions, thoughts, or any other kind of feedback about Prisma! 🙌

⬆️ Upgrading from Prisma 1

If you're currently using Prisma 1 and want to upgrade to the new version, you can start by learning about the upgrade process in the docs: How to upgrade 📚

If you have any questions or feedback about the upgrade process, please create a GitHub issue in our new feedback repo. You can also share your personal feedback path with us and we'll try to figure out the best way to upgrade with you!

We're also planning upgrade webinars, where we're demoing the upgrade process for different scenarios (e.g. using prisma-binding, Prisma Client, Nexus, ...). The webinars are currently planned for July, we'll announce the dates soon!

🌎 Join us online for Prisma Day on June 25th and 26th

We're hosting another edition of Prisma Day this year and are going fully remote. Join us online for hands-on workshops on June 25th and great talks on June 26th. Some of the speakers include GitHub co-founder Tom Preston-Werner, Netlify CEO Mathias Biilmann Christensen and lots of Prisma folks to tell you the latest about Prisma 2.0.

Today, we are issuing the ninth Beta release: 2.0.0-beta.9 (short: beta.9).

Enforcing arrays in OR

We used to allow this syntax:

  const orIncorrect = await prisma.post.findMany({
    orderBy: {
      id: 'asc'
    },
    where: {
      OR: {
        title: {
          equals: "Prisma makes databases easy"
        },
        authorId: {
          equals: 2
        }
      }
    }
  });

However, the thing that we want is this:

const orCorrect = await prisma.post.findMany({
   orderBy: {
     id: 'asc'
   },
   where: {
     OR: [{
       title: {
         equals: "Prisma makes databases easy"
       },
     }, {
       authorId: {
         equals: 2
       }
     }]
   }
 })

So only the array syntax makes sense, therefore we also only allow that from now on.

Fixes and improvements

prisma

• Expose a logger interface
• Emit an error event when the database connection is interrupted
• Limit implicit m-n relations to primary keys only
• Rename pinnedPlatform to pinnedBinaryTarget
• @prisma/engine-core forces users to enable esModuleInterop

prisma-client-js

• findMany / OR accepts non-array value - should only accept arrays
• Queries and mutations stuck (runs forever?) if log option is ['query', 'warn']

vscode

• Ctrl+Space suggests type after type
• suggest ? after type
• Add JSON to auto-completion types

prisma-engines

• Use exact id column type for the version check during introspection
• add uniqueIndexes to Model in DMMF
• bring back default for Field in DMMF

Credits

Huge thanks to @Sytten for helping!

Today, we are issuing the eighth Beta release: 2.0.0-beta.8 (short: beta.8).

Breaking change: Splitting .raw into .queryRaw and .executeRaw

When dealing with raw SQL queries, there are two things we care about - the "return payload", which is being calculated by the SELECT statement we use and the number of affected rows - if we for example do an UPDATE query.

Until now, Prisma Client decided under the hood with a heuristic, when to return the number of affected rows and when to return the result data. This heuristic broke if you wanted the opposite of what the heuristic returned. That means that the decision has to be made by the developer using Prisma Client instead. Therefore, we remove the raw command and replace it with executeRaw and queryRaw.

So what does return what?

• executeRaw returns the number of affected rows
• queryRaw returns the result data

The heuristic used to return the data for SELECT statements. So if you upgrade to Beta 8, you need to use queryRaw for your SELECT statements and executeRaw for all SQL queries, which mutate data.

The rule of thumb is: Do not use executeRaw for queries that return rows. In Postgres, it will work to use executeRaw('SELECT 1), however, SQLite will not allow that.

Fixes and improvements

prisma

• Make sure Netlify deployments are not listed with their .netlify.com domain in Google and Co
• .raw doesn't return data if query doesn't start with SELECT statement
• Prisma 2.0.0-beta.7 npx prisma generate issue if working directory contains spaces
• JSON type is broken for array. Array comes back as string.
• Error: spawn node --max-old-space-size=8096 .\node_modules@prisma\client\generator-build\index.js ENOENT
• Add a test case for project paths with spaces

prisma-client-js

• Prisma Client removed on adding a new package: Error: @prisma/client did not initialize yet
• JSON types should return a JSON object and not a JavaScript object
• Datasource override from client constructor doesn't match the datasource block from the schema.prisma file

Credits

Huge thanks to @Sytten, @merelinguist for helping!

Today, we are issuing the seventh Beta release: 2.0.0-beta.7 (short: beta.7).

New Pagination

Prisma Client's pagination has been simplified a lot!

• Removed first, last, before, after arguments.
• Added cursor and take arguments.
• skip argument unchanged.

The take argument replaces first and last.

Examples

first

prisma.user.findMany({
  first: 10
})

// becomes
prisma.user.findMany({
  take: 10
})

last

prisma.user.findMany({
  last: 10
})

// becomes
prisma.user.findMany({
  take: -10
})

before

prisma.user.findMany({
  before: "someid"
  first: 10
})

// becomes
prisma.user.findMany({
  cursor: "someid"
  take: -10
  skip: 1
})

after

prisma.user.findMany({
  after: "someid"
  first: 10
})

// becomes
prisma.user.findMany({
  cursor: "someid"
  take: 10
  skip: 1
})

The record specified with cursor is now included in the results, making skip: 1 necessary if you want to preserve the previous before / after semantics.

This diagram illustrates how the pagination works:

             cursor: 5                              
             skip: 0 or undefined                   
                       │                            
                       │                            
                       │                            
                       ▼                            
 ┌───┐┌───┐┌───┐┏━━━┓┏━━━┓┌───┐┌───┐┌───┐┌───┐┌───┐ 
 │ 1 ││ 2 ││ 3 │┃ 4 ┃┃ 5 ┃│ 6 ││ 7 ││ 8 ││ 9 ││10 │ 
 └───┘└───┘└───┘┗━━━┛┗━━━┛└───┘└───┘└───┘└───┘└───┘ 
                ◀────────                           
                 take: -2                           
                                                    
                                                    
                                                    
                    cursor: 5                       
                     skip: 1                        
                        │                           
                        │                           
                        │                           
                        ▼                           
  ┌───┐┌───┐┏━━━┓┏━━━┓┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐
  │ 1 ││ 2 │┃ 3 ┃┃ 4 ┃│ 5 ││ 6 ││ 7 ││ 8 ││ 9 ││10 │
  └───┘└───┘┗━━━┛┗━━━┛└───┘└───┘└───┘└───┘└───┘└───┘
                 ◀────────                          
                  take: -2                          
                                                    
                                                    
                                                    
                    cursor: 5                       
                     skip: 2                        
                        │                           
                        │                           
                        │                           
                        ▼                           
  ┌───┐┏━━━┓┏━━━┓┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐
  │ 1 │┃ 2 ┃┃ 3 ┃│ 4 ││ 5 ││ 6 ││ 7 ││ 8 ││ 9 ││10 │
  └───┘┗━━━┛┗━━━┛└───┘└───┘└───┘└───┘└───┘└───┘└───┘
                 ◀────────                          
                  take: -2                          
                                                    
                                                    
            cursor: 5                               
            skip: 0 or undefined                    
                      │                             
                      │                             
                      │                             
                      ▼                             
┌───┐┌───┐┌───┐┌───┐┏━━━┓┏━━━┓┏━━━┓┌───┐┌───┐┌───┐  
│ 1 ││ 2 ││ 3 ││ 4 │┃ 5 ┃┃ 6 ┃┃ 7 ┃│ 8 ││ 9 ││10 │  
└───┘└───┘└───┘└───┘┗━━━┛┗━━━┛┗━━━┛└───┘└───┘└───┘  
                      ──────────▶                   
                        take: 3                     
                                                    
                                                    
                  cursor: 5                         
                  skip: 1                           
                      │                             
                      │                             
                      │                             
                      ▼                             
┌───┐┌───┐┌───┐┌───┐┌───┐┏━━━┓┏━━━┓┏━━━┓┌───┐┌───┐  
│ 1 ││ 2 ││ 3 ││ 4 ││ 5 │┃ 6 ┃┃ 7 ┃┃ 8 ┃│ 9 ││10 │  
└───┘└───┘└───┘└───┘└───┘┗━━━┛┗━━━┛┗━━━┛└───┘└───┘  
                      ──────────▶                   
                        take: 3                     
                                                    
                                                    
                  cursor: 5                         
                  skip: 2                           
                      │                             
                      │                             
                      │                             
                      ▼                             
┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐┏━━━┓┏━━━┓┏━━━┓┌───┐  
│ 1 ││ 2 ││ 3 ││ 4 ││ 5 ││ 6 │┃ 7 ┃┃ 8 ┃┃ 9 ┃│10 │  
└───┘└───┘└───┘└───┘└───┘└───┘┗━━━┛┗━━━┛┗━━━┛└───┘  
                      ──────────▶                   
                        take: 3                     

Auto restart on panic

The Query Engine now automatically restarts with an exponential backoff with jitter, if it exits for some reason, for example in the case of a panic. That helps a lot to make Prisma Client more resilient in production! https://github.com/prisma/prisma/issues/2100

Introspection now recognizes @default(cuid / uuid)

If you introspect a Prisma 1 schema, the introspection now correctly recognizes cuid or uuid usage https://github.com/prisma/prisma/issues/2499

Fixes and improvements

prisma

• Prisma should check for generator binaries in $PATH
• A generator provider should accept arbitrary commands
• generate does not work in folders with spaces
• Restart engine on panic
• Unable to save arrays in a Json type field
• findMany with a select argument errors out with models with self-relations (sometimes)
• [Introspection] Identify Prisma 1 Id defaults
• Prisma Client mixes up DateTimes and IDs when they are selected in queries
• findMany fails to select an enum list & a relation scalar at the same time
• [Prisma Client] Duplicate identifier with models "X" and "XClient"
• Output notice about Prisma1->Prisma2 upgrade documentation and tool
• New raw functions not exported from @prisma/client
• Generated GitHub link too long

prisma-client-js

• Error when passing a null value to a nullable Json field type

vscode

• Message: Request textDocument/definition failed with message: Schema parsing
• Show linter snippet in formatting error
• Using svg breaks markeplace publish
• Not possible to use backslash in string field
• Run CI tests every time a release gets published
• Include CLI version in startup output
• Startup output does not include binary hash any more
• Using autocompletion for @default() puts curcor after ) instead of inside ()
• Ctrl+Space does not suggest current model for self relation
• @unique @unique
• Formatter adds new lines on every format call
• Move out anything unimportant to users from README to CONTRUBUTING.md
• Update README preview image
• Improving README
• vscode plugin formatting bug
• Auto-completion for relation directive shows wrong suggestions
• Format incorrectly deletes invalid lines
• Format deletes new lines in invalid block and removes any whitespaces in the beginning
• Format moves lines on every format call in an invalid schema

prisma-engines

• Implement simplified pagination

Credits

Huge thanks to @Sytten, @thankwsx, @zachasme for helping!

Today, we are issuing the sixth Beta release: 2.0.0-beta.6 (short: beta.6).

More powerful raw queries with Prisma Client

Thanks to @zachasme and @Sytten, the prisma.raw command became more powerful in https://github.com/prisma/prisma/pull/2311. There are two changes we introduce for raw:

Expose sql-template-tag helpers

Prisma Client's raw mode utilizes the sql-template-tag library. In order to construct raw SQL queries programmatically, Prisma Client now exposes a few helper functions:

import { sql, empty, join, raw, PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

const rawQueryTemplateFromSqlTemplate = await prisma.raw(
  sql`
    SELECT ${join([raw('email'), raw('id'), raw('name')])}
    FROM ${raw('User')}
    ${sql`WHERE name = ${'Alice'}`}
    ${empty}
  `
)

Allowing programmatic positional parameters

Sometimes, a static template string is not enough. Then constructing a string dynamically is the right choice. For this situation, we added support for arbitrary positional parameters:

const result = await prisma.raw(
  'SELECT * FROM User WHERE id = $1 OR email = $2;',
  1,
  'e@ma.il'
)

Other improvements

• You can now enable pgBouncer in your connection URL by adding the ?pgbouncer=true parameter (forceTransactions from the PrismaClient is now deprecated and will be removed in an upcoming release)
• Improved handling of comments in prisma format
• Various improvements to Prisma's VS Code extension (e.g. better error messages and debug information)

Fixes and improvements

prisma

• [Introspection] Better introspect success message
• DigitalOcean Postgres + PGBouncer Issues
• &sslcert=server-ca.pem in PostgreSQL connection url throw Error opening a TLS connection: One or more parameters passed to a function were not valid.
• Prisma generate --watch errors
• Introspect default value with backslashes causes problem when generating client
• Prisma DMMF parses comments as fields docs
• Cascade delete does not work unless relation is optional
• Special-case syntax error for multiple unnamed arguments in directive in the schema parser
• Error on table update using a mapped field in where clause
• Add renovate bot for dependencies
• Prisma Schema: Add .prisma syntax highlighting for Sublime Text
• Simple filtering for JSON
• Panic calling findOne with mapped unique key fields
• Validation issue for schemas with compound foreign keys
• [introspect] Expose database classification feature
• If a comment is the last line in a model, prisma format will move it out of the model
• Investigate alternatives to required PgBouncer configuration
• Overwriting database connection string in Prisma Client does not work
• PgBouncer mode
• Documentation parsed from doc comment is missing for enums

prisma-client-js

• Document forceTransactions / pgBouncer
• Better instructions on Query Engine panic
• Ability to use Heroku's pgbouncer
• Prisma Client failing with PgBouncer Transaction Mode
• Basic reporting capability for runtime errors in Client
• Prisma Client Beta 4 broken with Netlify
• PANIC error on upsert query
• Cannot use prisma.create() with nullable field set to null

vscode

• Trailing comments are broken to the next line when formatting
• Recognize Prisma1 schemas and tell user to install the other extension and rename file
• Allow inline comment
• Formatting moves comment from inside model to above model
• Preserve newlines / whitespaces inside models
• Extension deletes unused commented out models
• Use same versioning scheme & release cadence as Prisma itself
• prisma-fmt: add newline in the end of the file
• Triple slash comments in prisma schema file not working
• Versioning scheme
• Add badges and repo explanation to README
• VSCode extension errors when linting .prisma file
• Also output extension name / package and version on startup
• Configuring Git to handle line endings
• Remove Prisma as Icon Theme

prisma-engines

• Improve a model's default value in the AST

Credits

Huge thanks to @Sytten, @thankwsx, @zachasme for helping!