Firebase CLI-Befehlsreferenz für Data Connect

Mit der Firebase-Befehlszeile können Sie Firebase verwalten und konfigurieren. über die Befehlszeile nutzen.

Die Befehlszeile bietet Befehle, mit denen eine Vielzahl von Data Connect Aufgaben, z. B. das Erstellen einer neuen Data Connect Projekt, Initialisieren eines entsprechenden lokalen Arbeitsverzeichnisses, Einrichten der Data Connect-Emulator, der Data Connect Ressourcen auflistet, und Generierung von Client-SDKs.

Befehle zur Einrichtung

Data Connect einem Firebase-Projekt hinzufügen

Firebase Init

Verwenden Sie firebase init, um eine neue lokale Projektkonfiguration einzurichten. Mit diesem Workflow werden Firebase-Konfigurationsdateien in Ihrem Verzeichnis erstellt oder aktualisiert.

firebase init

Der firebase init-Vorgang führt Sie durch die Einrichtung eines Dienstes und einer Datenbank sowie optional durch die Installation des Data Connect-Emulators und die Konfiguration generierter SDKs.

Dienst- und Datenbankeinrichtung

Wenn Sie dataconnect für die Produkteinrichtung auswählen, werden Sie in der Befehlszeile aufgefordert, einen neuen Dienstnamen und Speicherort anzugeben und zu entscheiden, ob Sie eine vorhandene Cloud SQL for PostgreSQL-Instanz verknüpfen oder eine neue erstellen möchten.

Wenn eine vorhandene Instanz verknüpft ist, prüft die Befehlszeile auf kompatible Einstellungen wie wie IAM-Authentifizierung und öffentliche IP-Adressen.

Local Emulator Suite-Einrichtung

Im Befehlszeilenablauf können Sie Emulatoren einrichten, einschließlich der Data Connect Emulator.

Data Connect-Emulatorbefehle

Data Connect-Emulator starten

emulators:start/exec

firebase emulators:start/exec

Die Local Emulator Suite-Version des Data Connect-Emulators verwenden im interaktiven Modus mit start oder im skriptbasierten, nicht interaktiven Modus mit exec.

Schema- und Connector-Verwaltungsbefehle

Dieser Abschnitt enthält Befehlszeilen-Referenzinformationen zu Befehlen, die Sie zum Verwalten Schemas und Connectors.

Anwendungsfälle und empfohlene Praktiken im Zusammenhang mit diesen Befehlen finden Sie unter im Leitfaden zur Schema- und Connector-Verwaltung.

Schema- und Connector-Ressourcen bereitstellen

bereitstellen

firebase deploy

Mit diesem Befehl werden Ressourcen für Data Connect-Dienste bereitgestellt, die in firebase.json auf. Eine Schemamigration bei Bedarf durchgeführt wird.

Befehl Beschreibung

Firebase-Bereitstellung

Flag Beschreibung

–-only dataconnect

Schemas und Connectors für alle Data Connect-Dienste dafür bereitstellen Projekt erstellen, aber keine anderen Firebase-Produktressourcen bereitstellen.

–-only dataconnect:serviceId

Schema und Connectors für den angegebenen Data Connect-Dienst bereitstellen

–-only dataconnect:serviceId:connectorId

Einen einzelnen Connector für den angegebenen Data Connect-Dienst bereitstellen

–-only dataconnect:serviceId:schema

Stellen Sie das Schema für den angegebenen Data Connect-Dienst bereit.

Mit den –-only-Flags können Sie durch Kommas getrennte Werte übergeben, um eine beliebige Teilmenge von Ressourcen bereitzustellen.

firebase deploy --only dataconnect:service1:schema,dataconnect:service2

Data Connect-Dienste, -Schemas und -Connectors auflisten

dataconnect:services:list

firebase dataconnect:services:list

Dieser Befehl gibt grundlegende Informationen zu den Diensten, Schemas und Verbindungen aus, die in einem Projekt bereitgestellt werden.

SQL-Schemas vergleichen und migrieren

dataconnect:sql:diff

firebase dataconnect:sql:diff

Mit diesem Befehl wird das lokale Schema für einen Dienst mit dem aktuellen Schema der entsprechenden Cloud SQL-Datenbank verglichen. Er gibt die Befehle aus, um die Datenbank zu Ihrem neuen Schema zu migrieren.

Befehl Beschreibung

firebase dataconnect:sql:diff

Flag/Parameter Beschreibung

serviceId

Geben Sie den Dienst an. Wird dieser Parameter weggelassen, wird die Differenz für alle Dienste in firebase.json ausgegeben.

dataconnect:sql:migrate

firebase dataconnect:sql:migrate

Mit diesem Befehl werden lokale Schemaänderungen auf die Cloud SQL-Datenbank eines Dienstes angewendet.

Wenn Sie ein neues lokales Data Connect-Projekt mit der Standardeinstellung einrichten, dataconnect.yaml-Datei, das Verhalten des Befehls dataconect:sql:migrate Sie werden aufgefordert, alle erforderlichen Änderungen vorzunehmen, und Sie werden dann zu optionalen Änderungen aufgefordert. Änderungen vornehmen, bevor Sie sie ausführen. Sie können dieses Verhalten so ändern, Optionale Änderungen durch Aktualisieren von dataconnect.yaml einschließen oder ignorieren Konfiguration, wie unter Schema im strikten oder kompatiblen Modus migrieren beschrieben

In interaktiven Umgebungen werden in der Befehlszeile jede SQL-Anweisung für die Migration (und ob sie zerstörerisch ist) angezeigt und Sie werden aufgefordert, die gewünschten Änderungen anzuwenden. Wenn Sie das Flag --force übergeben, entspricht das der Annahme aller Prompts.

In nicht interaktiven Umgebungen:

  • Ohne --force werden nur zerstörungsfreie Änderungen vorgenommen. Wenn es schädliche Änderungen gibt, wird die Befehlszeile abgebrochen und es werden keine Änderungen vorgenommen.
  • Mit --force werden alle Änderungen vorgenommen. Enthält dies zerstörerische Elemente, werden diese gedruckt und Sie werden gefragt, ob Sie fortfahren möchten. es sei denn, das Flag --force wird angegeben.
Befehl Beschreibung

Firebase dataconnect:sql:migrate

Flag Beschreibung

serviceId

Migrieren Sie die Datenbank für den angegebenen Dienst. Die serviceId wird abgeleitet, wenn Ihr Projekt nur einen Dienst hat.

–-Kraft

Prompts automatisch akzeptieren

Wie bei anderen --only-Flags können Sie mehrere Dienste getrennt durch Kommas zu setzen.

Schema im strikten oder kompatiblen Modus migrieren

Für Data Connect-Schemamigrationen gibt es zwei verschiedene Schemaüberprüfungsmodi: streng und kompatibel. Bei der Validierung im strikten Modus muss der Parameter Datenbankschema genau mit dem Anwendungsschema vor der Anwendung übereinstimmt Schema bereitgestellt werden kann. Für die Validierung im kompatiblen Modus muss das Datenbankschema kompatibel mit dem Anwendungsschema sein. Das bedeutet, dass Elemente in Ihrer Datenbank, die nicht vom Anwendungsschema verwendet werden, unverändert bleiben.

Diese Schemavalidierungsmodi und Best Practices für die Schemamigration sind im Leitfaden zur Schema- und Connector-Verwaltung erläutert.

Der Validierungsmodus wird mit dem Schlüssel schemaValidation in der Datei dataconnect.yaml definiert. Wenn schemaValidation nicht angegeben ist, wird die Befehlszeile angewendet und fordert Sie auf, strenge Änderungen vorzunehmen. Weitere Informationen finden Sie in der Referenz zur Konfiguration.

SDK-Befehle

SDKs generieren

dataconnect:sdk:generate

firebase dataconnect:sdk:generate

Mit diesem Befehl werden die in connector.yaml deklarierten typisierten SDKs generiert.

Weitere Informationen finden Sie in den Leitfäden für die Arbeit mit den Web-SDKs, den Android SDKs und den iOS SDKs.

Befehl Beschreibung

Firebase dataconnect:sdk:generate

Flag Beschreibung

–-watch

Lässt den Prozess weiterlaufen und generiert bei jedem Speichern neue SDKs Änderungen an Ihrem Schema und den GQL-Dateien des Connectors vornehmen.

Wenn die Generierung fehlschlägt, werden Fehler auf stdout ausgegeben, der generierte Code wird nicht geändert und der Befehl wird fortgesetzt.

–-only connectId:platform

Generieren Sie nur SDKs für eine einzelne Plattform und einen einzelnen Connector.

Mit den –only-Flags können Sie kommagetrennte Werte übergeben.

firebase dataconnect:sdk:generate –-only connector1, connector1:kotlin

Cloud SQL-Verwaltungsbefehle

SQL-Rollen für Cloud SQL gewähren

dataconnect:sql:grant

firebase dataconnect:sql:grant

Durch diesen Befehl wird eine PostgreSQL-Nutzerrolle zugewiesen. für das angegebene Nutzer- oder Dienstkonto:

  • Leser: Kann aus Tabellen im Schema lesen.
  • Writer: Kann Tabellen im Schema lesen und in diese schreiben.
  • Inhaber: Kann Migrationen ausführen und das Schema ändern. Dies gilt nicht für die Berechtigung, Erweiterungen zu installieren.
Befehl Beschreibung

Firebase dataconnect:sql:grant

Flag/Parameter Beschreibung

-R, --role Rolle

Die SQL-Rolle, die gewährt werden soll, entweder „Inhaber“, „Autor“ oder „Leser“.

-E, --email email_address

E-Mail-Adresse für einen Nutzer oder ein Dienstkonto, dem die Rolle zugewiesen werden soll.

Globale Optionen

Die folgenden globalen Optionen gelten für alle Befehle:

  • --json wechselt die Befehlszeilenausgabe in JSON, um sie mit anderen Tools zu parsen.
  • --noninteractive und --interactive überschreiben bei Bedarf die automatische Erkennung von Umgebungen ohne TTY.