Class: Google::Cloud::Bigquery::Table::Updater

Inherits:
Google::Cloud::Bigquery::Table show all
Defined in:
lib/google/cloud/bigquery/table.rb

Overview

Yielded to a block to accumulate changes for a patch request.

Lifecycle collapse

Lifecycle collapse

Schema collapse

Methods inherited from Google::Cloud::Bigquery::Table

#api_url, #bytes_count, #copy, #created_at, #data, #dataset_id, #delete, #description, #description=, #etag, #expires_at, #extract, #fields, #headers, #id, #insert, #load, #location, #modified_at, #name, #name=, #project_id, #query_id, #reload!, #rows_count, #table?, #table_id, #view?

Constructor Details

#initialize(gapi) ⇒ Updater

Create an Updater object.



863
864
865
866
867
 
# File 'lib/google/cloud/bigquery/table.rb', line 863

def initialize gapi
  @updates = []
  @gapi = gapi
  @schema = nil
end

Instance Attribute Details

#updates ⇒ Object (readonly)

A list of attributes that were updated.



859
860
861
 
# File 'lib/google/cloud/bigquery/table.rb', line 859

def updates
  @updates
end

Instance Method Details

#boolean(name, description: nil, mode: :nullable) ⇒ Object

Adds a boolean field to the schema.

See Schema#boolean.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.boolean "active", mode: :required
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.



1024
1025
1026
 
# File 'lib/google/cloud/bigquery/table.rb', line 1024

def boolean name, description: nil, mode: :nullable
  schema.boolean name, description: description, mode: mode
end

#bytes(name, description: nil, mode: :nullable) ⇒ Object

Adds a bytes field to the schema.

See Schema#bytes.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.bytes "avatar", mode: :required
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.



1052
1053
1054
 
# File 'lib/google/cloud/bigquery/table.rb', line 1052

def bytes name, description: nil, mode: :nullable
  schema.bytes name, description: description, mode: mode
end

#check_for_mutated_schema! ⇒ Object

Make sure any access changes are saved



1208
1209
1210
1211
1212
1213
 
# File 'lib/google/cloud/bigquery/table.rb', line 1208

def check_for_mutated_schema!
  return if @schema.nil?
  return unless @schema.changed?
  @gapi.schema = @schema.to_gapi
  patch_gapi! :schema
end

#date(name, description: nil, mode: :nullable) ⇒ Object

Adds a date field to the schema.

See Schema#date.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.date "birthday", mode: :required
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.



1164
1165
1166
 
# File 'lib/google/cloud/bigquery/table.rb', line 1164

def date name, description: nil, mode: :nullable
  schema.date name, description: description, mode: mode
end

#datetime(name, description: nil, mode: :nullable) ⇒ Object

Adds a datetime field to the schema.

See Schema#datetime.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.datetime "target_end", mode: :required
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.



1136
1137
1138
 
# File 'lib/google/cloud/bigquery/table.rb', line 1136

def datetime name, description: nil, mode: :nullable
  schema.datetime name, description: description, mode: mode
end

#float(name, description: nil, mode: :nullable) ⇒ Object

Adds a floating-point number field to the schema.

See Schema#float.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.float "price", mode: :required
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.



996
997
998
 
# File 'lib/google/cloud/bigquery/table.rb', line 996

def float name, description: nil, mode: :nullable
  schema.float name, description: description, mode: mode
end

#integer(name, description: nil, mode: :nullable) ⇒ Object

Adds an integer field to the schema.

See Schema#integer.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.integer "age", mode: :required
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.



968
969
970
 
# File 'lib/google/cloud/bigquery/table.rb', line 968

def integer name, description: nil, mode: :nullable
  schema.integer name, description: description, mode: mode
end

#record(name, description: nil, mode: nil) {|nested_schema| ... } ⇒ Object

Adds a record field to the schema. A block must be passed describing the nested fields of the record. For more information about nested and repeated records, see Preparing Data for BigQuery .

See Schema#record.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.record "cities_lived", mode: :repeated do |cities_lived|
    cities_lived.string "place", mode: :required
    cities_lived.integer "number_of_years", mode: :required
  end
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.

Yields:

  • (nested_schema) —

    a block for setting the nested schema

Yield Parameters:

  • nested_schema (Schema) —

    the object accepting the nested schema



1202
1203
1204
 
# File 'lib/google/cloud/bigquery/table.rb', line 1202

def record name, description: nil, mode: nil, &block
  schema.record name, description: description, mode: mode, &block
end

#schema(replace: false) {|schema| ... } ⇒ Google::Cloud::Bigquery::Schema

Returns the table's schema. This method can also be used to set, replace, or add to the schema by passing a block. See Schema for available methods.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |t|
  t.name = "My Table",
  t.description = "A description of my table."
  t.schema do |s|
    s.string "first_name", mode: :required
    s.record "cities_lived", mode: :repeated do |r|
      r.string "place", mode: :required
      r.integer "number_of_years", mode: :required
    end
  end
end

Parameters:

  • replace (Boolean) —

    Whether to replace the existing schema with the new schema. If true, the fields will replace the existing schema. If false, the fields will be added to the existing schema. When a table already contains data, schema changes must be additive. Thus, the default value is false.

Yields:

  • (schema) —

    a block for setting the schema

Yield Parameters:

  • schema (Schema) —

    the object accepting the schema

Returns:



903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/google/cloud/bigquery/table.rb', line 903

def schema replace: false
  # Same as Table#schema, but not frozen
  # TODO: make sure to call ensure_full_data! on Dataset#update
  @schema ||= Schema.from_gapi @gapi.schema
  if block_given?
    @schema = Schema.from_gapi if replace
    yield @schema
    check_for_mutated_schema!
  end
  # Do not freeze on updater, allow modifications
  @schema
end

#string(name, description: nil, mode: :nullable) ⇒ Object

Adds a string field to the schema.

See Schema#string.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.string "first_name", mode: :required
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.



940
941
942
 
# File 'lib/google/cloud/bigquery/table.rb', line 940

def string name, description: nil, mode: :nullable
  schema.string name, description: description, mode: mode
end

#time(name, description: nil, mode: :nullable) ⇒ Object

Adds a time field to the schema.

See Schema#time.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.time "duration", mode: :required
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.



1108
1109
1110
 
# File 'lib/google/cloud/bigquery/table.rb', line 1108

def time name, description: nil, mode: :nullable
  schema.time name, description: description, mode: mode
end

#timestamp(name, description: nil, mode: :nullable) ⇒ Object

Adds a timestamp field to the schema.

See Schema#timestamp.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
table = dataset.create_table "my_table" do |schema|
  schema.timestamp "creation_date", mode: :required
end

Parameters:

  • name (String) —

    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.

  • description (String) —

    A description of the field.

  • mode (Symbol) —

    The field's mode. The possible values are :nullable, :required, and :repeated. The default value is :nullable.



1080
1081
1082
 
# File 'lib/google/cloud/bigquery/table.rb', line 1080

def timestamp name, description: nil, mode: :nullable
  schema.timestamp name, description: description, mode: mode
end

#to_gapi ⇒ Object 



1215
1216
1217
1218
 
# File 'lib/google/cloud/bigquery/table.rb', line 1215

def to_gapi
  check_for_mutated_schema!
  @gapi
end