Google BigQuery Storage v1 API - Class TableFieldSchema (3.4.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class TableFieldSchema : IMessage<TableFieldSchema>, IEquatable<TableFieldSchema>, IDeepCloneable<TableFieldSchema>, IBufferMessage, IMessage

Reference documentation and code samples for the Google BigQuery Storage v1 API class TableFieldSchema.

TableFieldSchema defines a single field/column within a table schema.

Inheritance

Object > TableFieldSchema

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

TableFieldSchema()

public TableFieldSchema()

TableFieldSchema(TableFieldSchema)

public TableFieldSchema(TableFieldSchema other)
Parameter
NameDescription
otherTableFieldSchema

Properties

Description

public string Description { get; set; }

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

Property Value
TypeDescription
String

Fields

public RepeatedField<TableFieldSchema> Fields { get; }

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

Property Value
TypeDescription
RepeatedField<TableFieldSchema>

MaxLength

public long MaxLength { get; set; }

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

Property Value
TypeDescription
Int64

Mode

public TableFieldSchema.Types.Mode Mode { get; set; }

Optional. The field mode. The default value is NULLABLE.

Property Value
TypeDescription
TableFieldSchema.Types.Mode

Name

public string Name { get; set; }

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.

Property Value
TypeDescription
String

Precision

public long Precision { get; set; }

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.

Property Value
TypeDescription
Int64

Scale

public long Scale { get; set; }

Optional. See documentation for precision.

Property Value
TypeDescription
Int64

Type

public TableFieldSchema.Types.Type Type { get; set; }

Required. The field data type.

Property Value
TypeDescription
TableFieldSchema.Types.Type