TheFirebase CLI is a tool that lets you to manage and configure Firebaseproducts and services from the command line.

The CLI provides commands that can be used to perform a variety ofData Connect tasks, like creating a newData Connectproject, initializing a corresponding local working directory, setting up theData Connect emulator, listingData Connect resources,generating client SDKs and more.

Setup commands

AddData Connect to a Firebase project

firebase init

Usefirebase init to set up a new local project configuration. This workflowcreates or updatesFirebase configuration files inyour directory.

firebaseinit

Thefirebase init flow guides you through setting up a service and database,and optionally installing theData Connect emulator andconfiguring generated SDKs.

Service and database setup

If you selectdataconnect for product setup, the CLI prompts you for a newservice name and location, and whether to link an existing Cloud SQL forPostgreSQL instance or create a new instance.

If an existing instance is linked, the CLI checks for compatible settings, suchas IAM authentication and public IP addresses.

firebaseemulators:start/exec

# Export data from local emulator from a separate terminalfirebaseemulators:export--onlydataconnect<export_directory># Import data from local directory, here using emulators:execfirebaseemulators:exec./<your-test-script>.sh--onlydataconnect--import<import_directory>

For how-to use cases and recommended practices related to these commands, seetheschema and connector management guide.

Deploy schemas and connectors

deploy

firebasedeploy

This command deploys resources for Data Connect services indexed infirebase.json. Aschema migrationandconnector update are performed if necessary.

With the–-only flags, you can pass comma-separated values to deploy anysubset of resources you want.

firebasedeploy--onlydataconnect:service1:schema,dataconnect:service2

List Data Connect services, schemas and connectors

dataconnect:services:list

firebasedataconnect:services:list

This command prints out basic info about the services, schemas, and connectorsdeployed on a project.

Compare and migrate SQL schemas

When you runfirebase deploy, the CLI performs a SQL schemacomparison before deploying updates. You can also perform the comparisonand update directly with a set ofdataconnect:sql commands.

dataconnect:sql:diff

firebasedataconnect:sql:diff

This command compares local schema for a service with the current schema of thecorresponding Cloud SQL database. It prints out the commands that would be runto migrate the database to your new schema.

dataconnect:sql:migrate

firebasedataconnect:sql:migrate

This command applies local schema changes to a service's Cloud SQL database.

When you set up a new localData Connect project, with the defaultdataconnect.yaml file, the behavior of thedataconnect:sql:migrate commandis to prompt you for any required changes, and then prompt for any optionalchanges, before executing the changes. You can modify this behavior to alwaysinclude or ignore optional changes by updating yourdataconnect.yamlconfiguration, as discussed inmigrate a schema in strict or compatible mode

In interactive environments, the CLI displays each migration SQL statement(and whether it is destructive) and prompts for the changes you want to apply.Passing the--force flag is equivalent to accepting all prompts.

In noninteractive environments:

• Without--force, only non-destructive changes are made. If there aredestructive changes, the CLI aborts with no changes made.
• With--force, all changes are made. If this includes any destructivechanges, they are printed and you are prompted whether you want to continue,unless the--force flag is provided.

As with other--only flags, you can provide multiple services separated bycommas.

Migrate a schema in strict or compatible mode

Data Connect schema migrations have two different schema validationmodes:strict andcompatible. Strict mode validation requires that thedatabase schema exactly match the application schema before the applicationschema can be deployed. Compatible mode validation requires that the databaseschema becompatible with the application schema, meaning elements in yourdatabase that are not used by your application schema are left unmodified.

These schema validation modes and best practices for schema migration arecovered in theschema and connector management guide

The validation mode is defined using theschemaValidation key in yourdataconnect.yaml file. IfschemaValidation is unspecified, the CLI appliescompatible changes and prompts you before executing any strict changes. Seetheconfiguration reference.

Manage changes to connectors

When you runfirebase deploy, the CLI initiates anupdate of the applicable connectors. The CLI analyzes changes to each connectorand issues a set of assessment messages with respect to connector changes thatmay cause unexpected behavior (messages are warning-level) or breakages (messagesare breaking-level) in previous versions of client code.

Warnings and prompts always occur for:

• PUBLIC

And, warnings and prompts occur on the following access levels when youdon't augment them with filters usingauth.uid:

• USER
• USER_ANON
• USER_EMAIL_VERIFIED

For more information about authorization, refer to theauthorization and attestation guide.

SDK commands

Generate SDKs

dataconnect:sdk:generate

firebasedataconnect:sdk:generate

This command generates the typed SDKs declared inconnector.yaml.

Also see the guides for working withthe web SDKs,the Android SDKs andthe iOS SDKs.

With the–only flags, you can pass comma-separated values.

firebasedataconnect:sdk:generate–-onlyconnector1,connector1:kotlin

Cloud SQL management commands

Grant SQL roles for Cloud SQL

Data Connect operates on top of your own PostgreSQL instance hostedon Cloud SQL. SQL role commands help you manage permissions on your databasetables.

dataconnect:sql:setup

firebasedataconnect:sql:setup

This command configures initial, global permissions to tables in your database.

The default database provisioning and management flow assumes your projectuses a new (greenfield) database, and when you invokefirebase deploy,Data Connect will display database schema changes to be made andperforms any migrations after you approve. If this is your preferred flow,dataconnect:sql:setup prompts you to grant permissions includingsuperuserschema ownerships.

For existing (brownfield) databases, you may have your own workflow formigrating schemas and want to maintain schema ownership yourself. If thisis your preferred flow, make sure todecline at thedataconnect:sql:setupprompt for whetherData Connect should handle SQL migrations for you.As a result of declining,Data Connect will only takeread andwrite access to your database tables, but schema ownerships and migrationswill remain your responsibility.

For more discussion and use cases, seeManage services and databases.

dataconnect:sql:grant

firebasedataconnect:sql:grant

In some cases, you might want to access your database directlyto query or update the data generated by yourData Connect apps. Todo this, you will need to grant one of the roles defined in this sectionto the needed user or service account.

For details on the granted roles, seePostgreSQL user roles.