メインコンテンツまでスキップ

where リレーションフィルタ

where 条件の中でリレーション先のデータを基準にフィルタリングしたい場合に利用します。

使用するには事前にリレーション定義が必要です。

説明例用のシート​

リレーション定義のシート例を使用します。

対応するメソッド​

where リレーションフィルタは以下の全メソッドで利用できます。

  • findMany / findFirst
  • update / updateMany / deleteMany
  • aggregate / count / groupBy

フィルタの種類​

リレーションの種類によって使用できるフィルタが異なります。

フィルタoneToManymanyToManyoneToOnemanyToOne
some使用可使用可--
every使用可使用可--
none使用可使用可--
is--使用可使用可
isNot--使用可使用可

リストリレーションのフィルタ（oneToMany / manyToMany）​

some​

関連レコードの中に少なくとも 1 つ条件に一致するものがあるレコードを取得します。

例：公開済みの投稿を 1 件以上持つユーザーを取得

const result = gassma.Users.findMany({
  where: {
    posts: {
      some: { published: true },
    },
  },
});

戻り値は以下の形式です。

[
  { id: 1, name: "Alice", email: "[email protected]" },
];

Alice は公開済みの投稿を持っているため取得されます。Bob は published: false の投稿のみ、Charlie は投稿なしのため除外されます。

every​

関連レコードの全てが条件に一致するレコードを取得します。関連レコードが 0 件の場合も一致扱いになります。

例：全ての投稿が公開済みのユーザーを取得

const result = gassma.Users.findMany({
  where: {
    posts: {
      every: { published: true },
    },
  },
});

戻り値は以下の形式です。

[
  { id: 1, name: "Alice", email: "[email protected]" },
  { id: 3, name: "Charlie", email: "[email protected]" },
];

Alice は全投稿が published: true、Charlie は投稿が 0 件（=全てが条件を満たす）のため取得されます。

none​

関連レコードの中に条件に一致するものが1 つもないレコードを取得します。

例：公開済みの投稿を 1 件も持たないユーザーを取得

const result = gassma.Users.findMany({
  where: {
    posts: {
      none: { published: true },
    },
  },
});

戻り値は以下の形式です。

[
  { id: 2, name: "Bob", email: "[email protected]" },
  { id: 3, name: "Charlie", email: "[email protected]" },
];
注記

親レコード自身の結合キー（リレーション定義の reference に指定した列）が null の場合、関連レコードは 0 件として扱われます。そのため every（全てが条件を満たす扱い）と none（一致するものがない扱い）の結果には含まれ、some の結果には含まれません（Prisma と同じです）。

単一リレーションのフィルタ（oneToOne / manyToOne）​

is​

関連レコードが条件に一致するレコードを取得します。null を指定すると、関連レコードが存在しないレコードを取得できます。

例：著者名が "Alice" の投稿を取得

const result = gassma.Posts.findMany({
  where: {
    author: {
      is: { name: "Alice" },
    },
  },
});

戻り値は以下の形式です。

[
  { id: 1, title: "初めての投稿", authorId: 1, published: true },
  { id: 2, title: "GASの使い方", authorId: 1, published: true },
];

is: null​

関連レコードが存在しないレコードを取得できます。manyToOne（FK を保有する側）では FK が null のレコード、oneToOne（FK を持たない側）では関連レコードが存在しないレコードが対象になります。

例：著者（FK の authorId）が null の投稿を取得

const result = gassma.Posts.findMany({
  where: {
    author: {
      is: null,
    },
  },
});

例：プロフィールを持たないユーザーを取得（非FK側の oneToOne）

const result = gassma.Users.findMany({
  where: {
    profile: {
      is: null,
    },
  },
});

戻り値は以下の形式です。

[
  { id: 3, name: "Charlie", email: "[email protected]" },
];
注記

oneToOne（FK を持たない側）では、自分側の結合キー（reference に指定した列）が null のレコードも「関連レコードが存在しない」として is: null の結果に含まれます。

isNot​

関連レコードが条件に一致しないレコードを取得します。null を指定すると、関連レコードが存在するレコードを取得できます。

例：著者名が "Alice" ではない投稿を取得

const result = gassma.Posts.findMany({
  where: {
    author: {
      isNot: { name: "Alice" },
    },
  },
});

戻り値は以下の形式です。

[
  { id: 3, title: "下書き記事", authorId: 2, published: false },
];
注記

関連レコードを持たない行（manyToOne では FK が null の行、oneToOne では関連レコードが存在しない行）も isNot: <条件> の結果に含まれます。関連レコードが存在しない = 「条件に一致する関連レコードを持たない」扱いです（Prisma と同じです）。

isNot: null​

関連レコードが存在するレコードを取得できます。manyToOne（FK を保有する側）では FK が null でないレコード、oneToOne（FK を持たない側）では関連レコードが存在するレコードが対象になります。

const result = gassma.Posts.findMany({
  where: {
    author: {
      isNot: null,
    },
  },
});

AND / OR / NOT との組み合わせ​

リレーションフィルタは AND / OR / NOT と自由に組み合わせることができます。

OR との組み合わせ​

例：公開済みの投稿を持つユーザー、または名前が "Charlie" のユーザーを取得

const result = gassma.Users.findMany({
  where: {
    OR: [
      { posts: { some: { published: true } } },
      { name: "Charlie" },
    ],
  },
});

NOT との組み合わせ​

例：下書き記事を持たないユーザーを取得

const result = gassma.Users.findMany({
  where: {
    NOT: {
      posts: { some: { published: false } },
    },
  },
});

findMany / findFirst 以外での使用例​

updateMany​

公開済み投稿を持つユーザーのメールアドレスを更新

gassma.Users.updateMany({
  where: {
    posts: { some: { published: true } },
  },
  data: {
    email: "[email protected]",
  },
});

count​

公開済み投稿を持つユーザー数をカウント

const count = gassma.Users.count({
  where: {
    posts: { some: { published: true } },
  },
});

バリデーション​

エラー原因
WhereRelationWithoutContextErrorリレーション定義なしでリレーションフィルタ構文を使用
WhereRelationInvalidFilterErrorリストフィルタ (some/every/none) を oneToOne/manyToOne に使用、または単一フィルタ (is/isNot) を oneToMany/manyToMany に使用