Class: Embulk::Output::Bigquery::BigqueryClient

Inherits:
GoogleClient
  • Object
show all
Defined in:
lib/embulk/output/bigquery/bigquery_client.rb

Constant Summary collapse

BIGQUERY_TABLE_OPERATION_INTERVAL =

cloud.google.com/bigquery/quotas

2

Instance Method Summary collapse

Methods inherited from GoogleClient

#client, #with_network_retry

Constructor Details

#initialize(task, schema, fields = nil) ⇒ BigqueryClient

Returns a new instance of BigqueryClient.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 13

def initialize(task, schema, fields = nil)
  scope = "https://www.googleapis.com/auth/bigquery"
  client_class = Google::Apis::BigqueryV2::BigqueryService
  super(task, scope, client_class)

  @schema = schema
  reset_fields(fields) if fields
  @project = @task['project']
  @destination_project = @task['destination_project']
  @dataset = @task['dataset']
  @location = @task['location']
  @location_for_log = @location.nil? ? 'Primary location' : @location

  @task['source_format'] ||= 'CSV'
  @task['max_bad_records'] ||= 0
  @task['field_delimiter'] ||= ','
  @task['source_format'] == 'CSV' ? @task['field_delimiter'] : nil
  @task['encoding'] ||= 'UTF-8'
  @task['ignore_unknown_values'] = false if @task['ignore_unknown_values'].nil?
  @task['allow_quoted_newlines'] = false if @task['allow_quoted_newlines'].nil?
end

Instance Method Details

#copy(source_table, destination_table, destination_dataset = nil, write_disposition: 'WRITE_TRUNCATE') ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 241

def copy(source_table, destination_table, destination_dataset = nil, write_disposition: 'WRITE_TRUNCATE')
  with_job_retry do
    begin
      destination_dataset ||= @dataset
      job_id = "embulk_copy_job_#{SecureRandom.uuid}"

      Embulk.logger.info {
        "embulk-output-bigquery: Copy job starting... job_id:[#{job_id}] " \
        "#{@destination_project}:#{@dataset}.#{source_table} => #{@destination_project}:#{destination_dataset}.#{destination_table}"
      }

      body = {
        job_reference: {
          project_id: @project,
          job_id: job_id,
        },
        configuration: {
          copy: {
            create_deposition: 'CREATE_IF_NEEDED',
            write_disposition: write_disposition,
            source_table: {
              project_id: @destination_project,
              dataset_id: @dataset,
              table_id: source_table,
            },
            destination_table: {
              project_id: @destination_project,
              dataset_id: destination_dataset,
              table_id: destination_table,
            },
          }
        }
      }

      if @location
        body[:job_reference][:location] = @location
      end

      opts = {}
      Embulk.logger.debug { "embulk-output-bigquery: insert_job(#{@project}, #{body}, #{opts})" }
      response = with_network_retry { client.insert_job(@project, body, **opts) }
      wait_load('Copy', response)
    rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
      response = {status_code: e.status_code, message: e.message, error_class: e.class}
      Embulk.logger.error {
        "embulk-output-bigquery: insert_job(#{@project}, #{body}, #{opts}), response:#{response}"
      }
      raise Error, "failed to copy #{@destination_project}:#{@dataset}.#{source_table} " \
        "to #{@destination_project}:#{destination_dataset}.#{destination_table}, response:#{response}"
    end
  end
end

#create_dataset(dataset = nil, reference: nil) ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 356

def create_dataset(dataset = nil, reference: nil)
  dataset ||= @dataset
  begin
    Embulk.logger.info { "embulk-output-bigquery: Create dataset... #{@destination_project}:#{dataset} in #{@location_for_log}" }
    hint = {}
    if reference
      response = get_dataset(reference)
      hint = { access: response.access }
    end
    body = {
      dataset_reference: {
        project_id: @project,
        dataset_id: dataset,
      },
    }.merge(hint)
    if @location
      body[:location] = @location
    end
    opts = {}
    Embulk.logger.debug { "embulk-output-bigquery: insert_dataset(#{@project}, #{dataset}, #{@location_for_log}, #{body}, #{opts})" }
    with_network_retry { client.insert_dataset(@project, body, **opts) }
  rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
    if e.status_code == 409 && /Already Exists:/ =~ e.message
      # ignore 'Already Exists' error
      return
    end

    response = {status_code: e.status_code, message: e.message, error_class: e.class}
    Embulk.logger.error {
      "embulk-output-bigquery: insert_dataset(#{@project}, #{body}, #{opts}), response:#{response}"
    }
    raise Error, "failed to create dataset #{@destination_project}:#{dataset} in #{@location_for_log}, response:#{response}"
  end
end

#create_table_if_not_exists(table, dataset: nil, options: nil) ⇒ Object 



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 409

def create_table_if_not_exists(table, dataset: nil, options: nil)
  begin
    dataset ||= @dataset
    options ||= {}
    options['time_partitioning'] ||= @task['time_partitioning']
    if Helper.has_partition_decorator?(table)
      options['time_partitioning'] ||= {'type' => 'DAY'}
      table = Helper.chomp_partition_decorator(table)
    end

    Embulk.logger.info { "embulk-output-bigquery: Create table... #{@destination_project}:#{dataset}.#{table}" }
    body = {
      table_reference: {
        table_id: table,
      },
      description: @task['description'],
      schema: {
        fields: fields,
      }
    }

    if options['time_partitioning']
      body[:time_partitioning] = {
        type: options['time_partitioning']['type'],
        expiration_ms: options['time_partitioning']['expiration_ms'],
        field: options['time_partitioning']['field'],
      }
    end

    options['clustering'] ||= @task['clustering']
    if options['clustering']
      body[:clustering] = {
        fields: options['clustering']['fields'],
      }
    end

    if options['expiration_time']
      # expiration_time is expressed in milliseconds
      body[:expiration_time] = (Time.now.to_i + options['expiration_time']) * 1000
    end

    opts = {}
    Embulk.logger.debug { "embulk-output-bigquery: insert_table(#{@destination_project}, #{dataset}, #{@location_for_log}, #{body}, #{opts})" }
    with_network_retry { client.insert_table(@destination_project, dataset, body, **opts) }
  rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
    if e.status_code == 409 && /Already Exists:/ =~ e.message
      # ignore 'Already Exists' error
      return
    end

    response = {status_code: e.status_code, message: e.message, error_class: e.class}
    Embulk.logger.error {
      "embulk-output-bigquery: insert_table(#{@destination_project}, #{dataset}, #{@location_for_log}, #{body}, #{opts}), response:#{response}"
    }
    raise Error, "failed to create table #{@destination_project}:#{dataset}.#{table} in #{@location_for_log}, response:#{response}"
  end
end

#delete_partition(table, dataset: nil) ⇒ Object 



472
473
474
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 472

def delete_partition(table, dataset: nil)
  delete_table_or_partition(table, dataset: dataset)
end

#delete_table(table, dataset: nil) ⇒ Object 



467
468
469
470
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 467

def delete_table(table, dataset: nil)
  table = Helper.chomp_partition_decorator(table)
  delete_table_or_partition(table, dataset: dataset)
end

#delete_table_or_partition(table, dataset: nil) ⇒ Object

if ‘table` with a partition decorator is given, a partition is deleted.



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 477

def delete_table_or_partition(table, dataset: nil)
  begin
    dataset ||= @dataset
    Embulk.logger.info { "embulk-output-bigquery: Delete table... #{@destination_project}:#{dataset}.#{table}" }
    with_network_retry { client.delete_table(@destination_project, dataset, table) }
  rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
    if e.status_code == 404 && /Not found:/ =~ e.message
      # ignore 'Not Found' error
      return
    end

    response = {status_code: e.status_code, message: e.message, error_class: e.class}
    Embulk.logger.error {
      "embulk-output-bigquery: delete_table(#{@destination_project}, #{dataset}, #{table}), response:#{response}"
    }
    raise Error, "failed to delete table #{@destination_project}:#{dataset}.#{table}, response:#{response}"
  end
end

#fields ⇒ Object 



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 35

def fields
  return @fields if @fields
  if @task['schema_file']
    @fields = Helper.deep_symbolize_keys(JSON.parse(File.read(@task['schema_file'])))
  elsif @task['template_table']
    @fields = fields_from_table(@task['template_table'])
  else
    @fields = Helper.fields_from_embulk_schema(@task, @schema)
  end
end

#fields_from_table(table) ⇒ Object 



46
47
48
49
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 46

def fields_from_table(table)
  response = get_table(table)
  response.schema.fields.map {|field| field.to_h }
end

#get_dataset(dataset = nil) ⇒ Object 



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 391

def get_dataset(dataset = nil)
  dataset ||= @dataset
  begin
    Embulk.logger.info { "embulk-output-bigquery: Get dataset... #{@destination_project}:#{dataset}" }
    with_network_retry { client.get_dataset(@destination_project, dataset) }
  rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
    if e.status_code == 404
      raise NotFoundError, "Dataset #{@destination_project}:#{dataset} is not found"
    end

    response = {status_code: e.status_code, message: e.message, error_class: e.class}
    Embulk.logger.error {
      "embulk-output-bigquery: get_dataset(#{@destination_project}, #{dataset}), response:#{response}"
    }
    raise Error, "failed to get dataset #{@destination_project}:#{dataset}, response:#{response}"
  end
end

#get_partition(table, dataset: nil) ⇒ Object 



501
502
503
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 501

def get_partition(table, dataset: nil)
  get_table_or_partition(table)
end

#get_table(table, dataset: nil) ⇒ Object 



496
497
498
499
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 496

def get_table(table, dataset: nil)
  table = Helper.chomp_partition_decorator(table)
  get_table_or_partition(table)
end

#get_table_or_partition(table, dataset: nil) ⇒ Object 



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 505

def get_table_or_partition(table, dataset: nil)
  begin
    dataset ||= @dataset
    Embulk.logger.info { "embulk-output-bigquery: Get table... #{@destination_project}:#{dataset}.#{table}" }
    with_network_retry { client.get_table(@destination_project, dataset, table) }
  rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
    if e.status_code == 404
      raise NotFoundError, "Table #{@destination_project}:#{dataset}.#{table} is not found"
    end

    response = {status_code: e.status_code, message: e.message, error_class: e.class}
    Embulk.logger.error {
      "embulk-output-bigquery: get_table(#{@destination_project}, #{dataset}, #{table}), response:#{response}"
    }
    raise Error, "failed to get table #{@destination_project}:#{dataset}.#{table}, response:#{response}"
  end
end

#load(path, table, write_disposition: 'WRITE_APPEND') ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 168

def load(path, table, write_disposition: 'WRITE_APPEND')
  with_job_retry do
    begin
      if File.exist?(path)
        # As https://cloud.google.com/bigquery/docs/managing_jobs_datasets_projects#managingjobs says,
        # we should generate job_id in client code, otherwise, retrying would cause duplication
        job_id = "embulk_load_job_#{SecureRandom.uuid}"
        Embulk.logger.info { "embulk-output-bigquery: Load job starting... job_id:[#{job_id}] #{path} => #{@destination_project}:#{@dataset}.#{table} in #{@location_for_log}" }
      else
        Embulk.logger.info { "embulk-output-bigquery: Load job starting... #{path} does not exist, skipped" }
        return
      end

      body = {
        job_reference: {
          project_id: @project,
          job_id: job_id,
        },
        configuration: {
          load: {
            destination_table: {
              project_id: @destination_project,
              dataset_id: @dataset,
              table_id: table,
            },
            schema: {
              fields: fields,
            },
            write_disposition:     write_disposition,
            source_format:         @task['source_format'],
            max_bad_records:       @task['max_bad_records'],
            field_delimiter:       @task['source_format'] == 'CSV' ? @task['field_delimiter'] : nil,
            encoding:              @task['encoding'],
            ignore_unknown_values: @task['ignore_unknown_values'],
            allow_quoted_newlines: @task['allow_quoted_newlines'],
          }
        }
      }

      if @location
        body[:job_reference][:location] = @location
      end

      if @task['schema_update_options']
        body[:configuration][:load][:schema_update_options] = @task['schema_update_options']
      end

      opts = {
        upload_source: path,
        content_type: "application/octet-stream",
        # options: {
        #   retries: @task['retries'],
        #   timeout_sec: @task['timeout_sec'],
        #   open_timeout_sec: @task['open_timeout_sec']
        # },
      }
      Embulk.logger.debug { "embulk-output-bigquery: insert_job(#{@project}, #{body}, #{opts})" }
      response = with_network_retry { client.insert_job(@project, body, **opts) }
      if @task['is_skip_job_result_check']
        response
      else
        response = wait_load('Load', response)
      end
    rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
      response = {status_code: e.status_code, message: e.message, error_class: e.class}
      Embulk.logger.error {
        "embulk-output-bigquery: insert_job(#{@project}, #{body}, #{opts}), response:#{response}"
      }
      raise Error, "failed to load #{path} to #{@destination_project}:#{@dataset}.#{table} in #{@location_for_log}, response:#{response}"
    end
  end
end

#load_from_gcs(object_uris, table) ⇒ Array

Returns responses.

Returns:

  • (Array) —

    responses



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 78

def load_from_gcs(object_uris, table)
  with_job_retry do
    begin
      # As https://cloud.google.com/bigquery/docs/managing_jobs_datasets_projects#managingjobs says,
      # we should generate job_id in client code, otherwise, retrying would cause duplication
      job_id = "embulk_load_job_#{SecureRandom.uuid}"
      Embulk.logger.info { "embulk-output-bigquery: Load job starting... job_id:[#{job_id}] #{object_uris} => #{@destination_project}:#{@dataset}.#{table} in #{@location_for_log}" }

      body = {
        job_reference: {
          project_id: @project,
          job_id: job_id,
        },
        configuration: {
          load: {
            destination_table: {
              project_id: @destination_project,
              dataset_id: @dataset,
              table_id: table,
            },
            schema: {
              fields: fields,
            },
            write_disposition: 'WRITE_APPEND',
            source_format:         @task['source_format'],
            max_bad_records:       @task['max_bad_records'],
            field_delimiter:       @task['source_format'] == 'CSV' ? @task['field_delimiter'] : nil,
            encoding:              @task['encoding'],
            ignore_unknown_values: @task['ignore_unknown_values'],
            allow_quoted_newlines: @task['allow_quoted_newlines'],
            source_uris: object_uris,
          }
        }
      }

      if @location
        body[:job_reference][:location] = @location
      end

      if @task['schema_update_options']
        body[:configuration][:load][:schema_update_options] = @task['schema_update_options']
      end

      opts = {}

      Embulk.logger.debug { "embulk-output-bigquery: insert_job(#{@project}, #{body}, #{opts})" }
      response = with_network_retry { client.insert_job(@project, body, **opts) }
      unless @task['is_skip_job_result_check']
        response = wait_load('Load', response)
      end
      [response]
    rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
      response = {status_code: e.status_code, message: e.message, error_class: e.class}
      Embulk.logger.error {
        "embulk-output-bigquery: insert_job(#{@project}, #{body}, #{opts}), response:#{response}"
      }
      raise Error, "failed to load #{object_uris} to #{@destination_project}:#{@dataset}.#{table} in #{@location_for_log}, response:#{response}"
    end
  end
end

#load_in_parallel(paths, table) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 139

def load_in_parallel(paths, table)
  return [] if paths.empty?
  # You may think as, load job is a background job, so sending requests in parallel
  # does not improve performance. However, with actual experiments, this parallel
  # loadings drastically shortened waiting time. It looks one jobs.insert takes about 50 sec.
  # NOTICE: parallel uploadings of files consumes network traffic. With 24 concurrencies
  # with 100MB files consumed about 500Mbps in the experimented environment at a peak.
  #
  # We before had a `max_load_parallels` option, but this was not extensible for map reduce executor
  # So, we dropped it. See https://github.com/embulk/embulk-output-bigquery/pull/35
  responses = []
  threads = []
  Embulk.logger.debug { "embulk-output-bigquery: LOAD IN PARALLEL #{paths}" }
  paths.each_with_index do |path, idx|
    threads << Thread.new(path, idx) do |path, idx|
      # I am not sure whether google-api-ruby-client is thread-safe,
      # so let me create new instances for each thread for safe
      bigquery = self.class.new(@task, @schema, fields)
      response = bigquery.load(path, table)
      [idx, response]
    end
  end
  ThreadsWait.all_waits(*threads) do |th|
    idx, response = th.value # raise errors occurred in threads
    responses[idx] = response
  end
  responses
end

#reset_fields(fields = nil) ⇒ Object 



51
52
53
54
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 51

def reset_fields(fields = nil)
  @fields = fields
  self.fields
end

#wait_load(kind, response) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 294

def wait_load(kind, response)
  started = Time.now

  wait_interval = @task['job_status_polling_interval']
  max_polling_time = @task['job_status_max_polling_time']
  _response = response

  while true
    job_id = _response.job_reference.job_id
    location = @location || _response.job_reference.location
    elapsed = Time.now - started
    status = _response.status.state
    if status == "DONE"
      Embulk.logger.info {
        "embulk-output-bigquery: #{kind} job completed... " \
        "job_id:[#{job_id}] elapsed_time:#{elapsed.to_f}sec status:[#{status}]"
      }
      break
    elsif elapsed.to_i > max_polling_time
      message = "embulk-output-bigquery: #{kind} job checking... " \
        "job_id:[#{job_id}] elapsed_time:#{elapsed.to_f}sec status:[TIMEOUT]"
      Embulk.logger.info { message }
      raise JobTimeoutError.new(message)
    else
      Embulk.logger.info {
        "embulk-output-bigquery: #{kind} job checking... " \
        "job_id:[#{job_id}] elapsed_time:#{elapsed.to_f}sec status:[#{status}]"
      }
      sleep wait_interval
      _response = with_network_retry { client.get_job(@project, job_id, location: location) }
    end
  end

  # `errors` returns Array<Google::Apis::BigqueryV2::ErrorProto> if any error exists.
  _errors = _response.status.errors

  # cf. http://www.rubydoc.info/github/google/google-api-ruby-client/Google/Apis/BigqueryV2/JobStatus#errors-instance_method
  # `error_result` returns Google::Apis::BigqueryV2::ErrorProto if job failed.
  # Otherwise, this returns nil.
  if _response.status.error_result
    msg = "failed during waiting a #{kind} job, get_job(#{@project}, #{job_id}), errors:#{_errors.map(&:to_h)}"
    if _errors.any? {|error| error.reason == 'backendError' }
      raise BackendError, msg
    elsif _errors.any? {|error| error.reason == 'internalError' }
      raise InternalError, msg
    elsif _errors.any? {|error| error.reason == 'rateLimitExceeded' }
      raise RateLimitExceeded, msg
    else
      Embulk.logger.error { "embulk-output-bigquery: #{msg}" }
      raise Error, msg
    end
  end

  if _errors
    Embulk.logger.warn { "embulk-output-bigquery: #{kind} job errors... job_id:[#{job_id}] errors:#{_errors.map(&:to_h)}" }
  end

  Embulk.logger.info { "embulk-output-bigquery: #{kind} job response... job_id:[#{job_id}] response.statistics:#{_response.statistics.to_h}" }

  _response
end

#with_job_retry(&block) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/embulk/output/bigquery/bigquery_client.rb', line 56

def with_job_retry(&block)
  retries = 0
  begin
    yield
  rescue BackendError, InternalError, RateLimitExceeded => e
    if e.is_a?(RateLimitExceeded)
      sleep(BIGQUERY_TABLE_OPERATION_INTERVAL)
    end

    if retries < @task['retries']
      retries += 1
      Embulk.logger.warn { "embulk-output-bigquery: retry \##{retries}, #{e.message}" }
      retry
    else
      Embulk.logger.error { "embulk-output-bigquery: retry exhausted \##{retries}, #{e.message}" }
      raise e
    end
  end
end