Firebase CLI Supports Firestore Provisioning API #5616

VicVer09 · 2023-03-20T21:57:45Z

b/267473272

Add support for Firestore Provisioning API.

This feature is experimental and may not yet be enabled on all projects. It introduces 6 new commands to the Firebase CLI:

List Locations (firestore:locations)

necessary for creating a firestore database, lists all available location ids in ASCII table format
optional flag --json to show full JSON response

Testing:

$ firebase firestore:locations
┌────────────────────┬──────────────────────────────┐
│ Display Name       │ LocationId                   │
├────────────────────┼──────────────────────────────┤
│ Taiwan             │ asia-east1                   │
├────────────────────┼──────────────────────────────┤
│ Hong Kong          │ asia-east2                   │
├────────────────────┼──────────────────────────────┤
│ Tokyo              │ asia-northeast1              │
├────────────────────┼──────────────────────────────┤
│ Osaka              │ asia-northeast2              │
├────────────────────┼──────────────────────────────┤
│ Seoul              │ asia-northeast3              │
├────────────────────┼──────────────────────────────┤
│ Mumbai             │ asia-south1                  │
├────────────────────┼──────────────────────────────┤
│ Singapore          │ asia-southeast1              │
├────────────────────┼──────────────────────────────┤
│ Jakarta            │ asia-southeast2              │
├────────────────────┼──────────────────────────────┤
│ Sydney             │ australia-southeast1         │
├────────────────────┼──────────────────────────────┤
│ Melbourne          │ australia-southeast2         │
├────────────────────┼──────────────────────────────┤
│ Europe             │ eur3                         │
├────────────────────┼──────────────────────────────┤
│ Warsaw             │ europe-central2              │
├────────────────────┼──────────────────────────────┤
│ London             │ europe-west2                 │
├────────────────────┼──────────────────────────────┤
│ Frankfurt          │ europe-west3                 │
├────────────────────┼──────────────────────────────┤
│ Netherlands        │ europe-west4                 │
├────────────────────┼──────────────────────────────┤
│ Zurich             │ europe-west6                 │
├────────────────────┼──────────────────────────────┤
│ United States      │ nam5                         │
├────────────────────┼──────────────────────────────┤
│ Montréal           │ northamerica-northeast1      │
├────────────────────┼──────────────────────────────┤
│ São Paulo          │ southamerica-east1           │
├────────────────────┼──────────────────────────────┤
│ South Carolina     │ us-east1                     │
├────────────────────┼──────────────────────────────┤
│ Northern Virginia  │ us-east4                     │
├────────────────────┼──────────────────────────────┤
│ Oregon             │ us-west1                     │
├────────────────────┼──────────────────────────────┤
│ Los Angeles        │ us-west2                     │
├────────────────────┼──────────────────────────────┤
│ Salt Lake City     │ us-west3                     │
├────────────────────┼──────────────────────────────┤
│ Las Vegas          │ us-west4                     │
└────────────────────┴──────────────────────────────┘

Create Database (firestore:databases:create)

creates a firestore database
mandatory positional argument for database ID
mandatory flag --location (location id)
This is a single value since multi region is not supported
Since Datastore Mode is not exposed/accessible in the Firebase console today, database type is hardcoded to be FIRESTORE_NATIVE.
optional flag –delete-protection ENABLED or DISABLED (default)
Newly created databases will have closed rules by default, at the end of command user is prompted to create a firestore rules configuration
Command will wait until the operation is complete, then displays the database details

Testing:

$ firebase firestore:databases:create demo --location nam5 --delete-protection ENABLED
Successfully created projects/firebase-cli-database-id-dev/databases/demo

List Databases (firestore:databases:list)

lists all existing databases
optional flag --json to show full JSON response

Testing:

$ firebase firestore:databases:list
┌─────────────────────────────────────────────────────────────────────────────┐
│ Database Name                                                               │
├─────────────────────────────────────────────────────────────────────────────┤
│ projects/firebase-cli-database-id-dev/databases/(default)                   │
├─────────────────────────────────────────────────────────────────────────────┤
│ projects/firebase-cli-database-id-dev/databases/named                       │
├─────────────────────────────────────────────────────────────────────────────┤
│ projects/firebase-cli-database-id-dev/databases/protected                   │
├─────────────────────────────────────────────────────────────────────────────┤
│ projects/firebase-cli-database-id-dev/databases/verylooooooooooooooongdb    │
└─────────────────────────────────────────────────────────────────────────────┘

Get Database (firestore:databases:get)

shows config for database
optional database positional argument, (default) if none provided
optional --json flag to display raw api response

Testing:

$ firebase firestore:databases:get demo       
┌─────────────────────────┬──────────────────────────────────────────────────────────────┐
│ Field                   │ Value                                                        │
├─────────────────────────┼──────────────────────────────────────────────────────────────┤
│ Name                    │ projects/firebase-cli-database-id-dev/databases/demo         │
├─────────────────────────┼──────────────────────────────────────────────────────────────┤
│ Create Time             │ 2023-02-24T20:14:48.306235Z                                  │
├─────────────────────────┼──────────────────────────────────────────────────────────────┤
│ Last Update Time        │ 2023-02-24T20:14:48.306235Z                                  │
├─────────────────────────┼──────────────────────────────────────────────────────────────┤
│ Type                    │ FIRESTORE_NATIVE                                             │
├─────────────────────────┼──────────────────────────────────────────────────────────────┤
│ Location                │ nam5                                                         │
├─────────────────────────┼──────────────────────────────────────────────────────────────┤
│ Delete Protection State │ DELETE_PROTECTION_DISABLED                                   │
└─────────────────────────┴──────────────────────────────────────────────────────────────┘

Update Database (firestore:databases:update)

updates delete protection state of given db
mandatory positional argument for database ID
mandatory delete protection state

Testing

$ firebase firestore:databases:update demo --delete-protection DISABLED
Successfully updated projects/firebase-cli-database-id-dev/databases/demo

Delete Database (firestore:databases:delete)

deletes given database
mandatory positional argument for database ID
confirmation prompt if --force not set
(default) database can also be deleted

Testing:

$ firebase firestore:databases:delete demo
? You are about to delete projects/firebase-cli-database-id-dev/databases/demo. Do you wish to continue? Yes
Successfully deleted projects/firebase-cli-database-id-dev/databases/demo

$ firebase firestore:databases:delete protected --force
Error: HTTP Error: 400, Cannot delete the database because delete protection state is set to DELETE_PROTECTION_ENABLED.

Having trouble? Try firebase [command] --help

b/267551167

b/267558636

b/267549787

b/267558640

…nto victorvim-main

…-tools into victorvim-main

…nto victorvim-main

VicVer09 · 2023-03-31T17:04:49Z

Addressed comments and after discussion with some of the team added another option to the create command to set delete protection state as well as another command - firestore:databases:update to modify both the database type and delete protection state. major difference is if protection is enabled, then firestore:databases:delete will 400.

Please take a look and pending council approval i'll merge the changes

rwhogg · 2023-03-31T17:28:08Z

CHANGELOG.md

+- firestore:databases:get
+- firestore:databases:delete
+- firestore:locations
+- Releases Cloud Firestore emulator v1.16.1, which adds support for read_time in ListCollectionIds.


Unsure as to why this line is there?

ah yep good catch, another stray changelog from a bad merge

joehan

Couple small things but code LGTM - will leave any discussion of the API surface to other contexts

joehan · 2023-03-31T20:46:36Z

src/commands/firestore-databases-create.ts

+      return;
+    }
+    const deleteProtectionState: types.DatabaseDeleteProtectionState =
+      options.deleteProtectionState || types.DatabaseDeleteProtectionState.DISABLED;


Nit: Prefer ?? over || here - it shouldn't make a functional difference with the current code, but ?? only falls through to the right when the left side is undefined (not just falsy), which is the intent here

joehan · 2023-03-31T20:46:43Z

CHANGELOG.md

@@ -1,2 +1,8 @@
+- Adds support for the Firestore Provisioning API commands: (#5616)


Consider rewording this message to be a little clearer to external users - ie "Adds new commands for provisioning and managing Firestore databases:"

Also, include the databases:update command here too

joehan · 2023-03-31T20:49:46Z

src/commands/firestore-databases-update.ts

+      "JSON specification format."
+  )
+  .option("--database <databaseId>", "Name of database to be updated. (required)")
+  .option(


Nit: If I'm reading the code correctly, type can be updated, but its not obvious from this help text. Consider clarifying to something like ie Type to update the database to - with the current wording, it sound like i'm supposed to provide the current type/

joehan · 2023-03-31T20:55:21Z

src/firestore/api-types.ts

+  appEngineIntegrationMode: string;
+  keyPrefix: string;
+  deleteProtectionState: string;
+  etag: string;


Optional - I've been partial to string union types instead of JS enums, as they require a little less type casting when used. You could consider them instead:

deleteProtectionState: "DELETE_PROTECTION_ENABLED" || "DELETE_PROTECTION_DISABLED"

…-tools into victorvim-main

VicVer09 · 2023-04-12T21:41:35Z

added changes based on comments from firebase api council:

database is now a positional arg
use --json option instead of --pretty
database type always firestore native
--deleteProtectionState -> --delete-protection
DELETE_PROTECTION_ENABLED/DELETE_PROTECTION_DISABLED -> ENABLED/DISABLED
print locations and databases in ascii table format

joehan

1 last thing to fix, and this should be good to go!

joehan · 2023-04-17T16:22:23Z

src/commands/firestore-databases-create.ts

+
+export const command = new Command("firestore:databases:create <database>")
+  .description("Create a database in your Firebase project.")
+  .option("--json", "Prints raw json response of the create API call if specified")


Applies for all commands: No need to explicitly declare --json as an option - it is defined as a program option for firebase, not on a per command basis (https://github.com/firebase/firebase-tools/blob/master/src/index.ts#L16)

To support --json, all you need to do is have your command return the JSON that should be shown - in this case, that's databaseResp, so you should be all good.

anonimitoraf · 2023-04-19T04:04:05Z

This looks great. Just confirming, does this allow multiple Firestore DBs in different locations? (e.g. 1 DB in us-east1, another in australia-southeast1)?

VicVer09 · 2023-04-19T15:33:27Z

This looks great. Just confirming, does this allow multiple Firestore DBs in different locations? (e.g. 1 DB in us-east1, another in australia-southeast1)?

yes, but for now only for projects that have the multiple databases feature enabled (in private preview).

most projects will not see this capability until later when it is generally available (cannot confirm any exact dates, but keep an eye out for announcements). error messages will say something along the lines of max quota reached.

ycmjason · 2023-04-20T16:26:15Z

THIS IS SO EXCITING

b/267473272 - Add support for Firestore Provisioning API. This feature is experimental and may not yet be enabled on all projects. It introduces 6 new commands to the Firebase CLI

VicVer09 added 30 commits February 22, 2023 10:36

Firebase.json supports multiple instances configuration (#5534)

7ff8b20

b/267551167

Firestore Indexes API Supports DatabaseId (#5547) b/267558636

d08a2ab

b/267558636

Firestore deploy works with multiple databases b/267549787 (#5553)

5049de4

b/267549787

Firestore commands accept databaseId option b/267558640 (#5557)

dcf9064

b/267558640

Merge branch 'master' of https://github.com/firebase/firebase-tools i…

d662417

…nto victorvim-main

address comments

4810550

Merge branch 'master' of https://github.com/firebase/firebase-tools i…

6ef0d60

…nto victorvim-main

address comments

238d687

address comments

6218821

clarify delete tip

21681dd

address comments

3fa45c9

address comments

8428590

add changelog notes

efdc6b1

fix todo comment

49468f8

fix lint in changelog

3eb68be

fix lint in changelog

f13241d

npm run format:other

d467e80

fix merge conflict

4258097

address comments

6f96be2

Merge branch 'victorvim-main' of https://github.com/firebase/firebase…

9314fdc

…-tools into victorvim-main

changelog

1ac9117

fix lint

4c748d1

changelog

06f87fd

address comments

e3cd50a

fix changelog newline

e037c19

Merge branch 'master' of https://github.com/firebase/firebase-tools i…

0217223

…nto victorvim-main

provisioning api initial commit

bf52e42

fix lint

ea0a52a

fix crlf -> lf

a36eb34

fix crlf -> lf

e1d0e7a

VicVer09 added 3 commits March 31, 2023 10:54

add update and address comments

ac14501

fix merge conflict

5c60380

fix lint

42b7c77

VicVer09 requested review from joehan and rwhogg March 31, 2023 17:02

rwhogg reviewed Mar 31, 2023

View reviewed changes

fix changelog

47666de

rwhogg approved these changes Mar 31, 2023

View reviewed changes

joehan approved these changes Mar 31, 2023

View reviewed changes

joehan and others added 6 commits April 3, 2023 09:04

Merge branch 'master' into victorvim-main

55ec87d

address comments

5044aa8

Merge branch 'victorvim-main' of https://github.com/firebase/firebase…

ec5eb92

…-tools into victorvim-main

address firebase api council comments

8765a4f

fix lint

6755598

fix lint

8712e08

VicVer09 requested a review from joehan April 12, 2023 21:39

VicVer09 added 3 commits April 13, 2023 08:55

Merge branch 'master' into victorvim-main

68d6024

fix merge

4142d8d

address api proposal comments

2d1f33c

joehan reviewed Apr 17, 2023

View reviewed changes

VicVer09 added 2 commits April 17, 2023 13:30

address final comments

23f09f8

Merge branch 'master' into victorvim-main

56f2425

VicVer09 merged commit f5786fd into master Apr 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Firebase CLI Supports Firestore Provisioning API #5616

Firebase CLI Supports Firestore Provisioning API #5616

VicVer09 commented Mar 20, 2023 •

edited

Loading

VicVer09 commented Mar 31, 2023

rwhogg Mar 31, 2023

VicVer09 Mar 31, 2023

joehan left a comment

joehan Mar 31, 2023

joehan Mar 31, 2023

joehan Mar 31, 2023

joehan Mar 31, 2023

VicVer09 commented Apr 12, 2023

joehan left a comment

joehan Apr 17, 2023

anonimitoraf commented Apr 19, 2023

VicVer09 commented Apr 19, 2023

ycmjason commented Apr 20, 2023

		@@ -1,2 +1,8 @@
		- Adds support for the Firestore Provisioning API commands: (#5616)

Firebase CLI Supports Firestore Provisioning API #5616

Firebase CLI Supports Firestore Provisioning API #5616

Conversation

VicVer09 commented Mar 20, 2023 • edited Loading

Add support for Firestore Provisioning API.

List Locations (firestore:locations)

Testing:

Create Database (firestore:databases:create)

Testing:

List Databases (firestore:databases:list)

Testing:

Get Database (firestore:databases:get)

Testing:

Update Database (firestore:databases:update)

Testing

Delete Database (firestore:databases:delete)

Testing:

VicVer09 commented Mar 31, 2023

rwhogg Mar 31, 2023

Choose a reason for hiding this comment

VicVer09 Mar 31, 2023

Choose a reason for hiding this comment

joehan left a comment

Choose a reason for hiding this comment

joehan Mar 31, 2023

Choose a reason for hiding this comment

joehan Mar 31, 2023

Choose a reason for hiding this comment

joehan Mar 31, 2023

Choose a reason for hiding this comment

joehan Mar 31, 2023

Choose a reason for hiding this comment

VicVer09 commented Apr 12, 2023

joehan left a comment

Choose a reason for hiding this comment

joehan Apr 17, 2023

Choose a reason for hiding this comment

anonimitoraf commented Apr 19, 2023

VicVer09 commented Apr 19, 2023

ycmjason commented Apr 20, 2023

VicVer09 commented Mar 20, 2023 •

edited

Loading