Class: TreasureData::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/td/client.rb,
lib/td/client/version.rb

Constant Summary collapse

VERSION = 
'3.0.0'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(apikey, opts = {}) ⇒ Client 



27
28
29
 
# File 'lib/td/client.rb', line 27

def initialize(apikey, opts={})
  @api = API.new(apikey, opts)
end

Instance Attribute Details

#api ⇒ Object (readonly)

Returns the value of attribute api.



32
33
34
 
# File 'lib/td/client.rb', line 32

def api
  @api
end

Class Method Details

.authenticate(user, password, opts = {}) ⇒ Client 



12
13
14
15
16
 
# File 'lib/td/client.rb', line 12

def self.authenticate(user, password, opts={})
  api = API.new(nil, opts)
  apikey = api.authenticate(user, password)
  new(apikey)
end

.server_status(opts = {}) ⇒ String 



20
21
22
23
 
# File 'lib/td/client.rb', line 20

def self.server_status(opts={})
  api = API.new(nil, opts)
  api.server_status
end

Instance Method Details

#account ⇒ Account 



58
59
60
61
 
# File 'lib/td/client.rb', line 58

def 
  , plan, storage, guaranteed_cores, maximum_cores, created_at = @api.
  return .new(self, , plan, storage, guaranteed_cores, maximum_cores, created_at)
end

#add_apikey(user) ⇒ true 



501
502
503
 
# File 'lib/td/client.rb', line 501

def add_apikey(user)
  @api.add_apikey(user)
end

#add_user(name, org, email, password) ⇒ true 



476
477
478
 
# File 'lib/td/client.rb', line 476

def add_user(name, org, email, password)
  @api.add_user(name, org, email, password)
end

#apikey ⇒ String 



35
36
37
 
# File 'lib/td/client.rb', line 35

def apikey
  @api.apikey
end

#bulk_import(name) ⇒ BulkImport 



330
331
332
333
 
# File 'lib/td/client.rb', line 330

def bulk_import(name)
  data = @api.show_bulk_import(name)
  BulkImport.new(self, data)
end

#bulk_import_delete_part(name, part_name) ⇒ nil 



354
355
356
 
# File 'lib/td/client.rb', line 354

def bulk_import_delete_part(name, part_name)
  @api.bulk_import_delete_part(name, part_name)
end

#bulk_import_error_records(name, &block) ⇒ Hash 



324
325
326
 
# File 'lib/td/client.rb', line 324

def bulk_import_error_records(name, &block)
  @api.bulk_import_error_records(name, &block)
end

#bulk_import_upload_part(name, part_name, stream, size) ⇒ nil 



347
348
349
 
# File 'lib/td/client.rb', line 347

def bulk_import_upload_part(name, part_name, stream, size)
  @api.bulk_import_upload_part(name, part_name, stream, size)
end

#bulk_imports ⇒ Array<BulkImport> 



336
337
338
339
340
 
# File 'lib/td/client.rb', line 336

def bulk_imports
  @api.list_bulk_imports.map {|data|
    BulkImport.new(self, data)
  }
end

#bulk_load_create(name, database, table, job, opts = {}) ⇒ Object

name: String, database: String, table: String, job: BulkLoad -> BulkLoad



547
548
549
 
# File 'lib/td/client.rb', line 547

def bulk_load_create(name, database, table, job, opts = {})
  @api.bulk_load_create(name, database, table, job, opts)
end

#bulk_load_delete(name) ⇒ Object

name: String -> BulkLoad



562
563
564
 
# File 'lib/td/client.rb', line 562

def bulk_load_delete(name)
  @api.bulk_load_delete(name)
end

#bulk_load_guess(job) ⇒ Object

> BulkLoad::Job



527
528
529
 
# File 'lib/td/client.rb', line 527

def bulk_load_guess(job)
  @api.bulk_load_guess(job)
end

#bulk_load_history(name) ⇒ Object

name: String -> [Job]



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

def bulk_load_history(name)
  @api.bulk_load_history(name)
end

#bulk_load_issue(database, table, job) ⇒ Object

> String



537
538
539
 
# File 'lib/td/client.rb', line 537

def bulk_load_issue(database, table, job)
  @api.bulk_load_issue(database, table, job)
end

#bulk_load_list ⇒ Object

nil -> [BulkLoad]



542
543
544
 
# File 'lib/td/client.rb', line 542

def bulk_load_list
  @api.bulk_load_list
end

#bulk_load_preview(job) ⇒ Object

> BulkLoad::Job



532
533
534
 
# File 'lib/td/client.rb', line 532

def bulk_load_preview(job)
  @api.bulk_load_preview(job)
end

#bulk_load_run(name, scheduled_time = nil) ⇒ Object 



571
572
573
 
# File 'lib/td/client.rb', line 571

def bulk_load_run(name, scheduled_time = nil)
  @api.bulk_load_run(name, scheduled_time)
end

#bulk_load_show(name) ⇒ Object

name: String -> BulkLoad



552
553
554
 
# File 'lib/td/client.rb', line 552

def bulk_load_show(name)
  @api.bulk_load_show(name)
end

#bulk_load_update(name, settings) ⇒ Object

name: String, settings: Hash -> BulkLoad



557
558
559
 
# File 'lib/td/client.rb', line 557

def bulk_load_update(name, settings)
  @api.bulk_load_update(name, settings)
end

#change_database(db_name, table_name, new_db_name) ⇒ true 



172
173
174
 
# File 'lib/td/client.rb', line 172

def change_database(db_name, table_name, new_db_name)
  @api.change_database(db_name, table_name, new_db_name)
end

#change_email(user, email) ⇒ true 



489
490
491
 
# File 'lib/td/client.rb', line 489

def change_email(user, email)
  @api.change_email(user, email)
end

#change_my_password(old_password, password) ⇒ true 



522
523
524
 
# File 'lib/td/client.rb', line 522

def change_my_password(old_password, password)
  @api.change_my_password(old_password, password)
end

#change_password(user, password) ⇒ true 



515
516
517
 
# File 'lib/td/client.rb', line 515

def change_password(user, password)
  @api.change_password(user, password)
end

#commit_bulk_import(name) ⇒ nil 



317
318
319
 
# File 'lib/td/client.rb', line 317

def commit_bulk_import(name)
  @api.commit_bulk_import(name)
end

#create_bulk_import(name, database, table, opts = {}) ⇒ nil 



285
286
287
 
# File 'lib/td/client.rb', line 285

def create_bulk_import(name, database, table, opts={})
  @api.create_bulk_import(name, database, table, opts)
end

#create_database(db_name, opts = {}) ⇒ true 



47
48
49
 
# File 'lib/td/client.rb', line 47

def create_database(db_name, opts={})
  @api.create_database(db_name, opts)
end

#create_log_table(db_name, table_name, params = {}) ⇒ true

Options Hash (params):

  • :expire_days (Fixnum) —

    days to expire table

  • :include_v (Boolean) — default: true —

    include v column on Hive

  • :detect_schema (Boolean) — default: true —

    detect schema on import



89
90
91
 
# File 'lib/td/client.rb', line 89

def create_log_table(db_name, table_name, params={})
  @api.create_log_table(db_name, table_name, params)
end

#create_result(name, url, opts = {}) ⇒ true 



453
454
455
 
# File 'lib/td/client.rb', line 453

def create_result(name, url, opts={})
  @api.create_result(name, url, opts)
end

#create_schedule(name, opts) ⇒ Time

Raises:

  • (ArgumentError) 


367
368
369
370
371
372
 
# File 'lib/td/client.rb', line 367

def create_schedule(name, opts)
  raise ArgumentError, "'cron' option is required" unless opts[:cron] || opts['cron']
  raise ArgumentError, "'query' option is required" unless opts[:query] || opts['query']
  start = @api.create_schedule(name, opts)
  return start && Time.parse(start)
end

#database(db_name) ⇒ Database

Raises:



73
74
75
76
77
78
79
80
81
 
# File 'lib/td/client.rb', line 73

def database(db_name)
  m = @api.list_databases
  m.each {|name,(count, created_at, updated_at, org, permission)|
    if name == db_name
      return Database.new(self, name, nil, count, created_at, updated_at, org, permission)
    end
  }
  raise NotFoundError, "Database '#{db_name}' does not exist"
end

#databases ⇒ Array 



64
65
66
67
68
69
 
# File 'lib/td/client.rb', line 64

def databases
  m = @api.list_databases
  m.map {|db_name,(count, created_at, updated_at, org, permission)|
    Database.new(self, db_name, nil, count, created_at, updated_at, org, permission)
  }
end

#delete_bulk_import(name) ⇒ nil 



291
292
293
 
# File 'lib/td/client.rb', line 291

def delete_bulk_import(name)
  @api.delete_bulk_import(name)
end

#delete_database(db_name) ⇒ Symbol 



53
54
55
 
# File 'lib/td/client.rb', line 53

def delete_database(db_name)
  @api.delete_database(db_name)
end

#delete_result(name) ⇒ true 



459
460
461
 
# File 'lib/td/client.rb', line 459

def delete_result(name)
  @api.delete_result(name)
end

#delete_schedule(name) ⇒ Array 



376
377
378
 
# File 'lib/td/client.rb', line 376

def delete_schedule(name)
  @api.delete_schedule(name)
end

#delete_table(db_name, table_name) ⇒ Symbol 



132
133
134
 
# File 'lib/td/client.rb', line 132

def delete_table(db_name, table_name)
  @api.delete_table(db_name, table_name)
end

#export(db_name, table_name, storage_type, opts = {}) ⇒ Job 



267
268
269
270
 
# File 'lib/td/client.rb', line 267

def export(db_name, table_name, storage_type, opts={})
  job_id = @api.export(db_name, table_name, storage_type, opts)
  Job.new(self, job_id, :export, nil)
end

#freeze_bulk_import(name) ⇒ nil 



297
298
299
 
# File 'lib/td/client.rb', line 297

def freeze_bulk_import(name)
  @api.freeze_bulk_import(name)
end

#history(name, from = nil, to = nil) ⇒ Array<ScheduledJob> 



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/td/client.rb', line 400

def history(name, from=nil, to=nil)
  result = @api.history(name, from, to)
  result.map {|scheduled_at,job_id,type,status,query,start_at,end_at,result_url,priority,database|
    job_param = [job_id, type, query, status,
      nil, nil, # url, debug
      start_at, end_at,
      nil, # cpu_time
      nil, nil, # result_size, result
      result_url,
      nil, # hive_result_schema
      priority,
      nil, # retry_limit
      nil, # TODO org_name
      database]
    ScheduledJob.new(self, scheduled_at, *job_param)
  }
end

#import(db_name, table_name, format, stream, size, unique_id = nil) ⇒ Float 



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

def import(db_name, table_name, format, stream, size, unique_id=nil)
  @api.import(db_name, table_name, format, stream, size, unique_id)
end

#job(job_id) ⇒ Job 



209
210
211
212
213
214
215
 
# File 'lib/td/client.rb', line 209

def job(job_id)
  job_id = job_id.to_s
  type, query, status, url, debug, start_at, end_at, cpu_time,
    result_size, result_url, hive_result_schema, priority, retry_limit, org, db, duration, num_records = @api.show_job(job_id)
  Job.new(self, job_id, type, query, status, url, debug, start_at, end_at, cpu_time,
          result_size, nil, result_url, hive_result_schema, priority, retry_limit, org, db, duration, num_records)
end

#job_result(job_id) ⇒ Object 



225
226
227
 
# File 'lib/td/client.rb', line 225

def job_result(job_id)
  @api.job_result(job_id)
end

#job_result_each(job_id, &block) ⇒ nil 



245
246
247
 
# File 'lib/td/client.rb', line 245

def job_result_each(job_id, &block)
  @api.job_result_each(job_id, &block)
end

#job_result_each_with_compr_size(job_id, &block) ⇒ nil 



252
253
254
 
# File 'lib/td/client.rb', line 252

def job_result_each_with_compr_size(job_id, &block)
  @api.job_result_each_with_compr_size(job_id, &block)
end

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



234
235
236
 
# File 'lib/td/client.rb', line 234

def job_result_format(job_id, format, io=nil, &block)
  @api.job_result_format(job_id, format, io, &block)
end

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



238
239
240
 
# File 'lib/td/client.rb', line 238

def job_result_raw(job_id, format, io=nil, &block)
  @api.job_result_raw(job_id, format, io, &block)
end

#job_status(job_id) ⇒ String 



219
220
221
 
# File 'lib/td/client.rb', line 219

def job_status(job_id)
  return @api.job_status(job_id)
end

#jobs(from = nil, to = nil, status = nil, conditions = nil) ⇒ Job 



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/td/client.rb', line 196

def jobs(from=nil, to=nil, status=nil, conditions=nil)
  results = @api.list_jobs(from, to, status, conditions)
  results.map {|job_id, type, status, query, start_at, end_at, cpu_time,
               result_size, result_url, priority, retry_limit, org, db,
               duration, num_records|
    Job.new(self, job_id, type, query, status, nil, nil, start_at, end_at, cpu_time,
            result_size, nil, result_url, nil, priority, retry_limit, org, db,
            duration, num_records)
  }
end

#kill(job_id) ⇒ String 



258
259
260
 
# File 'lib/td/client.rb', line 258

def kill(job_id)
  @api.kill(job_id)
end

#list_apikeys(user) ⇒ Array<String> 



495
496
497
 
# File 'lib/td/client.rb', line 495

def list_apikeys(user)
  @api.list_apikeys(user)
end

#list_bulk_import_parts(name) ⇒ Array 



360
361
362
 
# File 'lib/td/client.rb', line 360

def list_bulk_import_parts(name)
  @api.list_bulk_import_parts(name)
end

#perform_bulk_import(name, opts = {}) ⇒ Job 



310
311
312
313
 
# File 'lib/td/client.rb', line 310

def perform_bulk_import(name, opts={})
  job_id = @api.perform_bulk_import(name, opts)
  Job.new(self, job_id, :bulk_import, nil)
end

#query(db_name, q, result_url = nil, priority = nil, retry_limit = nil, opts = {}) ⇒ Job

Raises:

  • (ArgumentError) 


183
184
185
186
187
188
189
 
# File 'lib/td/client.rb', line 183

def query(db_name, q, result_url=nil, priority=nil, retry_limit=nil, opts={})
  # for compatibility, assume type is hive unless specifically specified
  type = opts[:type] || opts['type'] || :hive
  raise ArgumentError, "The specified query type is not supported: #{type}" unless [:hive, :pig, :impala, :presto, :trino].include?(type)
  job_id = @api.query(q, type, db_name, result_url, priority, retry_limit, opts)
  Job.new(self, job_id, type, q)
end

#remove_apikey(user, apikey) ⇒ true 



508
509
510
 
# File 'lib/td/client.rb', line 508

def remove_apikey(user, apikey)
  @api.remove_apikey(user, apikey)
end

#remove_user(user) ⇒ true 



482
483
484
 
# File 'lib/td/client.rb', line 482

def remove_user(user)
  @api.remove_user(user)
end

#result_export(target_job_id, opts = {}) ⇒ Job 



275
276
277
278
 
# File 'lib/td/client.rb', line 275

def result_export(target_job_id, opts={})
  job_id = @api.result_export(target_job_id, opts)
  Job.new(self, job_id, :result_export, nil)
end

#results ⇒ Array<Result> 



441
442
443
444
445
446
447
 
# File 'lib/td/client.rb', line 441

def results
  results = @api.list_result
  rs = results.map {|name,url,organizations|
    Result.new(self, name, url, organizations)
  }
  return rs
end

#run_schedule(name, time, num) ⇒ Array<ScheduledJob> 



422
423
424
425
426
427
 
# File 'lib/td/client.rb', line 422

def run_schedule(name, time, num)
  results = @api.run_schedule(name, time, num)
  results.map {|job_id,type,scheduled_at|
    ScheduledJob.new(self, scheduled_at, job_id, type, nil)
  }
end

#schedules ⇒ Array<Schedule> 



381
382
383
384
385
386
 
# File 'lib/td/client.rb', line 381

def schedules
  result = @api.list_schedules
  result.map {|name,cron,query,database,result_url,timezone,delay,next_time,priority,retry_limit,org_name|
    Schedule.new(self, name, cron, query, database, result_url, timezone, delay, next_time, priority, retry_limit, org_name)
  }
end

#server_status ⇒ String 



40
41
42
 
# File 'lib/td/client.rb', line 40

def server_status
  @api.server_status
end

#swap_table(db_name, table_name1, table_name2) ⇒ true

Swap table names



99
100
101
 
# File 'lib/td/client.rb', line 99

def swap_table(db_name, table_name1, table_name2)
  @api.swap_table(db_name, table_name1, table_name2)
end

#table(db_name, table_name) ⇒ Table

Raises:



150
151
152
153
154
155
156
157
 
# File 'lib/td/client.rb', line 150

def table(db_name, table_name)
  tables(db_name).each {|t|
    if t.name == table_name
      return t
    end
  }
  raise NotFoundError, "Table '#{db_name}.#{table_name}' does not exist"
end

#tables(db_name) ⇒ Array 



138
139
140
141
142
143
144
145
 
# File 'lib/td/client.rb', line 138

def tables(db_name)
  m = @api.list_tables(db_name)
  m.map {|table_name, (type, schema, count, created_at, updated_at, estimated_storage_size, last_import, last_log_timestamp, expire_days, include_v)|
    schema = Schema.new.from_json(schema)
    Table.new(self, db_name, table_name, type, schema, count, created_at, updated_at,
      estimated_storage_size, last_import, last_log_timestamp, expire_days, include_v)
  }
end

#tail(db_name, table_name, count, to = nil, from = nil, &block) ⇒ Array? 



164
165
166
 
# File 'lib/td/client.rb', line 164

def tail(db_name, table_name, count, to = nil, from = nil, &block)
  @api.tail(db_name, table_name, count, to, from, &block)
end

#unfreeze_bulk_import(name) ⇒ nil 



303
304
305
 
# File 'lib/td/client.rb', line 303

def unfreeze_bulk_import(name)
  @api.unfreeze_bulk_import(name)
end

#update_expire(db_name, table_name, expire_days) ⇒ true 



125
126
127
 
# File 'lib/td/client.rb', line 125

def update_expire(db_name, table_name, expire_days)
  @api.update_expire(db_name, table_name, expire_days)
end

#update_schedule(name, params) ⇒ nil 



391
392
393
394
 
# File 'lib/td/client.rb', line 391

def update_schedule(name, params)
  @api.update_schedule(name, params)
  nil
end

#update_schema(db_name, table_name, schema) ⇒ true 



107
108
109
 
# File 'lib/td/client.rb', line 107

def update_schema(db_name, table_name, schema)
  @api.update_schema(db_name, table_name, schema.to_json)
end

#update_table(db_name, table_name, params = {}) ⇒ true

Options Hash (params):

  • :expire_days (Fixnum) —

    days to expire table

  • :include_v (Boolean) — default: true —

    include v column on Hive

  • :detect_schema (Boolean) — default: true —

    detect schema on import



117
118
119
 
# File 'lib/td/client.rb', line 117

def update_table(db_name, table_name, params={})
  @api.update_table(db_name, table_name, params)
end

#users ⇒ Array<User> 



464
465
466
467
468
469
 
# File 'lib/td/client.rb', line 464

def users
  list = @api.list_users
  list.map {|name,org,roles,email|
    User.new(self, name, org, roles, email)
  }
end