feat: add parameterized queries (#45)

Author: michaelahojna

CHANGELOG.md

@@ -5,6 +5,12 @@
 ### Bug Fixes
 1. [#46](https://github.com/influxdata/influxdb-client-swift/pull/46): Add missing PermissionResources from Cloud API definition
 
+### Features
+1. [#45](https://github.com/influxdata/influxdb-client-swift/pull/45): Add support for Parameterized Queries
+
+### Documentation
+1. [#45](https://github.com/influxdata/influxdb-client-swift/pull/45): Add Parameterized Queries example
+
 ## 0.9.0 [2021-11-26]
 
 ### Documentation

Examples/ParameterizedQuery/.swiftlint.yml

@@ -0,0 +1,36 @@
+opt_in_rules:
+  - array_init
+  - collection_alignment
+  - contains_over_first_not_nil
+  - closure_end_indentation
+  - closure_spacing
+  - conditional_returns_on_newline
+  - empty_count
+  - empty_string
+  - explicit_init
+  - explicit_self
+  - fatal_error_message
+  - first_where
+  - implicit_return
+  - missing_docs
+  - modifier_order
+  - multiline_arguments
+  - multiline_literal_brackets
+  - multiline_parameters
+  - operator_usage_whitespace
+  - pattern_matching_keywords
+  - redundant_nil_coalescing
+  - redundant_type_annotation
+  - sorted_first_last
+  - sorted_imports
+  - trailing_closure
+  - unneeded_parentheses_in_closure_argument
+  - unused_import
+  - unused_declaration
+  - vertical_parameter_alignment_on_call
+  - vertical_whitespace_closing_braces
+  - vertical_whitespace_opening_braces
+
+excluded:
+  - Package.swift
+  - .build/

Examples/ParameterizedQuery/Package.swift

@@ -0,0 +1,20 @@
+// swift-tools-version:5.3
+
+import PackageDescription
+
+let package = Package(
+        name: "ParameterizedQuery",
+        products: [
+            .executable(name: "parameterized-query", targets: ["ParameterizedQuery"])
+        ],
+        dependencies: [
+            .package(name: "influxdb-client-swift", path: "../../"),
+            .package(url: "https://github.com/apple/swift-argument-parser", from: "0.3.0")
+        ],
+        targets: [
+            .target(name: "ParameterizedQuery", dependencies: [
+                .product(name: "InfluxDBSwift", package: "influxdb-client-swift"),
+                .product(name: "ArgumentParser", package: "swift-argument-parser")
+            ])
+        ]
+)

Examples/ParameterizedQuery/README.md

@@ -0,0 +1,84 @@
+# ParameterizedQuery
+
+This is an example how to query with query parameters.
+The Telegraf sends data from [CPU Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/cpu/README.md) into InfluxDB 2.0.
+
+## Prerequisites:
+- Docker
+- Cloned examples:
+   ```bash
+   git clone [email protected]:influxdata/influxdb-client-swift.git
+   cd Examples/ParameterizedQuery
+   ```
+
+## Sources:
+- [Package.swift](/Examples/ParameterizedQuery/Package.swift)
+- [main.swift](/Examples/ParameterizedQuery/Sources/ParameterizedQuery/main.swift)
+
+## How to test:
+1. Start InfluxDB:
+    ```bash
+    docker run --rm \
+      --name influxdb_v2 \
+      --detach \
+      --publish 8086:8086 \
+      influxdb:latest
+    ```
+1. Configure your username, password, organization, bucket and token:
+   ```bash
+   docker run --rm \
+      --link influxdb_v2 \
+      curlimages/curl -s -i -X POST http://influxdb_v2:8086/api/v2/setup \
+         -H 'accept: application/json' \
+         -d '{"username": "my-user", "password": "my-password", "org": "my-org", "bucket": "my-bucket", "token": "my-token"}'
+   ```
+1. Start Telegraf as a source of data:
+   ```bash
+   docker run --rm \
+      --name telegraf \
+      --link influxdb_v2 \
+      --detach \
+      --env HOST_ETC=/hostfs/etc \
+      --env HOST_PROC=/hostfs/proc \
+      --env HOST_SYS=/hostfs/sys \
+      --env HOST_VAR=/hostfs/var \
+      --env HOST_RUN=/hostfs/run \
+      --env HOST_MOUNT_PREFIX=/hostfs \
+      --volume /:/hostfs:ro \
+      --volume $PWD/telegraf.conf:/etc/telegraf/telegraf.conf:ro \
+      telegraf
+   ```
+1. Start SwiftCLI by:
+   ```bash
+    docker run --rm \
+      --link influxdb_v2 \
+      --privileged \
+      --interactive \
+      --tty \
+      --volume $PWD/../..:/client \
+      --workdir /client/Examples/ParameterizedQuery \
+      swift:5.3 /bin/bash
+   ```
+1. Execute Query by:
+   ```bash
+   swift run parameterized-query --org my-org --bucket my-bucket --token my-token --url http://influxdb_v2:8086
+   ```
+   
+## Expected output
+
+```bash
+Query to execute:
+
+from(bucket: "my-bucket")
+    |> range(start: -10m)
+    |> filter(fn: (r) => r["_measurement"] == "cpu")
+    |> filter(fn: (r) => r["cpu"] == "cpu-total")
+    |> filter(fn: (r) => r["_field"] == "usage_user" or r["_field"] == "usage_system")
+    |> last()
+
+Success response...
+
+CPU usage:
+        usage_system: 22.717622080683473
+        usage_user: 61.46496815287725
+```

Examples/ParameterizedQuery/Sources/ParameterizedQuery/main.swift

@@ -0,0 +1,78 @@
+//
+// Warning: Parameterized Queries are supported only in InfluxDB Cloud, currently there is no support in InfluxDB OSS.
+//
+
+import ArgumentParser
+import Foundation
+import InfluxDBSwift
+
+struct ParameterizedQuery: ParsableCommand {
+    @Option(name: .shortAndLong, help: "The bucket to query. The name or id of the bucket destination.")
+    private var bucket: String
+
+    @Option(name: .shortAndLong,
+            help: "The organization executing the query. Takes either the `ID` or `Name` interchangeably.")
+    private var org: String
+
+    @Option(name: .shortAndLong, help: "Authentication token.")
+    private var token: String
+
+    @Option(name: .shortAndLong, help: "HTTP address of InfluxDB.")
+    private var url: String
+
+    public func run() {
+        // Initialize Client with default Organization
+        let client = InfluxDBClient(
+                url: url,
+                token: token,
+                options: InfluxDBClient.InfluxDBOptions(org: self.org))
+
+        // Flux query
+        let query = """
+                    from(bucket: params.bucketParam)
+                        |> range(start: duration(v: params.startParam))
+                        |> filter(fn: (r) => r["_measurement"] == "cpu")
+                        |> filter(fn: (r) => r["cpu"] == "cpu-total")
+                        |> filter(fn: (r) => r["_field"] == "usage_user" or r["_field"] == "usage_system")
+                        |> last()
+                    """
+        // Query parameters [String:String]
+        let queryParams = [ "bucketParam":"\(self.bucket)", "startParam":"-10m" ]
+
+        print("\nQuery to execute:\n\n\(query)\n\n\(queryParams)")
+
+        client.queryAPI.query(query: query, params: queryParams) { response, error in
+            // For handle error
+            if let error = error {
+                self.atExit(client: client, error: error)
+            }
+
+            // For Success response
+            if let response = response {
+                print("\nSuccess response...\n")
+                print("CPU usage:")
+                do {
+                    try response.forEach { record in
+                        print("\t\(record.values["_field"]!): \(record.values["_value"]!)")
+                    }
+                } catch {
+                    self.atExit(client: client, error: InfluxDBClient.InfluxDBError.cause(error))
+                }
+            }
+
+            self.atExit(client: client)
+        }
+
+        // Wait to end of script
+        RunLoop.current.run()
+    }
+
+    private func atExit(client: InfluxDBClient, error: InfluxDBClient.InfluxDBError? = nil) {
+        // Dispose the Client
+        client.close()
+        // Exit script
+        Self.exit(withError: error)
+    }
+}
+
+ParameterizedQuery.main()