メインコンテンツへスキップ

1対1のリレーション

このページでは、1対1のリレーションを紹介し、Prismaスキーマでそれらを使用する方法について説明します。

概要​

1対1（1-1）リレーションとは、リレーションの両側で最大1つのレコードを接続できるリレーションを指します。以下の例では、UserとProfileの間に1対1のリレーションがあります。

model User {
  id      Int      @id @default(autoincrement())
  profile Profile?
}

model Profile {
  id     Int  @id @default(autoincrement())
  user   User @relation(fields: [userId], references: [id])
  userId Int  @unique // relation scalar field (used in the `@relation` attribute above)
}

userIdリレーションスカラーは、基盤となるデータベースの外部キーを直接表現したものです。この1対1のリレーションは、以下を表現しています。

  • 「ユーザーはプロファイルをゼロ個または1個持つことができる」（profileフィールドがUserでオプションであるため）
  • 「プロファイルは常に1人のユーザーに接続されている必要がある」

前の例では、Profileモデルのuserリレーションフィールドは、Userモデルのidフィールドを参照しています。別のフィールドを参照することもできます。この場合、各Profileに接続されているUserが1つだけであることを保証するために、フィールドに@unique属性をマークする必要があります。次の例では、userフィールドはUserモデルのemailフィールドを参照しており、これは@unique属性でマークされています。

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique // <-- add unique attribute
  profile Profile?
}

model Profile {
  id        Int    @id @default(autoincrement())
  user      User   @relation(fields: [userEmail], references: [email])
  userEmail String @unique // relation scalar field (used in the `@relation` attribute above)
}
警告

MySQLでは、参照側のインデックスのみで、ユニーク制約なしで外部キーを作成できます。Prisma ORMバージョン4.0.0以降では、このタイプのリレーションをイントロスペクションすると、バリデーションエラーが発生します。これを修正するには、参照フィールドに@unique制約を追加する必要があります。

リレーショナルデータベースにおける複合フィールドリレーション​

リレーショナルデータベースのみでは、1対1のリレーションを定義するために複合フィールドIDを使用することもできます。

model User {
  firstName String
  lastName  String
  profile   Profile?

  @@id([firstName, lastName])
}

model Profile {
  id            Int    @id @default(autoincrement())
  user          User   @relation(fields: [userFirstName, userLastName], references: [firstName, lastName])
  userFirstName String // relation scalar field (used in the `@relation` attribute above)
  userLastName  String // relation scalar field (used in the `@relation` attribute above)

  @@unique([userFirstName, userLastName])
}

データベースにおける1-1リレーション​

リレーショナルデータベース​

以下の例は、SQLで1対1のリレーションを作成する方法を示しています。

CREATE TABLE "User" (
    id SERIAL PRIMARY KEY
);
CREATE TABLE "Profile" (
    id SERIAL PRIMARY KEY,
    "userId" INTEGER NOT NULL UNIQUE,
    FOREIGN KEY ("userId") REFERENCES "User"(id)
);

外部キーuserIdにUNIQUE制約があることに注意してください。このUNIQUE制約がない場合、リレーションは1対多のリレーションと見なされます。

以下の例は、複合キー（firstNameとlastName）を使用してSQLで1対1のリレーションを作成する方法を示しています。

CREATE TABLE "User" (
    firstName TEXT,
    lastName TEXT,
    PRIMARY KEY ("firstName","lastName")
);
CREATE TABLE "Profile" (
    id SERIAL PRIMARY KEY,
    "userFirstName" TEXT NOT NULL,
    "userLastName" TEXT NOT NULL,
    UNIQUE ("userFirstName", "userLastName")
    FOREIGN KEY ("userFirstName", "userLastName") REFERENCES "User"("firstName", "lastName")
);

MongoDB​

MongoDBの場合、Prisma ORMは現在、正規化されたデータモデル設計を使用しています。これは、ドキュメントがリレーショナルデータベースと同様の方法でIDによって相互参照することを意味します。

次のMongoDBドキュメントは、Userを表します。

{ "_id": { "$oid": "60d58e130011041800d209e1" }, "name": "Bob" }

次のMongoDBドキュメントは、Profileを表します。userIdフィールドに注目してください。これは、Userドキュメントの$oidを参照しています。

{
  "_id": { "$oid": "60d58e140011041800d209e2" },
  "bio": "I'm Bob, and I like drawing.",
  "userId": { "$oid": "60d58e130011041800d209e1" }
}

必須およびオプションの1-1リレーションフィールド​

1対1のリレーションでは、リレーションスカラー（データベースの外部キーを表すフィールド）がない側のリレーションはオプションである必要があります。

model User {
  id      Int      @id @default(autoincrement())
  profile Profile? // No relation scalar - must be optional
}

この制限は2.12.0で導入されました。

ただし、リレーションスカラーがある側のリレーションをオプションにするか必須にするかを選択できます。

必須の1-1リレーション​

次の例では、profileとprofileIdは必須です。これは、Profileを接続または作成せずにUserを作成できないことを意味します。

model User {
  id        Int     @id @default(autoincrement())
  profile   Profile @relation(fields: [profileId], references: [id]) // references `id` of `Profile`
  profileId Int     @unique // relation scalar field (used in the `@relation` attribute above)
}

model Profile {
  id   Int   @id @default(autoincrement())
  user User?
}

オプションの1-1リレーション​

次の例では、profileとprofileIdはオプションです。これは、Profileを接続または作成せずにユーザーを作成できることを意味します。

model User {
  id        Int      @id @default(autoincrement())
  profile   Profile? @relation(fields: [profileId], references: [id]) // references `id` of `Profile`
  profileId Int?     @unique // relation scalar field (used in the `@relation` attribute above)
}

model Profile {
  id   Int   @id @default(autoincrement())
  user User?
}

1-1リレーションで外部キーを格納する側を選択する​

1-1リレーションでは、リレーションのどちら側を@relation属性でアノテーションするか（したがって外部キーを保持するか）を自分で決定できます。

次の例では、Profileモデルのリレーションフィールドは@relation属性でアノテーションされています。userIdは、基盤となるデータベースの外部キーを直接表現したものです。

model User {
  id      Int      @id @default(autoincrement())
  profile Profile?
}

model Profile {
  id     Int  @id @default(autoincrement())
  user   User @relation(fields: [userId], references: [id])
  userId Int  @unique // relation scalar field (used in the `@relation` attribute above)
}

リレーションの反対側を@relation属性でアノテーションすることもできます。次の例は、Userモデルのリレーションフィールドをアノテーションしています。profileIdは、基盤となるデータベースの外部キーを直接表現したものです。

model User {
  id        Int      @id @default(autoincrement())
  profile   Profile? @relation(fields: [profileId], references: [id])
  profileId Int?     @unique // relation scalar field (used in the `@relation` attribute above)
}

model Profile {
  id   Int   @id @default(autoincrement())
  user User?
}