Class: TreasureData::API
- Inherits:
-
Object
- Object
- TreasureData::API
- Defined in:
- lib/td/client/api.rb
Defined Under Namespace
Modules: DeflateReadBodyMixin, DirectReadBodyMixin
Constant Summary collapse
- DEFAULT_ENDPOINT =
'api.treasure-data.com'
- DEFAULT_IMPORT_ENDPOINT =
'api-import.treasure-data.com'
- NEW_DEFAULT_ENDPOINT =
'api.treasuredata.com'
- NEW_DEFAULT_IMPORT_ENDPOINT =
'api-import.treasuredata.com'
Instance Attribute Summary collapse
-
#apikey ⇒ Object
readonly
TODO error check & raise appropriate errors.
Class Method Summary collapse
-
.create_empty_gz_data ⇒ Object
for fluent-plugin-td / td command to check table existence with import onlt user.
- .normalize_database_name(name) ⇒ Object
- .normalize_table_name(name) ⇒ Object
-
.normalize_type_name(name) ⇒ Object
TODO support array types.
- .normalized_msgpack(record, out = nil) ⇒ Object
- .validate_column_name(name) ⇒ Object
- .validate_database_name(name) ⇒ Object
- .validate_name(target, min_len, max_len, name) ⇒ Object
- .validate_result_set_name(name) ⇒ Object
- .validate_table_name(name) ⇒ Object
Instance Method Summary collapse
- #account_core_utilization(from, to) ⇒ Object
-
#add_apikey(user) ⇒ Object
> true.
-
#add_user(name, org, email, password) ⇒ Object
> true.
-
#authenticate(user, password) ⇒ Object
apikey:String.
-
#bulk_import_delete_part(name, part_name, opts = {}) ⇒ Object
> nil.
-
#bulk_import_error_records(name, opts = {}, &block) ⇒ Object
> data…
-
#bulk_import_upload_part(name, part_name, stream, size, opts = {}) ⇒ Object
> nil.
-
#change_email(user, email) ⇒ Object
> true.
-
#change_my_password(old_password, password) ⇒ Object
> true.
-
#change_password(user, password) ⇒ Object
> true.
-
#commit_bulk_import(name, opts = {}) ⇒ Object
> nil.
-
#create_bulk_import(name, db, table, opts = {}) ⇒ Object
> nil.
-
#create_database(db, opts = {}) ⇒ Object
> true.
-
#create_item_table(db, table, primary_key, primary_key_type) ⇒ Object
> true.
-
#create_log_table(db, table) ⇒ Object
> true.
-
#create_result(name, url, opts = {}) ⇒ Object
> true.
-
#create_schedule(name, opts) ⇒ Object
> start:String.
-
#delete_bulk_import(name, opts = {}) ⇒ Object
> nil.
-
#delete_database(db) ⇒ Object
> true.
-
#delete_result(name) ⇒ Object
> true.
-
#delete_schedule(name) ⇒ Object
> cron:String, query:String.
-
#delete_table(db, table) ⇒ Object
> type:Symbol.
-
#export(db, table, storage_type, opts = {}) ⇒ Object
> jobId:String.
-
#freeze_bulk_import(name, opts = {}) ⇒ Object
> nil.
-
#grant_access_control(subject, action, scope, grant_option) ⇒ Object
Access Control API.
- #history(name, from = 0, to = nil) ⇒ Object
-
#hive_query(q, db = nil, result_url = nil, priority = nil, retry_limit = nil, opts = {}) ⇒ Object
> jobId:String.
-
#import(db, table, format, stream, size, unique_id = nil) ⇒ Object
> time:Float.
-
#initialize(apikey, opts = {}) ⇒ API
constructor
A new instance of API.
- #job_result(job_id) ⇒ Object
-
#job_result_each(job_id, &block) ⇒ Object
block is optional and must accept 1 argument.
-
#job_result_each_with_compr_size(job_id, &block) ⇒ Object
block is optional and must accept 1 argument.
-
#job_result_format(job_id, format, io = nil, &block) ⇒ Object
block is optional and must accept 1 parameter.
- #job_result_raw(job_id, format) ⇒ Object
- #job_status(job_id) ⇒ Object
- #kill(job_id) ⇒ Object
-
#list_access_controls ⇒ Object
[subject:String,action:String,scope:String].
-
#list_apikeys(user) ⇒ Object
> [apikey:String].
- #list_bulk_import_parts(name, opts = {}) ⇒ Object
-
#list_bulk_imports(opts = {}) ⇒ Object
> result:.
-
#list_databases ⇒ Object
> [name:String].
-
#list_jobs(from = 0, to = nil, status = nil, conditions = nil) ⇒ Object
> [(jobId:String, type:Symbol, status:String, start_at:String, end_at:String, result_url:String)].
-
#list_result ⇒ Object
Result API.
-
#list_schedules ⇒ Object
> [(name:String, cron:String, query:String, database:String, result_url:String)].
-
#list_tables(db) ⇒ Object
> => [type:Symbol, count:Integer].
- #list_users ⇒ Object
-
#partial_delete(db, table, to, from, opts = {}) ⇒ Object
Partial delete API.
-
#perform_bulk_import(name, opts = {}) ⇒ Object
> jobId:String.
-
#pig_query(q, db = nil, result_url = nil, priority = nil, retry_limit = nil, opts = {}) ⇒ Object
> jobId:String.
-
#query(q, type = :hive, db = nil, result_url = nil, priority = nil, retry_limit = nil, opts = {}) ⇒ Object
> jobId:String.
-
#remove_apikey(user, apikey) ⇒ Object
> true.
-
#remove_user(user) ⇒ Object
> true.
- #revoke_access_control(subject, action, scope) ⇒ Object
- #run_schedule(name, time, num) ⇒ Object
-
#server_status ⇒ Object
> status:String.
-
#show_account ⇒ Object
Account API.
-
#show_bulk_import(name) ⇒ Object
> data:Hash.
-
#show_job(job_id) ⇒ Object
> (type:Symbol, status:String, result:String, url:String, result:String).
- #ssl_ca_file=(ssl_ca_file) ⇒ Object
-
#swap_table(db, table1, table2) ⇒ Object
> true.
- #tail(db, table, count, to, from, &block) ⇒ Object
-
#test_access_control(user, action, scope) ⇒ Object
[true, [subject:String,action:String,scope:String]].
-
#unfreeze_bulk_import(name, opts = {}) ⇒ Object
> nil.
- #update_expire(db, table, expire_days) ⇒ Object
- #update_schedule(name, params) ⇒ Object
-
#update_schema(db, table, schema_json) ⇒ Object
> true.
Constructor Details
#initialize(apikey, opts = {}) ⇒ API
Returns a new instance of API.
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 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 |
# File 'lib/td/client/api.rb', line 36 def initialize(apikey, opts={}) require 'json' require 'time' require 'uri' require 'net/http' require 'net/https' require 'time' #require 'faraday' # faraday doesn't support streaming upload with httpclient yet so now disabled require 'httpclient' @apikey = apikey @user_agent = "TD-Client-Ruby: #{TreasureData::Client::VERSION}" @user_agent = "#{opts[:user_agent]}; " + @user_agent if opts.has_key?(:user_agent) endpoint = opts[:endpoint] || ENV['TD_API_SERVER'] || DEFAULT_ENDPOINT uri = URI.parse(endpoint) @connect_timeout = opts[:connect_timeout] || 60 @read_timeout = opts[:read_timeout] || 600 @send_timeout = opts[:send_timeout] || 600 @retry_post_requests = opts[:retry_post_requests] || false @max_cumul_retry_delay = opts[:max_cumul_retry_delay] || 600 case uri.scheme when 'http', 'https' @host = uri.host @port = uri.port # the opts[:ssl] option is ignored here, it's value # overridden by the scheme of the endpoint URI @ssl = (uri.scheme == 'https') @base_path = uri.path.to_s else if uri.port # invalid URI raise "Invalid endpoint: #{endpoint}" end # generic URI @host, @port = endpoint.split(':', 2) @port = @port.to_i if opts[:ssl] @port = 443 if @port == 0 @ssl = true else @port = 80 if @port == 0 @ssl = false end @base_path = '' end @http_proxy = opts[:http_proxy] || ENV['HTTP_PROXY'] if @http_proxy http_proxy = if @http_proxy =~ /\Ahttp:\/\/(.*)\z/ $~[1] else @http_proxy end proxy_host, proxy_port = http_proxy.split(':', 2) proxy_port = (proxy_port ? proxy_port.to_i : 80) @http_class = Net::HTTP::Proxy(proxy_host, proxy_port) else @http_class = Net::HTTP end @headers = opts[:headers] || {} end |
Instance Attribute Details
#apikey ⇒ Object (readonly)
TODO error check & raise appropriate errors
106 107 108 |
# File 'lib/td/client/api.rb', line 106 def apikey @apikey end |
Class Method Details
.create_empty_gz_data ⇒ Object
for fluent-plugin-td / td command to check table existence with import onlt user
197 198 199 200 201 202 203 204 |
# File 'lib/td/client/api.rb', line 197 def self.create_empty_gz_data require 'zlib' require 'stringio' io = StringIO.new Zlib::GzipWriter.new(io).close io.string end |
.normalize_database_name(name) ⇒ Object
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/td/client/api.rb', line 158 def self.normalize_database_name(name) name = name.to_s if name.empty? raise "Empty name is not allowed" end if name.length < 3 name += "_" * (3 - name.length) end if 255 < name.length name = name[0, 253] + "__" end name = name.downcase name = name.gsub(/[^a-z0-9_]/, '_') name end |
.normalize_table_name(name) ⇒ Object
174 175 176 |
# File 'lib/td/client/api.rb', line 174 def self.normalize_table_name(name) normalize_database_name(name) end |
.normalize_type_name(name) ⇒ Object
TODO support array types
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/td/client/api.rb', line 179 def self.normalize_type_name(name) case name when /int/i, /integer/i "int" when /long/i, /bigint/i "long" when /string/i "string" when /float/i "float" when /double/i "double" else raise "Type name must eather of int, long, string float or double" end end |
.normalized_msgpack(record, out = nil) ⇒ Object
108 109 110 111 112 113 114 115 116 |
# File 'lib/td/client/api.rb', line 108 def self.normalized_msgpack(record, out = nil) record.keys.each { |k| v = record[k] if v.kind_of?(Bignum) record[k] = v.to_s end } record.to_msgpack(out) end |
.validate_column_name(name) ⇒ Object
154 155 156 |
# File 'lib/td/client/api.rb', line 154 def self.validate_column_name(name) validate_name("column", 1, 255, name) end |
.validate_database_name(name) ⇒ Object
142 143 144 |
# File 'lib/td/client/api.rb', line 142 def self.validate_database_name(name) validate_name("database", 3, 255, name) end |
.validate_name(target, min_len, max_len, name) ⇒ Object
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/td/client/api.rb', line 118 def self.validate_name(target, min_len, max_len, name) if !target.instance_of?(String) || target.empty? raise ParameterValidationError, "A valid target name is required" end name = name.to_s if name.empty? raise ParameterValidationError, "Empty #{target} name is not allowed" end if name.length < min_len || name.length > max_len raise ParameterValidationError, "#{target.capitalize} name must be between #{min_len} and #{max_len} characters long. Got #{name.length} " + (name.length == 1 ? "character" : "characters") + "." end unless name =~ /^([a-z0-9_]+)$/ raise ParameterValidationError, "#{target.capitalize} name must only consist of lower-case alpha-numeric characters and '_'." end name end |
.validate_result_set_name(name) ⇒ Object
150 151 152 |
# File 'lib/td/client/api.rb', line 150 def self.validate_result_set_name(name) validate_name("result set", 3, 255, name) end |
.validate_table_name(name) ⇒ Object
146 147 148 |
# File 'lib/td/client/api.rb', line 146 def self.validate_table_name(name) validate_name("table", 3, 255, name) end |
Instance Method Details
#account_core_utilization(from, to) ⇒ Object
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/td/client/api.rb', line 226 def account_core_utilization(from, to) params = { } params['from'] = from.to_s if from params['to'] = to.to_s if to code, body, res = get("/v3/account/core_utilization", params) if code != "200" raise_error("Show account failed", res) end js = checked_json(body, %w[from to interval history]) from = Time.parse(js['from']).utc to = Time.parse(js['to']).utc interval = js['interval'].to_i history = js['history'] return [from, to, interval, history] end |
#add_apikey(user) ⇒ Object
> true
1082 1083 1084 1085 1086 1087 1088 |
# File 'lib/td/client/api.rb', line 1082 def add_apikey(user) code, body, res = post("/v3/user/apikey/add/#{e user}") if code != "200" raise_error("Adding API key failed", res) end return true end |
#add_user(name, org, email, password) ⇒ Object
> true
1043 1044 1045 1046 1047 1048 1049 1050 |
# File 'lib/td/client/api.rb', line 1043 def add_user(name, org, email, password) params = {'organization'=>org, :email=>email, :password=>password} code, body, res = post("/v3/user/add/#{e name}", params) if code != "200" raise_error("Adding user failed", res) end return true end |
#authenticate(user, password) ⇒ Object
apikey:String
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 |
# File 'lib/td/client/api.rb', line 1013 def authenticate(user, password) code, body, res = post("/v3/user/authenticate", {'user'=>user, 'password'=>password}) if code != "200" if code == "400" raise_error("Authentication failed", res, AuthError) else raise_error("Authentication failed", res) end end js = checked_json(body, %w[apikey]) apikey = js['apikey'] return apikey end |
#bulk_import_delete_part(name, part_name, opts = {}) ⇒ Object
> nil
756 757 758 759 760 761 762 763 |
# File 'lib/td/client/api.rb', line 756 def bulk_import_delete_part(name, part_name, opts={}) params = opts.dup code, body, res = post("/v3/bulk_import/delete_part/#{e name}/#{e part_name}", params) if code[0] != ?2 raise_error("Delete a part failed", res) end return nil end |
#bulk_import_error_records(name, opts = {}, &block) ⇒ Object
> data…
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 |
# File 'lib/td/client/api.rb', line 807 def bulk_import_error_records(name, opts={}, &block) params = opts.dup code, body, res = get("/v3/bulk_import/error_records/#{e name}", params) if code != "200" raise_error("Failed to get bulk import error records", res) end if body.empty? if block return nil else return [] end end require 'zlib' require 'stringio' require 'msgpack' require File.('compat_gzip_reader', File.dirname(__FILE__)) u = MessagePack::Unpacker.new(Zlib::GzipReader.new(StringIO.new(body))) if block begin u.each(&block) rescue EOFError end nil else result = [] begin u.each {|row| result << row } rescue EOFError end return result end end |
#bulk_import_upload_part(name, part_name, stream, size, opts = {}) ⇒ Object
> nil
747 748 749 750 751 752 753 |
# File 'lib/td/client/api.rb', line 747 def bulk_import_upload_part(name, part_name, stream, size, opts={}) code, body, res = put("/v3/bulk_import/upload_part/#{e name}/#{e part_name}", stream, size) if code[0] != ?2 raise_error("Upload a part failed", res) end return nil end |
#change_email(user, email) ⇒ Object
> true
1062 1063 1064 1065 1066 1067 1068 1069 |
# File 'lib/td/client/api.rb', line 1062 def change_email(user, email) params = {'email' => email} code, body, res = post("/v3/user/email/change/#{e user}", params) if code != "200" raise_error("Changing email failed", res) end return true end |
#change_my_password(old_password, password) ⇒ Object
> true
1111 1112 1113 1114 1115 1116 1117 1118 |
# File 'lib/td/client/api.rb', line 1111 def change_my_password(old_password, password) params = {'old_password' => old_password, 'password' => password} code, body, res = post("/v3/user/password/change", params) if code != "200" raise_error("Changing password failed", res) end return true end |
#change_password(user, password) ⇒ Object
> true
1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'lib/td/client/api.rb', line 1101 def change_password(user, password) params = {'password' => password} code, body, res = post("/v3/user/password/change/#{e user}", params) if code != "200" raise_error("Changing password failed", res) end return true end |
#commit_bulk_import(name, opts = {}) ⇒ Object
> nil
797 798 799 800 801 802 803 804 |
# File 'lib/td/client/api.rb', line 797 def commit_bulk_import(name, opts={}) params = opts.dup code, body, res = post("/v3/bulk_import/commit/#{e name}", params) if code != "200" raise_error("Commit bulk import failed", res) end return nil end |
#create_bulk_import(name, db, table, opts = {}) ⇒ Object
> nil
696 697 698 699 700 701 702 703 |
# File 'lib/td/client/api.rb', line 696 def create_bulk_import(name, db, table, opts={}) params = opts.dup code, body, res = post("/v3/bulk_import/create/#{e name}/#{e db}/#{e table}", params) if code != "200" raise_error("Create bulk import failed", res) end return nil end |
#create_database(db, opts = {}) ⇒ Object
> true
276 277 278 279 280 281 282 283 |
# File 'lib/td/client/api.rb', line 276 def create_database(db, opts={}) params = opts.dup code, body, res = post("/v3/database/create/#{e db}", params) if code != "200" raise_error("Create database failed", res) end return true end |
#create_item_table(db, table, primary_key, primary_key_type) ⇒ Object
> true
331 332 333 334 |
# File 'lib/td/client/api.rb', line 331 def create_item_table(db, table, primary_key, primary_key_type) params = {'primary_key' => primary_key, 'primary_key_type' => primary_key_type} create_table(db, table, :item, params) end |
#create_log_table(db, table) ⇒ Object
> true
326 327 328 |
# File 'lib/td/client/api.rb', line 326 def create_log_table(db, table) create_table(db, table, :log) end |
#create_result(name, url, opts = {}) ⇒ Object
> true
989 990 991 992 993 994 995 996 |
# File 'lib/td/client/api.rb', line 989 def create_result(name, url, opts={}) params = {'url'=>url}.merge(opts) code, body, res = post("/v3/result/create/#{e name}", params) if code != "200" raise_error("Create result table failed", res) end return true end |
#create_schedule(name, opts) ⇒ Object
> start:String
848 849 850 851 852 853 854 855 856 |
# File 'lib/td/client/api.rb', line 848 def create_schedule(name, opts) params = opts.update({:type=> opts[:type] || opts['type'] || 'hive'}) code, body, res = post("/v3/schedule/create/#{e name}", params) if code != "200" raise_error("Create schedule failed", res) end js = checked_json(body, %w[start]) return js['start'] end |
#delete_bulk_import(name, opts = {}) ⇒ Object
> nil
706 707 708 709 710 711 712 713 |
# File 'lib/td/client/api.rb', line 706 def delete_bulk_import(name, opts={}) params = opts.dup code, body, res = post("/v3/bulk_import/delete/#{e name}", params) if code != "200" raise_error("Delete bulk import failed", res) end return nil end |
#delete_database(db) ⇒ Object
> true
267 268 269 270 271 272 273 |
# File 'lib/td/client/api.rb', line 267 def delete_database(db) code, body, res = post("/v3/database/delete/#{e db}") if code != "200" raise_error("Delete database failed", res) end return true end |
#delete_result(name) ⇒ Object
> true
999 1000 1001 1002 1003 1004 1005 |
# File 'lib/td/client/api.rb', line 999 def delete_result(name) code, body, res = post("/v3/result/delete/#{e name}") if code != "200" raise_error("Delete result table failed", res) end return true end |
#delete_schedule(name) ⇒ Object
> cron:String, query:String
859 860 861 862 863 864 865 866 |
# File 'lib/td/client/api.rb', line 859 def delete_schedule(name) code, body, res = post("/v3/schedule/delete/#{e name}") if code != "200" raise_error("Delete schedule failed", res) end js = checked_json(body, %w[]) return js['cron'], js["query"] end |
#delete_table(db, table) ⇒ Object
> type:Symbol
373 374 375 376 377 378 379 380 381 |
# File 'lib/td/client/api.rb', line 373 def delete_table(db, table) code, body, res = post("/v3/table/delete/#{e db}/#{e table}") if code != "200" raise_error("Delete table failed", res) end js = checked_json(body, %w[]) type = (js['type'] || '?').to_sym return type end |
#export(db, table, storage_type, opts = {}) ⇒ Object
> jobId:String
663 664 665 666 667 668 669 670 671 672 |
# File 'lib/td/client/api.rb', line 663 def export(db, table, storage_type, opts={}) params = opts.dup params['storage_type'] = storage_type code, body, res = post("/v3/export/run/#{e db}/#{e table}", params) if code != "200" raise_error("Export failed", res) end js = checked_json(body, %w[job_id]) return js['job_id'].to_s end |
#freeze_bulk_import(name, opts = {}) ⇒ Object
> nil
766 767 768 769 770 771 772 773 |
# File 'lib/td/client/api.rb', line 766 def freeze_bulk_import(name, opts={}) params = opts.dup code, body, res = post("/v3/bulk_import/freeze/#{e name}", params) if code != "200" raise_error("Freeze bulk import failed", res) end return nil end |
#grant_access_control(subject, action, scope, grant_option) ⇒ Object
Access Control API
1125 1126 1127 1128 1129 1130 1131 1132 |
# File 'lib/td/client/api.rb', line 1125 def grant_access_control(subject, action, scope, grant_option) params = {'subject'=>subject, 'action'=>action, 'scope'=>scope, 'grant_option'=>grant_option.to_s} code, body, res = post("/v3/acl/grant", params) if code != "200" raise_error("Granting access control failed", res) end return true end |
#history(name, from = 0, to = nil) ⇒ Object
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 |
# File 'lib/td/client/api.rb', line 900 def history(name, from=0, to=nil) params = {} params['from'] = from.to_s if from params['to'] = to.to_s if to code, body, res = get("/v3/schedule/history/#{e name}", params) if code != "200" raise_error("List history failed", res) end js = checked_json(body, %w[history]) result = [] js['history'].each {|m| job_id = m['job_id'] type = (m['type'] || '?').to_sym database = m['database'] status = m['status'] query = m['query'] start_at = m['start_at'] end_at = m['end_at'] scheduled_at = m['scheduled_at'] result_url = m['result'] priority = m['priority'] result << [scheduled_at, job_id, type, status, query, start_at, end_at, result_url, priority, database] } return result end |
#hive_query(q, db = nil, result_url = nil, priority = nil, retry_limit = nil, opts = {}) ⇒ Object
> jobId:String
635 636 637 |
# File 'lib/td/client/api.rb', line 635 def hive_query(q, db=nil, result_url=nil, priority=nil, retry_limit=nil, opts={}) query(q, :hive, db, result_url, priority, retry_limit, opts) end |
#import(db, table, format, stream, size, unique_id = nil) ⇒ Object
> time:Float
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 |
# File 'lib/td/client/api.rb', line 949 def import(db, table, format, stream, size, unique_id=nil) if unique_id path = "/v3/table/import_with_id/#{e db}/#{e table}/#{unique_id}/#{format}" else path = "/v3/table/import/#{e db}/#{e table}/#{format}" end opts = {} if @host == DEFAULT_ENDPOINT opts[:host] = DEFAULT_IMPORT_ENDPOINT elsif @host == NEW_DEFAULT_ENDPOINT opts[:host] = NEW_DEFAULT_IMPORT_ENDPOINT end code, body, res = put(path, stream, size, opts) if code[0] != ?2 raise_error("Import failed", res) end js = checked_json(body, %w[]) time = js['elapsed_time'].to_f return time end |
#job_result(job_id) ⇒ Object
508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'lib/td/client/api.rb', line 508 def job_result(job_id) require 'msgpack' code, body, res = get("/v3/job/result/#{e job_id}", {'format'=>'msgpack'}) if code != "200" raise_error("Get job result failed", res) end result = [] MessagePack::Unpacker.new.feed_each(body) {|row| result << row } return result end |
#job_result_each(job_id, &block) ⇒ Object
block is optional and must accept 1 argument
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'lib/td/client/api.rb', line 566 def job_result_each(job_id, &block) require 'msgpack' get("/v3/job/result/#{e job_id}", {'format'=>'msgpack'}) {|res| if res.code != "200" raise_error("Get job result failed", res) end # default to decompressing the response since format is fixed to 'msgpack' res.extend(DeflateReadBodyMixin) res.gzip = (res.header['Content-Encoding'] == 'gzip') upkr = MessagePack::Unpacker.new res.each_fragment {|inflated_fragment| upkr.feed_each(inflated_fragment, &block) } } nil end |
#job_result_each_with_compr_size(job_id, &block) ⇒ Object
block is optional and must accept 1 argument
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 |
# File 'lib/td/client/api.rb', line 585 def job_result_each_with_compr_size(job_id, &block) require 'zlib' require 'msgpack' get("/v3/job/result/#{e job_id}", {'format'=>'msgpack'}) {|res| if res.code != "200" raise_error("Get job result failed", res) end res.extend(DirectReadBodyMixin) if res.header['Content-Encoding'] == 'gzip' infl = Zlib::Inflate.new(Zlib::MAX_WBITS + 16) else infl = Zlib::Inflate.new end upkr = MessagePack::Unpacker.new begin total_compr_size = 0 res.each_fragment {|fragment| total_compr_size += fragment.size upkr.feed_each(infl.inflate(fragment)) {|unpacked| block.call(unpacked, total_compr_size) if block_given? } } ensure infl.close end } nil end |
#job_result_format(job_id, format, io = nil, &block) ⇒ Object
block is optional and must accept 1 parameter
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 |
# File 'lib/td/client/api.rb', line 522 def job_result_format(job_id, format, io=nil, &block) if io code, body, res = get("/v3/job/result/#{e job_id}", {'format'=>format}) {|res| if res.code != "200" raise_error("Get job result failed", res) end if ce = res.header['Content-Encoding'] require 'zlib' res.extend(DeflateReadBodyMixin) res.gzip = true if ce == 'gzip' else res.extend(DirectReadBodyMixin) end res.extend(DirectReadBodyMixin) if ce = res.header['Content-Encoding'] if ce == 'gzip' infl = Zlib::Inflate.new(Zlib::MAX_WBITS + 16) else infl = Zlib::Inflate.new end end total_compr_size = 0 res.each_fragment {|fragment| total_compr_size += fragment.size # uncompressed if the 'Content-Enconding' header is set in response fragment = infl.inflate(fragment) if ce io.write(fragment) block.call(total_compr_size) if block_given? } } nil else code, body, res = get("/v3/job/result/#{e job_id}", {'format'=>format}) if res.code != "200" raise_error("Get job result failed", res) end body end end |
#job_result_raw(job_id, format) ⇒ Object
616 617 618 619 620 621 622 |
# File 'lib/td/client/api.rb', line 616 def job_result_raw(job_id, format) code, body, res = get("/v3/job/result/#{e job_id}", {'format'=>format}) if code != "200" raise_error("Get job result failed", res) end return body end |
#job_status(job_id) ⇒ Object
498 499 500 501 502 503 504 505 506 |
# File 'lib/td/client/api.rb', line 498 def job_status(job_id) code, body, res = get("/v3/job/status/#{e job_id}") if code != "200" raise_error("Get job status failed", res) end js = checked_json(body, %w[status]) return js['status'] end |
#kill(job_id) ⇒ Object
624 625 626 627 628 629 630 631 632 |
# File 'lib/td/client/api.rb', line 624 def kill(job_id) code, body, res = post("/v3/job/kill/#{e job_id}") if code != "200" raise_error("Kill job failed", res) end js = checked_json(body, %w[]) former_status = js['former_status'] return former_status end |
#list_access_controls ⇒ Object
- subject:String,action:String,scope:String
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 |
# File 'lib/td/client/api.rb', line 1162 def list_access_controls code, body, res = get("/v3/acl/list") if code != "200" raise_error("Listing access control failed", res) end js = checked_json(body, %w[access_controls]) acl = js["access_controls"].map {|roleinfo| subject = roleinfo['subject'] action = roleinfo['action'] scope = roleinfo['scope'] grant_option = roleinfo['grant_option'] [subject, action, scope, grant_option] } return acl end |
#list_apikeys(user) ⇒ Object
> [apikey:String]
1072 1073 1074 1075 1076 1077 1078 1079 |
# File 'lib/td/client/api.rb', line 1072 def list_apikeys(user) code, body, res = get("/v3/user/apikey/list/#{e user}") if code != "200" raise_error("List API keys failed", res) end js = checked_json(body, %w[apikeys]) return js['apikeys'] end |
#list_bulk_import_parts(name, opts = {}) ⇒ Object
736 737 738 739 740 741 742 743 744 |
# File 'lib/td/client/api.rb', line 736 def list_bulk_import_parts(name, opts={}) params = opts.dup code, body, res = get("/v3/bulk_import/list_parts/#{e name}", params) if code != "200" raise_error("List bulk import parts failed", res) end js = checked_json(body, %w[parts]) return js['parts'] end |
#list_bulk_imports(opts = {}) ⇒ Object
> result:
726 727 728 729 730 731 732 733 734 |
# File 'lib/td/client/api.rb', line 726 def list_bulk_imports(opts={}) params = opts.dup code, body, res = get("/v3/bulk_import/list", params) if code != "200" raise_error("List bulk imports failed", res) end js = checked_json(body, %w[bulk_imports]) return js['bulk_imports'] end |
#list_databases ⇒ Object
> [name:String]
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/td/client/api.rb', line 248 def list_databases code, body, res = get("/v3/database/list") if code != "200" raise_error("List databases failed", res) end js = checked_json(body, %w[databases]) result = {} js["databases"].each {|m| name = m['name'] count = m['count'] created_at = m['created_at'] updated_at = m['updated_at'] = m['permission'] result[name] = [count, created_at, updated_at, nil, ] # set nil to org for API compatibiilty } return result end |
#list_jobs(from = 0, to = nil, status = nil, conditions = nil) ⇒ Object
> [(jobId:String, type:Symbol, status:String, start_at:String, end_at:String, result_url:String)]
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 |
# File 'lib/td/client/api.rb', line 411 def list_jobs(from=0, to=nil, status=nil, conditions=nil) params = {} params['from'] = from.to_s if from params['to'] = to.to_s if to params['status'] = status.to_s if status params.merge!(conditions) if conditions code, body, res = get("/v3/job/list", params) if code != "200" raise_error("List jobs failed", res) end js = checked_json(body, %w[jobs]) result = [] js['jobs'].each {|m| job_id = m['job_id'] type = (m['type'] || '?').to_sym database = m['database'] status = m['status'] query = m['query'] start_at = m['start_at'] end_at = m['end_at'] cpu_time = m['cpu_time'] result_size = m['result_size'] # compressed result size in msgpack.gz format result_url = m['result'] priority = m['priority'] retry_limit = m['retry_limit'] result << [job_id, type, status, query, start_at, end_at, cpu_time, result_size, result_url, priority, retry_limit, nil, database] } return result end |
#list_result ⇒ Object
Result API
975 976 977 978 979 980 981 982 983 984 985 986 |
# File 'lib/td/client/api.rb', line 975 def list_result code, body, res = get("/v3/result/list") if code != "200" raise_error("List result table failed", res) end js = checked_json(body, %w[results]) result = [] js['results'].map {|m| result << [m['name'], m['url'], nil] # same as database } return result end |
#list_schedules ⇒ Object
> [(name:String, cron:String, query:String, database:String, result_url:String)]
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 |
# File 'lib/td/client/api.rb', line 869 def list_schedules code, body, res = get("/v3/schedule/list") if code != "200" raise_error("List schedules failed", res) end js = checked_json(body, %w[schedules]) result = [] js['schedules'].each {|m| name = m['name'] cron = m['cron'] query = m['query'] database = m['database'] result_url = m['result'] timezone = m['timezone'] delay = m['delay'] next_time = m['next_time'] priority = m['priority'] retry_limit = m['retry_limit'] result << [name, cron, query, database, result_url, timezone, delay, next_time, priority, retry_limit, nil] # same as database } return result end |
#list_tables(db) ⇒ Object
> => [type:Symbol, count:Integer]
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/td/client/api.rb', line 291 def list_tables(db) code, body, res = get("/v3/table/list/#{e db}") if code != "200" raise_error("List tables failed", res) end js = checked_json(body, %w[tables]) result = {} js["tables"].map {|m| name = m['name'] type = (m['type'] || '?').to_sym count = (m['count'] || 0).to_i # TODO? created_at = m['created_at'] updated_at = m['updated_at'] last_import = m['counter_updated_at'] = m['last_log_timestamp'] estimated_storage_size = m['estimated_storage_size'].to_i schema = JSON.parse(m['schema'] || '[]') expire_days = m['expire_days'] primary_key = m['primary_key'] primary_key_type = m['primary_key_type'] result[name] = [type, schema, count, created_at, updated_at, estimated_storage_size, last_import, , expire_days, primary_key, primary_key_type] } return result end |
#list_users ⇒ Object
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 |
# File 'lib/td/client/api.rb', line 1028 def list_users code, body, res = get("/v3/user/list") if code != "200" raise_error("List users failed", res) end js = checked_json(body, %w[users]) result = js["users"].map {|roleinfo| name = roleinfo['name'] email = roleinfo['email'] [name, nil, nil, email] # set nil to org and role for API compatibility } return result end |
#partial_delete(db, table, to, from, opts = {}) ⇒ Object
Partial delete API
679 680 681 682 683 684 685 686 687 688 689 |
# File 'lib/td/client/api.rb', line 679 def partial_delete(db, table, to, from, opts={}) params = opts.dup params['to'] = to.to_s params['from'] = from.to_s code, body, res = post("/v3/table/partialdelete/#{e db}/#{e table}", params) if code != "200" raise_error("Partial delete failed", res) end js = checked_json(body, %w[job_id]) return js['job_id'].to_s end |
#perform_bulk_import(name, opts = {}) ⇒ Object
> jobId:String
786 787 788 789 790 791 792 793 794 |
# File 'lib/td/client/api.rb', line 786 def perform_bulk_import(name, opts={}) params = opts.dup code, body, res = post("/v3/bulk_import/perform/#{e name}", params) if code != "200" raise_error("Perform bulk import failed", res) end js = checked_json(body, %w[job_id]) return js['job_id'].to_s end |
#pig_query(q, db = nil, result_url = nil, priority = nil, retry_limit = nil, opts = {}) ⇒ Object
> jobId:String
640 641 642 |
# File 'lib/td/client/api.rb', line 640 def pig_query(q, db=nil, result_url=nil, priority=nil, retry_limit=nil, opts={}) query(q, :pig, db, result_url, priority, retry_limit, opts) end |
#query(q, type = :hive, db = nil, result_url = nil, priority = nil, retry_limit = nil, opts = {}) ⇒ Object
> jobId:String
645 646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/td/client/api.rb', line 645 def query(q, type=:hive, db=nil, result_url=nil, priority=nil, retry_limit=nil, opts={}) params = {'query' => q}.merge(opts) params['result'] = result_url if result_url params['priority'] = priority if priority params['retry_limit'] = retry_limit if retry_limit code, body, res = post("/v3/job/issue/#{type}/#{e db}", params) if code != "200" raise_error("Query failed", res) end js = checked_json(body, %w[job_id]) return js['job_id'].to_s end |
#remove_apikey(user, apikey) ⇒ Object
> true
1091 1092 1093 1094 1095 1096 1097 1098 |
# File 'lib/td/client/api.rb', line 1091 def remove_apikey(user, apikey) params = {'apikey' => apikey} code, body, res = post("/v3/user/apikey/remove/#{e user}", params) if code != "200" raise_error("Removing API key failed", res) end return true end |
#remove_user(user) ⇒ Object
> true
1053 1054 1055 1056 1057 1058 1059 |
# File 'lib/td/client/api.rb', line 1053 def remove_user(user) code, body, res = post("/v3/user/remove/#{e user}") if code != "200" raise_error("Removing user failed", res) end return true end |
#revoke_access_control(subject, action, scope) ⇒ Object
1134 1135 1136 1137 1138 1139 1140 1141 |
# File 'lib/td/client/api.rb', line 1134 def revoke_access_control(subject, action, scope) params = {'subject'=>subject, 'action'=>action, 'scope'=>scope} code, body, res = post("/v3/acl/revoke", params) if code != "200" raise_error("Revoking access control failed", res) end return true end |
#run_schedule(name, time, num) ⇒ Object
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 |
# File 'lib/td/client/api.rb', line 926 def run_schedule(name, time, num) params = {} params = {'num' => num} if num code, body, res = post("/v3/schedule/run/#{e name}/#{e time}", params) if code != "200" raise_error("Run schedule failed", res) end js = checked_json(body, %w[jobs]) result = [] js['jobs'].each {|m| job_id = m['job_id'] scheduled_at = m['scheduled_at'] type = (m['type'] || '?').to_sym result << [job_id, type, scheduled_at] } return result end |
#server_status ⇒ Object
> status:String
1183 1184 1185 1186 1187 1188 1189 1190 1191 |
# File 'lib/td/client/api.rb', line 1183 def server_status code, body, res = get('/v3/system/server_status') if code != "200" return "Server is down (#{code})" end js = checked_json(body, %w[status]) status = js['status'] return status end |
#show_account ⇒ Object
Account API
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/td/client/api.rb', line 210 def show_account code, body, res = get("/v3/account/show") if code != "200" raise_error("Show account failed", res) end js = checked_json(body, %w[account]) a = js["account"] account_id = a['id'].to_i plan = a['plan'].to_i storage_size = a['storage_size'].to_i guaranteed_cores = a['guaranteed_cores'].to_i maximum_cores = a['maximum_cores'].to_i created_at = a['created_at'] return [account_id, plan, storage_size, guaranteed_cores, maximum_cores, created_at] end |
#show_bulk_import(name) ⇒ Object
> data:Hash
716 717 718 719 720 721 722 723 |
# File 'lib/td/client/api.rb', line 716 def show_bulk_import(name) code, body, res = get("/v3/bulk_import/show/#{name}") if code != "200" raise_error("Show bulk import failed", res) end js = checked_json(body, %w[status]) return js end |
#show_job(job_id) ⇒ Object
> (type:Symbol, status:String, result:String, url:String, result:String)
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 |
# File 'lib/td/client/api.rb', line 443 def show_job(job_id) # use v3/job/status instead of v3/job/show to poll finish of a job code, body, res = get("/v3/job/show/#{e job_id}") if code != "200" raise_error("Show job failed", res) end js = checked_json(body, %w[status]) # TODO debug type = (js['type'] || '?').to_sym # TODO database = js['database'] query = js['query'] status = js['status'] debug = js['debug'] url = js['url'] start_at = js['start_at'] end_at = js['end_at'] cpu_time = js['cpu_time'] result_size = js['result_size'] # compressed result size in msgpack.gz format result = js['result'] # result target URL hive_result_schema = (js['hive_result_schema'] || '') if hive_result_schema.empty? hive_result_schema = nil else begin hive_result_schema = JSON.parse(hive_result_schema) rescue JSON::ParserError => e # this is a workaround for a Known Limitation in the Pig Engine which does not set a default, auto-generated # column name for anonymous columns (such as the ones that are generated from UDF like COUNT or SUM). # The schema will contain 'nil' for the name of those columns and that breaks the JSON parser since it violates # the JSON syntax standard. if type == :pig and hive_result_schema !~ /[\{\}]/ begin # NOTE: this works because a JSON 2 dimensional array is the same as a Ruby one. # Any change in the format for the hive_result_schema output may cause a syntax error, in which case # this lame attempt at fixing the problem will fail and we will be raising the original JSON exception hive_result_schema = eval(hive_result_schema) rescue SyntaxError => ignored_e raise e end hive_result_schema.each_with_index {|col_schema, idx| if col_schema[0].nil? col_schema[0] = "_col#{idx}" end } else raise e end end end priority = js['priority'] retry_limit = js['retry_limit'] return [type, query, status, url, debug, start_at, end_at, cpu_time, result_size, result, hive_result_schema, priority, retry_limit, nil, database] end |
#ssl_ca_file=(ssl_ca_file) ⇒ Object
1193 1194 1195 |
# File 'lib/td/client/api.rb', line 1193 def ssl_ca_file=(ssl_ca_file) @ssl_ca_file = ssl_ca_file end |
#swap_table(db, table1, table2) ⇒ Object
> true
347 348 349 350 351 352 353 |
# File 'lib/td/client/api.rb', line 347 def swap_table(db, table1, table2) code, body, res = post("/v3/table/swap/#{e db}/#{e table1}/#{e table2}") if code != "200" raise_error("Swap tables failed", res) end return true end |
#tail(db, table, count, to, from, &block) ⇒ Object
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
# File 'lib/td/client/api.rb', line 383 def tail(db, table, count, to, from, &block) params = {'format' => 'msgpack'} params['count'] = count.to_s if count params['to'] = to.to_s if to params['from'] = from.to_s if from code, body, res = get("/v3/table/tail/#{e db}/#{e table}", params) if code != "200" raise_error("Tail table failed", res) end require 'msgpack' if block MessagePack::Unpacker.new.feed_each(body, &block) nil else result = [] MessagePack::Unpacker.new.feed_each(body) {|row| result << row } return result end end |
#test_access_control(user, action, scope) ⇒ Object
- true, [subject:String,action:String,scope:String]
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 |
# File 'lib/td/client/api.rb', line 1144 def test_access_control(user, action, scope) params = {'user'=>user, 'action'=>action, 'scope'=>scope} code, body, res = get("/v3/acl/test", params) if code != "200" raise_error("Testing access control failed", res) end js = checked_json(body, %w[permission access_controls]) perm = js["permission"] acl = js["access_controls"].map {|roleinfo| subject = roleinfo['subject'] action = roleinfo['action'] scope = roleinfo['scope'] [name, action, scope] } return perm, acl end |
#unfreeze_bulk_import(name, opts = {}) ⇒ Object
> nil
776 777 778 779 780 781 782 783 |
# File 'lib/td/client/api.rb', line 776 def unfreeze_bulk_import(name, opts={}) params = opts.dup code, body, res = post("/v3/bulk_import/unfreeze/#{e name}", params) if code != "200" raise_error("Unfreeze bulk import failed", res) end return nil end |
#update_expire(db, table, expire_days) ⇒ Object
364 365 366 367 368 369 370 |
# File 'lib/td/client/api.rb', line 364 def update_expire(db, table, expire_days) code, body, res = post("/v3/table/update/#{e db}/#{e table}", {'expire_days'=>expire_days}) if code != "200" raise_error("Update table expiration failed", res) end return true end |
#update_schedule(name, params) ⇒ Object
892 893 894 895 896 897 898 |
# File 'lib/td/client/api.rb', line 892 def update_schedule(name, params) code, body, res = post("/v3/schedule/update/#{e name}", params) if code != "200" raise_error("Update schedule failed", res) end return nil end |
#update_schema(db, table, schema_json) ⇒ Object
> true
356 357 358 359 360 361 362 |
# File 'lib/td/client/api.rb', line 356 def update_schema(db, table, schema_json) code, body, res = post("/v3/table/update-schema/#{e db}/#{e table}", {'schema'=>schema_json}) if code != "200" raise_error("Create schema table failed", res) end return true end |