Skip to content

Commit e43140b

Browse files
fixup! EDU-1502: Adds bigQuery page
1 parent b7d2197 commit e43140b

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

content/bigquery.textile

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ Set up the necessary BigQuery resources, permissions, and authentication to enab
3030

3131
h3(#settings). BigQuery rule settings
3232

33+
The following explains the components of the BigQuery rule settings:
34+
3335
|_. Section |_. Purpose |
3436
| *Source* | Defines the type of event(s) for delivery. |
3537
| *Channel filter* | A regular expression to filter which channels to capture. Only events on channels matching this regex are streamed into BigQuery. |
@@ -38,7 +40,7 @@ h3(#settings). BigQuery rule settings
3840
| *Partitioning* | _(Optional)_ The table must be created with the desired partitioning settings in BigQuery before making the rule in Ably. |
3941
| *Advanced settings* | Any additional configuration or custom fields relevant to your BigQuery setup (for future enhancements). |
4042

41-
h4(#dashboard). Create a BigQuery rule in the Dashboard
43+
h4(#dashboard). Create a BigQuery rule in the dashboard
4244

4345
The following steps to create a BigQuery rule using the Ably dashboard:
4446

@@ -51,7 +53,7 @@ The following steps to create a BigQuery rule using the Ably dashboard:
5153

5254
h4(#api-rule). Create a BigQuery rule using the Control API
5355

54-
The following steps to create a BigQuery rule using the Control API:
56+
The following steps to create a BigQuery rule using the "Control API:":https://ably.com/docs/api#control-api
5557

5658
* Using the required "rules":/control-api#examples-rules to specify the following parameters:
5759
** @ruleType@: Set this to "bigquery" to define the rule as a BigQuery integration.
@@ -61,7 +63,6 @@ The following steps to create a BigQuery rule using the Control API:
6163
** @format@ (optional): Define the data format based on how you want messages to be structured.
6264
* Make an HTTP request to the Control API to create the rule.
6365

64-
6566
h3(#schema). JSON Schema
6667

6768
You can run queries directly against the Ably-managed BigQuery table. For example, if the message payloads are stored as raw JSON in the data column, you can parse them using the following query:
@@ -88,10 +89,10 @@ WHERE channel = “my-channel”
8889

8990
The following explains the components of the query:
9091

91-
|. Query Function |. Purpose |
92-
| CAST(data AS STRING) | Converts the data column from BYTES (if applicable) into a STRING format. |
93-
| PARSE_JSON(…) | Parses the string into a structured JSON object for easier querying. |
94-
| WHERE channel = “my-channel” | Filters results to retrieve messages only from a specific Ably channel. |
92+
|_. Query Function |_. Purpose |
93+
| @CAST(data AS STRING)@ | Converts the data column from BYTES (if applicable) into a STRING format. |
94+
| @PARSE_JSON(…)@ | Parses the string into a structured JSON object for easier querying. |
95+
| @WHERE channel = “my-channel”@ | Filters results to retrieve messages only from a specific Ably channel. |
9596

9697
<aside data-type='note'>
9798
<p>Parsing JSON at query time can be computationally expensive for large datasets. If your queries need frequent JSON parsing, consider pre-processing and storing structured fields in a secondary table using an ETL pipeline for better performance.</p>

0 commit comments

Comments
 (0)