Skip to content

Commit

Permalink
docs(firestore-bigquery-export): add document_name to clustering (#1906)
Browse files Browse the repository at this point in the history
  • Loading branch information
jauntybrain authored Jan 11, 2024
1 parent cbd1626 commit b87ee50
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/firestore-bigquery-export/Clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Through the extension, adding clustering is as simple as adding a comma-separate

Clustering allows up to a maximum of four fields and can be configured similar to

`document_id, timestamp, event_id, data`
`document_id, document_name, timestamp, event_id, data`

![example](/docs/firestore-bigquery-export/media/clustering.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/firestore-bigquery-export/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ During installation, you will be prompted to specify a number of configuration p

This parameter will allow you to set up Clustering for the BigQuery Table
created by the extension. (for example: `data,document_id,timestamp`- no whitespaces). You can select up to 4 comma-separated fields(order matters).
Available schema extensions table fields for clustering: `document_id, timestamp, event_id, operation, data`.
Available schema extensions table fields for clustering: `document_id, document_name, timestamp, event_id, operation, data`.

- **Backup Collection Name:**

Expand Down
2 changes: 1 addition & 1 deletion firestore-bigquery-export/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ To install an extension, your project must be on the [Blaze (pay as you go) plan

* BigQuery SQL Time Partitioning table schema field(column) type: Parameter for BigQuery SQL schema field type for the selected Time Partitioning Firestore Document field option. Cannot be changed if Table is already partitioned.

* BigQuery SQL table clustering: This parameter will allow you to set up Clustering for the BigQuery Table created by the extension. (for example: `data,document_id,timestamp`- no whitespaces). You can select up to 4 comma separated fields. The order of the specified columns determines the sort order of the data. Available schema extensions table fields for clustering: `document_id, timestamp, event_id, operation, data`.
* BigQuery SQL table clustering: This parameter will allow you to set up Clustering for the BigQuery Table created by the extension. (for example: `data,document_id,timestamp`- no whitespaces). You can select up to 4 comma separated fields. The order of the specified columns determines the sort order of the data. Available schema extensions table fields for clustering: `document_id, document_name, timestamp, event_id, operation, data`.

* Maximum number of synced documents per second: This parameter will set the maximum number of syncronised documents per second with BQ. Please note, any other external updates to a Big Query table will be included within this quota. Ensure that you have a set a low enough number to componsate. Defaults to 10.

Expand Down
2 changes: 1 addition & 1 deletion firestore-bigquery-export/extension.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ params:
description: >-
This parameter will allow you to set up Clustering for the BigQuery Table
created by the extension. (for example: `data,document_id,timestamp`- no whitespaces). You can select up to 4 comma separated fields. The order of the specified columns determines the sort order of the data.
Available schema extensions table fields for clustering: `document_id, timestamp, event_id, operation, data`.
Available schema extensions table fields for clustering: `document_id, document_name, timestamp, event_id, operation, data`.
type: string
validationRegex: ^[^,\s]+(?:,[^,\s]+){0,3}$
validationErrorMessage: No whitespaces. Max 4 fields. e.g. `data,timestamp,event_id,operation`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Object {

exports[`extension config config.clustering param exists 1`] = `
Object {
"description": "This parameter will allow you to set up Clustering for the BigQuery Table created by the extension. (for example: \`data,document_id,timestamp\`- no whitespaces). You can select up to 4 comma separated fields. The order of the specified columns determines the sort order of the data. Available schema extensions table fields for clustering: \`document_id, timestamp, event_id, operation, data\`.",
"description": "This parameter will allow you to set up Clustering for the BigQuery Table created by the extension. (for example: \`data,document_id,timestamp\`- no whitespaces). You can select up to 4 comma separated fields. The order of the specified columns determines the sort order of the data. Available schema extensions table fields for clustering: \`document_id, document_name, timestamp, event_id, operation, data\`.",
"example": "data,document_id,timestamp",
"label": "BigQuery SQL table clustering",
"param": "CLUSTERING",
Expand Down

0 comments on commit b87ee50

Please sign in to comment.