influxdb-client 1.1.0.pre.323 → 1.1.0.pre.373

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5468123420673da53963b6610fc3c42ba6379a919b07d2e3623c949303962fd2
-  data.tar.gz: 1eaab67ebca09a668c1669780807808d3fe07fb973bd5f387e846be3fd7449db
+  metadata.gz: 83c5ef3d43578302150587bea139d9169dfc59736cf3bab4e360faa0b1f28257
+  data.tar.gz: 122c4b77d8ae2aa65eef10257a7f57d0c0b105e8a3e8dd29668be04a37159002
 SHA512:
-  metadata.gz: 1cd55d49226c9d1a8060fff080674c8e18118361296c7975dfd456e1465f969c376ddfe4b30f15341d333353abc0fa40c74992d50fc61e63252a97bc0c6463ea
-  data.tar.gz: c7044374c0f284f7b329a46dc0c9d6beb896554c49b166315997bf9e6df3136c9f295107030e08618401ab0a9f97be2997d0c3d51b499bdba262ddeb9f440841
+  metadata.gz: ab2b29dc351db166a073bdbaa9a7cc787f12fe75487907dd7e5a2dcc4f83967b6946279db6b29092e198668d9edeb8822d1c397f35b1144013bf378adf30758b
+  data.tar.gz: c9dff47d659d43afb66f2e1132660252df0f0e90f1ad0565b6a4c3e4838b96c228da349b549c167e5ac3b305780ebe6ed3774edcfbc51622ead1f5a6bcf57f24

data/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Features
 1. [#14](https://github.com/influxdata/influxdb-client-ruby/issues/14): Added QueryApi
+2. [#17](https://github.com/influxdata/influxdb-client-ruby/issues/17): Added query_steam
  
 ## 1.0.0.beta [2020-01-17]
 

data/README.md

@@ -63,6 +63,7 @@ The result retrieved by [QueryApi](https://github.com/influxdata/influxdb-client
 
    1. Raw query response
    2. Flux data structure: [FluxTable, FluxColumn and FluxRecord](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/flux_table.rb)
+   3. Stream of [FluxRecord](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/flux_table.rb)
 
 #### Query raw
 
@@ -86,6 +87,23 @@ query_api = client.create_query_api
 result = query_api.query(query: 'from(bucket:"' + bucket + '") |> range(start: 1970-01-01T00:00:00.000000001Z) |> last()')
 ```
 
+#### Query stream
+Synchronously executes the Flux query and return stream of [FluxRecord](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/flux_table.rb)
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org')
+
+query_api = client.create_query_api
+
+query = 'from(bucket: "my-bucket") |> range(start: -10m, stop: now()) ' \
+      "|> filter(fn: (r) => r._measurement == \"#{measurement}\")"
+
+query_api.query_stream(query: query).each do |record|
+  puts record.to_s
+end
+```
+
 ### Writing data
 
 ```ruby

data/lib/influxdb2/client/flux_csv_parser.rb

@@ -22,6 +22,7 @@ require 'base64'
 
 module InfluxDB2
   # This class represents Flux query error
+  #
   class FluxQueryError < StandardError
     def initialize(message, reference)
       super(message)
@@ -32,6 +33,7 @@ module InfluxDB2
   end
 
   # This class represents Flux query error
+  #
   class FluxCsvParserError < StandardError
     def initialize(message)
       super(message)
@@ -39,20 +41,28 @@ module InfluxDB2
   end
 
   # This class us used to construct FluxResult from CSV.
+  #
   class FluxCsvParser
-    def initialize
+    include Enumerable
+    def initialize(response, stream: false)
+      @response = response
+      @stream = stream
       @tables = {}
 
       @table_index = 0
       @start_new_table = false
       @table = nil
       @parsing_state_error = false
+
+      @closed = false
     end
 
-    attr_reader :tables
+    attr_reader :tables, :closed
+
+    def parse
+      @csv_file = CSV.new(@response.instance_of?(Net::HTTPOK) ? @response.body : @response)
 
-    def parse(response)
-      CSV.parse(response) do |csv|
+      while (csv = @csv_file.shift)
         # Response has HTTP status ok, but response is error.
         next if csv.empty?
 
@@ -68,10 +78,24 @@ module InfluxDB2
           raise FluxQueryError.new(error, reference_value.nil? || reference_value.empty? ? 0 : reference_value.to_i)
         end
 
-        _parse_line(csv)
+        result = _parse_line(csv)
+
+        yield result if @stream && result.instance_of?(InfluxDB2::FluxRecord)
+      end
+
+      self
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      parse do |record|
+        yield record
       end
 
-      @tables
+      self
+    ensure
+      _close_connection
     end
 
     private
@@ -84,7 +108,9 @@ module InfluxDB2
         # Return already parsed DataFrame
         @start_new_table = true
         @table = InfluxDB2::FluxTable.new
-        @tables[@table_index] = @table
+
+        @tables[@table_index] = @table unless @stream
+
         @table_index += 1
       elsif @table.nil?
         raise FluxCsvParserError, 'Unable to parse CSV response. FluxTable definition was not found.'
@@ -157,13 +183,17 @@ module InfluxDB2
           @table.columns.push(column)
         end
 
-        @tables[@table_index] = @table
+        @tables[@table_index] = @table unless @stream
         @table_index += 1
       end
 
       flux_record = _parse_record(@table_index - 1, @table, csv)
 
-      @tables[@table_index - 1].records.push(flux_record)
+      if @stream
+        flux_record
+      else
+        @tables[@table_index - 1].records.push(flux_record)
+      end
     end
 
     def _parse_record(table_index, table, csv)
@@ -206,5 +236,11 @@ module InfluxDB2
         str_val
       end
     end
+
+    def _close_connection
+      # Close CSV Parser
+      @csv_file.close
+      @closed = true
+    end
   end
 end

data/lib/influxdb2/client/query_api.rb

@@ -38,16 +38,7 @@ module InfluxDB2
     # @param [String] org specifies the source organization
     # @return [String] result of query
     def query_raw(query: nil, org: nil, dialect: DEFAULT_DIALECT)
-      org_param = org || @options[:org]
-      _check('org', org_param)
-
-      payload = _generate_payload(query, dialect)
-      return nil if payload.nil?
-
-      uri = URI.parse(File.join(@options[:url], '/api/v2/query'))
-      uri.query = URI.encode_www_form(org: org_param)
-
-      _post(payload.to_body.to_json, uri).read_body
+      _post_query(query: query, org: org, dialect: dialect).read_body
     end
 
     # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
@@ -55,13 +46,36 @@ module InfluxDB2
     # @return [Array] list of FluxTables which are matched the query
     def query(query: nil, org: nil, dialect: DEFAULT_DIALECT)
       response = query_raw(query: query, org: org, dialect: dialect)
-      parser = InfluxDB2::FluxCsvParser.new
+      parser = InfluxDB2::FluxCsvParser.new(response)
 
-      parser.parse(response)
+      parser.parse
+      parser.tables
+    end
+
+    # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
+    # @param [String] org specifies the source organization
+    # @return stream of Flux Records
+    def query_stream(query: nil, org: nil, dialect: DEFAULT_DIALECT)
+      response = _post_query(query: query, org: org, dialect: dialect)
+
+      InfluxDB2::FluxCsvParser.new(response, stream: true)
     end
 
     private
 
+    def _post_query(query: nil, org: nil, dialect: DEFAULT_DIALECT)
+      org_param = org || @options[:org]
+      _check('org', org_param)
+
+      payload = _generate_payload(query, dialect)
+      return nil if payload.nil?
+
+      uri = URI.parse(File.join(@options[:url], '/api/v2/query'))
+      uri.query = URI.encode_www_form(org: org_param)
+
+      _post(payload.to_body.to_json, uri)
+    end
+
     def _generate_payload(query, dialect)
       if query.nil?
         nil

data/test/influxdb/flux_csv_parser_test.rb

@@ -21,10 +21,6 @@
 require 'test_helper'
 
 class FluxCsvParserTest < MiniTest::Test
-  def setup
-    @parser = InfluxDB2::FluxCsvParser.new
-  end
-
   def test_multiple_values
     data = "#datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,string,string,string,string,long,long,string\n" \
       "#group,false,false,true,true,true,true,true,true,false,false,false\n" \
@@ -35,7 +31,7 @@ class FluxCsvParserTest < MiniTest::Test
       ",,2,1677-09-21T00:12:43.145224192Z,2018-07-16T11:21:02.547596934Z,usage_system,cpu,A,west,1444,38,test\n" \
       ',,3,1677-09-21T00:12:43.145224192Z,2018-07-16T11:21:02.547596934Z,user_usage,cpu,A,west,2401,49,test'
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
 
     column_headers = tables[0].columns
     assert_equal 11, column_headers.size
@@ -55,7 +51,7 @@ class FluxCsvParserTest < MiniTest::Test
       ",result,table,_start,_stop,_time,_value,_field,_measurement,host,value\n" \
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,true\n"
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
 
     assert_equal 1, tables.size
     assert_equal 1, tables[0].records.size
@@ -81,7 +77,7 @@ class FluxCsvParserTest < MiniTest::Test
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,x\n" \
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,\n"
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
     records = tables[0].records
 
     assert_equal true, records[0].values['value']
@@ -101,7 +97,7 @@ class FluxCsvParserTest < MiniTest::Test
 
     expected = 17_916_881_237_904_312_345
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
     records = tables[0].records
 
     assert_equal expected, records[0].values['value']
@@ -117,7 +113,7 @@ class FluxCsvParserTest < MiniTest::Test
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,12.25\n" \
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,\n" \
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
     records = tables[0].records
 
     assert_equal 12.25, records[0].values['value']
@@ -136,7 +132,7 @@ class FluxCsvParserTest < MiniTest::Test
       ',,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,' + encoded_data + "\n" \
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,\n"
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
     records = tables[0].records
 
     value = records[0].values['value']
@@ -156,7 +152,7 @@ class FluxCsvParserTest < MiniTest::Test
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,1970-01-01T00:00:10Z\n" \
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,\n"
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
     records = tables[0].records
 
     assert_equal Time.parse('1970-01-01T00:00:10Z').to_datetime.rfc3339, records[0].values['value']
@@ -172,7 +168,7 @@ class FluxCsvParserTest < MiniTest::Test
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,125\n" \
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,\n"
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
     records = tables[0].records
 
     assert_equal 125, records[0].values['value']
@@ -188,7 +184,7 @@ class FluxCsvParserTest < MiniTest::Test
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,125\n" \
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,\n" \
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
 
     assert_equal 10, tables[0].columns.size
     assert_equal 2, tables[0].group_key.size
@@ -203,7 +199,7 @@ class FluxCsvParserTest < MiniTest::Test
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,12.25\n" \
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,\n"
 
-    tables = @parser.parse(data)
+    tables = InfluxDB2::FluxCsvParser.new(data).parse.tables
     records = tables[0].records
 
     assert_equal '12.25', records[0].values['value']
@@ -278,10 +274,6 @@ class FluxCsvParserTest < MiniTest::Test
 end
 
 class FluxCsvParserErrorTest < MiniTest::Test
-  def setup
-    @parser = InfluxDB2::FluxCsvParser.new
-  end
-
   def test_error
     data = "#datatype,string,string\n" \
       "#group,true,true\n" \
@@ -289,8 +281,10 @@ class FluxCsvParserErrorTest < MiniTest::Test
       ",error,reference\n" \
       ',failed to create physical plan: invalid time bounds from procedure from: bounds contain zero time,897'
 
+    parser = InfluxDB2::FluxCsvParser.new(data)
+
     error = assert_raises InfluxDB2::FluxQueryError do
-      @parser.parse(data)
+      parser.parse
     end
 
     assert_equal 'failed to create physical plan: invalid time bounds from procedure from: bounds contain zero time',
@@ -305,8 +299,10 @@ class FluxCsvParserErrorTest < MiniTest::Test
       ",error,reference\n" \
       ',failed to create physical plan: invalid time bounds from procedure from: bounds contain zero time,'
 
+    parser = InfluxDB2::FluxCsvParser.new(data)
+
     error = assert_raises InfluxDB2::FluxQueryError do
-      @parser.parse(data)
+      parser.parse
     end
 
     assert_equal 'failed to create physical plan: invalid time bounds from procedure from: bounds contain zero time',
@@ -319,8 +315,10 @@ class FluxCsvParserErrorTest < MiniTest::Test
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,12.25\n" \
       ",,0,1970-01-01T00:00:10Z,1970-01-01T00:00:20Z,1970-01-01T00:00:10Z,10,free,mem,A,\n"
 
+    parser = InfluxDB2::FluxCsvParser.new(data)
+
     error = assert_raises InfluxDB2::FluxCsvParserError do
-      @parser.parse(data)
+      parser.parse
     end
 
     assert_equal 'Unable to parse CSV response. FluxTable definition was not found.', error.message

data/test/influxdb/query_api_stream_test.rb

@@ -0,0 +1,98 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'test_helper'
+
+class QueryApiStreamTest < MiniTest::Test
+  def setup
+    WebMock.allow_net_connect!
+
+    @client = InfluxDB2::Client.new('http://localhost:9999', 'my-token',
+                                    bucket: 'my-bucket',
+                                    org: 'my-org',
+                                    precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                    use_ssl: false)
+    @now = Time.now.utc
+  end
+
+  def test_query_stream
+    measurement = 'h2o_query_stream' + @now.to_i.to_s + @now.nsec.to_s
+    _write(10, measurement: measurement)
+
+    query = 'from(bucket: "my-bucket") |> range(start: -1m, stop: now()) ' \
+      "|> filter(fn: (r) => r._measurement == \"#{measurement}\")"
+
+    count = 0
+    @client.create_query_api.query_stream(query: query).each do |record|
+      count += 1
+      assert_equal measurement, record.measurement
+      assert_equal 'europe', record.values['location']
+      assert_equal count, record.value
+      assert_equal 'level', record.field
+    end
+
+    assert_equal 10, count
+  end
+
+  def test_query_stream_break
+    measurement = 'h2o_query_stream_break' + @now.to_i.to_s + @now.nsec.to_s
+    _write(20, measurement: measurement)
+
+    query = 'from(bucket: "my-bucket") |> range(start: -1m, stop: now()) ' \
+      "|> filter(fn: (r) => r._measurement == \"#{measurement}\")"
+
+    records = []
+
+    parser = @client.create_query_api.query_stream(query: query)
+
+    assert_equal false, parser.closed
+
+    count = 0
+    parser.each do |record|
+      records.push(record)
+      count += 1
+
+      break if count >= 5
+    end
+
+    assert_equal 5, records.size
+    assert_equal true, parser.closed
+
+    # record 1
+    record = records[0]
+    assert_equal measurement, record.measurement
+    assert_equal 'europe', record.values['location']
+    assert_equal 1, record.value
+    assert_equal 'level', record.field
+  end
+
+  private
+
+  def _write(values, measurement:)
+    write_api = @client.create_write_api
+
+    (1..values).each do |value|
+      write_api.write(data: InfluxDB2::Point.new(name: measurement)
+                                 .add_tag('location', 'europe')
+                                 .add_field('level', value)
+                                 .time(@now - values + value, InfluxDB2::WritePrecision::NANOSECOND))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre.323
+  version: 1.1.0.pre.373
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2020-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - test/influxdb/flux_csv_parser_test.rb
 - test/influxdb/point_test.rb
 - test/influxdb/query_api_integration_test.rb
+- test/influxdb/query_api_stream_test.rb
 - test/influxdb/query_api_test.rb
 - test/influxdb/write_api_integration_test.rb
 - test/influxdb/write_api_test.rb
@@ -197,6 +198,7 @@ test_files:
 - test/influxdb/flux_csv_parser_test.rb
 - test/influxdb/point_test.rb
 - test/influxdb/query_api_integration_test.rb
+- test/influxdb/query_api_stream_test.rb
 - test/influxdb/query_api_test.rb
 - test/influxdb/write_api_integration_test.rb
 - test/influxdb/write_api_test.rb