クエリエンジンAPI

AI Marketerのバックエンドは、データベースレイヤーとより低いレベルで対話するためのクエリエンジンAPIを提供しています。

✋ Caution

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.

☑️ Prerequisites

クエリエンジンAPIのドキュメンテーションを深く掘り下げる前に、以下の紹介を読むことをお勧めします:

• バックエンドのカスタマイズの紹介、
• Content APIsの紹介。

基本的な使用方法

クエリエンジンは AI Marketer.db.query を通じて利用できます:

AI Marketer.db.query('api::blog.article').findMany({ // uid syntax: 'api::api-name.content-type-name'
  where: {
    title: {
      $startsWith: '2021',
      $endsWith: 'v4',
    },
  },
  populate: {
    category: true,
  },
});

利用可能な操作

クエリエンジンは、データベースエントリーに対して以下の操作を許可します:

📄️ 単一の操作

クエリエンジンAPIを使用して、データベースエントリーを作成、読み取り、更新、削除します。

📄️ 一括操作

クエリエンジンAPIを使用して、複数のデータベースエントリを作成、読み取り、更新、削除します。

📄️ フィルター

クエリエンジンAPIを使用してデータベースエントリをフィルタリングし、必要なものを正確に取得します。

📄️ Populate

関係をポピュレートすることで、クエリエンジンAPIのクエリに追加データを取得します。

📄️ 順序付けとページネーション

クエリエンジンAPIのクエリの結果をソートし、ページネーションします。