Module standard_sql (3.24.0)

API documentation for bigquery.standard_sql module.

Classes

StandardSqlDataType

  StandardSqlDataType 
 ( 
 type_kind 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 bigquery 
 . 
 enums 
 . 
 StandardSqlTypeNames 
 ] 
 = 
 StandardSqlTypeNames 
 . 
 TYPE_KIND_UNSPECIFIED 
 , 
 array_element_type 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 bigquery 
 . 
 standard_sql 
 . 
 StandardSqlDataType 
 ] 
 = 
 None 
 , 
 struct_type 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 bigquery 
 . 
 standard_sql 
 . 
 StandardSqlStructType 
 ] 
 = 
 None 
 , 
 range_element_type 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 bigquery 
 . 
 standard_sql 
 . 
 StandardSqlDataType 
 ] 
 = 
 None 
 , 
 )

The type of a variable, e.g., a function argument.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/StandardSqlDataType

Examples:

 INT64: {type_kind="INT64"}
ARRAY: {type_kind="ARRAY", array_element_type="STRING"}
STRUCT<x STRING, y ARRAY>: {
    type_kind="STRUCT",
    struct_type={
        fields=[
            {name="x", type={type_kind="STRING"}},
            {
                name="y",
                type={type_kind="ARRAY", array_element_type="DATE"}
            }
        ]
    }
}
RANGE: {type_kind="RANGE", range_element_type="DATETIME"}

Parameters

Name

Description

type_kind

typing.Optional[ google.cloud.bigquery.enums.StandardSqlTypeNames 
]

The top level type of this field. Can be any standard SQL data type, e.g. INT64, DATE, ARRAY.

array_element_type

typing.Optional[StandardSqlDataType]

The type of the array's elements, if type_kind is ARRAY.

struct_type

typing.Optional[StandardSqlStructType]

The fields of this struct, in order, if type_kind is STRUCT.

range_element_type

typing.Optional[StandardSqlDataType]

The type of the range's elements, if type_kind is RANGE.

StandardSqlField

  StandardSqlField 
 ( 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 type 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 bigquery 
 . 
 standard_sql 
 . 
 StandardSqlDataType 
 ] 
 = 
 None 
 , 
 )

A field or a column.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/StandardSqlField

Parameters

Name

Description

name

typing.Optional[str]

The name of this field. Can be absent for struct fields.

type

typing.Optional[ google.cloud.bigquery.standard_sql.StandardSqlDataType 
]

The type of this parameter. Absent if not explicitly specified. For example, CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).

StandardSqlStructType

  StandardSqlStructType 
 ( 
 fields 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Iterable 
 [ 
 google 
 . 
 cloud 
 . 
 bigquery 
 . 
 standard_sql 
 . 
 StandardSqlField 
 ] 
 ] 
 = 
 None 
 , 
 )

Type of a struct field.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/StandardSqlDataType#StandardSqlStructType

Parameter

Name

Description

fields

typing.Optional[typing.Iterable[ google.cloud.bigquery.standard_sql.StandardSqlField 
]]

The fields in this struct.

StandardSqlTableType

  StandardSqlTableType 
 ( 
 columns 
 : 
 typing 
 . 
 Iterable 
 [ 
 google 
 . 
 cloud 
 . 
 bigquery 
 . 
 standard_sql 
 . 
 StandardSqlField 
 ], 
 )

A table type.

See: https://cloud.google.com/workflows/docs/reference/googleapis/bigquery/v2/Overview#StandardSqlTableType

Parameter

Name

Description

columns

typing.Iterable[ google.cloud.bigquery.standard_sql.StandardSqlField 
]

The columns in this table type.

Module standard_sql (3.24.0) Stay organized with collections Save and categorize content based on your preferences.

Classes

StandardSqlDataType

StandardSqlField

StandardSqlStructType

StandardSqlTableType

Module standard_sql (3.24.0)