Module schema (3.24.0)
- 3.39.0 (latest)
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.1
- 3.22.0
- 3.21.0
- 3.20.1
- 3.19.0
- 3.18.0
- 3.17.2
- 3.16.0
- 3.15.0
- 3.14.1
- 3.13.0
- 3.12.0
- 3.11.4
- 3.4.0
- 3.3.6
- 3.2.0
- 3.1.0
- 3.0.1
- 2.34.4
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.1
- 2.29.0
- 2.28.1
- 2.27.1
- 2.26.0
- 2.25.2
- 2.24.1
- 2.23.3
- 2.22.1
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.1
- 2.15.0
- 2.14.0
- 2.13.1
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.2
- 2.5.0
- 2.4.0
- 2.3.1
- 2.2.0
- 2.1.0
- 2.0.0
- 1.28.2
- 1.27.2
- 1.26.1
- 1.25.0
- 1.24.0
- 1.23.1
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
Schemas for BigQuery tables / queries.
Classes
FieldElementType
FieldElementType(element_type:str)Represents the type of a field element.
| Parameter | |
|---|---|
| Name | Description |
element_type | strThe type of a field element. |
PolicyTagList
PolicyTagList(names:typing.Iterable[str]=())Define Policy Tags for a column.
SchemaField
SchemaField(name:str,field_type:str,mode:str="NULLABLE",default_value_expression:typing.Optional[str]=None,description:typing.Union[str,google.cloud.bigquery.schema._DefaultSentinel]=_DefaultSentinel.DEFAULT_VALUE,fields:typing.Iterable[google.cloud.bigquery.schema.SchemaField]=(),policy_tags:typing.Union[google.cloud.bigquery.schema.PolicyTagList,None,google.cloud.bigquery.schema._DefaultSentinel,]=_DefaultSentinel.DEFAULT_VALUE,precision:typing.Union[int,google.cloud.bigquery.schema._DefaultSentinel]=_DefaultSentinel.DEFAULT_VALUE,scale:typing.Union[int,google.cloud.bigquery.schema._DefaultSentinel]=_DefaultSentinel.DEFAULT_VALUE,max_length:typing.Union[int,google.cloud.bigquery.schema._DefaultSentinel]=_DefaultSentinel.DEFAULT_VALUE,range_element_type:typing.Optional[typing.Union[google.cloud.bigquery.schema.FieldElementType,str]]=None,)Describe a single field within a table schema.
| Parameters | |
|---|---|
| Name | Description |
name | strThe name of the field. |
field_type | strThe type of the field. Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.type |
mode | strDefaults to |
default_value_expression | typing.Optional[str]str, Optional Used to specify the default value of a field using a SQL expression. It can only be set for top level fields (columns). You can use a struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - The following functions: |
description | typing.Union[str, google.cloud.bigquery.schema._DefaultSentinel]Description for the field. |
fields | typing.Iterable[SchemaField]Subfields (requires |
policy_tags | typing.Union[PolicyTagList, NoneType, google.cloud.bigquery.schema._DefaultSentinel]The policy tag list for the field. |
precision | typing.Union[int, google.cloud.bigquery.schema._DefaultSentinel]Precison (number of digits) of fields with NUMERIC or BIGNUMERIC type. |
scale | typing.Union[int, google.cloud.bigquery.schema._DefaultSentinel]Scale (digits after decimal) of fields with NUMERIC or BIGNUMERIC type. |
max_length | typing.Union[int, google.cloud.bigquery.schema._DefaultSentinel]Maximum length of fields with STRING or BYTES type. |
range_element_type | typing.Union[google.cloud.bigquery.schema.FieldElementType, str, NoneType]FieldElementType, str, Optional The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-16 UTC.