google.cloud.bigquery.schema.SchemaField#
Methods
|
Return a |
Return a dictionary representing this schema field. |
|
Return the field as the standard SQL field representation object. |
Attributes
description for the field. |
|
The type of the field. |
|
Subfields contained in this field. |
|
whether ‘mode’ is ‘nullable’. |
|
The mode of the field. |
|
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
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 (requiresfield_type
of ‘RECORD’).
-
property
field_type
# The type of the field.
See: https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.type
- Type
-
property
fields
# Subfields contained in this field.
Must be empty unset if
field_type
is not ‘RECORD’.- Type
-
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
-
property
mode
# The mode of the field.
See: https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.mode
- Type
-
to_api_repr
()[source]# Return a dictionary representing this schema field.
- Returns
- A dictionary representing the SchemaField in a serialized
form.
- Return type
-
to_standard_sql
()[source]# Return the field as the standard SQL field representation object.
- Returns
An instance of
StandardSqlField
.