Skip to content

Getting Started improvements (PlanetScale) #2820

@tanberry

Description

@tanberry

These are remnant edits that we want to add to the Getting Started (from scratch) docs for PlanetScale:

  • On the first page, rewrite this:
    To connect your database, you need to set the url field of the datasource block in your Prisma schema to your database connection URL:
    To this:
    To connect your database, you need to modify your prisma.schema file to set the url field of the datasource block to your database connection URL:

Note from past @ruheni — The wording is okay and needs no improvement

  • On the Connect your database page:
    -- delete the first two images and jump straight to the MySQL image
    -- rewrite all of the text about what to configure to be more simple, something like:

    "To connect your database, you need to modify your prisma.schema file:
    - In the  datasource block, set the provider to use the mysql and set the referential integrity type to "prisma"
    - in the generator block, add referentialIntegrity as a preview feature"

  • Add a Note asking users to verify that hey have sslaccept=strict at the end of the URL... just in case they were unable to find Prisma in the dropdown.

Note from past @ruheni — Planetscale by default includes the query parameter as part of the connection string when copying it from their dashboard, so this is not necessary

  • On the Install Prisma Client page, in the very first sentence, clarify that they should be in the top-level directory when they run npm install @prisma/client.

Note from past @ruheni — The wording is okay and needs no improvement

  • On the Install Prisma Client page, move this section up higher in doc, and turn it into an admonition:
    ”Whenever you make changes to your Prisma schema in the future, you need to manually invoke prisma generate in order to accommodate the changes in your Prisma Client API.”

Note from past @ruheni — current level is just okay

CleanShot 2023-04-26 at 09 24 07@2x

  • On the Querying the database page, in the section about writing data to the DB, I was unclear what sections in my index.ts I should remove, versus what I need to leave. Let's rewrite it to make it more clear what you leave in the file, and what you're adding, etc.

  • The output shown on the Querying page doesn't match the output I got in my terminal... mine always shows both CREATEDATE and UPDATEDAT, for example.

Metadata

Metadata

Assignees

Labels

type/docsDocumentation creation, updates or corrections

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions