Send feedback
Module schema (3.36.0) Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
Schemas for BigQuery tables / queries.
Classes
FieldElementType
(
element_type
:
str
)
Represents the type of a field element.
element_type
str
The type of a field element.
ForeignTypeInfo
(
type_system
:
typing
.
Optional
[
str
]
=
None
)
Metadata about the foreign data type definition such as the system in which the
type is defined.
type_system
str
Required. Specifies the system which defines the foreign data type. TypeSystem enum currently includes: * "TYPE_SYSTEM_UNSPECIFIED" * "HIVE"
PolicyTagList
(
names
:
typing
.
Iterable
[
str
]
=
())
Define Policy Tags for a column.
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
,
rounding_mode
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
bigquery
.
enums
.
RoundingMode
,
str
]
]
=
None
,
foreign_type_definition
:
typing
.
Optional
[
str
]
=
None
,
)
Describe a single field within a table schema.
SerDeInfo
(
serialization_library
:
str
,
name
:
typing
.
Optional
[
str
]
=
None
,
parameters
:
typing
.
Optional
[
dict
[
str
,
str
]]
=
None
,
)
Serializer and deserializer information.
serialization_library
str
Required. Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.
name
Optional[str]
Name of the SerDe. The maximum length is 256 characters.
StorageDescriptor
(
input_format
:
typing
.
Optional
[
str
]
=
None
,
location_uri
:
typing
.
Optional
[
str
]
=
None
,
output_format
:
typing
.
Optional
[
str
]
=
None
,
serde_info
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
bigquery
.
schema
.
SerDeInfo
,
dict
]
]
=
None
,
)
Contains information about how a table's data is stored and accessed by open
source query engines.
input_format
Optional[str]
Specifies the fully qualified class name of the InputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). The maximum length is 128 characters.
location_uri
Optional[str]
The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/'). The maximum length is 2056 bytes.
output_format
Optional[str]
Specifies the fully qualified class name of the OutputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). The maximum length is 128 characters.
serde_info
Union[SerDeInfo, dict, None]
Serializer and deserializer information.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Module schema (3.36.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.36.0 (latest)](/python/docs/reference/bigquery/latest/google.cloud.bigquery.schema)\n- [3.35.1](/python/docs/reference/bigquery/3.35.1/google.cloud.bigquery.schema)\n- [3.34.0](/python/docs/reference/bigquery/3.34.0/google.cloud.bigquery.schema)\n- [3.33.0](/python/docs/reference/bigquery/3.33.0/google.cloud.bigquery.schema)\n- [3.31.0](/python/docs/reference/bigquery/3.31.0/google.cloud.bigquery.schema)\n- [3.30.0](/python/docs/reference/bigquery/3.30.0/google.cloud.bigquery.schema)\n- [3.29.0](/python/docs/reference/bigquery/3.29.0/google.cloud.bigquery.schema)\n- [3.27.0](/python/docs/reference/bigquery/3.27.0/google.cloud.bigquery.schema)\n- [3.26.0](/python/docs/reference/bigquery/3.26.0/google.cloud.bigquery.schema)\n- [3.25.0](/python/docs/reference/bigquery/3.25.0/google.cloud.bigquery.schema)\n- [3.24.0](/python/docs/reference/bigquery/3.24.0/google.cloud.bigquery.schema)\n- [3.23.1](/python/docs/reference/bigquery/3.23.1/google.cloud.bigquery.schema)\n- [3.22.0](/python/docs/reference/bigquery/3.22.0/google.cloud.bigquery.schema)\n- [3.21.0](/python/docs/reference/bigquery/3.21.0/google.cloud.bigquery.schema)\n- [3.20.1](/python/docs/reference/bigquery/3.20.1/google.cloud.bigquery.schema)\n- [3.19.0](/python/docs/reference/bigquery/3.19.0/google.cloud.bigquery.schema)\n- [3.18.0](/python/docs/reference/bigquery/3.18.0/google.cloud.bigquery.schema)\n- [3.17.2](/python/docs/reference/bigquery/3.17.2/google.cloud.bigquery.schema)\n- [3.16.0](/python/docs/reference/bigquery/3.16.0/google.cloud.bigquery.schema)\n- [3.15.0](/python/docs/reference/bigquery/3.15.0/google.cloud.bigquery.schema)\n- [3.14.1](/python/docs/reference/bigquery/3.14.1/google.cloud.bigquery.schema)\n- [3.13.0](/python/docs/reference/bigquery/3.13.0/google.cloud.bigquery.schema)\n- [3.12.0](/python/docs/reference/bigquery/3.12.0/google.cloud.bigquery.schema)\n- [3.11.4](/python/docs/reference/bigquery/3.11.4/google.cloud.bigquery.schema)\n- [3.4.0](/python/docs/reference/bigquery/3.4.0/google.cloud.bigquery.schema)\n- [3.3.6](/python/docs/reference/bigquery/3.3.6/google.cloud.bigquery.schema)\n- [3.2.0](/python/docs/reference/bigquery/3.2.0/google.cloud.bigquery.schema)\n- [3.1.0](/python/docs/reference/bigquery/3.1.0/google.cloud.bigquery.schema)\n- [3.0.1](/python/docs/reference/bigquery/3.0.1/google.cloud.bigquery.schema)\n- [2.34.4](/python/docs/reference/bigquery/2.34.4/google.cloud.bigquery.schema)\n- [2.33.0](/python/docs/reference/bigquery/2.33.0/google.cloud.bigquery.schema)\n- [2.32.0](/python/docs/reference/bigquery/2.32.0/google.cloud.bigquery.schema)\n- [2.31.0](/python/docs/reference/bigquery/2.31.0/google.cloud.bigquery.schema)\n- [2.30.1](/python/docs/reference/bigquery/2.30.1/google.cloud.bigquery.schema)\n- [2.29.0](/python/docs/reference/bigquery/2.29.0/google.cloud.bigquery.schema)\n- [2.28.1](/python/docs/reference/bigquery/2.28.1/google.cloud.bigquery.schema)\n- [2.27.1](/python/docs/reference/bigquery/2.27.1/google.cloud.bigquery.schema)\n- [2.26.0](/python/docs/reference/bigquery/2.26.0/google.cloud.bigquery.schema)\n- [2.25.2](/python/docs/reference/bigquery/2.25.2/google.cloud.bigquery.schema)\n- [2.24.1](/python/docs/reference/bigquery/2.24.1/google.cloud.bigquery.schema)\n- [2.23.3](/python/docs/reference/bigquery/2.23.3/google.cloud.bigquery.schema)\n- [2.22.1](/python/docs/reference/bigquery/2.22.1/google.cloud.bigquery.schema)\n- [2.21.0](/python/docs/reference/bigquery/2.21.0/google.cloud.bigquery.schema)\n- [2.20.0](/python/docs/reference/bigquery/2.20.0/google.cloud.bigquery.schema)\n- [2.19.0](/python/docs/reference/bigquery/2.19.0/google.cloud.bigquery.schema)\n- [2.18.0](/python/docs/reference/bigquery/2.18.0/google.cloud.bigquery.schema)\n- [2.17.0](/python/docs/reference/bigquery/2.17.0/google.cloud.bigquery.schema)\n- [2.16.1](/python/docs/reference/bigquery/2.16.1/google.cloud.bigquery.schema)\n- [2.15.0](/python/docs/reference/bigquery/2.15.0/google.cloud.bigquery.schema)\n- [2.14.0](/python/docs/reference/bigquery/2.14.0/google.cloud.bigquery.schema)\n- [2.13.1](/python/docs/reference/bigquery/2.13.1/google.cloud.bigquery.schema)\n- [2.12.0](/python/docs/reference/bigquery/2.12.0/google.cloud.bigquery.schema)\n- [2.11.0](/python/docs/reference/bigquery/2.11.0/google.cloud.bigquery.schema)\n- [2.10.0](/python/docs/reference/bigquery/2.10.0/google.cloud.bigquery.schema)\n- [2.9.0](/python/docs/reference/bigquery/2.9.0/google.cloud.bigquery.schema)\n- [2.8.0](/python/docs/reference/bigquery/2.8.0/google.cloud.bigquery.schema)\n- [2.7.0](/python/docs/reference/bigquery/2.7.0/google.cloud.bigquery.schema)\n- [2.6.2](/python/docs/reference/bigquery/2.6.2/google.cloud.bigquery.schema)\n- [2.5.0](/python/docs/reference/bigquery/2.5.0/google.cloud.bigquery.schema)\n- [2.4.0](/python/docs/reference/bigquery/2.4.0/google.cloud.bigquery.schema)\n- [2.3.1](/python/docs/reference/bigquery/2.3.1/google.cloud.bigquery.schema)\n- [2.2.0](/python/docs/reference/bigquery/2.2.0/google.cloud.bigquery.schema)\n- [2.1.0](/python/docs/reference/bigquery/2.1.0/google.cloud.bigquery.schema)\n- [2.0.0](/python/docs/reference/bigquery/2.0.0/google.cloud.bigquery.schema)\n- [1.28.2](/python/docs/reference/bigquery/1.28.2/google.cloud.bigquery.schema)\n- [1.27.2](/python/docs/reference/bigquery/1.27.2/google.cloud.bigquery.schema)\n- [1.26.1](/python/docs/reference/bigquery/1.26.1/google.cloud.bigquery.schema)\n- [1.25.0](/python/docs/reference/bigquery/1.25.0/google.cloud.bigquery.schema)\n- [1.24.0](/python/docs/reference/bigquery/1.24.0/google.cloud.bigquery.schema)\n- [1.23.1](/python/docs/reference/bigquery/1.23.1/google.cloud.bigquery.schema)\n- [1.22.0](/python/docs/reference/bigquery/1.22.0/google.cloud.bigquery.schema)\n- [1.21.0](/python/docs/reference/bigquery/1.21.0/google.cloud.bigquery.schema)\n- [1.20.0](/python/docs/reference/bigquery/1.20.0/google.cloud.bigquery.schema)\n- [1.19.0](/python/docs/reference/bigquery/1.19.0/google.cloud.bigquery.schema)\n- [1.18.0](/python/docs/reference/bigquery/1.18.0/google.cloud.bigquery.schema)\n- [1.17.0](/python/docs/reference/bigquery/1.17.0/google.cloud.bigquery.schema)\n- [1.16.0](/python/docs/reference/bigquery/1.16.0/google.cloud.bigquery.schema) \nSchemas for BigQuery tables / queries.\n\nClasses\n-------\n\n### [FieldElementType](/python/docs/reference/bigquery/latest/google.cloud.bigquery.schema.FieldElementType)\n\n FieldElementType(element_type: str)\n\nRepresents the type of a field element.\n\n### [ForeignTypeInfo](/python/docs/reference/bigquery/latest/google.cloud.bigquery.schema.ForeignTypeInfo)\n\n ForeignTypeInfo(type_system: typing.Optional[str] = None)\n\nMetadata about the foreign data type definition such as the system in which the\ntype is defined.\n\n### [PolicyTagList](/python/docs/reference/bigquery/latest/google.cloud.bigquery.schema.PolicyTagList)\n\n PolicyTagList(names: typing.Iterable[str] = ())\n\nDefine Policy Tags for a column.\n\n### [SchemaField](/python/docs/reference/bigquery/latest/google.cloud.bigquery.schema.SchemaField)\n\n SchemaField(\n name: str,\n field_type: str,\n mode: str = \"NULLABLE\",\n default_value_expression: typing.Optional[str] = None,\n description: typing.Union[\n str, google.cloud.bigquery.schema._DefaultSentinel\n ] = _DefaultSentinel.DEFAULT_VALUE,\n fields: typing.Iterable[google.cloud.bigquery.schema.SchemaField] = (),\n policy_tags: typing.Union[\n google.cloud.bigquery.schema.PolicyTagList,\n None,\n google.cloud.bigquery.schema._DefaultSentinel,\n ] = _DefaultSentinel.DEFAULT_VALUE,\n precision: typing.Union[\n int, google.cloud.bigquery.schema._DefaultSentinel\n ] = _DefaultSentinel.DEFAULT_VALUE,\n scale: typing.Union[\n int, google.cloud.bigquery.schema._DefaultSentinel\n ] = _DefaultSentinel.DEFAULT_VALUE,\n max_length: typing.Union[\n int, google.cloud.bigquery.schema._DefaultSentinel\n ] = _DefaultSentinel.DEFAULT_VALUE,\n range_element_type: typing.Optional[\n typing.Union[google.cloud.bigquery.schema.FieldElementType, str]\n ] = None,\n rounding_mode: typing.Optional[\n typing.Union[google.cloud.bigquery.enums.RoundingMode, str]\n ] = None,\n foreign_type_definition: typing.Optional[str] = None,\n )\n\nDescribe a single field within a table schema.\n\n### [SerDeInfo](/python/docs/reference/bigquery/latest/google.cloud.bigquery.schema.SerDeInfo)\n\n SerDeInfo(\n serialization_library: str,\n name: typing.Optional[str] = None,\n parameters: typing.Optional[dict[str, str]] = None,\n )\n\nSerializer and deserializer information.\n\n### [StorageDescriptor](/python/docs/reference/bigquery/latest/google.cloud.bigquery.schema.StorageDescriptor)\n\n StorageDescriptor(\n input_format: typing.Optional[str] = None,\n location_uri: typing.Optional[str] = None,\n output_format: typing.Optional[str] = None,\n serde_info: typing.Optional[\n typing.Union[google.cloud.bigquery.schema.SerDeInfo, dict]\n ] = None,\n )\n\nContains information about how a table's data is stored and accessed by open\nsource query engines."]]
