The output of a DataDocumentation scan.
| JSON representation |
|---|
{ // Union field |
| Fields | |
|---|---|
Union field result. The result of the data documentation scan. result can be only one of the following: |
|
tableResult |
Output only. Table result for insights. |
TableResult
Generated metadata about the table.
| JSON representation |
|---|
{ "name": string, "overview": string, "schema": { object ( |
| Fields | |
|---|---|
name |
Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID |
overview |
Output only. Generated description of the table. |
schema |
Output only. Schema of the table with generated metadata of the columns in the schema. |
queries[] |
Output only. Sample SQL queries for the table. |
Schema
Schema of the table with generated metadata of columns.
| JSON representation |
|---|
{
"fields": [
{
object ( |
| Fields | |
|---|---|
fields[] |
Output only. The list of columns. |
Field
Column of a table with generated metadata and nested fields.
| JSON representation |
|---|
{
"name": string,
"description": string,
"fields": [
{
object ( |
| Fields | |
|---|---|
name |
Output only. The name of the column. |
description |
Output only. Generated description for columns and fields. |
fields[] |
Output only. Nested fields. |
Query
A sample SQL query in data documentation.
| JSON representation |
|---|
{ "sql": string, "description": string } |
| Fields | |
|---|---|
sql |
Output only. The SQL query string which can be executed. |
description |
Output only. The description for the query. |