Query Engine API でのフィルタリング
In most cases you should not use the Query Engine API and rather use the Document Service API.
Only use the Query Engine API if you exactly know what you are doing, for instance if you want to use a lower-level API that directly interacts with unique rows of the database.
Please keep in mind that the Query Engine API is not aware of the most advanced Strapi 5 features like Draft & Publish, Internationalization, Content History, and possibly more.
This also means that the Query Engine API will not be able to use documentId and will use id, which means it could lead to unattended consequences at the database level or partial or incomplete compatibility with Strapi 5 features.
Before diving deeper into the Query Engine API documentation, it is recommended that you read the following introductions:
- the backend customization introduction,
- and the Content APIs introduction.
Query Engine API では、findMany() の結果をフィルタリングできます。
where パラメータで結果を絞り込みます。where は 論理演算子 と 属性演算子 を受け取り、各演算子は $ で始まります。
For examples of how to deep filter with the various APIs, please refer to this blog article.
論理演算子
$and
ネストした条件がすべて true である必要があります。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
$and: [
{
title: 'Hello World',
},
{
createdAt: { $gt: '2021-11-17T14:28:25.843Z' },
},
],
},
});
ネストした条件をオブジェクトで渡すと、暗黙的に $and が使われます。
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: 'Hello World',
createdAt: { $gt: '2021-11-17T14:28:25.843Z' },
},
});
$or
ネストした条件の 1 つ以上が true である必要があります。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
$or: [
{
title: 'Hello World',
},
{
createdAt: { $gt: '2021-11-17T14:28:25.843Z' },
},
],
},
});
$not
ネストした条件を 否定します。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
$not: {
title: 'Hello World',
},
},
});
$not は次のように使えます。
- 論理演算子（例:
where: { $not: { // conditions… }}） - 属性演算子（例:
where: { attribute-name: $not: { … } }）。
$and、$or、$not は互いにネストできます。
属性演算子
これらの演算子は Strapi ではなくデータベース側で比較されるため、利用するデータベース実装により結果が異なる場合があります。
$not
ネストした条件を否定します。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$not: {
$contains: 'Hello World',
},
},
},
});
$eq
属性が入力値と等しい。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$eq: 'Hello World',
},
},
});
$eq は省略できます。
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: 'Hello World',
},
});
$eqi
属性が入力値と等しい（大文字・小文字を区別しない）。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$eqi: 'HELLO World',
},
},
});
$ne
属性が入力値と等しくない。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$ne: 'ABCD',
},
},
});
$nei
属性が入力値と等しくない（大文字・小文字を区別しない）。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$nei: 'abcd',
},
},
});
$in
属性が入力リストに含まれる。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$in: ['Hello', 'Hola', 'Bonjour'],
},
},
});
値の配列を渡す場合は $in を省略できます。
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: ['Hello', 'Hola', 'Bonjour'],
},
});
$notIn
属性が入力リストに含まれない。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$notIn: ['Hello', 'Hola', 'Bonjour'],
},
},
});
$lt
属性が入力値より小さい。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
rating: {
$lt: 10,
},
},
});
$lte
属性が入力値以下。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
rating: {
$lte: 10,
},
},
});
$gt
属性が入力値より大きい。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
rating: {
$gt: 5,
},
},
});
$gte
属性が入力値以上。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
rating: {
$gte: 5,
},
},
});
$between
属性が 2 つの入力値のあいだ（境界を含む）。例: $between[1, 3] は 1 と 3 も返します。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
rating: {
$between: [1, 20],
},
},
});
$contains
属性が入力値を含む（大文字・小文字を区別）。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$contains: 'Hello',
},
},
});
$notContains
属性が入力値を含まない（大文字・小文字を区別）。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$notContains: 'Hello',
},
},
});
$containsi
属性が入力値を含む。$containsi は大文字・小文字を区別せず、$contains は区別します。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$containsi: 'hello',
},
},
});
$notContainsi
属性が入力値を含まない。$notContainsi は大文字・小文字を区別せず、$notContains は区別します。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$notContainsi: 'hello',
},
},
});
$startsWith
属性が入力値で始まる。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$startsWith: 'ABCD',
},
},
});
$endsWith
属性が入力値で終わる。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$endsWith: 'ABCD',
},
},
});
$null
属性が null である。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$null: true,
},
},
});
$notNull
属性が null でない。
例
const entries = await strapi.db.query('api::article.article').findMany({
where: {
title: {
$notNull: true,
},
},
});