Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class SchemaField (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').

builtins.object > SchemaField

Optional[str]: description for the field.

str: The type of the field.

tuple: Subfields contained in this field.

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

bool: whether 'mode' is 'nullable'.

str: The mode of the field.

str: The name of the field.

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

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

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()

Return a dictionary representing this schema field.

Returns

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

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').