Reference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::TableFieldSchema.
TableFieldSchema defines a single field/column within a table schema.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#default_value_expression
def default_value_expression() -> ::String- (::String) — Optional. A SQL expression to specify the default value for this field.
#default_value_expression=
def default_value_expression=(value) -> ::String- value (::String) — Optional. A SQL expression to specify the default value for this field.
- (::String) — Optional. A SQL expression to specify the default value for this field.
#description
def description() -> ::String- (::String) — Optional. The field description. The maximum length is 1,024 characters.
#description=
def description=(value) -> ::String- value (::String) — Optional. The field description. The maximum length is 1,024 characters.
- (::String) — Optional. The field description. The maximum length is 1,024 characters.
#fields
def fields() -> ::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>- (::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>) — Optional. Describes the nested schema fields if the type property is set to STRUCT.
#fields=
def fields=(value) -> ::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>- value (::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>) — Optional. Describes the nested schema fields if the type property is set to STRUCT.
- (::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>) — Optional. Describes the nested schema fields if the type property is set to STRUCT.
#max_length
def max_length() -> ::Integer-
(::Integer) — Optional. Maximum length of values of this field for STRINGS or BYTES.
If max_length is not specified, no maximum length constraint is imposed on this field.
If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field.
If type = "BYTES", then max_length represents the maximum number of bytes in this field.
It is invalid to set this field if type is not "STRING" or "BYTES".
#max_length=
def max_length=(value) -> ::Integer-
value (::Integer) — Optional. Maximum length of values of this field for STRINGS or BYTES.
If max_length is not specified, no maximum length constraint is imposed on this field.
If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field.
If type = "BYTES", then max_length represents the maximum number of bytes in this field.
It is invalid to set this field if type is not "STRING" or "BYTES".
-
(::Integer) — Optional. Maximum length of values of this field for STRINGS or BYTES.
If max_length is not specified, no maximum length constraint is imposed on this field.
If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field.
If type = "BYTES", then max_length represents the maximum number of bytes in this field.
It is invalid to set this field if type is not "STRING" or "BYTES".
#mode
def mode() -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Mode- (::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Mode) — Optional. The field mode. The default value is NULLABLE.
#mode=
def mode=(value) -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Mode- value (::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Mode) — Optional. The field mode. The default value is NULLABLE.
- (::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Mode) — Optional. The field mode. The default value is NULLABLE.
#name
def name() -> ::String- (::String) — Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
#name=
def name=(value) -> ::String- value (::String) — Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
- (::String) — Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
#precision
def precision() -> ::Integer-
(::Integer) — Optional. Precision (maximum number of total digits in base 10) and scale
(maximum number of digits in the fractional part in base 10) constraints
for values of this field for NUMERIC or BIGNUMERIC.
It is invalid to set precision or scale if type is not "NUMERIC" or "BIGNUMERIC".
If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type.
Values of this NUMERIC or BIGNUMERIC field must be in this range when:
- Precision (P) and scale (S) are specified: [-10^(P-S) + 10^(-S), 10^(P-S) - 10^(-S)]
- Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10^P + 1, 10^P - 1].
Acceptable values for precision and scale if both are specified:
- If type = "NUMERIC": 1 <= precision - scale <= 29 and 0 <= scale <= 9.
- If type = "BIGNUMERIC": 1 <= precision - scale <= 38 and 0 <= scale <= 38.
Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero):
- If type = "NUMERIC": 1 <= precision <= 29.
- If type = "BIGNUMERIC": 1 <= precision <= 38.
If scale is specified but not precision, then it is invalid.
#precision=
def precision=(value) -> ::Integer-
value (::Integer) — Optional. Precision (maximum number of total digits in base 10) and scale
(maximum number of digits in the fractional part in base 10) constraints
for values of this field for NUMERIC or BIGNUMERIC.
It is invalid to set precision or scale if type is not "NUMERIC" or "BIGNUMERIC".
If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type.
Values of this NUMERIC or BIGNUMERIC field must be in this range when:
- Precision (P) and scale (S) are specified: [-10^(P-S) + 10^(-S), 10^(P-S) - 10^(-S)]
- Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10^P + 1, 10^P - 1].
Acceptable values for precision and scale if both are specified:
- If type = "NUMERIC": 1 <= precision - scale <= 29 and 0 <= scale <= 9.
- If type = "BIGNUMERIC": 1 <= precision - scale <= 38 and 0 <= scale <= 38.
Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero):
- If type = "NUMERIC": 1 <= precision <= 29.
- If type = "BIGNUMERIC": 1 <= precision <= 38.
If scale is specified but not precision, then it is invalid.
-
(::Integer) — Optional. Precision (maximum number of total digits in base 10) and scale
(maximum number of digits in the fractional part in base 10) constraints
for values of this field for NUMERIC or BIGNUMERIC.
It is invalid to set precision or scale if type is not "NUMERIC" or "BIGNUMERIC".
If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type.
Values of this NUMERIC or BIGNUMERIC field must be in this range when:
- Precision (P) and scale (S) are specified: [-10^(P-S) + 10^(-S), 10^(P-S) - 10^(-S)]
- Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10^P + 1, 10^P - 1].
Acceptable values for precision and scale if both are specified:
- If type = "NUMERIC": 1 <= precision - scale <= 29 and 0 <= scale <= 9.
- If type = "BIGNUMERIC": 1 <= precision - scale <= 38 and 0 <= scale <= 38.
Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero):
- If type = "NUMERIC": 1 <= precision <= 29.
- If type = "BIGNUMERIC": 1 <= precision <= 38.
If scale is specified but not precision, then it is invalid.
#range_element_type
def range_element_type() -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::FieldElementType-
(::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::FieldElementType) —
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:
- DATE
- DATETIME
- TIMESTAMP
#range_element_type=
def range_element_type=(value) -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::FieldElementType-
value (::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::FieldElementType) —
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:
- DATE
- DATETIME
- TIMESTAMP
-
(::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::FieldElementType) —
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:
- DATE
- DATETIME
- TIMESTAMP
#scale
def scale() -> ::Integer- (::Integer) — Optional. See documentation for precision.
#scale=
def scale=(value) -> ::Integer- value (::Integer) — Optional. See documentation for precision.
- (::Integer) — Optional. See documentation for precision.
#type
def type() -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Type- (::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Type) — Required. The field data type.
#type=
def type=(value) -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Type- value (::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Type) — Required. The field data type.
- (::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Type) — Required. The field data type.