Overview

The Publish to BigQuery node allows for publishing metrics to Google BigQuery for charting and visualization. This integration is useful for applications requiring detailed data analysis and reporting, enhancing the capabilities of data-driven decision-making processes.

Custom Metrics

Custom Function nodes can publish custom metrics and metadata for specific objects by storing them under its node metadata. Refer to Custom Function for how to do so.

Inputs & Outputs

Input media: Raw Video.
Output media: Raw Video.
Output metadata: None.

Properties

Property	Description	Type	Default	Required
`bigquery_project_id`	The ID of the BigQuery project that the dataset belongs to.	`string`	`null`	Yes
`bigquery_dataset_id`	The ID of the BigQuery dataset to publish to.	`string`	`null`	Yes
`bigquery_credentials`	Service account key in JSON format for the Google Cloud project with BigQuery Data Editor role.	`string`	`null`	Yes
`node_ids_to_publish`	Select a node to publish its metadata. Leave blank to publish all nodes.	`string`	`null`	Yes
`trigger`	Publish node metadata only when this condition evaluates to true	trigger-condition	`null`	No
`objects_to_publish`	Publish object metadata depending on object's properties meeting the specified criteria. Options: Specified by node (`node_related`); Specified by metadata pattern (`pattern_matched_objects`); Specific types (`type_matched_objects`).	`enum`	`null`	No
`object_match_patterns`	Publish object metadata for objects specified by this pattern. Conditional on `objects_to_publish` being `pattern_matched_objects`. Format: comma-separated metadata paths or patterns.	`string`	`null`	No
`object_types`	ex. `car`,`person`,`car.red`. Object types to publish. Leave blank to process all. Conditional on `objects_to_publish` being `type_matched_objects`.	model-labels	`null`	No
`event_type`	Metrics event type to publish. This can be used to filter or count specific events in the dashboard.	`string`	`null`	No
`event_trigger`	Log a metrics event when this condition evaluates to true.	trigger-condition	`null`	No
`metrics_tag`	Tag published metrics with this tag to make it easier to filter them in the Dashboard.	`string`	`null`	No
`objects_only_new_updated`	If true, only publish objects the first time they are seen else publish both new and updated objects.	`bool`	`true`	No
`object_track_lifespan`	Number of frames for which an object is tracked to prevent duplicate reporting when the new/updated option is set. Unit: frames.	`number`	`600`	No
`interval`	Min. time between consecutive publish actions. Unit: seconds.	`float`	`1`	No
`use_stream_clock`	Use timestamps from stream?	`bool`	`false`	No
`debug`	Print each outbound BigQuery row payload and destination table before publishing.	`bool`	`false`	No

BigQuery Project & Dataset ID

This node will create tables within the specified BigQuery project and dataset. Specify their id's as shown in the image.

BigQuery Credentials

The bigquery_credentials field expects JSON format private key for a service account which has BigQuery Data Editor role for your BigQuery project and dataset.

You can create one as follows:

Start at Google cloud console -> IAM & Admin -> Service Accounts. Create Service Account.

Configure Service account with BigQuery Data Editor role.

Generate a JSON private key for the service account

Download and use the key as contents in the bigquery_credentials field.

Output Metadata

Node does not insert any output metadata; upstream metadata continues through the pipeline