Skip to content

Commit

Permalink
docs(firestore-bigquery-export): update CLI params description
Browse files Browse the repository at this point in the history
  • Loading branch information
jauntybrain committed Jan 12, 2024
1 parent 584712e commit 178da05
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions firestore-bigquery-export/guides/GENERATE_SCHEMA_VIEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ installation of the extension:

- `${param:PROJECT_ID}`: the project ID for the Firebase project in
which you installed the extension
- `${param:BIGQUERY_PROJECT_ID}`: the project ID for the GCP project that contains
the BigQuery instance.
- `${param:DATASET_ID}`: the ID that you specified for your dataset during
extension installation
- `${param:TABLE_ID}`: the common prefix of BigQuery views to generate
Expand All @@ -116,6 +118,7 @@ via `npm` (the Node Package Manager).
$ npx @firebaseextensions/fs-bq-schema-views \
--non-interactive \
--project=${param:PROJECT_ID} \
--big-query-project=${param:BIGQUERY_PROJECT_ID} \
--dataset=${param:DATASET_ID} \
--table-name-prefix=${param:TABLE_ID} \
--schema-files=./test_schema.json
Expand Down
3 changes: 3 additions & 0 deletions firestore-bigquery-export/guides/IMPORT_EXISTING_DOCUMENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Warning: A `collectionGroup` query will target every collection in your Firestor
The import script requires several values from your installation of the extension:

- `${PROJECT_ID}`: the project ID for the Firebase project in which you installed the extension
- `${BIGQUERY_PROJECT_ID}`: the project ID for the GCP project in which the BigQuery instance is located. Defaults to Firebase project ID.
- `${COLLECTION_PATH}`: the collection path that you specified during extension installation
- `${COLLECTION_GROUP_QUERY}`: uses a `collectionGroup` query if this value is `"true"`. For any other value, a `collection` query is used.
- `${DATASET_ID}`: the ID that you specified for your dataset during extension installation
Expand Down Expand Up @@ -61,6 +62,8 @@ Run the import script using [`npx` (the Node Package Runner)](https://www.npmjs.

**Note**: The script can be run non-interactively. To see its usage, run the above command with `--help`.

1. _(Optional)_ When prompted, you can enter the BigQuery project ID to use a BigQuery instance located in a GCP project other than your Firebase project.

1. When prompted, enter the Cloud Firestore collection path that you specified during extension installation, `${COLLECTION_PATH}`.

1. _(Optional)_ You can pause and resume the import at any time:
Expand Down

0 comments on commit 178da05

Please sign in to comment.