Class SchemaField (1.17.0)

Version 1.17.0

• 3.20.1 (latest)
• 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

SchemaField(name, field_type, mode="NULLABLE", description=None, fields=())

Describe a single field within a table schema.

Parameters

Name	Description
name	str the name of the field.
field_type	str the type of the field. See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.type
mode	str the mode of the field. See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.mode
description	Optional[str] description for the field.
fields	Tuple[SchemaField] subfields (requires field_type of 'RECORD').

Inheritance

builtins.object > SchemaField

Properties

description

Optional[str]: description for the field.

field_type

str: The type of the field.

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

fields

tuple: Subfields contained in this field.

Must be empty unset if field_type is not 'RECORD'.

is_nullable

bool: whether 'mode' is 'nullable'.

mode

str: The mode of the field.

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

name

str: The name of the field.

Methods

__init__

__init__(name, field_type, mode="NULLABLE", description=None, fields=())

Initialize self. See help(type(self)) for accurate signature.

from_api_repr

from_api_repr(api_repr)

Return a SchemaField object deserialized from a dictionary.

Parameter

Name	Description
api_repr	Mapping[str, str] The serialized representation of the SchemaField, such as what is output by to_api_repr.

Returns

Type	Description
google.cloud.biquery.schema.SchemaField	The ``SchemaField`` object.

to_api_repr

to_api_repr()

Return a dictionary representing this schema field.

Returns

Type	Description
dict	A dictionary representing the SchemaField in a serialized form.

SchemaField

SchemaField(name, field_type, mode="NULLABLE", description=None, fields=())

Describe a single field within a table schema.

Parameters

Name	Description
name	str the name of the field.
field_type	str the type of the field. See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.type
mode	str the mode of the field. See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.mode
description	Optional[str] description for the field.
fields	Tuple[SchemaField] subfields (requires field_type of 'RECORD').