daru-td 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 631763c13dcea8476948aa9a158a0172e9f57e0b
-  data.tar.gz: d07e39950c7e6652960f2f24cda6542ecead9d96
+  metadata.gz: 670482e222c3ba743ef4f8fceb62f21c7ace7191
+  data.tar.gz: 7f96f38abc3543d8e83d44365227edeff4a65f3e
 SHA512:
-  metadata.gz: 2eb0c9b47059a55518b220411e7bb91579cd5dc03155055a88b49351fb22aea2ea54c467bc211887e4dc9bc8cd969d7f89d1d3d4e5ff83baa7c2f65875f2d6df
-  data.tar.gz: 2e70fdf28a25e4183fde5538d1321f1847d3b8b5a75789cb9839a77027c571d19911b07b63f3e97dd3bd14e66a31734fa10dbd1866a8caf1120589e4a056b546
+  metadata.gz: 1b62680de8c4a441d542dbc7ea22a3920d707be76a9bb750c91f0f61de67227533bb648d9e66969c711f12af4ef96fb1ac4992e7b24cdc2091f3ac6ea65bf6fe
+  data.tar.gz: fe7f3df1871995feeaa3885224d424ea34a2351bf2c2201655e960845fbfe65f917a62c2509ee75af40afb006f51e28ef30ad58b19c41fe2b900cfdce9dc31ff

data/CHANGES.md

@@ -0,0 +1,13 @@
+# Changes
+
+## 0.2.0
+
+- :heavy_plus_sign: `Daru::TD.read_td_job`.
+
+## 0.1.1
+
+- :bug: Fix a critical NameError
+
+## 0.1.0
+
+- :tada: First release

data/README.md

@@ -39,11 +39,18 @@ df_tables = conn.tables('db_name')
 
 ```ruby
 engine = Daru::TD.create_engine('presto:sample_datasets', conn:conn)
-df_result = Daru::TD.read_td_query(<<-SQL, engine)
+df_query_result = Daru::TD.read_td_query(<<-SQL, engine)
   select * From nasdaq limit 3
 SQL
 ```
 
+### Read the result of the existing job
+
+```ruby
+job_id = 12345678
+df_job_result = Daru::TD.read_td_job(job_id, engine)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/daru/td.rb

@@ -58,6 +58,27 @@ module Daru
                              clear_progress: clear_progress)
     end
 
+    # Read Treasure Data query into a Daru's DataFrame.
+    #
+    # Returns a Daru::DataFrame corresponding to the result set of the query string.
+    #
+    # @param query [String]
+    #   Query string to be executed.
+    # @param engine [Daru::TD::QueryEngine]
+    #   Handler returned by create_engine.
+    # @param parse_dates [Array, nil]
+    #   When an Array given, it has column names to parse as dates.
+    # @param distributed_join [true, false]
+    #   (Presto only) If true, distributed join is enabled.
+    #   If false (default), broadcast join is used.
+    #   See https://prestodb.io/docs/current/release/release-0.77.html
+    # @params kwargs [Hash, nil]
+    #   Parameters to pass to execute method.
+    #   Available parameters:
+    #   - result_url [String] is result output URL.
+    #   - priority [Integer, String] is job's priority (e.g. "NORMAL", "HIGH", etc.)
+    #   - retry_limit [Integer] is retry limit.
+    # @return [Daru::DataFrame]
     def self.read_td_query(query, engine, **kwargs)
       distributed_join = kwargs.delete(:distributed_join)
       parse_dates = kwargs.delete(:parse_dates)
@@ -69,6 +90,24 @@ module Daru
       result.to_dataframe(parse_dates: parse_dates)
     end
 
+    # Read Treasure Data job result int a Daru's DataFrame.
+    #
+    # Returns a DataFrame corresponding to the result set of the job.
+    # This method waits for job completion if the specified job is still running.
+    #
+    # @param job_id [Integer] Job ID.
+    # @param engine [Daru::TD::QueryEngine]
+    #   Handler returned by create_engine.
+    # @param parse_dates [Array, nil]
+    #   When an Array given, it has column names to parse as dates.
+    # @return [Daru::DataFrame]
+    def self.read_td_job(job_id, engine, **kwargs)
+      parse_dates = kwargs.delete(:parse_dates)
+      job = QueryEngine::JobWrapper.new(engine.connection.client.job(job_id))
+      result = engine.get_result(job, wait: true)
+      result.to_dataframe(parse_dates: parse_dates)
+    end
+
     def self.parse_query(query_string)
       CGI.parse(query_string).tap do |hash|
         hash.keys.each do |key|

data/lib/daru/td/query_engine.rb

@@ -119,7 +119,9 @@ module Daru
       def render_progress_html_erb(given_binding)
         template = <<-'END_ERB'
 <div style="border-style: dashed; border-width: 1px;">
-  <%=html_text("issued at #{job.issued_at.iso8601}") %>
+  <% if job.issued_at %>
+  <%=  html_text("issued at #{job.issued_at.iso8601}") %>
+  <% end %>
   URL: <a href="<%=job.url %>" target="_blank"><%=job.url %></a><br>
   <% if job.type == :presto %>
   <%   if job.debug && job.debug['cmdout'] %>

data/lib/daru/td/version.rb

@@ -1,5 +1,5 @@
 module Daru
   module TD
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: daru-td
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenta Murata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-24 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -104,6 +104,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md