|
22 | 22 |
|
23 | 23 |
|
24 | 24 |
|
25 | | -**DETAILS**: Use this extension to export the documents in a Cloud Firestore collection to BigQuery. Exports are realtime and incremental, so the data in BigQuery is a mirror of your content in Firestore. |
26 | | - |
27 | | -The extension creates and updates a [dataset](https://cloud.google.com/bigquery/docs/datasets-intro) containing the following two BigQuery resources: |
28 | | - |
29 | | -+ A [table](https://cloud.google.com/bigquery/docs/tables-intro) of raw data that stores a full change history of the documents within your collection. This table includes a number of metadata fields so that BigQuery can display the current state of your data. The principle metadata fields are `timestamp`, `document_name`, and the `operation` for the document change. |
30 | | -+ A [view](https://cloud.google.com/bigquery/docs/views-intro) which represents the current state of the data within your collection. It also shows a log of the latest `operation` for each document (`CREATE`, `UPDATE`, or `IMPORT`). |
31 | | - |
32 | | -Whenever a document is created, updated, deleted, or imported in the specified collection, this extension sends that update to BigQuery. You can then run queries on this mirrored dataset. |
33 | | - |
34 | | -Note that this extension only listens for _document_ changes in the collection, but not changes in any _subcollection_. You can, though, install additional instances of this extension to specifically listen to a subcollection or other collections in your database. |
35 | | - |
36 | | -### Additional setup |
37 | | - |
38 | | -Before installing this extension, you'll need to: |
39 | | - |
40 | | -+ [Set up Cloud Firestore in your Firebase project.](https://firebase.google.com/docs/firestore/quickstart) |
41 | | -+ [Link your Firebase project to BigQuery.](https://support.google.com/firebase/answer/6318765) |
42 | | - |
43 | | -#### Import existing documents |
44 | | - |
45 | | -This extension only sends the content of documents that have been changed -- it does not export your full dataset of existing documents into BigQuery. So, to backfill your BigQuery dataset with all the documents in your collection, you can run the import script provided by this extension. |
46 | | - |
47 | | -**Important:** Run the script over the entire collection _after_ installing this extension, otherwise all writes to your database during the import might be lost. |
48 | | - |
49 | | -Learn more about using this script to [backfill your existing collection](https://dev-partners.googlesource.com/samples/firebase/mods/+/master/firestore-bigquery-export/guides/IMPORT_EXISTING_DOCUMENTS.md). |
50 | | - |
51 | | -### Billing |
52 | | - |
53 | | -This extension uses other Firebase or Google Cloud Platform services which may have associated charges: |
54 | | - |
55 | | -+ Cloud Firestore |
56 | | -+ BigQuery |
57 | | -+ Cloud Functions |
58 | | - |
| 25 | +**DETAILS**: Use this extension to export the documents in a Cloud Firestore collection to BigQuery. Exports are realtime and incremental, so the data in BigQuery is a mirror of your content in Firestore. |
| 26 | + |
| 27 | +The extension creates and updates a [dataset](https://cloud.google.com/bigquery/docs/datasets-intro) containing the following two BigQuery resources: |
| 28 | + |
| 29 | ++ A [table](https://cloud.google.com/bigquery/docs/tables-intro) of raw data that stores a full change history of the documents within your collection. This table includes a number of metadata fields so that BigQuery can display the current state of your data. The principle metadata fields are `timestamp`, `document_name`, and the `operation` for the document change. |
| 30 | ++ A [view](https://cloud.google.com/bigquery/docs/views-intro) which represents the current state of the data within your collection. It also shows a log of the latest `operation` for each document (`CREATE`, `UPDATE`, or `IMPORT`). |
| 31 | + |
| 32 | +Whenever a document is created, updated, deleted, or imported in the specified collection, this extension sends that update to BigQuery. You can then run queries on this mirrored dataset. |
| 33 | + |
| 34 | +Note that this extension only listens for _document_ changes in the collection, but not changes in any _subcollection_. You can, though, install additional instances of this extension to specifically listen to a subcollection or other collections in your database. |
| 35 | + |
| 36 | +### Additional setup |
| 37 | + |
| 38 | +Before installing this extension, you'll need to: |
| 39 | + |
| 40 | ++ [Set up Cloud Firestore in your Firebase project.](https://firebase.google.com/docs/firestore/quickstart) |
| 41 | ++ [Link your Firebase project to BigQuery.](https://support.google.com/firebase/answer/6318765) |
| 42 | + |
| 43 | +#### Import existing documents |
| 44 | + |
| 45 | +This extension only sends the content of documents that have been changed -- it does not export your full dataset of existing documents into BigQuery. So, to backfill your BigQuery dataset with all the documents in your collection, you can run the import script provided by this extension. |
| 46 | + |
| 47 | +**Important:** Run the script over the entire collection _after_ installing this extension, otherwise all writes to your database during the import might be lost. |
| 48 | + |
| 49 | +Learn more about using this script to [backfill your existing collection](https://github.com/firebase/extensions/blob/master/firestore-bigquery-export/guides/IMPORT_EXISTING_DOCUMENTS.md). |
| 50 | + |
| 51 | +### Billing |
| 52 | + |
| 53 | +This extension uses other Firebase or Google Cloud Platform services which may have associated charges: |
| 54 | + |
| 55 | ++ Cloud Firestore |
| 56 | ++ BigQuery |
| 57 | ++ Cloud Functions |
| 58 | + |
59 | 59 | When you use Firebase Extensions, you're only charged for the underlying resources that you use. A paid-tier billing plan is only required if the extension uses a service that requires a paid-tier plan, for example calling to a Google Cloud Platform API or making outbound network requests to non-Google services. All Firebase services offer a free tier of usage. [Learn more about Firebase billing.](https://firebase.google.com/pricing) |
60 | 60 |
|
61 | 61 |
|
|
0 commit comments