influxdb-client 1.1.0.pre.323 → 1.2.0.pre.503

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5468123420673da53963b6610fc3c42ba6379a919b07d2e3623c949303962fd2
-  data.tar.gz: 1eaab67ebca09a668c1669780807808d3fe07fb973bd5f387e846be3fd7449db
+  metadata.gz: 369c8281b3985a0757703f1c68a95d25793508a8c1c3c6dd458646ae01c768d8
+  data.tar.gz: 82c4dae23afd29ccb574a6314443ef53fc4fe3ff17f9f952d435c7522441d7e3
 SHA512:
-  metadata.gz: 1cd55d49226c9d1a8060fff080674c8e18118361296c7975dfd456e1465f969c376ddfe4b30f15341d333353abc0fa40c74992d50fc61e63252a97bc0c6463ea
-  data.tar.gz: c7044374c0f284f7b329a46dc0c9d6beb896554c49b166315997bf9e6df3136c9f295107030e08618401ab0a9f97be2997d0c3d51b499bdba262ddeb9f440841
+  metadata.gz: 17c810f5d87978b3c7359031b52fa86d39c06d70bb118a15e4f686f5f0b515de2001bc77cae24bce50a1dec6d4f3b366b104997e657d61219586e266c67b3d4b
+  data.tar.gz: 5255b4b24ffd03b9895c624a501e765881a944368cd31d41eb02c421b29344955ad941532df9d02b416acb0ab9a7ff389142c432fca974ecf301ef88ba3f7c88

data/CHANGELOG.md

@@ -1,7 +1,14 @@
-## 1.1.0 [unreleased]
+## 1.2.0 [unreleased]
+
+### Bugs
+1. [#22](https://github.com/influxdata/influxdb-client-ruby/pull/22): Fixed batch write
+
+## 1.1.0 [2020-02-14]
 
 ### 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 possibility to stream query result
+3. [#19](https://github.com/influxdata/influxdb-client-ruby/issues/19): Added WriteOptions and possibility to batch write
  
 ## 1.0.0.beta [2020-01-17]
 

data/README.md

@@ -11,7 +11,6 @@
 This repository contains the reference Ruby client for the InfluxDB 2.0.
 
 #### Note: This library is for use with InfluxDB 2.x. For connecting to InfluxDB 1.x instances, please use the [influxdb-ruby](https://github.com/influxdata/influxdb-ruby) client.
-#### Disclaimer: This library is a work in progress and should not be considered production ready yet.
 
 ## Installation
 
@@ -24,7 +23,7 @@ The client can be installed manually or with bundler.
 To install the client gem manually:
 
 ```
-gem install influxdb-client -v 1.0.0.beta
+gem install influxdb-client -v 1.1.0
 ```
 
 ## Usage
@@ -63,6 +62,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,7 +86,25 @@ 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
+The [WriteApi](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/write_api.rb) supports synchronous and batching writes into InfluxDB 2.0. In default api uses synchronous write. To enable batching you can use WriteOption.
 
 ```ruby
 client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
@@ -98,6 +116,28 @@ write_api = client.create_write_api
 write_api.write(data: 'h2o,location=west value=33i 15')
 ```
 
+#### Batching
+The writes are processed in batches which are configurable by `WriteOptions`:
+
+| Property | Description | Default Value |
+| --- | --- | --- |
+| **batchSize** | the number of data point to collect in batch | 1000 |
+| **flushInterval** | the number of milliseconds before the batch is written | 1000 |
+
+```ruby
+write_options = InfluxDB2::WriteOptions.new(write_type: InfluxDB2::WriteType::BATCHING,
+                                            batch_size: 10, flush_interval: 5_000)
+client = InfluxDB2::Client.new('http://localhost:9999',
+                               'my-token',
+                               bucket: 'my-bucket',
+                               org: 'my-org',
+                               precision: InfluxDB2::WritePrecision::NANOSECOND,
+                               use_ssl: false)
+
+write_api = client.create_write_api(write_options: write_options)
+write_api.write(data: 'h2o,location=west value=33i 15')
+```
+
 #### Time precision
 
 Configure default time precision:
@@ -117,7 +157,6 @@ client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
 write_api = client.create_write_api
 write_api.write(data: 'h2o,location=west value=33i 15', precision: InfluxDB2::WritePrecision::SECOND)
 ```
-
 Allowed values for precision are:
 - `InfluxDB::WritePrecision::NANOSECOND` for nanosecond
 - `InfluxDB::WritePrecision::MICROSECOND` for microsecond

data/lib/influxdb2/client/client.rb

@@ -45,6 +45,7 @@ module InfluxDB2
     # @option options [bool] :use_ssl Turn on/off SSL for HTTP communication
     #   the body line-protocol
     def initialize(url, token, options = nil)
+      @auto_closeable = []
       @options = options ? options.dup : {}
       @options[:url] = url if url.is_a? String
       @options[:token] = token if token.is_a? String
@@ -56,8 +57,10 @@ module InfluxDB2
     # Write time series data into InfluxDB thought WriteApi.
     #
     # @return [WriteApi] New instance of WriteApi.
-    def create_write_api
-      WriteApi.new(options: @options)
+    def create_write_api(write_options: InfluxDB2::SYNCHRONOUS)
+      write_api = WriteApi.new(options: @options, write_options: write_options)
+      @auto_closeable.push(write_api)
+      write_api
     end
 
     # Get the Query client.
@@ -72,6 +75,7 @@ module InfluxDB2
     # @return [ true ] Always true.
     def close!
       @closed = true
+      @auto_closeable.each(&:close!)
       true
     end
   end

data/lib/influxdb2/client/flux_csv_parser.rb

@@ -19,9 +19,11 @@
 # THE SOFTWARE.
 require 'csv'
 require 'base64'
+require 'time'
 
 module InfluxDB2
   # This class represents Flux query error
+  #
   class FluxQueryError < StandardError
     def initialize(message, reference)
       super(message)
@@ -32,6 +34,7 @@ module InfluxDB2
   end
 
   # This class represents Flux query error
+  #
   class FluxCsvParserError < StandardError
     def initialize(message)
       super(message)
@@ -39,20 +42,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 +79,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 +109,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 +184,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 +237,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/point.rb

@@ -45,6 +45,7 @@ module InfluxDB2
       @time = time
       @precision = precision
     end
+    attr_reader :precision
 
     # Create DataPoint instance from specified data.
     #

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/lib/influxdb2/client/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module InfluxDB2
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/influxdb2/client/worker.rb

@@ -0,0 +1,93 @@
+# 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.
+
+module InfluxDB2
+  # Worker for handling write batching queue
+  #
+  class Worker
+    def initialize(api_client, write_options)
+      @api_client = api_client
+      @write_options = write_options
+
+      @queue = Queue.new
+      @queue_event = Queue.new
+
+      @queue_event.push(true)
+
+      @thread_flush = Thread.new do
+        until api_client.closed
+          sleep @write_options.flush_interval / 1_000
+          check_background_queue
+        end
+      end
+
+      @thread_size = Thread.new do
+        until api_client.closed
+          check_background_queue(size: true) if @queue.length >= @write_options.batch_size
+          sleep 0.01
+        end
+      end
+    end
+
+    def push(payload)
+      @queue.push(payload)
+    end
+
+    def check_background_queue(size: false)
+      @queue_event.pop
+      data = {}
+      points = 0
+
+      if size && @queue.length < @write_options.batch_size
+        @queue_event.push(true)
+        return
+      end
+
+      while (points < @write_options.batch_size) && !@queue.empty?
+        begin
+          item = @queue.pop(true)
+          key = item.key
+          data[key] = [] unless data.key?(key)
+          data[key] << item.data
+          points += 1
+        rescue ThreadError
+          @queue_event.push(true)
+          return
+        end
+      end
+
+      begin
+        write(data) unless data.values.flatten.empty?
+      ensure
+        @queue_event.push(true)
+      end
+    end
+
+    def flush_all
+      check_background_queue until @queue.empty?
+    end
+
+    def write(data)
+      data.each do |key, points|
+        @api_client.write_raw(points.join("\n"), precision: key.precision, bucket: key.bucket, org: key.org)
+      end
+    end
+  end
+end

data/lib/influxdb2/client/write_api.rb

@@ -17,8 +17,31 @@
 # 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_relative 'worker'
 
 module InfluxDB2
+  module WriteType
+    SYNCHRONOUS = 1
+    BATCHING = 2
+  end
+
+  # Creates write api configuration.
+  #
+  # @param write_type: methods of write (batching, asynchronous, synchronous)
+  # @param batch_size: the number of data point to collect in batch
+  # @param flush_interval: flush data at least in this interval
+  class WriteOptions
+    def initialize(write_type: WriteType::SYNCHRONOUS, batch_size: 1_000, flush_interval: 1_000)
+      @write_type = write_type
+      @batch_size = batch_size
+      @flush_interval = flush_interval
+    end
+
+    attr_reader :write_type, :batch_size, :flush_interval
+  end
+
+  SYNCHRONOUS = InfluxDB2::WriteOptions.new(write_type: WriteType::SYNCHRONOUS)
+
   # Precision constants.
   #
   class WritePrecision
@@ -39,9 +62,13 @@ module InfluxDB2
   #
   class WriteApi < DefaultApi
     # @param [Hash] options The options to be used by the client.
-    def initialize(options:)
+    # @param [WriteOptions] write_options Write api configuration.
+    def initialize(options:, write_options: SYNCHRONOUS)
       super(options: options)
+      @write_options = write_options
+      @closed = false
     end
+    attr_reader :closed
 
     # Write data into specified Bucket.
     #
@@ -83,33 +110,108 @@ module InfluxDB2
       _check('bucket', bucket_param)
       _check('org', org_param)
 
-      payload = _generate_payload(data)
+      payload = _generate_payload(data, bucket: bucket_param, org: org_param, precision: precision_param)
       return nil if payload.nil?
 
+      if WriteType::BATCHING == @write_options.write_type
+        _worker.push(payload)
+      else
+        write_raw(payload, precision: precision_param, bucket: bucket_param, org: org_param)
+      end
+    end
+
+    # @return [ true ] Always true.
+    def close!
+      _worker.flush_all unless _worker.nil?
+      @closed = true
+      true
+    end
+
+    # @param [String] payload data as String
+    # @param [WritePrecision] precision The precision for the unix timestamps within the body line-protocol
+    # @param [String] bucket specifies the destination bucket for writes
+    # @param [String] org specifies the destination organization for writes
+    def write_raw(payload, precision: nil, bucket: nil, org: nil)
+      precision_param = precision || @options[:precision]
+      bucket_param = bucket || @options[:bucket]
+      org_param = org || @options[:org]
+      _check('precision', precision_param)
+      _check('bucket', bucket_param)
+      _check('org', org_param)
+
+      return nil unless payload.instance_of?(String) || payload.empty?
+
       uri = URI.parse(File.join(@options[:url], '/api/v2/write'))
       uri.query = URI.encode_www_form(bucket: bucket_param, org: org_param, precision: precision_param.to_s)
 
       _post(payload, uri)
     end
 
+    # Item for batching queue
+    class BatchItem
+      def initialize(key, data)
+        @key = key
+        @data = data
+      end
+      attr_reader :key, :data
+    end
+
+    # Key for batch item
+    class BatchItemKey
+      def initialize(bucket, org, precision = DEFAULT_WRITE_PRECISION)
+        @bucket = bucket
+        @org = org
+        @precision = precision
+      end
+      attr_reader :bucket, :org, :precision
+
+      def ==(other)
+        @bucket == other.bucket && @org == other.org && @precision == other.precision
+      end
+
+      alias eql? ==
+
+      def hash
+        @bucket.hash ^ @org.hash ^ @precision.hash # XOR
+      end
+    end
+
     private
 
-    def _generate_payload(data)
+    WORKER_MUTEX = Mutex.new
+    def _worker
+      return nil unless @write_options.write_type == WriteType::BATCHING
+
+      return @worker if @worker
+
+      WORKER_MUTEX.synchronize do
+        # this return is necessary because the previous mutex holder
+        # might have already assigned the @worker
+        return @worker if @worker
+
+        @worker = Worker.new(self, @write_options)
+      end
+    end
+
+    def _generate_payload(data, precision: nil, bucket: nil, org: nil)
       if data.nil?
         nil
       elsif data.is_a?(Point)
-        data.to_line_protocol
+        _generate_payload(data.to_line_protocol, bucket: bucket, org: org, precision: data.precision ||
+            DEFAULT_WRITE_PRECISION)
       elsif data.is_a?(String)
         if data.empty?
           nil
+        elsif @write_options.write_type == WriteType::BATCHING
+          BatchItem.new(BatchItemKey.new(bucket, org, precision), data)
         else
           data
         end
       elsif data.is_a?(Hash)
-        _generate_payload(Point.from_hash(data))
+        _generate_payload(Point.from_hash(data), bucket: bucket, org: org, precision: precision)
       elsif data.respond_to? :map
         data.map do |item|
-          _generate_payload(item)
+          _generate_payload(item, bucket: bucket, org: org, precision: precision)
         end.reject(&:nil?).join("\n".freeze)
       end
     end

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

data/test/influxdb/write_api_batching_test.rb

@@ -0,0 +1,166 @@
+# 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 WriteApiBatchingTest < MiniTest::Test
+  def setup
+    WebMock.disable_net_connect!
+
+    @write_options = InfluxDB2::WriteOptions.new(write_type: InfluxDB2::WriteType::BATCHING,
+                                                 batch_size: 2, flush_interval: 5_000)
+    @client = InfluxDB2::Client.new('http://localhost:9999',
+                                    'my-token',
+                                    bucket: 'my-bucket',
+                                    org: 'my-org',
+                                    precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                    use_ssl: false)
+
+    @write_client = @client.create_write_api(write_options: @write_options)
+  end
+
+  def teardown
+    @client.close!
+
+    assert_equal true, @write_client.closed
+
+    WebMock.reset!
+  end
+
+  def test_batch_size
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=4.0 4')
+
+    sleep(1)
+
+    request1 = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
+               'h2o_feet,location=coyote_creek level\\ water_level=2.0 2'
+    request2 = "h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n" \
+               'h2o_feet,location=coyote_creek level\\ water_level=4.0 4'
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: request1)
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: request2)
+  end
+
+  def test_batch_size_group_by
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=s')
+      .to_return(status: 204)
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org-a&precision=ns')
+      .to_return(status: 204)
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket2&org=my-org-a&precision=ns')
+      .to_return(status: 204)
+
+    bucket = 'my-bucket'
+    bucket2 = 'my-bucket2'
+    org_a = 'my-org-a'
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1', bucket: bucket, org: 'my-org')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2', bucket: bucket, org: 'my-org',
+                        precision: InfluxDB2::WritePrecision::SECOND)
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3', bucket: bucket, org: org_a)
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=4.0 4', bucket: bucket, org: org_a)
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=5.0 5', bucket: bucket2, org: org_a)
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=6.0 6', bucket: bucket, org: org_a)
+
+    sleep(1)
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1')
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=s',
+                     times: 1, body: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2')
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org-a&precision=ns',
+                     times: 1, body: "h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n" \
+                    'h2o_feet,location=coyote_creek level\\ water_level=4.0 4')
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket2&org=my-org-a&precision=ns',
+                     times: 1, body: 'h2o_feet,location=coyote_creek level\\ water_level=5.0 5')
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org-a&precision=ns',
+                     times: 1, body: 'h2o_feet,location=coyote_creek level\\ water_level=6.0 6')
+  end
+
+  def test_flush_interval
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    request1 = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
+               'h2o_feet,location=coyote_creek level\\ water_level=2.0 2'
+    request2 = 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3'
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2')
+
+    sleep(1)
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: request1)
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+
+    sleep(2)
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 0, body: request2)
+
+    sleep(3)
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: request2)
+  end
+
+  def test_flush_all_by_close_client
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    @client.close!
+
+    @write_options = InfluxDB2::WriteOptions.new(write_type: InfluxDB2::WriteType::BATCHING,
+                                                 batch_size: 10, flush_interval: 5_000)
+    @client = InfluxDB2::Client.new('http://localhost:9999',
+                                    'my-token',
+                                    bucket: 'my-bucket',
+                                    org: 'my-org',
+                                    precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                    use_ssl: false)
+
+    @write_client = @client.create_write_api(write_options: @write_options)
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 0, body: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+
+    @client.close!
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
+                     "h2o_feet,location=coyote_creek level\\ water_level=2.0 2\n" \
+                     'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+  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.2.0.pre.503
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,12 +157,15 @@ files:
 - lib/influxdb2/client/point.rb
 - lib/influxdb2/client/query_api.rb
 - lib/influxdb2/client/version.rb
+- lib/influxdb2/client/worker.rb
 - lib/influxdb2/client/write_api.rb
 - test/influxdb/client_test.rb
 - 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_batching_test.rb
 - test/influxdb/write_api_integration_test.rb
 - test/influxdb/write_api_test.rb
 - test/test_helper.rb
@@ -197,7 +200,9 @@ 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_batching_test.rb
 - test/influxdb/write_api_integration_test.rb
 - test/influxdb/write_api_test.rb
 - test/test_helper.rb