開始使用 Firebase Data Connect

注意：Firebase Data Connect 為公開測試版。Data Connect 將受《Google Cloud Platform 服務條款》中「服務專屬條款」一節的「正式發布前產品條款」規範。正式發布前功能是依「原樣」提供，支援服務可能受限。詳情請參閱推出階段說明。

在本快速入門導覽課程中，您將瞭解如何在應用程式中建構 Firebase Data Connect。

注意： 如要將 Data Connect 新增至 Blaze 方案中的某個 Firebase 專案，請按照這份快速入門指南操作，建立 Data Connect 服務，並為原型設計提供 Cloud SQL 資料庫。如果您想使用 Spark 方案，並在本機使用模擬器和本機資料庫建立原型，請嘗試本機開發入門。

• 將 Firebase Data Connect 新增至 Firebase 專案。
• 設定開發環境，包括 Visual Studio Code 擴充功能，以便與實際工作環境執行個體搭配使用。
• 接著，我們會說明如何：
  • 為電影評論應用程式建立結構定義，並部署至實際工作環境。
  • 為結構定義查詢和變異式。
  • 產生強型別 SDK，並在應用程式中使用
  • 將最終的結構定義、查詢和資料部署至實際工作環境。

按照網頁程式碼研究室的指示，找出快速入門應用程式存放區，並建構功能齊全的 Data Connect 應用程式。我們即將推出 Android 和 iOS 版程式碼研究室。

事前準備

如要在本機環境中使用本快速入門導覽課程，您需要下列項目。

• Linux、macOS 或 Windows
• Visual Studio Code

連線至 Firebase 專案

1. 如果您還沒有 Firebase 專案，請先建立。
   1. 在 Firebase 控制台中，按一下「新增專案」，然後按照畫面上的指示操作。
2. 前往 Firebase 控制台的 Data Connect 專區，然後按照產品設定工作流程操作。

3. 將專案升級至 Blaze 方案。這樣一來，您就能建立 PostgreSQL 適用的 Cloud SQL 執行個體。

   注意： 雖然您在 Blaze 升級中設定了帳單設定，但在預覽期間，您不會因使用 Data Connect 或預設 PostgreSQL 適用的 Cloud SQL 設定而遭到收費。

4. 選取 CloudSQL for PostgreSQL 資料庫的位置。

5. 請記下專案、服務和資料庫的名稱和 ID，以便稍後確認。

6. 按照剩餘的設定流程操作，然後按一下「完成」。

   注意： 為 Cloud SQL for PostgreSQL 例項佈建預配作業最多可能需要 15 分鐘。您可以使用 Google Cloud 主控台確認 Data Connect 設定流程 (包括資料庫佈建) 是否已完成。

選擇並設定開發環境

Data Connect 支援兩種開發體驗：

• 如果您是 Kotlin Android、iOS、Flutter 或 網頁開發人員，可以使用 VS Code 開發工具，在連線至 Cloud SQL for PostgreSQL 執行個體的同時，在本機設計及測試結構定義和作業。
• 如果您是網頁開發人員，可以使用 IDX 開發工具，在 IDX 工作區中使用預先設定的 IDX 範本 (搭配 PostgreSQL)、VS Code 擴充功能 (搭配 Data Connect 模擬器) 和快速入門用途的用戶端程式碼進行原型設計。如需進一步瞭解相關資訊，請前往 Project IDX 網站。

本快速入門課程著重於 VS Code 擴充功能的開發流程。如要繼續操作，請按照下列步驟操作：

1. 為本機專案建立新目錄。
2. 在新目錄中開啟 VS Code。

3. 前往 Visual Studio Code Marketplace 安裝 Firebase Data Connect 擴充功能。

   注意： 此擴充功能包含市集的 GraphQL 語法醒目顯示擴充功能。您安裝的其他 GraphQL 擴充功能可能會與 Firebase Data Connect 擴充功能內建的 GraphQL 支援功能發生衝突。

設定本機專案

注意： 如果您不使用 IDX，請按照本節中的步驟操作。

按照一般操作說明安裝 CLI。如果您已安裝 npm，請執行下列指令：

npm install -g firebase-tools

注意： 如果您使用的是現有的 CLI 安裝版本，請務必更新至最新版本。

設定專案目錄

如要設定本機專案，請初始化專案目錄。

在 VS Code 左側面板中，按一下 Firebase 圖示，開啟 Firebase VS Code 擴充功能 UI。

1. 點選「使用 Google 帳戶登入」按鈕。
2. 按一下「連結 Firebase 專案」按鈕，然後選取您先前在控制台中建立的專案。
3. 按一下「Run firebase init」按鈕。
4. 如果您的專案採用 Blaze 方案，當系統提示「您是否想立即設定後端資源？」時，請回答「是」。

5. 按一下「Start emulators」按鈕。

   注意： 在整合式終端機中，確認已設定的模擬器是否啟動。執行後，您應該會看到擴充功能 UI 更新，並顯示模擬器詳細資料。

建立結構定義

在 Firebase 專案目錄的 /dataconnect/schema/schema.gql 檔案中，開始定義包含電影的 GraphQL 結構定義。

電影

在 Data Connect 中，GraphQL 欄位會對應至資料欄。Movie 類型包含 id、title、imageUrl 和 genre。Data Connect 會辨識原始資料類型 String 和 UUID。

複製下列程式碼片段，或取消註解檔案中的對應行。

# File `/dataconnect/schema/schema.gql`

# By default, a UUID id key will be created by default as primary key.
type Movie @table {
  id: UUID! @default(expr: "uuidV4()")
  title: String!
  imageUrl: String!
  genre: String
}

MovieMetadata

有了電影後，您就可以模擬電影中繼資料。

複製下列程式碼片段，或取消註解檔案中的對應行。

# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata @table {
  # This time, we omit adding a primary key because
  # you can rely on Data Connect to manage it.

  # @unique indicates a 1-1 relationship
  movie: Movie! @unique
  # movieId: UUID <- this is created by the above reference
  rating: Float
  releaseYear: Int
  description: String
}

請注意，movie 欄位會對應至 Movie 類型。Data Connect 瞭解這是 Movie 與 MovieMetadata 之間的關係，並會為您管理這項關係。

進一步瞭解說明文件中的 Data Connect 結構定義

將結構定義部署至實際工作環境

如果您使用 Firebase VS Code 擴充功能搭配正式資料庫，請先部署結構定義再繼續操作。將結構定義部署至實際運作資料庫後，您應該可以在控制台中查看結構定義。

注意： 為 PostgreSQL 適用的 Cloud SQL 例項進行佈建作業最多可能需要 15 分鐘。在執行個體準備就緒前，您無法進行部署。部署結構定義前，請使用 Google Cloud 控制台確認 Data Connect 設定流程 (包括資料庫佈建) 已完成。

1. 您可以使用 Data Connect VS Code 擴充功能進行部署。
   • 在擴充功能 UI 的 Firebase Data Connect 面板下方，按一下「部署至生產環境」。
2. 您可能需要檢查結構定義變更，並核准可能會造成破壞性的修改。系統會提示你：
   • 使用 firebase dataconnect:sql:diff 查看結構定義變更
   • 滿意變更內容後，請使用 firebase dataconnect:sql:migrate 啟動的流程套用變更。

在表格中新增資料

在 VS Code 編輯器面板中，您會看到 CodeLens 按鈕會顯示在 /dataconnect/schema/schema.gql 中的 GraphQL 類型上。由於您已將結構定義部署至實際執行環境，因此可以使用「Add data」和「Run (Production)」按鈕，將資料新增至後端資料庫。

如要在 Movie 表格中新增記錄，請按照下列步驟操作：

1. 在 schema.gql 中，按一下 Movie 類型宣告上方的「Add data」按鈕。
   
2. 在產生的 Movie_insert.gql 檔案中，為四個欄位硬式編碼資料。
3. 按一下「Run (Production)」按鈕。
   
4. 重複上述步驟，在 MovieMetadata 資料表中新增記錄，並在 movieId 欄位中提供電影的 id，如產生的 MovieMetadata_insert 變異顯示。

如要快速驗證資料是否已新增，請按照下列步驟操作：

1. 回到 schema.gql，按一下 Movie 類型宣告上方的「Read data」按鈕。
2. 在產生的 Movie_read.gql 檔案中，按一下「Run (Production)」按鈕執行查詢。

進一步瞭解說明文件中的 Data Connect 變異體

定義查詢

接下來是查詢的部分。開發人員通常習慣編寫 SQL 查詢，而非 GraphQL 查詢，因此一開始可能會覺得有點不同。不過，GraphQL 比原始 SQL 更精簡，且具有類型安全性。我們的 VS Code 擴充功能可讓開發體驗更輕鬆。

開始編輯 /dataconnect/connector/queries.gql 檔案。如要取得所有電影，請使用類似以下的查詢。

# File `/dataconnect/connector/queries.gql`

# @auth() directives control who can call each operation.
# Anyone should be able to list all movies, so the auth level
# is set to PUBLIC
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

使用附近的 CodeLens 按鈕執行查詢。

提示： 您可以在 Firebase 中使用 Gemini，在 Firebase 主控台中建立及測試 GraphQL 查詢。如要進一步瞭解如何使用 AI 協助功能查詢和變更，請參閱這篇文章。

進一步瞭解說明文件中的 Data Connect 查詢

產生 SDK 並在應用程式中使用

1. 按一下「Add SDK to app」按鈕。

2. 在隨即顯示的對話方塊中，選取包含應用程式程式碼的目錄。Data Connect。系統會在該處產生並儲存 SDK 程式碼。

   注意： 如果您還沒有應用程式目錄，可以先建立並選取 SDK 程式碼的新目錄，稍後再將其連結至應用程式。

3. 選取應用程式平台後，SDK 程式碼會立即在所選目錄中產生。

瞭解如何使用產生的 SDK，從用戶端應用程式 (網頁、Android、iOS、Flutter) 呼叫查詢和突變。

將結構定義和查詢部署至實際工作環境

您已完成一個開發迭代。您現在可以使用 Firebase 擴充功能 UI 或 Firebase CLI，將結構定義、資料和查詢部署至伺服器，就像為結構定義執行這項操作一樣。

如果您使用 Firebase VS Code 擴充功能進行部署，請按一下「Deploy to production」(部署至正式版) 按鈕。

部署完成後，請前往 Firebase 控制台，確認結構定義、作業和資料已上傳至雲端。您應該可以查看結構定義，並在控制台中執行作業。Cloud SQL for PostgreSQL 執行個體會更新為最終部署產生的結構定義和資料。

進一步瞭解如何在說明文件中使用 Data Connect Emulator

後續步驟

查看已部署的專案，並探索更多工具：

• 在 Firebase 控制台中，您可以將資料新增至資料庫、檢查及修改結構定義，以及監控 Data Connect 服務。如需更多資訊，請參閱說明文件。舉例來說，您已完成快速入門導覽課程：

• 進一步瞭解結構定義、查詢和變異式開發

• 瞭解如何為 網頁、Android、iOS 和 Flutter 產生用戶端 SDK，以及從用戶端程式碼呼叫查詢和變異。