React を使用して Firebase SQL Connect を使ってみる

このクイックスタートでは、小さなサンプル データベースを作成してデプロイし、 React フロントエンドからアクセスします。

前提条件

このクイックスタートを完了するには、次のものが必要です。

  • NPM を含む Node.js 環境。
  • Google アカウント。

チュートリアル

チュートリアル

1. プロジェクトの初期化

新しいディレクトリを作成し、そのディレクトリで Firebase プロジェクトを初期化します。プロンプトが表示されたら、 次のオプションを選択します。

  • 新しい Firebase プロジェクトを作成します。
  • Gemini でスキーマを作成しないでください（このチュートリアルでは、事前構築済みの サンプル スキーマを使用します）。
  • 新しい Cloud SQL インスタンスを作成します。
  • React テンプレートを作成します。
 
mkdir myproj ; cd myproj
npx -y firebase-tools@latest login --reauth
npx -y firebase-tools@latest init dataconnect

2. GraphQL の定義例を確認する

SQL Connect では、GraphQL を使用してすべてのデータベース スキーマとオペレーションを定義します。プロジェクトを初期化すると、Firebase CLI によって、作業を開始するための定義例が作成されます。

 dataconnect/schema/schema.gql（抜粋） 
type Movie @table {
  title: String!
  imageUrl: String!
  genre: String
}

type MovieMetadata @table {
  movie: Movie! @unique
  rating: Float
  releaseYear: Int
  description: String
}
 dataconnect/example/queries.gql（抜粋） 
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

3. スキーマとオペレーションをデプロイする

データベース スキーマ、クエリ、ミューテーションに変更を加えるたびに、変更をデータベースに反映させるにはデプロイする必要があります。

 
npx -y firebase-tools@latest deploy --only dataconnect

4. サンプルデータでデータベースにシードを設定する

このシードデータを使用すると、サンプルアプリをテストするときに確認できます。注 このステップでは、管理タスクで許可されている任意の GraphQL を実行できます。

 
npx -y firebase-tools@latest \
         dataconnect:execute dataconnect/seed_data.gql

5. JavaScript クライアント SDK を生成する

このコマンドは、GraphQL の定義を使用して、型定義を含むデータベース専用の JavaScript ライブラリ を生成します。このライブラリは、クライアント アプリですべてのデータベース オペレーションを実行するために使用します。

`connector.yaml` に定義を追加することで、Android 用の Kotlin、iOS 用の Swift、Flutter など、複数のプラットフォーム用のライブラリを生成できます。

 
npx -y firebase-tools@latest dataconnect:sdk:generate
 自動生成された React SDK（抜粋） 
export interface ListMoviesData {
  movies: ({
    id: UUIDString;
    title: string;
    imageUrl: string;
    genre?: string | null;
  } & Movie_Key)[];
}

export function useListMovies(
  options?: useDataConnectQueryOptions&<ListMoviesData>
): UseDataConnectQueryResult&<ListMoviesData, undefined>;

6. ウェブアプリを設定する

次のコマンドを実行して、Firebase プロジェクトに新しいウェブアプリを追加します。

 
npx -y firebase-tools@latest \
          apps:create web react-example
npx -y firebase-tools@latest \
          apps:sdkconfig web \
          -o web-app/src/firebase-config.json
cd web-app
npm i firebase \
            @tanstack/react-query \
            @tanstack-query-firebase/react

7. サンプル React クライアントを作成する

web-app/src/App.jsx の内容を、次の簡単な React アプリに置き換えます。

このアプリは、生成された SDK の関数を使用して、必要なデータベース アクセスを完了します。React 用に生成された SDK は、TanStack Query を使用して状態 管理を行います。

 
import { initializeApp } from 'firebase/app';
import firebaseConfig from './firebase-config.json';
import {
  QueryClient,
  QueryClientProvider
} from '@tanstack/react-query';

import { useListMovies } from '@dataconnect/generated/react';
import './App.css';

const app = initializeApp(firebaseConfig);
const queryClient = new QueryClient();

function App() {
  return (
    <QueryClientProvider client={queryClient}>
      <Movies />
    </QueryClientProvider>
  );
}

function Movies() {
  const { isLoading, data } = useListMovies();
  if (isLoading) {
    return <h1>...</h1>
  }
  return (
    <>
      {data?.movies.map(
        movie => <h1 key={movie.id}>{movie.title}</h1>
      )}
    </>
  );
}

export default App;

8. ウェブアプリを試す

開発用サーバーを起動して、サンプルアプリの動作を確認します。

 
npm run dev

次のステップ

SQL Connect VS Code 拡張機能を試す

SQL Connect で開発する場合は、 SQL Connect VS Code 拡張機能を使用することを強くおすすめします。 Visual Studio Code を主要な開発環境として使用していない場合でも、この拡張機能には、スキーマとオペレーションの開発をより便利にするいくつかの機能があります。

  • GraphQL 言語サーバー。 SQL Connect に固有の構文チェックとオートコンプリート候補を提供します。
  • コードに沿った CodeLens ボタン。スキーマ定義ファイルからデータの読み取りと書き込みを行い、オペレーション定義からクエリとミューテーションを実行できます。
  • 生成された SDK を GraphQL の定義と自動的に同期します。
  • ローカル エミュレータの設定を簡素化します。
  • 本番環境へのデプロイを簡素化します。

ローカル開発に SQL Connect エミュレータを使用する

このチュートリアルでは、SQL Connect スキーマとオペレーションを本番環境に直接デプロイする方法について説明しましたが、アプリを積極的に開発している間は、本番環境データベースを変更しないことをおすすめします。代わりに、 SQL Connect エミュレータ を設定し、本番環境ではなくエミュレータに対して開発作業を行います。エミュレータは、ライブ PostgreSQL インスタンスと同様に動作するローカル PGlite インスタンスを Cloud SQL に設定します。

アプリのスキーマと オペレーションを作成する方法を学ぶ

SQL Connect でアプリを開発する場合、スキーマとオペレーションの設計 は、最初に行う最も重要な開発タスクの 1 つです。

  • コンソールのFirebase Gemini は、アプリの自然言語の説明からSQL Connect スキーマを生成できる AI ツールです。このツールを使用すると、特にリレーショナル データベースを初めて使用する場合に、非常に迅速に作業を開始できます。
  • または、GraphQL を使用してデータベース スキーマ、クエリ、ミューテーション を直接作成することもできます。まず、 スキーマSQL Connectの設計のガイダンスから始め、 次のページに進んでオペレーションの作成方法を学習してください。