influxdb-client 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be3ac6c581d2ec4f1bea7183b78bc8d189510a9815cd54483e09611ca65402bd
-  data.tar.gz: 5c18d34011098b03d9226188d5663a1c16b2b02348931409bf7fb5fb832dbb10
+  metadata.gz: 5d6f5f89f9daa086decb93207d92e031202d6b710dc727c4ae57bc46944be578
+  data.tar.gz: 437d834ee65767d564211e114172cef9b2e256b3a9d523c9f649c5c35869062f
 SHA512:
-  metadata.gz: 5e998c044335d66a56dcf9b25e53fbdbac305307458a456a451c517698e2e6f1295ea44bb11142fbbad6e42856e1a0e5fa1f0c6105cc3a9711a1efdc30ebfe8f
-  data.tar.gz: 58626af8588b716b4b4edba032c0a5d28b8a5645080ad0cd2ba39ded13d529025c6029aee5ac66e687a6143c6c4795d356730f74fbc78f78d551299745194217
+  metadata.gz: caafd6227b5159448a486952e0943792aafced212a489771516da8a0ef3a0e9b6df14915202bfedb2c254c1c6887dcfa014c0712589060612799b3674483cef0
+  data.tar.gz: 588b2b3df0f49fa89db5d3e8ef30d946178c75d01a5e7f3346ca818edc58f986ffc35484981d24ef4104cc919eb0b9b21c68cf0c2e366880b47f3fec2d2f1039

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 2.2.0 [2022-02-18]
+
+### Features
+1. [#96](https://github.com/influxdata/influxdb-client-ruby/pull/96): Add support for Parameterized Queries
+
+### Bug Fixes
+1. [#97](https://github.com/influxdata/influxdb-client-ruby/pull/97): Add missing PermissionResources from Cloud API definition
+
+### Documentation
+1. [#96](https://github.com/influxdata/influxdb-client-ruby/pull/96): Add Parameterized Queries example
+
 ## 2.1.0 [2021-10-22]
 
 ### Features

data/README.md

@@ -64,13 +64,13 @@ The client can be installed manually or with bundler.
 To install the client gem manually:
 
 ```
-gem install influxdb-client -v 2.1.0
+gem install influxdb-client -v 2.2.0
 ```
 
 For management API:
 
 ```
-gem install influxdb-client-apis -v 2.1.0
+gem install influxdb-client-apis -v 2.2.0
 ```
 
 ## Usage
@@ -152,6 +152,33 @@ query_api.query_stream(query: query).each do |record|
 end
 ```
 
+#### Parameterized queries
+InfluxDB Cloud supports [Parameterized Queries](https://docs.influxdata.com/influxdb/cloud/query-data/parameterized-queries/)
+that let you dynamically change values in a query using the InfluxDB API. Parameterized queries make Flux queries more
+reusable and can also be used to help prevent injection attacks.
+
+InfluxDB Cloud inserts the params object into the Flux query as a Flux record named `params`. Use dot or bracket
+notation to access parameters in the `params` record in your Flux query. Parameterized Flux queries support only `int`
+, `float`, and `string` data types. To convert the supported data types into
+other [Flux basic data types, use Flux type conversion functions](https://docs.influxdata.com/influxdb/cloud/query-data/parameterized-queries/#supported-parameter-data-types).
+
+Parameterized query example:
+> :warning: Parameterized Queries are supported only in InfluxDB Cloud, currently there is no support in InfluxDB OSS.
+
+```ruby
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org')
+
+query = 'from(bucket: params.bucketParam) |> range(start: duration(v: params.startParam))'
+params = { 'bucketParam' => 'my-bucket', 'startParam' => '-1h' }
+
+query_api = client.create_query_api
+result = query_api.query(query: query, params: params)
+
+result[0].records.each { |record| puts "#{record.time} #{record.measurement}: #{record.field} #{record.value}" }
+```
+
 ### 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.
 

data/lib/influxdb2/client/models/query.rb

@@ -1,7 +1,7 @@
 =begin
-#Influx OSS API Service
+#InfluxDB OSS API Service
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. 
 
 The version of the OpenAPI document: 2.0.0
 
@@ -24,6 +24,9 @@ module InfluxDB2
     # The type of query. Must be \"flux\".
     attr_reader :type
 
+    # Enumeration of key/value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both) 
+    attr_accessor :params
+
     attr_accessor :dialect
 
     # Specifies the time that should be reported as \"now\" in the query. Default is the server's now time.
@@ -57,6 +60,7 @@ module InfluxDB2
         :'extern' => :'extern',
         :'query' => :'query',
         :'type' => :'type',
+        :'params' => :'params',
         :'dialect' => :'dialect',
         :'now' => :'now',
       }
@@ -68,6 +72,7 @@ module InfluxDB2
         :'extern' => :'File',
         :'query' => :'String',
         :'type' => :'String',
+        :'params' => :'Hash<String, Object>',
         :'dialect' => :'Dialect',
         :'now' => :'Time'
       }
@@ -106,6 +111,12 @@ module InfluxDB2
         self.type = attributes[:'type']
       end
 
+      if attributes.key?(:'params')
+        if (value = attributes[:'params']).is_a?(Hash)
+          self.params = value
+        end
+      end
+
       if attributes.key?(:'dialect')
         self.dialect = attributes[:'dialect']
       end
@@ -153,6 +164,7 @@ module InfluxDB2
           extern == o.extern &&
           query == o.query &&
           type == o.type &&
+          params == o.params &&
           dialect == o.dialect &&
           now == o.now
     end
@@ -166,7 +178,7 @@ module InfluxDB2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [extern, query, type, dialect, now].hash
+      [extern, query, type, params, dialect, now].hash
     end
 
     # Builds the object from hash

data/lib/influxdb2/client/query_api.rb

@@ -36,16 +36,18 @@ module InfluxDB2
 
     # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
     # @param [String] org specifies the source organization
+    # @param [Enumerable] params represent key/value pairs parameters to be injected into query
     # @return [String] result of query
-    def query_raw(query: nil, org: nil, dialect: DEFAULT_DIALECT)
-      _post_query(query: query, org: org, dialect: dialect).read_body
+    def query_raw(query: nil, org: nil, dialect: DEFAULT_DIALECT, params: nil)
+      _post_query(query: query, org: org, dialect: dialect, params: params).read_body
     end
 
     # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
     # @param [String] org specifies the source organization
+    # @param [Enumerable] params represent key/value pairs parameters to be injected into query
     # @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)
+    def query(query: nil, org: nil, dialect: DEFAULT_DIALECT, params: nil)
+      response = query_raw(query: query, org: org, dialect: dialect, params: params)
       parser = InfluxDB2::FluxCsvParser.new(response)
 
       parser.parse
@@ -54,20 +56,21 @@ module InfluxDB2
 
     # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
     # @param [String] org specifies the source organization
+    # @param [Enumerable] params represent key/value pairs parameters to be injected into query
     # @return stream of Flux Records
-    def query_stream(query: nil, org: nil, dialect: DEFAULT_DIALECT)
-      response = _post_query(query: query, org: org, dialect: dialect)
+    def query_stream(query: nil, org: nil, dialect: DEFAULT_DIALECT, params: nil)
+      response = _post_query(query: query, org: org, dialect: dialect, params: params)
 
       InfluxDB2::FluxCsvParser.new(response, stream: true)
     end
 
     private
 
-    def _post_query(query: nil, org: nil, dialect: DEFAULT_DIALECT)
+    def _post_query(query: nil, org: nil, dialect: DEFAULT_DIALECT, params: nil)
       org_param = org || @options[:org]
       _check('org', org_param)
 
-      payload = _generate_payload(query, dialect)
+      payload = _generate_payload(query: query, dialect: dialect, params: params)
       return nil if payload.nil?
 
       uri = _parse_uri('/api/v2/query')
@@ -76,16 +79,17 @@ module InfluxDB2
       _post_json(payload.to_body.to_json, uri)
     end
 
-    def _generate_payload(query, dialect)
+    def _generate_payload(query: nil, dialect: nil, params: nil)
       if query.nil?
         nil
       elsif query.is_a?(Query)
+        query.params = params unless params.nil?
         query
       elsif query.is_a?(String)
         if query.empty?
           nil
         else
-          Query.new(query: query, dialect: dialect, type: nil)
+          Query.new(query: query, dialect: dialect, type: nil, params: params)
         end
       end
     end

data/lib/influxdb2/client/version.rb

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

data/test/influxdb/query_api_test.rb

@@ -49,6 +49,27 @@ class QueryApiTest < MiniTest::Test
     assert_equal result, SUCCESS_DATA
   end
 
+  def test_parameterized_query_raw
+    body = '{"query":"from(bucket: params.bucketParam) |> range(start:  duration(v: params.startParam)) |> last()",' \
+'"params":{"bucketParam":"my-bucket","startParam":"1970-01-01T00:00:00.000000001Z"},' \
+'"dialect":{"header":true,"delimiter":",","annotations":["datatype","group","default"],' \
+'"commentPrefix":"#","dateTimeFormat":"RFC3339"}}'
+    stub_request(:post, 'http://localhost:8086/api/v2/query?org=my-org')
+      .with(body: body)
+      .to_return(body: SUCCESS_DATA)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   use_ssl: false)
+
+    query = 'from(bucket: params.bucketParam) |> range(start:  duration(v: params.startParam)) |> last()'
+    params = Hash['bucketParam' => 'my-bucket', 'startParam' => '1970-01-01T00:00:00.000000001Z']
+    result = client.create_query_api.query_raw(query: query, params: params)
+
+    assert_equal result, SUCCESS_DATA
+  end
+
   def test_query
     stub_request(:post, 'http://localhost:8086/api/v2/query?org=my-org')
       .to_return(body: SUCCESS_DATA)
@@ -73,6 +94,36 @@ class QueryApiTest < MiniTest::Test
     assert_equal 'free', record1.field
   end
 
+  def test_parameterized_query
+    body = '{"query":"from(bucket: params.bucketParam) |> range(start:  duration(v: params.startParam)) |> last()",' \
+'"params":{"bucketParam":"my-bucket","startParam":"1970-01-01T00:00:00.000000001Z"},' \
+'"dialect":{"header":true,"delimiter":",","annotations":["datatype","group","default"],' \
+'"commentPrefix":"#","dateTimeFormat":"RFC3339"}}'
+    stub_request(:post, 'http://localhost:8086/api/v2/query?org=my-org')
+      .with(body: body)
+      .to_return(body: SUCCESS_DATA)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   use_ssl: false)
+
+    query = 'from(bucket: params.bucketParam) |> range(start:  duration(v: params.startParam)) |> last()'
+    params = Hash['bucketParam' => 'my-bucket', 'startParam' => '1970-01-01T00:00:00.000000001Z']
+
+    result = client.create_query_api.query(query: query, params: params)
+
+    assert_equal 1, result.length
+    assert_equal 4, result[0].records.length
+
+    record1 = result[0].records[0]
+
+    assert_equal Time.parse('1970-01-01T00:00:10Z').to_datetime.rfc3339(9), record1.time
+    assert_equal 'mem', record1.measurement
+    assert_equal 10, record1.value
+    assert_equal 'free', record1.field
+  end
+
   def test_headers
     stub_request(:post, 'http://localhost:8086/api/v2/query?org=my-org')
       .to_return(body: SUCCESS_DATA)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-client
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-22 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler