td-client 0.8.4 → 0.8.5

data/ChangeLog

@@ -1,4 +1,11 @@
 
+== 2011-12-04 version 0.8.5
+
+* added new feature: ResultSet
+* added new feature: AggregationSchema
+* added Job#rset and Schedule#rset to get associated ResultSet
+
+
 == 2011-11-11 version 0.8.4
 
 * Added Model#client

data/lib/td/client.rb

@@ -104,30 +104,33 @@ class Client
   end
 
   # => Job
-  def query(db_name, q)
-    job_id = @api.hive_query(q, db_name)
+  def query(db_name, q, rset=nil)
+    job_id = @api.hive_query(q, db_name, rset)
     Job.new(self, job_id, :hive, q)  # TODO url
   end
 
   # => [Job]
   def jobs(from=nil, to=nil)
     result = @api.list_jobs(from, to)
-    result.map {|job_id,type,status,query,start_at,end_at|
-      Job.new(self, job_id, type, query, status, nil, nil, start_at, end_at)
+    result.map {|job_id,type,status,query,start_at,end_at,rset|
+      rset = ResultSet.new(self, rset) if rset
+      Job.new(self, job_id, type, query, status, nil, nil, start_at, end_at, nil, rset)
     }
   end
 
   # => Job
   def job(job_id)
     job_id = job_id.to_s
-    type, query, status, url, debug, start_at, end_at = @api.show_job(job_id)
-    Job.new(self, job_id, type, query, status, url, debug, start_at, end_at)
+    type, query, status, url, debug, start_at, end_at, rset = @api.show_job(job_id)
+    rset = ResultSet.new(self, rset) if rset
+    Job.new(self, job_id, type, query, status, url, debug, start_at, end_at, nil, rset)
   end
 
   # => type:Symbol, url:String
   def job_status(job_id)
-    type, query, status, url, debug, start_at, end_at = @api.show_job(job_id)
-    return query, status, url, debug, start_at, end_at
+    type, query, status, url, debug, start_at, end_at, rset = @api.show_job(job_id)
+    rset = ResultSet.new(self, rset) if rset
+    return query, status, url, debug, start_at, end_at, rset
   end
 
   # => result:[{column:String=>value:Object]
@@ -166,16 +169,18 @@ class Client
   # [Schedule]
   def schedules
     result = @api.list_schedules
-    result.map {|name,cron,query,database|
-      Schedule.new(self, name, cron, query, database)
+    result.map {|name,cron,query,database,rset|
+      rset = ResultSet.new(self, rset) if rset
+      Schedule.new(self, name, cron, query, database, rset)
     }
   end
 
   # [ScheduledJob]
   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|
-      ScheduledJob.new(self, scheduled_at, job_id, type, query, status, nil, nil, start_at, end_at)
+    result.map {|scheduled_at,job_id,type,status,query,start_at,end_at,rset|
+      rset = ResultSet.new(self, rset) if rset
+      ScheduledJob.new(self, scheduled_at, job_id, type, query, status, nil, nil, start_at, end_at, nil, rset)
     }
   end
 
@@ -183,6 +188,86 @@ class Client
   def import(db_name, table_name, format, stream, size)
     @api.import(db_name, table_name, format, stream, size)
   end
+
+  # => [ResultSet]
+  def result_sets
+    info, names = @api.list_result_set
+    sets = names.map {|name|
+      ResultSet.new(self, name)
+    }
+    return sets
+  end
+
+  # => ResultSetInfo
+  def result_set_info
+    info, names = @api.list_result_set
+    info = ResultSetInfo.new(self, *info)
+    return info
+  end
+
+  # => true
+  def create_result_set(name)
+    @api.create_result_set(name)
+  end
+
+  # => true
+  def delete_result_set(name)
+    @api.delete_result_set(name)
+  end
+
+  # => [AggregationSchema]
+  def aggregation_schemas
+    list = @api.list_aggregation_schema
+    list.map {|name,relation_key|
+      AggregationSchema.new(self, name, relation_key)
+    }
+  end
+
+  # => true
+  def create_aggregation_schema(name, relation_key)
+    @api.create_aggregation_schema(name, relation_key)
+  end
+
+  # => true
+  def delete_aggregation_schema(name)
+    @api.delete_aggregation_schema(name)
+  end
+
+  # => AggregationSchema
+  def aggregation_schema(name)
+    relation_key, logs, attrs = @api.show_aggregation_schema(name)
+    logs.map! {|name,comment,database,table,okeys,value_key,count_key|
+      table = Table.new(self, database, table, 'log', nil, nil)
+      LogAggregationSchemaEntry.new(self, name, comment, table,
+                                    okeys, value_key, count_key)
+    }
+    attrs.map! {|name,comment,database,table,method_name,parameters|
+      table = Table.new(self, database, table, 'log', nil, nil)
+      AttributeAggregationSchemaEntry.new(self, name, comment, table,
+                                          method_name, parameters)
+    }
+    AggregationSchema.new(self, name, relation_key, logs, attrs)
+  end
+
+  # => true
+  def create_aggregation_log_entry(name, entry_name, comment, db, table, okeys, value_key, count_key)
+    @api.create_aggregation_log_entry(name, entry_name, comment, db, table, okeys, value_key, count_key)
+  end
+
+  # => true
+  def delete_aggregation_log_entry(name, entry_name)
+    @api.delete_aggregation_log_entry(name, entry_name)
+  end
+
+  # => true
+  def create_aggregation_attr_entry(name, entry_name, comment, db, table, method_name, parameters)
+    @api.create_aggregation_attr_entry(name, entry_name, comment, db, table, method_name, parameters)
+  end
+
+  # => true
+  def delete_aggregation_attr_entry(name, entry_name)
+    @api.delete_aggregation_attr_entry(name, entry_name)
+  end
 end
 
 

data/lib/td/client/api.rb

@@ -44,6 +44,10 @@ class API
     validate_database_name(name)
   end
 
+  def self.validate_result_set_name(name)
+    validate_database_name(name)
+  end
+
   def self.validate_column_name(name)
     name = name.to_s
     if name.empty?
@@ -204,7 +208,7 @@ class API
   ## Job API
   ##
 
-  # => [(jobId:String, type:Symbol, status:String, start_at:String, end_at:String)]
+  # => [(jobId:String, type:Symbol, status:String, start_at:String, end_at:String, rset:String)]
   def list_jobs(from=0, to=nil)
     params = {}
     params['from'] = from.to_s if from
@@ -223,12 +227,13 @@ class API
       query = m['query']
       start_at = m['start_at']
       end_at = m['end_at']
-      result << [job_id, type, status, query, start_at, end_at]
+      rset = m['result']
+      result << [job_id, type, status, query, start_at, end_at, rset]
     }
     return result
   end
 
-  # => (type:Symbol, status:String, result:String, url:String)
+  # => (type:Symbol, status:String, result:String, url:String, result:String)
   def show_job(job_id)
     code, body, res = get("/v3/job/show/#{e job_id}")
     if code != "200"
@@ -244,7 +249,8 @@ class API
     url = js['url']
     start_at = js['start_at']
     end_at = js['end_at']
-    return [type, query, status, url, debug, start_at, end_at]
+    result = js['result']
+    return [type, query, status, url, debug, start_at, end_at, result]
   end
 
   def job_result(job_id)
@@ -303,8 +309,10 @@ class API
   end
 
   # => jobId:String
-  def hive_query(q, db=nil)
-    code, body, res = post("/v3/job/issue/hive/#{e db}", {'query'=>q})
+  def hive_query(q, db=nil, rset=nil)
+    params = {'query' => q}
+    params['result'] = rset if rset
+    code, body, res = post("/v3/job/issue/hive/#{e db}", params)
     if code != "200"
       raise_error("Query failed", res)
     end
@@ -341,6 +349,7 @@ class API
     return js['cron'], js["query"]
   end
 
+  # => [(name:String, cron:String, query:String, database:String, rset:String)]
   def list_schedules
     code, body, res = get("/v3/schedule/list")
     if code != "200"
@@ -354,7 +363,8 @@ class API
       cron = m['cron']
       query = m['query']
       database = m['database']
-      result << [name, cron, query, database]
+      rset = m['result']
+      result << [name, cron, query, database, rset]
     }
     return result
   end
@@ -378,7 +388,8 @@ class API
       start_at = m['start_at']
       end_at = m['end_at']
       scheduled_at = m['scheduled_at']
-      result << [scheduled_at, job_id, type, status, query, start_at, end_at]
+      rset = m['result']
+      result << [scheduled_at, job_id, type, status, query, start_at, end_at, rset]
     }
     return result
   end
@@ -401,6 +412,185 @@ class API
   end
 
 
+  ####
+  ## Result set API
+  ##
+
+  # => (
+  #   info:(type:String, host:String, port:Integer, database:String, user:String, pass:String)
+  #   entries:[name:String]
+  # )
+  def list_result_set
+    code, body, res = get("/v3/result/list")
+    if code != "200"
+      raise_error("List result set failed", res)
+    end
+    # TODO format check
+    js = JSON.load(body)
+    type = (js["type"] || 'unknown').to_s
+    host = js["host"].to_s
+    port = js["port"].to_i
+    database = js["database"].to_s
+    user = js["user"].to_s
+    pass = js["pass"].to_s
+    names = (js["results"] || []).map {|rsets|
+      rsets['name'].to_s
+    }
+    info = [type, host, port, database, user, pass]
+    return info, names
+  end
+
+  # => true
+  def create_result_set(db)
+    code, body, res = post("/v3/result/create/#{e db}")
+    if code != "200"
+      raise_error("Create result set failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def delete_result_set(db)
+    code, body, res = post("/v3/result/delete/#{e db}")
+    if code != "200"
+      raise_error("Delete result set failed", res)
+    end
+    return true
+  end
+
+
+  ####
+  ## Aggregation Schema API
+  ##
+
+  # => [(name:String, relation_key:String)]
+  def list_aggregation_schema
+    code, body, res = get("/v3/aggr/list")
+    if code != "200"
+      raise_error("List aggregation schema failed", res)
+    end
+    # TODO format check
+    js = JSON.load(body)
+    result = js["aggrs"].map {|aggrinfo|
+      name = aggrinfo['name'].to_s
+      relation_key = aggrinfo['relation_key'].to_s
+      [name, relation_key]
+    }
+    return result
+  end
+
+  # => true
+  def create_aggregation_schema(name, relation_key)
+    params = {}
+    params['relation_key'] = relation_key if relation_key
+    code, body, res = post("/v3/aggr/create/#{e name}", params)
+    if code != "200"
+      raise_error("Create aggregation schema failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def delete_aggregation_schema(name)
+    code, body, res = post("/v3/aggr/delete/#{e name}")
+    if code != "200"
+      raise_error("Delete aggregation schema failed", res)
+    end
+    return true
+  end
+
+  # => [
+  #   {
+  #     relation_key: String,
+  #     logs: (entry_name:String, comment:String, database:String, table:String,
+  #            os:Array[String], value_key:String?, count_key:String?),
+  #     attrs: (entry_name:String, comment:String, database:String, table:String,
+  #            method_name:String, parameters:Hash[String=>Object])
+  #   }
+  # ]
+  def show_aggregation_schema(name)
+    code, body, res = get("/v3/aggr/show/#{e name}")
+    if code != "200"
+      raise_error("Show job failed", res)
+    end
+    # TODO format check
+    js = JSON.load(body)
+    relation_key = js['relation_key']
+    logs = js['logs'].map {|loginfo|
+      entry_name = loginfo['name'].to_s
+      comment = loginfo['comment'].to_s
+      database = loginfo['database'].to_s
+      table = loginfo['table'].to_s
+      os = loginfo['os']
+      value_key = loginfo['value_key'].to_s
+      count_key = loginfo['count_key'].to_s
+      value_key = nil if value_key.empty?
+      count_key = nil if count_key.empty?
+      [entry_name, comment, database, table, os, value_key, count_key]
+    }
+    attrs = js['attrs'].map {|attrinfo|
+      entry_name = attrinfo['name'].to_s
+      comment = attrinfo['comment'].to_s
+      database = attrinfo['database'].to_s
+      table = attrinfo['table'].to_s
+      method_name = attrinfo['method_name'].to_s
+      parameters = attrinfo['parameters'].to_s
+      parameters = "{}" if parameters.empty?
+      parameters = JSON.parse(parameters)
+      [entry_name, comment, database, table, method_name, parameters]
+    }
+    return [relation_key, logs, attrs]
+  end
+
+  # => true
+  def create_aggregation_log_entry(name, entry_name, comment, db, table, okeys, value_key, count_key)
+    params = {}
+    params['comment'] = comment if comment
+    okeys.each_with_index {|okey,i|
+      params["os[#{i}]"] = okey
+    }
+    params['value_key'] = value_key if value_key
+    params['count_key'] = count_key if count_key
+    code, body, res = post("/v3/aggr/entry/log/create/#{e name}/#{e entry_name}/#{e db}/#{e table}", params)
+    if code != "200"
+      raise_error("Create aggregation log entry failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def delete_aggregation_log_entry(name, entry_name)
+    code, body, res = post("/v3/aggr/entry/log/delete/#{e name}/#{e entry_name}")
+    if code != "200"
+      raise_error("Delete aggregation log entry failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def create_aggregation_attr_entry(name, entry_name, comment, db, table, method_name, parameters)
+    params = {}
+    parameters.each_pair {|k,v|
+      params["parameters[#{k}]"] = v.to_s
+    }
+    params['comment'] = comment if comment
+    code, body, res = post("/v3/aggr/entry/attr/create/#{e name}/#{e entry_name}/#{e db}/#{e table}/#{e method_name}", params)
+    if code != "200"
+      raise_error("Create aggregation attr entry failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def delete_aggregation_attr_entry(name, entry_name)
+    code, body, res = post("/v3/aggr/entry/attr/delete/#{e name}/#{e entry_name}")
+    if code != "200"
+      raise_error("Delete aggregation attr entry failed", res)
+    end
+    return true
+  end
+
+
   ####
   ## User API
   ##

data/lib/td/client/model.rb

@@ -148,7 +148,7 @@ class Job < Model
   STATUS_KILLED = "killed"
   FINISHED_STATUS = [STATUS_SUCCESS, STATUS_ERROR, STATUS_KILLED]
 
-  def initialize(client, job_id, type, query, status=nil, url=nil, debug=nil, start_at=nil, end_at=nil, result=nil)
+  def initialize(client, job_id, type, query, status=nil, url=nil, debug=nil, start_at=nil, end_at=nil, result=nil, rset=nil)
     super(client)
     @job_id = job_id
     @type = type
@@ -159,9 +159,10 @@ class Job < Model
     @start_at = start_at
     @end_at = end_at
     @result = result
+    @rset = rset
   end
 
-  attr_reader :job_id, :type
+  attr_reader :job_id, :type, :rset
 
   def wait(timeout=nil)
     # TODO
@@ -201,6 +202,10 @@ class Job < Model
     @end_at && !@end_at.empty? ? Time.parse(@end_at) : nil
   end
 
+  def rset_name
+    @rset ? @rset.name : nil
+  end
+
   def result
     unless @result
       return nil unless finished?
@@ -252,7 +257,7 @@ class Job < Model
   end
 
   def update_status!
-    query, status, url, debug, start_at, end_at = @client.job_status(@job_id)
+    query, status, url, debug, start_at, end_at, rset = @client.job_status(@job_id)
     @query = query
     @status = status
     @url = url
@@ -277,15 +282,107 @@ end
 
 
 class Schedule < Model
-  def initialize(client, name, cron, query, database=nil)
+  def initialize(client, name, cron, query, database=nil, rset=nil)
     super(client)
     @name = name
     @cron = cron
     @query = query
     @database = database
+    @rset = rset
+  end
+
+  def rset_name
+    @rset ? @rset.name : nil
+  end
+
+  attr_reader :name, :cron, :query, :database, :rset
+end
+
+
+class ResultSetInfo < Model
+  def initialize(client, type, host, port, database, user, password)
+    super(client)
+    @type = type
+    @host = host
+    @port = port
+    @database = database
+    @user = user
+    @password = password
+  end
+
+  attr_reader :type, :host, :port, :database, :user, :password
+end
+
+
+class ResultSet < Model
+  def initialize(client, name)
+    super(client)
+    @name = name
+  end
+
+  attr_reader :name
+end
+
+
+class AggregationSchema < Model
+  def initialize(client, name, relation_key, logs=nil, attributes=nil)
+    super(client)
+    @name = name
+    @relation_key = relation_key
+    @logs = logs
+    @attributes = attributes
+  end
+
+  attr_reader :name, :relation_key
+
+  def logs
+    update_entries! unless @logs
+    @logs
+  end
+
+  def attributes
+    update_entries! unless @attributes
+    @attributes
+  end
+
+  def update_entries!
+    sc = @client.aggregation_schema(@name)
+    @relation_key = sc.relation_key
+    @logs = sc.logs
+    @attributes = sc.attributes
+    self
+  end
+end
+
+
+class LogAggregationSchemaEntry < Model
+  def initialize(client, name, comment, table, okeys, value_key, count_key)
+    super(client)
+    @name = name
+    @comment = comment
+    @table = table
+    @okeys = okeys
+    @value_key = value_key
+    @count_key = count_key
+  end
+
+  attr_reader :name, :comment, :table
+  attr_reader :okeys, :value_key, :count_key
+end
+
+
+class AttributeAggregationSchemaEntry < Model
+  def initialize(client, name, comment, table, method_name, parameters)
+    super(client)
+    @name = name
+    @comment = comment
+    @table = table
+    @method_name = method_name
+    @parameters = parameters
   end
 
-  attr_reader :name, :cron, :query, :database
+  attr_reader :name, :comment, :table
+  attr_reader :method_name, :parameters
 end
 
 

data/lib/td/client/version.rb

@@ -1,5 +1,5 @@
 module TreasureData
 
-VERSION = '0.8.4'
+VERSION = '0.8.5'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: td-client
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-10 00:00:00.000000000Z
+date: 2011-12-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
-  requirement: &70306417282560 !ruby/object:Gem::Requirement
+  requirement: &70311656540280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.4.4
   type: :runtime
   prerelease: false
-  version_requirements: *70306417282560
+  version_requirements: *70311656540280
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70306417281540 !ruby/object:Gem::Requirement
+  requirement: &70311656539740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 1.4.3
   type: :runtime
   prerelease: false
-  version_requirements: *70306417281540
+  version_requirements: *70311656539740
 description: 
 email: 
 executables: []