Class: TreasureData::Job

Inherits:
Model
  • Object
show all
Defined in:
lib/td/client/model.rb

Direct Known Subclasses

ScheduledJob

Constant Summary collapse

STATUS_QUEUED = 
"queued"
STATUS_BOOTING = 
"booting"
STATUS_RUNNING = 
"running"
STATUS_SUCCESS = 
"success"
STATUS_ERROR = 
"error"
STATUS_KILLED = 
"killed"
FINISHED_STATUS = 
[STATUS_SUCCESS, STATUS_ERROR, STATUS_KILLED]

Instance Attribute Summary collapse

Attributes inherited from Model

#client

Instance Method Summary collapse

Constructor Details

#initialize(client, job_id, type, query, status = nil, url = nil, debug = nil, start_at = nil, end_at = nil, cpu_time = nil, result_size = nil, result = nil, result_url = nil, hive_result_schema = nil, priority = nil, retry_limit = nil, org_name = nil, db_name = nil, duration = nil) ⇒ Job

Returns a new instance of Job.

Parameters:

  • client (TreasureData::Client)
  • job_id (String)
  • type (String)
  • query (String)
  • status (Fixnum) (defaults to: nil)
  • url (String) (defaults to: nil)
  • debug (Boolean) (defaults to: nil)
  • start_at (String) (defaults to: nil)
  • end_at (String) (defaults to: nil)
  • cpu_time (String) (defaults to: nil)
  • result_size (String) (defaults to: nil)
  • result (Array) (defaults to: nil)
  • result_url (String) (defaults to: nil)
  • hive_result_schema (Array) (defaults to: nil)
  • priority (Fixnum) (defaults to: nil)
  • retry_limit (Fixnum) (defaults to: nil)
  • org_name (String) (defaults to: nil)
  • db_name (String) (defaults to: nil)
  • duration (Fixnum) (defaults to: nil) 


405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/td/client/model.rb', line 405

def initialize(client, job_id, type, query, status=nil, url=nil, debug=nil, start_at=nil, end_at=nil, cpu_time=nil,
               result_size=nil, result=nil, result_url=nil, hive_result_schema=nil, priority=nil, retry_limit=nil,
               org_name=nil, db_name=nil, duration=nil)
  super(client)
  @job_id = job_id
  @type = type
  @url = url
  @query = query
  @status = status
  @debug = debug
  @start_at = start_at
  @end_at = end_at
  @cpu_time = cpu_time
  @result_size = result_size
  @result = result
  @result_url = result_url
  @hive_result_schema = hive_result_schema
  @priority = priority
  @retry_limit = retry_limit
  @db_name = db_name
  @duration = duration
end

Instance Attribute Details

#db_name ⇒ Object (readonly)

Returns the value of attribute db_name.



436
 
# File 'lib/td/client/model.rb', line 436

attr_reader :job_id, :type, :result_url

#duration ⇒ Object (readonly)

Returns the value of attribute duration.



436
 
# File 'lib/td/client/model.rb', line 436

attr_reader :job_id, :type, :result_url

#job_id ⇒ Object (readonly) 



436
437
438
 
# File 'lib/td/client/model.rb', line 436

def job_id
  @job_id
end

#org_name ⇒ Object (readonly)

Returns the value of attribute org_name.



436
 
# File 'lib/td/client/model.rb', line 436

attr_reader :job_id, :type, :result_url

#priority ⇒ Object (readonly)

Returns the value of attribute priority.



436
 
# File 'lib/td/client/model.rb', line 436

attr_reader :job_id, :type, :result_url

#result_url ⇒ Object (readonly)

Returns the value of attribute result_url.



436
 
# File 'lib/td/client/model.rb', line 436

attr_reader :job_id, :type, :result_url

#retry_limit ⇒ Object (readonly)

Returns the value of attribute retry_limit.



436
 
# File 'lib/td/client/model.rb', line 436

attr_reader :job_id, :type, :result_url

#type ⇒ Object (readonly) 



436
 
# File 'lib/td/client/model.rb', line 436

attr_reader :job_id, :type, :result_url

Instance Method Details

#cpu_time ⇒ String

Returns:

  • (String) 


504
505
506
507
 
# File 'lib/td/client/model.rb', line 504

def cpu_time
  update_status! unless @cpu_time || finished?
  @cpu_time
end

#debug ⇒ Boolean

Returns:

  • (Boolean) 


486
487
488
489
 
# File 'lib/td/client/model.rb', line 486

def debug
  update_status! unless @debug || finished?
  @debug
end

#end_at ⇒ Time?

Returns:

  • (Time, nil) 


498
499
500
501
 
# File 'lib/td/client/model.rb', line 498

def end_at
  update_status! unless @end_at || finished?
  @end_at && !@end_at.empty? ? Time.parse(@end_at) : nil
end

#error? ⇒ Boolean

Returns:

  • (Boolean) 


579
580
581
582
 
# File 'lib/td/client/model.rb', line 579

def error?
  update_progress! unless @status
  @status == STATUS_ERROR
end

#finished? ⇒ Boolean

Returns:

  • (Boolean) 


567
568
569
570
 
# File 'lib/td/client/model.rb', line 567

def finished?
  update_progress! unless @status
  FINISHED_STATUS.include?(@status)
end

#hive_result_schema ⇒ Array

Returns:

  • (Array) 


510
511
512
513
 
# File 'lib/td/client/model.rb', line 510

def hive_result_schema
  update_status! unless @hive_result_schema.instance_of? Array || finished?
  @hive_result_schema
end

#kill! ⇒ Object 



463
464
465
 
# File 'lib/td/client/model.rb', line 463

def kill!
  # TODO
end

#killed? ⇒ Boolean

Returns:

  • (Boolean) 


585
586
587
588
 
# File 'lib/td/client/model.rb', line 585

def killed?
  update_progress! unless @status
  @status == STATUS_KILLED
end

#query ⇒ String

Returns:

  • (String) 


468
469
470
471
 
# File 'lib/td/client/model.rb', line 468

def query
  update_status! unless @query || finished?
  @query
end

#queued? ⇒ Boolean

Returns:

  • (Boolean) 


591
592
593
594
 
# File 'lib/td/client/model.rb', line 591

def queued?
  update_progress! unless @status
  @status == STATUS_QUEUED
end

#result ⇒ Array

Returns:

  • (Array) 


522
523
524
525
526
527
528
 
# File 'lib/td/client/model.rb', line 522

def result
  unless @result
    return nil unless finished?
    @result = @client.job_result(@job_id)
  end
  @result
end

#result_each {|result| ... } ⇒ nil

Yields:

Returns:

  • (nil) 


557
558
559
560
561
562
563
564
 
# File 'lib/td/client/model.rb', line 557

def result_each(&block)
  if @result
    @result.each(&block)
  else
    @client.job_result_each(@job_id, &block)
  end
  nil
end

#result_each_with_compr_size {|result| ... } ⇒ nil

Yields:

Returns:

  • (nil) 


546
547
548
549
550
551
552
553
 
# File 'lib/td/client/model.rb', line 546

def result_each_with_compr_size(&block)
  if @result
    @result.each(&block)
  else
    @client.job_result_each_with_compr_size(@job_id, &block)
  end
  nil
end

#result_format(format, io = nil, &block) ⇒ nil, String

Parameters:

  • format (String)
  • io (IO) (defaults to: nil)
  • block (Proc)

Returns:

  • (nil, String) 


534
535
536
537
 
# File 'lib/td/client/model.rb', line 534

def result_format(format, io=nil, &block)
  return nil unless finished?
  @client.job_result_format(@job_id, format, io, &block)
end

#result_raw(format, io = nil, &block) ⇒ Object 



539
540
541
542
 
# File 'lib/td/client/model.rb', line 539

def result_raw(format, io=nil, &block)
  return nil unless finished?
  @client.job_result_raw(@job_id, format, io, &block)
end

#result_size ⇒ String

Returns:

  • (String) 


516
517
518
519
 
# File 'lib/td/client/model.rb', line 516

def result_size
  update_status! unless @result_size || finished?
  @result_size
end

#running? ⇒ Boolean

Returns:

  • (Boolean) 


597
598
599
600
 
# File 'lib/td/client/model.rb', line 597

def running?
  update_progress! unless @status
  @status == STATUS_RUNNING
end

#start_at ⇒ Time?

Returns:

  • (Time, nil) 


492
493
494
495
 
# File 'lib/td/client/model.rb', line 492

def start_at
  update_status! unless @start_at || finished?
  @start_at && !@start_at.empty? ? Time.parse(@start_at) : nil
end

#status ⇒ String

Returns:

  • (String) 


474
475
476
477
 
# File 'lib/td/client/model.rb', line 474

def status
  update_status! unless @status || finished?
  @status
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


573
574
575
576
 
# File 'lib/td/client/model.rb', line 573

def success?
  update_progress! unless @status
  @status == STATUS_SUCCESS
end

#update_progress! ⇒ Object 



602
603
604
 
# File 'lib/td/client/model.rb', line 602

def update_progress!
  @status = @client.job_status(@job_id)
end

#update_status! ⇒ Object 



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/td/client/model.rb', line 606

def update_status!
  type, query, status, url, debug, start_at, end_at, cpu_time,
    result_size, result_url, hive_result_schema, priority, retry_limit,
    org_name, db_name = @client.api.show_job(@job_id)
  @query = query
  @status = status
  @url = url
  @debug = debug
  @start_at = start_at
  @end_at = end_at
  @cpu_time = cpu_time
  @result_size = result_size
  @result_url = result_url
  @hive_result_schema = hive_result_schema
  @priority = priority
  @retry_limit = retry_limit
  @db_name = db_name
  self
end

#url ⇒ String

Returns:

  • (String) 


480
481
482
483
 
# File 'lib/td/client/model.rb', line 480

def url
  update_status! unless @url || finished?
  @url
end

#wait(timeout = nil, wait_interval = 2, detail: false, verbose: ) ⇒ Object

Parameters:

  • detail (Boolean) (defaults to: false) —

    update job detail or not

  • verbose (Boolean) (defaults to: ) —

    out retry log to stderr or not

  • timeout (Hash) (defaults to: nil) —

    a customizable set of options

  • wait_interval (Hash) (defaults to: 2) —

    a customizable set of options

Options Hash (timeout):

  • timeout (Integer, nil) —

    in second

Options Hash (wait_interval):

  • interval (Integer, nil) —

    in second of polling the job status



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/td/client/model.rb', line 444

def wait(timeout=nil, wait_interval=2, detail: false, verbose: ENV['TD_CLIENT_DEBUG'])
  deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + timeout if timeout
  timeout_klass = Class.new(Exception)
  begin
    if timeout
      if deadline <= Process.clock_gettime(Process::CLOCK_MONOTONIC)
        raise timeout_klass, "timeout (#{timeout}) exceeded wait_interval=#{wait_interval}"
      end
    end
    sleep wait_interval
    yield self if block_given?
      detail ? update_status! : update_progress!
  rescue timeout_klass
    raise Timeout::Error, $!.message
  rescue Timeout::Error, SystemCallError, EOFError, SocketError, HTTPClient::ConnectTimeoutError
    $stderr.puts "ignore network error (#{$!}); retry..." if verbose
  end until finished?
end