- 3.25.0 (latest)
- 3.24.0
- 3.23.1
- 3.22.0
- 3.21.0
- 3.20.1
- 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: 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.
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#TableFieldSchema.FIELDS.type |
mode |
str
Defaults to |
default_value_expression |
typing.Optional[str]
str, Optional Used to specify the default value of a field using a SQL expression. It can only be set for top level fields (columns). You can use a struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - The following functions: |
description |
typing.Union[str, google.cloud.bigquery.schema._DefaultSentinel]
Description for the field. |
fields |
typing.Iterable[SchemaField]
Subfields (requires |
policy_tags |
typing.Union[PolicyTagList, NoneType, google.cloud.bigquery.schema._DefaultSentinel]
The policy tag list for the field. |
precision |
typing.Union[int, google.cloud.bigquery.schema._DefaultSentinel]
Precison (number of digits) of fields with NUMERIC or BIGNUMERIC type. |
scale |
typing.Union[int, google.cloud.bigquery.schema._DefaultSentinel]
Scale (digits after decimal) of fields with NUMERIC or BIGNUMERIC type. |
max_length |
typing.Union[int, google.cloud.bigquery.schema._DefaultSentinel]
Maximum length of fields with STRING or BYTES type. |
range_element_type |
typing.Union[google.cloud.bigquery.schema.FieldElementType, str, NoneType]
FieldElementType, str, Optional The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include |
Properties
default_value_expression
Optional[str] default value of a field, using an SQL expression
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#TableFieldSchema.FIELDS.type
fields
Optional[tuple]: Subfields contained in this field.
Must be empty unset if field_type
is not 'RECORD'.
is_nullable
bool: whether 'mode' is 'nullable'.
max_length
Optional[int]: Maximum length for the STRING or BYTES field.
mode
Optional[str]: The mode of the field.
See: https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.mode
name
str: The name of the field.
policy_tags
Optional[google.cloud.bigquery.schema.PolicyTagList]: Policy tag list definition for this field.
precision
Optional[int]: Precision (number of digits) for the NUMERIC field.
range_element_type
Optional[FieldElementType]: The subtype of the RANGE, if the type of this field is RANGE.
Must be set when type
is "RANGE"
. Must be one of "DATE"
,
"DATETIME"
or "TIMESTAMP"
.
scale
Optional[int]: Scale (digits after decimal) for the NUMERIC field.
Methods
from_api_repr
from_api_repr(api_repr: dict) -> google.cloud.bigquery.schema.SchemaField
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 |
Returns | |
---|---|
Type | Description |
google.cloud.bigquery.schema.SchemaField |
The SchemaField object. |
to_api_repr
to_api_repr() -> dict
Return a dictionary representing this schema field.
Returns | |
---|---|
Type | Description |
Dict |
A dictionary representing the SchemaField in a serialized form. |
to_standard_sql
to_standard_sql() -> google.cloud.bigquery.standard_sql.StandardSqlField
Return the field as the standard SQL field representation object.