Class: Google::Cloud::Bigquery::StandardSql::Field

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigquery/standard_sql.rb

Overview

A field or a column. See Routine and Argument.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
routine = dataset.create_routine "my_routine" do |r|
  r.routine_type = "SCALAR_FUNCTION"
  r.language = :SQL
  r.body = "(SELECT SUM(IF(elem.name = \"foo\",elem.val,null)) FROM UNNEST(arr) AS elem)"
  r.arguments = [
    Google::Cloud::Bigquery::Argument.new(
      name: "arr",
      argument_kind: "FIXED_TYPE",
      data_type: Google::Cloud::Bigquery::StandardSql::DataType.new(
        type_kind: "ARRAY",
        array_element_type: Google::Cloud::Bigquery::StandardSql::DataType.new(
          type_kind: "STRUCT",
          struct_type: Google::Cloud::Bigquery::StandardSql::StructType.new(
            fields: [
              Google::Cloud::Bigquery::StandardSql::Field.new(
                name: "name",
                type: Google::Cloud::Bigquery::StandardSql::DataType.new(type_kind: "STRING")
              ),
              Google::Cloud::Bigquery::StandardSql::Field.new(
                name: "val",
                type: Google::Cloud::Bigquery::StandardSql::DataType.new(type_kind: "INT64")
              )
            ]
          )
        )
      )
    )
  ]
end

Instance Method Summary collapse

Constructor Details

#initialize(name, type) ⇒ Field

Creates a new, immutable StandardSql::Field object.

Parameters:

  • name (String) —

    The name of the field. Optional. Can be absent for struct fields.

  • type (StandardSql::DataType, String) —

    The type of the field. Optional. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).



107
108
109
110
111
 
# File 'lib/google/cloud/bigquery/standard_sql.rb', line 107

def initialize **kwargs
  # Convert client object kwargs to a gapi object
  kwargs[:type] = DataType.gapi_from_string_or_data_type kwargs[:type] if kwargs[:type]
  @gapi = Google::Apis::BigqueryV2::StandardSqlField.new(**kwargs)
end

Instance Method Details

#name ⇒ String?

The name of the field. Optional. Can be absent for struct fields.

Returns:

  • (String, nil) 


118
119
120
121
 
# File 'lib/google/cloud/bigquery/standard_sql.rb', line 118

def name
  return if @gapi.name == "".freeze
  @gapi.name
end

#type ⇒ DataType?

The type of the field. Optional. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).

Returns:

  • (DataType, nil) —

    The type of the field.



129
130
131
 
# File 'lib/google/cloud/bigquery/standard_sql.rb', line 129

def type
  DataType.from_gapi @gapi.type if @gapi.type
end