Skip to content

Fix getting started sql schema and add renaming to virtual fields #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikolasburk merged 2 commits into from
Apr 6, 2020
Merged

Fix getting started sql schema and add renaming to virtual fields #139

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c743118
Fix schema and add renaming
2color Apr 3, 2020
dc7a018
Correct default types
2color Apr 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 40 additions & 21 deletions content/01-getting-started/02-setup-prisma/02-start-from-scratch-sql.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,15 +223,15 @@ CREATE TABLE "public"."Post" (
"createdAt" TIMESTAMP NOT NULL DEFAULT now(),
content TEXT,
published BOOLEAN NOT NULL DEFAULT false,
author INTEGER NOT NULL,
FOREIGN KEY (author) REFERENCES "public"."User"(id)
"authorId" INTEGER NOT NULL,
FOREIGN KEY ("authorId") REFERENCES "public"."User"(id)
);

CREATE TABLE "public"."Profile" (
id SERIAL PRIMARY KEY NOT NULL,
bio TEXT,
"user" INTEGER UNIQUE NOT NULL,
FOREIGN KEY ("user") REFERENCES "public"."User"(id)
"userId" INTEGER UNIQUE NOT NULL,
FOREIGN KEY ("userId") REFERENCES "public"."User"(id)
);
```

Expand Down Expand Up @@ -276,20 +276,20 @@ Great, you now created three tables in your database

| Column name | Type | Primary key | Foreign key | Required | Default |
| :---------- | :------------- | :---------- | :---------- | :------- | :----------------- |
| `id` | `SERIAL` | **✔️** | No | No | _autoincrementing_ |
| `createdAt` | `TIMESTAMP` | No | No | **✔️** | `now()` |
| `title` | `VARCHAR(255)` | No | No | **✔️** | - |
| `id` | `SERIAL` | **✔️** | No | No | _autoincrementing_ |
| `createdAt` | `TIMESTAMP` | No | No | **✔️** | `now()` |
| `title` | `VARCHAR(255)` | No | No | **✔️** | - |
| `content` | `TEXT` | No | No | No | - |
| `published` | `BOOLEAN` | No | No | **✔️** | `false` |
| `author` | `INTEGER` | No | **✔️** | **✔️** | `false` |
| `published` | `BOOLEAN` | No | No | **✔️** | `false` |
| `authorId` | `INTEGER` | No | **✔️** | **✔️** | - |

**Profile**

| Column name | Type | Primary key | Foreign key | Required | Default |
| :---------- | :-------- | :---------- | :---------- | :------- | :----------------- |
| `id` | `SERIAL` | **✔️** | No | No | _autoincrementing_ |
| `bio` | `TEXT` | No | No | **✔️** | - |
| `user` | `INTEGER` | No | **✔️** | **✔️** | `false` |
| `id` | `SERIAL` | **✔️** | No | No | _autoincrementing_ |
| `bio` | `TEXT` | No | No | **✔️** | - |
| `userId` | `INTEGER` | No | **✔️** | **✔️** | - |

</details>

Expand Down Expand Up @@ -390,17 +390,15 @@ model Post {
title String
content String?
published Boolean @default(false)
author User @relation(fields: [authorId], references: [id])
authorId Int

@@index([authorId], name: "authorId")
User User @relation(fields: [authorId], references: [id])
}

model Profile {
id Int @default(autoincrement()) @id
bio String?
user User @relation(fields: [userId], references: [id])
userId Int @unique
id Int @default(autoincrement()) @id
bio String?
userId Int @unique
User User @relation(fields: [userId], references: [id])
}

model User {
Expand All @@ -421,9 +419,9 @@ Right now, there's a few minor "issues" with the data model:

These changes are relevant for the generated Prisma Client API where using `posts` and `profile` will feel more natural and idiomatic to JavaScript/TypeScript developers. You can therefore [configure your Prisma Client API](../../reference/tools-and-interfaces/prisma-client/configuring-the-prisma-client-api).

Because both the generated `Post` and `Profile` fields are _virtual_ (i.e. they're _not backed by a foreign key in the database_), you can manually rename them in your Prisma schema:
Because both the generated `Post` and `Profile` in the `User` model fields are _virtual_ (i.e. they're _not backed by a foreign key in the database_), you can manually rename them in your Prisma schema:

```prisma copy
```prisma
model User {
id Int @default(autoincrement()) @id
name String?
Expand All @@ -433,6 +431,27 @@ model User {
}
```

Equally, apply rename following the cone Profile model, renaming `User` to `user` and the `Post` model, renaming `User` to field:

```prisma
model Post {
id Int @default(autoincrement()) @id
createdAt DateTime @default(now())
title String
content String?
published Boolean @default(false)
authorId Int
author User @relation(fields: [authorId], references: [id])
}

model Profile {
id Int @default(autoincrement()) @id
bio String?
userId Int @unique
user User @relation(fields: [userId], references: [id])
}
```

In this example, the database schema did follow the [naming conventions](../../reference/tools-and-interfaces/prisma-schema/models#naming-models) for Prisma models (only the virtual relation fields that were generated from introspection did not adhere to them and needed adjustment). This optimizes the ergonomics of the generated Prisma Client API.

Learn more about this on the [Configuring your Prisma Client API](../../reference/tools-and-interfaces/prisma-client/configuring-the-prisma-client-api) page.
Expand Down