google.cloud.bigquery.schema.SchemaField#

Methods

from_api_repr(api_repr) Return a SchemaField object deserialized from a dictionary.
to_api_repr() Return a dictionary representing this schema field.

Attributes

description description for the field.
field_type The type of the field.
fields Subfields contained in this field.
is_nullable whether ‘mode’ is ‘nullable’.
mode The mode of the field.
name The name of the field.


class google.cloud.bigquery.schema.SchemaField(name, field_type, mode='NULLABLE', description=None, fields=())[source]#

Bases: object

Describe a single field within a table schema.

Parameters:
description#

description for the field.

Type:Optional[str]
field_type#

The type of the field.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.type

Type:str
fields#

Subfields contained in this field.

Must be empty unset if field_type is not ‘RECORD’.

Type:tuple
classmethod from_api_repr(api_repr)[source]#

Return a SchemaField object deserialized from a dictionary.

Parameters:api_repr (Mapping[str, str]) – The serialized representation of the SchemaField, such as what is output by to_api_repr().
Returns:The SchemaField object.
Return type:google.cloud.biquery.schema.SchemaField
is_nullable#

whether ‘mode’ is ‘nullable’.

Type:bool
mode#

The mode of the field.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.mode

Type:str
name#

The name of the field.

Type:str
to_api_repr()[source]#

Return a dictionary representing this schema field.

Returns:
A dictionary representing the SchemaField in a serialized
form.
Return type:dict