Skip to content

Commit a0822b8

Browse files
Merge pull request #362 from FirebasePrivate/rachelsaunders-githubrepo
PRE/POST - update to GitHub public repo URL
2 parents c87ead1 + b42e772 commit a0822b8

File tree

3 files changed

+33
-35
lines changed

3 files changed

+33
-35
lines changed
Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
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 Cloud Firestore.
2-
3-
The extension creates and updates a [dataset](https://cloud.google.com/bigquery/docs/datasets-intro) containing the following two BigQuery resources:
4-
+ 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.
5-
+ 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`).
6-
7-
If you create, update, delete, or import a document in the specified collection, this extension sends that update to BigQuery. You can then run queries on this mirrored dataset.
8-
9-
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. Or if you have the same subcollection across documents in a given collection, you can use `{wildcard}` notation to listen to all those subcollections (for example: `chats/{chatid}/posts`).
10-
11-
#### Additional setup
12-
13-
Before installing this extension, you'll need to:
14-
+ [Set up Cloud Firestore in your Firebase project.](https://firebase.google.com/docs/firestore/quickstart)
15-
+ [Link your Firebase project to BigQuery.](https://support.google.com/firebase/answer/6318765)
16-
17-
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.
18-
19-
**Important:** Run the script over the entire collection _after_ installing this extension, otherwise all writes to your database during the import might be lost.
20-
21-
Learn more about using this script to [backfill your existing collection](https://github.com/FirebasePrivate/extensions/blob/master/firestore-bigquery-export/guides/IMPORT_EXISTING_DOCUMENTS.md).
22-
23-
#### Billing
24-
25-
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
26-
+ Cloud Firestore
27-
+ BigQuery
28-
+ Cloud Functions
29-
30-
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)
1+
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 Cloud Firestore.
2+
3+
The extension creates and updates a [dataset](https://cloud.google.com/bigquery/docs/datasets-intro) containing the following two BigQuery resources:
4+
+ 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.
5+
+ 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`).
6+
7+
If you create, update, delete, or import a document in the specified collection, this extension sends that update to BigQuery. You can then run queries on this mirrored dataset.
8+
9+
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. Or if you have the same subcollection across documents in a given collection, you can use `{wildcard}` notation to listen to all those subcollections (for example: `chats/{chatid}/posts`).
10+
11+
#### Additional setup
12+
13+
Before installing this extension, you'll need to:
14+
+ [Set up Cloud Firestore in your Firebase project.](https://firebase.google.com/docs/firestore/quickstart)
15+
+ [Link your Firebase project to BigQuery.](https://support.google.com/firebase/answer/6318765)
16+
17+
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.
18+
19+
**Important:** Run the script over the entire collection _after_ installing this extension, otherwise all writes to your database during the import might be lost.
20+
21+
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).
22+
23+
#### Billing
24+
25+
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
26+
+ Cloud Firestore
27+
+ BigQuery
28+
+ Cloud Functions
29+
30+
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)

firestore-counter/POSTINSTALL.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,7 @@ gcloud scheduler jobs create http firestore-sharded-counter-controller --schedul
3333

3434
1. Download and copy the [Counter SDK](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/dist/sharded-counter.js) into your application project.
3535

36-
Note: You might get a "Permission denied" error for the source repository. If you do, locate the **Sign in** button on the error page, then sign in to access to the repo.
37-
38-
1. Use the Counter SDK library in your code to increment counters. The code snippet below shows an example of how to use the library. For more comprehensive API documentation, refer to the [source code](https://dev-partners.googlesource.com/samples/firebase/mods/+/master/firestore-counter/clients/web/src/index.ts).
36+
1. Use the Counter SDK library in your code to increment counters. The code snippet below shows an example of how to use the library. For more comprehensive API documentation, refer to the [source code](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts).
3937

4038
```html
4139
<html>

firestore-counter/PREINSTALL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Here are some features of this extension:
77
- Supports an arbitrary number of counters in your app.
88
- Works offline and provides latency compensation for the main counter.
99

10-
Note that this extension is currently fully resourced for use with JavaScript apps (we provide the required [JS SDK](https://dev-partners.googlesource.com/samples/firebase/mods/+/master/firestore-sharded-counter/clients/web/src/index.ts)). You can, however, use this extension on other platforms if you'd like to develop your own API based on the provided JS SDK.
10+
Note that this extension is currently fully resourced for use with JavaScript apps (we provide the required [JS SDK](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts)). You can, however, use this extension on other platforms if you'd like to develop your own API based on the provided JS SDK.
1111

1212

1313
#### Additional setup
@@ -17,7 +17,7 @@ Before installing this extension, make sure that you've [set up a Cloud Firestor
1717
After installing this extension, you'll need to:
1818
- Update your [database security rules](https://firebase.google.com/docs/rules).
1919
- Set up a [scheduled function](https://firebase.google.com/docs/functions/schedule-functions) to regularly call the controller function, which is created by this extension and monitors the extension's workload.
20-
- Install the provided [Counter SDK](https://dev-partners.googlesource.com/samples/firebase/mods/+/master/firestore-sharded-counter/clients/web/src/index.ts) in your app. You can then use this library in your code to specify your document path and increment values.
20+
- Install the provided [Counter SDK](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts) in your app. You can then use this library in your code to specify your document path and increment values.
2121

2222
Detailed information for these post-installation tasks are provided after you install this extension.
2323

0 commit comments

Comments
 (0)