com.google.cloud.bigquery.storage.v1.table

Members list

Concise view

Type members

Classlikes

final case class TableFieldSchema(name: String, `type`: Type, mode: Mode, fields: Seq[TableFieldSchema], description: String, maxLength: Long, precision: Long, scale: Long, defaultValueExpression: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[TableFieldSchema]

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

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

Attributes

defaultValueExpression

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

description

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

fields

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

maxLength

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

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

name

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

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

Optional. See documentation for precision.

type

Required. The field data type.

Companion:
object
Source:
TableFieldSchema.scala
Graph
Supertypes
trait Updatable[TableFieldSchema]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object TableFieldSchema extends GeneratedMessageCompanion[TableFieldSchema]

Attributes

Companion:
class
Source:
TableFieldSchema.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TableFieldSchema]
trait Serializable
class Object
trait Matchable
class Any
Self type
object TableProto extends GeneratedFileObject

Attributes

Source:
TableProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class TableSchema(fields: Seq[TableFieldSchema], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[TableSchema]

Schema of a table. This schema is a subset of google.cloud.bigquery.v2.TableSchema containing information necessary to generate valid message to write to BigQuery.

Schema of a table. This schema is a subset of google.cloud.bigquery.v2.TableSchema containing information necessary to generate valid message to write to BigQuery.

Attributes

fields

Describes the fields in a table.

Companion:
object
Source:
TableSchema.scala
Graph
Supertypes
trait Updatable[TableSchema]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object TableSchema extends GeneratedMessageCompanion[TableSchema]

Attributes

Companion:
class
Source:
TableSchema.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TableSchema]
trait Serializable
class Object
trait Matchable
class Any
Self type