GoogleApi.BigQuery.V2.Model.TableFieldSchema (google_api_big_query v0.70.1) View Source

Attributes

  • categories (type: GoogleApi.BigQuery.V2.Model.TableFieldSchemaCategories.t, default: nil) - [Optional] The categories attached to this field, used for field-level access control.
  • collationSpec (type: String.t, default: nil) - Optional. Collation specification of the field. It only can be set on string type field.
  • description (type: String.t, default: nil) - [Optional] The field description. The maximum length is 1,024 characters.
  • fields (type: list(GoogleApi.BigQuery.V2.Model.TableFieldSchema.t), default: nil) - [Optional] Describes the nested schema fields if the type property is set to RECORD.
  • maxLength (type: String.t, default: nil) - [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 ≠ "STRING" and ≠ "BYTES".
  • mode (type: String.t, default: nil) - [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
  • name (type: String.t, default: nil) - [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 300 characters.
  • policyTags (type: GoogleApi.BigQuery.V2.Model.TableFieldSchemaPolicyTags.t, default: nil) -
  • precision (type: String.t, default: nil) - [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 ≠ "NUMERIC" and ≠ "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: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 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.
  • scale (type: String.t, default: nil) - [Optional] See documentation for precision.
  • type (type: String.t, default: nil) - [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.BigQuery.V2.Model.TableFieldSchema{
  categories: GoogleApi.BigQuery.V2.Model.TableFieldSchemaCategories.t() | nil,
  collationSpec: String.t() | nil,
  description: String.t() | nil,
  fields: [GoogleApi.BigQuery.V2.Model.TableFieldSchema.t()] | nil,
  maxLength: String.t() | nil,
  mode: String.t() | nil,
  name: String.t() | nil,
  policyTags: GoogleApi.BigQuery.V2.Model.TableFieldSchemaPolicyTags.t() | nil,
  precision: String.t() | nil,
  scale: String.t() | nil,
  type: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.