Module schema (3.27.0)

Schemas for BigQuery tables / queries.

Classes

FieldElementType

FieldElementType(element_type: str)

Represents the type of a field element.

Parameter
Name Description
element_type str

The 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.