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

クイックスタート

Prisma Postgres

このクイックスタートガイドでは、プレーンな TypeScript プロジェクトで、Prisma ORM と Prisma Postgres データベースをゼロから始める方法を学びます。以下のワークフローについて説明します。

前提条件​

このチュートリアルを完了するには、以下が必要です。

  • a(PDP) アカウント
  • Node.js がマシンにインストールされていること（公式にサポートされているバージョンについては、システム要件 を参照してください）

1. プラットフォームコンソールで Prisma Postgres データベースをセットアップする​

Prisma Postgres データベースを作成するには、以下の手順に従ってください。

  1. にログインしコンソールを開きます。
  2. 任意の ワークスペース で、[新しいプロジェクト] ボタンをクリックします。
  3. [名前] フィールドにプロジェクト名を入力します。例: hello-ppg。
  4. [Prisma Postgres] セクションで、[開始する] ボタンをクリックします。
  5. [リージョン] ドロップダウンで、現在地から最も近いリージョンを選択します。例: 米国東部 (バージニア北部)。
  6. [プロジェクトを作成] ボタンをクリックします。

この時点で、[データベース] ページにリダイレクトされ、データベースのステータスが PROVISIONING から CONNECTED に変わるまで数秒待つ必要があります。

緑色の CONNECTED ラベルが表示されたら、データベースは使用可能です。

2. 例をダウンロードして依存関係をインストールする​

コンソールに表示されている try-prisma コマンドをコピーし、ターミナルに貼り付けて実行します。

参考までに、コマンドは次のようになります。

npx try-prisma@latest \
  --template databases/prisma-postgres \
  --name hello-prisma \
  --install npm

try-prisma コマンドが終了したら、プロジェクトディレクトリに移動します。

cd hello-prisma

3. データベース接続 URL を設定する​

データベースへの接続は、.env ファイルの環境変数を使用して構成されます。

まず、既存の .env.example ファイルの名前を .env に変更します。

mv .env.example .env

次に、プラットフォームコンソールのプロジェクト環境で、[データベースアクセスを設定] セクションでデータベースの資格情報を見つけ、DATABASE_URL 環境変数をコピーして .env ファイルに貼り付けます。

参考までに、ファイルは次のようになります。

DATABASE_URL="prisma+postgres://accelerate.prisma-data.net/?api_key=ey...."

4. データベーステーブルを作成する (スキーマ移行を使用)​

次に、データベースにテーブルを作成する必要があります。これは、Prisma CLI の次のコマンドを使用してスキーマ移行を作成および実行することで実行できます。

npx prisma migrate dev --name init

これにより、Prisma スキーマ で定義されている User モデルと Post モデルがデータベースにマッピングされます。また、実行され、新しく作成された prisma/migrations ディレクトリにテーブルを作成した SQL 移行を確認することもできます。

5. Prisma ORM でクエリを実行する​

src/queries.ts スクリプトには、データベースにデータを書き込みおよび読み取る多数の CRUD クエリが含まれています。ターミナルで次のコマンドを実行して実行できます。

npm run queries

スクリプトが完了したら、ターミナルのログを調べるか、Prisma Studio を使用してデータベースに作成されたレコードを確認できます。

npx prisma studio

6. Prisma Accelerate でキャッシングを試す​

src/caching.ts スクリプトには、Stale-While-Revalidate (SWR) と Time-To-Live (TTL) を使用して、Prisma Accelerate を使用してデータベースクエリをキャッシュするサンプルクエリが含まれています。次のように実行できます。

npm run caching

クエリの実行にかかった時間 (例:

The query took 2009.2467149999998ms.

次に、スクリプトを再度実行します。

npm run caching

クエリにかかった時間が今回は大幅に短縮されていることに気付くでしょう。例:

The query took 300.5655280000001ms.

7. 次のステップ​

このクイックスタートガイドでは、プレーンな TypeScript プロジェクトで Prisma ORM を始める方法を学びました。たとえば、findMany クエリにフィルタリング、ソート、およびページネーションオプションを含めたり、update や delete クエリなどのより多くの操作を試したりして、Prisma Client API をさらに自由に探索してください。

Prisma Studio でデータを探索する​

Prisma ORM には、データベース内のデータを表示および編集するための組み込み GUI が付属しています。次のコマンドを使用して開くことができます。

npx prisma studio

Prisma Postgres を使用すると、Prisma Studio をプロジェクトの [Studio] タブを選択して、直接使用することもできます。

Next.js でフルスタックアプリを構築する​

フルスタックアプリで Prisma Postgres を使用する方法を学びます。

すぐに実行できる Prisma ORM の例を探索する​

prisma-examples GitHub リポジトリをチェックして、Prisma ORM をお気に入りのライブラリで使用する方法を確認してください。このリポジトリには、Express、NestJS、GraphQL の例と、Next.js や Vue.js を使用したフルスタックの例など、多くの例が含まれています。

これらの例ではデフォルトで SQLite が使用されていますが、プロジェクトの README の指示に従って、いくつかの簡単な手順で Prisma Postgres に切り替えることができます。


Prisma とつながる

活発なコミュニティ に参加して、Prisma の旅を続けましょう。最新情報を入手し、参加して、他の開発者と協力しましょう。 活発なコミュニティ に参加して、Prisma の旅を続けましょう。最新情報を入手し、参加して、他の開発者と協力しましょう

皆様のご参加を心より歓迎し、コミュニティの一員としてお迎えできることを楽しみにしています。