Google BigQuery Storage V1 Client - Class TableFieldSchema (2.1.2)

Reference documentation and code samples for the Google BigQuery Storage V1 Client class TableFieldSchema.

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

Generated from protobuf message google.cloud.bigquery.storage.v1.TableFieldSchema

Namespace

Google \ Cloud \ BigQuery \ Storage \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ 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 128 characters.
↳ type int

Required. The field data type.
↳ mode int

Optional. The field mode. The default value is NULLABLE.
↳ fields array<TableFieldSchema>

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

Optional. The field description. The maximum length is 1,024 characters.
↳ max_length int|string

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".
↳ precision int|string

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.
↳ scale int|string

Optional. See documentation for precision.
↳ default_value_expression string

Optional. A SQL expression to specify the default value for this field.
↳ range_element_type 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

getName

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.

Returns
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Required. The field data type.

Returns
Type Description
int

setType

Required. The field data type.

Parameter
Name Description
var int
Returns
Type Description
$this

getMode

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

Returns
Type Description
int

setMode

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

Parameter
Name Description
var int
Returns
Type Description
$this

getFields

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFields

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

Parameter
Name Description
var array<TableFieldSchema>
Returns
Type Description
$this

getDescription

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

Returns
Type Description
string

setDescription

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

Parameter
Name Description
var string
Returns
Type Description
$this

getMaxLength

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

Returns
Type Description
int|string

setMaxLength

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getPrecision

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.
Returns
Type Description
int|string

setPrecision

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.
Parameter
Name Description
var int|string
Returns
Type Description
$this

getScale

Optional. See documentation for precision.

Returns
Type Description
int|string

setScale

Optional. See documentation for precision.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getDefaultValueExpression

Optional. A SQL expression to specify the default value for this field.

Returns
Type Description
string

setDefaultValueExpression

Optional. A SQL expression to specify the default value for this field.

Parameter
Name Description
var string
Returns
Type Description
$this

getRangeElementType

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
Returns
Type Description
TableFieldSchema\FieldElementType|null

hasRangeElementType

clearRangeElementType

setRangeElementType

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
Parameter
Name Description
var TableFieldSchema\FieldElementType
Returns
Type Description
$this