Struct google_api_proto::google::cloud::bigquery::v2::TableFieldSchema

pub struct TableFieldSchema {

    pub name: String,
    pub type: String,
    pub mode: String,
    pub fields: Vec<TableFieldSchema>,
    pub description: Option<String>,
    pub policy_tags: Option<PolicyTagList>,
    pub data_policies: Vec<DataPolicyOption>,
    pub max_length: i64,
    pub precision: i64,
    pub scale: i64,
    pub rounding_mode: i32,
    pub collation: Option<String>,
    pub default_value_expression: Option<String>,
    pub range_element_type: Option<FieldElementType>,
    pub foreign_type_definition: String,
}

A field in TableSchema

Fields

name: 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 300 characters.

type: String

Required. The field data type. Possible values include:

• STRING
• BYTES
• INTEGER (or INT64)
• FLOAT (or FLOAT64)
• BOOLEAN (or BOOL)
• TIMESTAMP
• DATE
• TIME
• DATETIME
• GEOGRAPHY
• NUMERIC
• BIGNUMERIC
• JSON
• RECORD (or STRUCT)
• RANGE

Use of RECORD/STRUCT indicates that the field contains a nested schema.

mode: String

Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

fields: Vec<TableFieldSchema>

Optional. Describes the nested schema fields if the type property is set to RECORD.

description: Option<String>

Optional. The field description. The maximum length is 1,024 characters.

policy_tags: Option<PolicyTagList>

Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.

data_policies: Vec<DataPolicyOption>

Optional. Data policy options, will replace the data_policies.

max_length: i64

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”.

precision: i64

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: [-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.

scale: i64

Optional. See documentation for precision.

rounding_mode: i32

Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.

collation: Option<String>

Optional. Field collation can be set only when the type of field is STRING. The following values are supported:

• ‘und:ci’: undetermined locale, case insensitive.
• ‘’: empty string. Default to case-sensitive behavior.

default_value_expression: Option<String>

Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.

range_element_type: Option<FieldElementType>

Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Values for the field element type can be the following:

• DATE
• DATETIME
• TIMESTAMP

foreign_type_definition: String

Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required.

Implementations

impl TableFieldSchema

pub fn rounding_mode(&self) -> RoundingMode

Returns the enum value of rounding_mode, or the default if the field is set to an invalid enum value.

pub fn set_rounding_mode(&mut self, value: RoundingMode)

Sets rounding_mode to the provided enum value.

Trait Implementations

impl Clone for TableFieldSchema

fn clone(&self) -> TableFieldSchema

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TableFieldSchema

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TableFieldSchema

fn default() -> Self

Returns the “default value” for a type.

impl Message for TableFieldSchema

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TableFieldSchema

fn eq(&self, other: &TableFieldSchema) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TableFieldSchema