Class SchemaField (2.25.2)

SchemaField(name, field_type, mode='NULLABLE', description=<object object>, fields=(), policy_tags=None, precision=<object object>, scale=<object object>, max_length=<object object>)

Describe a single field within a table schema.

Parameters

NameDescription
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 Optional[str]

The mode of the field. See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.mode

description Optional[str]

Description for the field.

fields Optional[Tuple[google.cloud.bigquery.schema.SchemaField]]

Subfields (requires field_type of 'RECORD').

policy_tags Optional[PolicyTagList]

The policy tag list for the field.

precision Optional[int]

Precison (number of digits) of fields with NUMERIC or BIGNUMERIC type.

scale Optional[int]

Scale (digits after decimal) of fields with NUMERIC or BIGNUMERIC type.

max_length Optional[int]

Maximim length of fields with STRING or BYTES type.

Inheritance

builtins.object > SchemaField

Properties

description

Optional[str]: description for the field.

field_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

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.

scale

Optional[int]: Scale (digits after decimal) for the NUMERIC field.

Methods

from_api_repr

from_api_repr(api_repr: dict)

Return a SchemaField object deserialized from a dictionary.

Parameter
NameDescription
api_repr Mapping[str, str]

The serialized representation of the SchemaField, such as what is output by to_api_repr.

Returns
TypeDescription
google.cloud.biquery.schema.SchemaFieldThe ``SchemaField`` object.

to_api_repr

to_api_repr()

Return a dictionary representing this schema field.

Returns
TypeDescription
DictA dictionary representing the SchemaField in a serialized form.

to_standard_sql

to_standard_sql()

Return the field as the standard SQL field representation object.

__init__

__init__(name, field_type, mode='NULLABLE', description=<object object>, fields=(), policy_tags=None, precision=<object object>, scale=<object object>, max_length=<object object>)

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

SchemaField

SchemaField(name, field_type, mode='NULLABLE', description=<object object>, fields=(), policy_tags=None, precision=<object object>, scale=<object object>, max_length=<object object>)

Describe a single field within a table schema.

Parameters
NameDescription
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 Optional[str]

The mode of the field. See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.mode

description Optional[str]

Description for the field.

fields Optional[Tuple[google.cloud.bigquery.schema.SchemaField]]

Subfields (requires field_type of 'RECORD').

policy_tags Optional[PolicyTagList]

The policy tag list for the field.

precision Optional[int]

Precison (number of digits) of fields with NUMERIC or BIGNUMERIC type.

scale Optional[int]

Scale (digits after decimal) of fields with NUMERIC or BIGNUMERIC type.

max_length Optional[int]

Maximim length of fields with STRING or BYTES type.