Console
    Start free

    DataDocumentationResult

    The output of a DataDocumentation scan.

    JSON representation 
     { 
 // Union field result 
can be only one of the following: 
 "datasetResult" 
 : 
 { 
 object (  DatasetResult 
 
) 
 } 
 , 
 "tableResult" 
 : 
 { 
 object (  TableResult 
 
) 
 } 
 // End of list of possible types for union field result 
. 
 }
    Fields
    Union field result . The result of the data documentation scan. result can be only one of the following:
    datasetResult

    object ( DatasetResult )

    Output only. Insights for a Dataset resource.

    tableResult

    object ( TableResult )

    Output only. Insights for a Table resource.

    DatasetResult

    Insights for a dataset resource.

    JSON representation 
     { 
 "overview" 
 : 
 string 
 , 
 "schemaRelationships" 
 : 
 [ 
 { 
 object (  SchemaRelationship 
 
) 
 } 
 ] 
 , 
 "queries" 
 : 
 [ 
 { 
 object (  Query 
 
) 
 } 
 ] 
 }
    Fields
    overview

    string

    Output only. Generated Dataset description.
    schemaRelationships[]

    object ( SchemaRelationship )

    Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema.
    queries[]

    object ( Query )

    Output only. Sample SQL queries for the dataset.

    SchemaRelationship

    Details of the relationship between the schema of two resources.

    JSON representation 
     { 
 "leftSchemaPaths" 
 : 
 { 
 object (  SchemaPaths 
 
) 
 } 
 , 
 "rightSchemaPaths" 
 : 
 { 
 object (  SchemaPaths 
 
) 
 } 
 , 
 "sources" 
 : 
 [ 
 enum (  Source 
 
) 
 ] 
 , 
 "type" 
 : 
 enum (  Type 
 
) 
 }
    Fields
    leftSchemaPaths

    object ( SchemaPaths )

    Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as rightSchemaPaths . Each field at index i in this list must correspond to a field at the same index in the rightSchemaPaths list.
    rightSchemaPaths

    object ( SchemaPaths )

    Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as leftSchemaPaths . Each field at index i in this list must correspond to a field at the same index in the leftSchemaPaths list.
    sources[]

    enum ( Source )

    Output only. Sources which generated the schema relation edge.
    type

    enum ( Type )

    Output only. The type of relationship between the schema paths.

    SchemaPaths

    Represents an ordered set of paths within a table's schema.

    JSON representation 
     { 
 "tableFqn" 
 : 
 string 
 , 
 "paths" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    tableFqn

    string

    Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
    paths[]

    string

    Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field

    Source

    Source which generated the schema relation edge.

    Enums
    SOURCE_UNSPECIFIED The source of the schema relationship is unspecified.
    AGENT The source of the schema relationship is agent.
    QUERY_HISTORY The source of the schema relationship is query history from the source system.
    TABLE_CONSTRAINTS The source of the schema relationship is table constraints added in the source system.

    Type

    The type of relationship.

    Enums
    TYPE_UNSPECIFIED The type of the schema relationship is unspecified.
    SCHEMA_JOIN Indicates a join relationship between the schema fields.

    Query

    A sample SQL query in data documentation.

    JSON representation 
     { 
 "sql" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 }
    Fields
    sql

    string

    Output only. The SQL query string which can be executed.
    description

    string

    Output only. The description for the query.

    TableResult

    Insights for a table resource.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "overview" 
 : 
 string 
 , 
 "schema" 
 : 
 { 
 object (  Schema 
 
) 
 } 
 , 
 "queries" 
 : 
 [ 
 { 
 object (  Query 
 
) 
 } 
 ] 
 }
    Fields
    name

    string

    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

    string

    Output only. Generated description of the table.
    schema

    object ( Schema )

    Output only. Schema of the table with generated metadata of the columns in the schema.
    queries[]

    object ( Query )

    Output only. Sample SQL queries for the table.

    Schema

    Schema of the table with generated metadata of columns.

    JSON representation 
     { 
 "fields" 
 : 
 [ 
 { 
 object (  Field 
 
) 
 } 
 ] 
 }
    Fields
    fields[]

    object ( Field )

    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 (  Field 
 
) 
 } 
 ] 
 }
    Fields
    name

    string

    Output only. The name of the column.
    description

    string

    Output only. Generated description for columns and fields.
    fields[]

    object ( Field )

    Output only. Nested fields.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: