Erste Schritte mit Firebase Data Connect lokal

Hinweis: Firebase Data Connect befindet sich in der öffentlichen Vorschau. Data Connect unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt dienstspezifische Nutzungsbedingungen der Nutzungsbedingungen der Google Cloud Platform. Pre-GA-Features sind „wie besehen“ verfügbar und bieten möglicherweise nur eingeschränkten Support. Weitere Informationen finden Sie unter Beschreibungen der Startphase.

In dieser Kurzanleitung erfahren Sie, wie Sie Firebase Data Connect lokal in Ihrer Anwendung erstellen, ohne eine Produktions-SQL-Instanz einzurichten.

Hinweis: Folgen Sie dieser lokalen Kurzanleitung, wenn Sie Data Connect mit einem Spark-Planprojekt ausprobieren möchten. In diesem Leitfaden erstellen Sie einen Prototyp lokal mit einem Emulator und einer lokalen Datenbank. Wenn Sie Data Connect stattdessen einem Blaze Plan-Projekt hinzufügen und einen Dienst und eine Cloud SQL-Datenbank einrichten möchten, sehen Sie sich die Einstiegsschritte für die Produktion an.

• Fügen Sie Firebase Data Connect Ihrem Firebase-Projekt hinzu.
• Richten Sie eine Entwicklungsumgebung mit einer Visual Studio Code-Erweiterung ein, um mit einer lokalen Instanz zu arbeiten.
• Anschließend zeigen wir Ihnen, wie Sie:
  • Schema für eine Film-App erstellen
  • Abfragen und Mutationen definieren, die in Ihrer App verwendet werden
  • Abfragen und Mutationen mit Beispieldaten in einem lokalen Emulator testen
  • Stark typisierte SDKs generieren und in Ihrer App verwenden
  • Bereitstellen Sie das endgültige Schema, die Abfragen und die Daten in der Cloud (optional, Blaze-Tarif erforderlich).

In unserem Codelab für das Web finden Sie ein Repository mit einer App für den Einstieg und können eine voll funktionsfähige Data Connect-App erstellen. Codelabs für Android und iOS folgen bald.

Vorbereitung

Für diesen Schnellstart benötigen Sie Folgendes:

• Linux, macOS oder Windows
• Visual Studio Code
• Installieren Sie Node.js mit nvm-windows für Windows oder nvm für macOS oder Linux.
• Falls noch nicht geschehen, erstellen Sie ein Firebase-Projekt in der Firebase Console.

Entwicklungsumgebung einrichten

Sie benötigen Visual Studio Code, um das Schema zu verwalten und Abfragen zu definieren, die in Ihrer Anwendung verwendet werden. Ein stark typisiertes SDK wird automatisch für Sie generiert:

1. Erstellen Sie ein neues Verzeichnis für Ihr lokales Projekt.
2. Öffnen Sie VS Code im neuen Verzeichnis.
3. Installieren Sie die Firebase Data Connect-Erweiterung aus dem Visual Studio Code Marketplace.

Projektverzeichnis einrichten

Um Ihr lokales Projekt einzurichten, müssen Sie das Projektverzeichnis initialisieren. Klicken Sie im linken Bereich von VS Code auf das Firebase-Symbol, um die Benutzeroberfläche der Data Connect-VS Code-Erweiterung zu öffnen:

1. Klicken Sie auf die Schaltfläche Über Google anmelden.
2. Klicken Sie auf die Schaltfläche Firebase-Projekt verknüpfen und wählen Sie das Projekt aus, das Sie zuvor in der Console erstellt haben.
3. Klicken Sie auf die Schaltfläche firebase init ausführen.

4. Klicken Sie auf die Schaltfläche Emulatoren starten.

   Hinweis: Prüfen Sie im integrierten Terminal, ob Ihre konfigurierten Emulatoren gestartet werden. Sobald sie ausgeführt werden, sollte die Erweiterungs-Benutzeroberfläche mit den Emulatordetails aktualisiert werden.

Schema erstellen

Definieren Sie in Ihrem Firebase-Projektverzeichnis in der Datei /dataconnect/schema/schema.gql ein GraphQL-Schema für Filme.

Film

In Data Connect werden GraphQL-Felder Spalten zugeordnet. Der Film hat id, title, imageUrl und genre. Data Connect erkennt primitive Datentypen: String und UUID.

Kopieren Sie das folgende Snippet oder entfernen Sie die Kommentarzeichen für die entsprechenden Zeilen in der Datei.

# By default, a UUID id key will be created by default as primary key.
# If you want to specify a primary key, say title, which you can do through
# the @table(key: "title") directive
type Movie @table {
  id: UUID! @default(expr: "uuidV4()")
  title: String!
  imageUrl: String!
  genre: String
}

MovieMetadata

Kopieren Sie das folgende Snippet oder entfernen Sie die Kommentarzeichen für die entsprechenden Zeilen in der Datei.

# 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
}

Das Feld movie ist einem Typ von Movie zugeordnet. Data Connect ist sich bewusst, dass es sich um eine Beziehung zwischen Movie und MovieMetadata handelt, und verwaltet diese Beziehung für Sie.

Weitere Informationen zu Data Connect-Schemas in der Dokumentation

Tabellen Daten hinzufügen

Im VS Code-Editor werden CodeLens-Schaltflächen über den GraphQL-Typen in /dataconnect/schema/schema.gql angezeigt. Mit den Schaltflächen Daten hinzufügen und Ausführen (lokal) können Sie Ihrer lokalen Datenbank Daten hinzufügen.

So fügen Sie den Tabellen Movie und MovieMetadata Einträge hinzu:

1. Klicken Sie in schema.gql über der Typdeklaration für Movie auf die Schaltfläche Daten hinzufügen.
   
2. Codieren Sie in der generierten Movie_insert.gql-Datei Daten für die drei Felder.
3. Klicken Sie auf die Schaltfläche Ausführen (lokal).
   
4. Wiederhole die vorherigen Schritte, um der Tabelle MovieMetadata einen Datensatz hinzuzufügen. Gib dazu die id deines Films in das Feld movieId ein, wie in der generierten MovieMetadata_insert-Mutation angegeben.

So prüfen Sie schnell, ob Daten hinzugefügt wurden:

1. Klicken Sie in schema.gql über der Typdeklaration für Movie auf die Schaltfläche Daten lesen.
2. Klicken Sie in der resultierenden Movie_read.gql-Datei auf die Schaltfläche Ausführen (lokal), um die Abfrage auszuführen.

Weitere Informationen zu Data Connect-Mutationen in der Dokumentation

Abfrage definieren

Jetzt kommt der Spaß: Definieren wir die Abfragen, die Sie in Ihrer Anwendung benötigen. Als Entwickler sind Sie es gewohnt, SQL-Abfragen anstelle von GraphQL-Abfragen zu schreiben. Das kann sich also anfangs etwas anders anfühlen. GraphQL ist jedoch viel prägnanter und typsicherer als reines SQL. Unsere VS Code-Erweiterung erleichtert die Entwicklung.

Bearbeiten Sie die Datei /dataconnect/connector/queries.gql. Wenn Sie alle Filme abrufen möchten, verwenden Sie eine Abfrage wie diese.

# 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
  }
}

Führen Sie die Abfrage mit der CodeLens-Schaltfläche aus.

Eine wirklich spannende Funktion ist die Möglichkeit, die Beziehungen der Datenbank als Graph darzustellen. Da „MovieMetadata“ ein movie-Feld enthält, das auf einen Film verweist, kannst du das Feld verschachteln und Informationen zu den Filminformationen zurückgeben. Fügen Sie der Abfrage „ListMovies“ den generierten Typ movieMetadata_on_movie hinzu.

query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
    movieMetadata_on_movie {
        rating
    }
  }
}

Weitere Informationen zu Data Connect-Abfragen finden Sie in der Dokumentation.

SDKs generieren und in Ihrer App verwenden

Klicken Sie im linken Bereich von VS Code auf das Firebase-Symbol, um die Benutzeroberfläche der Data Connect-VS Code-Erweiterung zu öffnen:

1. Klicken Sie auf die Schaltfläche SDK zur App hinzufügen.

2. Wählen Sie im angezeigten Dialogfeld ein Verzeichnis mit Code für Ihre App aus. Data Connect. Der SDK-Code wird dort generiert und gespeichert.

   Hinweis :Wenn Sie noch kein App-Verzeichnis haben, können Sie ein neues Verzeichnis für den SDK-Code erstellen und auswählen und es später mit Ihrer App verknüpfen.

3. Wählen Sie Ihre App-Plattform aus. Der SDK-Code wird dann sofort im ausgewählten Verzeichnis generiert.

Informationen zum Aufrufen von Abfragen und Mutationen aus Client-Apps (Web, Android, iOS, Flutter) mit dem generierten SDK

Schema und Abfrage in der Produktion bereitstellen

Sobald Sie die lokale Einrichtung in Ihrer App vorgenommen haben, können Sie Ihr Schema, Ihre Daten und Abfragen in der Cloud bereitstellen. Sie benötigen einen Blaze-Plan, um eine Cloud SQL-Instanz einzurichten.

1. Rufen Sie in der Firebase-Konsole den Bereich „Data Connect“ auf und erstellen Sie eine kostenlose Testversion einer Cloud SQL-Instanz.

   Hinweis: Die Bereitstellung Ihrer Cloud SQL for PostgreSQL-Instanz kann bis zu 15 Minuten dauern. Sie können erst dann eine Bereitstellung vornehmen, wenn Ihre Instanz bereit ist.

2. Führen Sie im integrierten Terminal von VS Code firebase init dataconnect aus und wählen Sie die Region/Dienst-ID aus, die Sie gerade in der Console erstellt haben.

3. Wählen Sie „Ja“ aus, wenn Sie gefragt werden: „Datei dataconnect/dataconnect.yaml existiert bereits, überschreiben?“

4. Klicken Sie in der Benutzeroberfläche der Data Connect-VS Code-Erweiterung auf die Schaltfläche In Produktion bereitstellen.

5. Rufen Sie nach der Bereitstellung die Firebase Console auf, um zu prüfen, ob das Schema, die Vorgänge und die Daten in die Cloud hochgeladen wurden. Sie sollten das Schema sehen und Ihre Vorgänge auch in der Console ausführen können. Die Cloud SQL for PostgreSQL-Instanz wird mit dem endgültig bereitgestellten generierten Schema und den Daten aktualisiert.

Nächste Schritte

Sehen Sie sich Ihr bereitgestelltes Projekt an und entdecken Sie weitere Tools:

• In der Firebase Console können Sie Ihrer Datenbank Daten hinzufügen, Ihre Schemas prüfen und ändern sowie Ihren Data Connect-Dienst überwachen.

Weitere Informationen finden Sie in der Dokumentation. Wenn Sie beispielsweise den Schnellstart abgeschlossen haben:

• Weitere Informationen zur Entwicklung von Schemas, Abfragen und Mutationen
• Informationen zum Generieren von Client-SDKs und zum Aufrufen von Abfragen und Mutationen aus Clientcode für das Web, Android, iOS und Flutter.