feat: add an example how to define consistency with enterprise version

Author: bednar

client/src/main/java/com/influxdb/client/InfluxDBClientFactory.java

@@ -26,6 +26,7 @@
 
 import com.influxdb.client.domain.OnboardingRequest;
 import com.influxdb.client.domain.OnboardingResponse;
+import com.influxdb.client.domain.WriteConsistency;
 import com.influxdb.client.internal.InfluxDBClientImpl;
 import com.influxdb.utils.Arguments;
 
@@ -160,7 +161,7 @@ public static InfluxDBClient create(@Nonnull final String url,
     }
 
     /**
-     * Create a instance of the InfluxDB 2.x client to connect into InfluxDB 1.8.
+     * Create an instance of the InfluxDB 2.x client to connect into InfluxDB 1.8.
      *
      * @param url             the url to connect to the InfluxDB 1.8
      * @param username        authorization username
@@ -175,6 +176,31 @@ public static InfluxDBClient createV1(@Nonnull final String url,
                                           final char[] password,
                                           @Nonnull final String database,
                                           @Nullable final String retentionPolicy) {
+        return createV1(url, username, password, database, retentionPolicy, null);
+    }
+
+    /**
+     * Create an instance of the InfluxDB 2.x client to connect into InfluxDB 1.8.
+     *
+     * @param url             the url to connect to the InfluxDB 1.8
+     * @param username        authorization username
+     * @param password        authorization password
+     * @param database        database name
+     * @param retentionPolicy retention policy
+     * @param consistency     Specify the write consistency for the point.
+     *                        InfluxDB assumes that the write consistency is {@link  WriteConsistency#ONE} if you
+     *                        do not specify consistency. See the <a href="https://bit.ly/enterprise-consistency">
+     *                        InfluxDB Enterprise documentation</a> for detailed descriptions of each consistency
+     *                        option. <b>Available with InfluxDB Enterprise clusters only!</b>
+     * @return client
+     */
+    @Nonnull
+    public static InfluxDBClient createV1(@Nonnull final String url,
+                                          @Nullable final String username,
+                                          final char[] password,
+                                          @Nonnull final String database,
+                                          @Nullable final String retentionPolicy,
+                                          @Nullable final WriteConsistency consistency) {
 
         Arguments.checkNonEmpty(database, "database");
 
@@ -185,6 +211,7 @@ public static InfluxDBClient createV1(@Nonnull final String url,
                         username == null ? "" : username,
                         password == null ? "" : String.valueOf(password)).toCharArray())
                 .bucket(String.format("%s/%s", database, retentionPolicy == null ? "" : retentionPolicy))
+                .consistency(consistency)
                 .build();
 
         return create(options);

examples/README.md

@@ -7,7 +7,8 @@ This directory contains Java, Kotlin and Scala examples.
 - [ParameterizedQuery.java](src/main/java/example/ParameterizedQuery.java) - How to use Parameterized Queries
 
 ### Others
-- [InvocableScripts.py](src/main/java/example/InvocableScripts.java) - How to use Invocable scripts Cloud API to create custom endpoints that query data
+- [InvocableScripts.java](src/main/java/example/InvocableScripts.java) - How to use Invocable scripts Cloud API to create custom endpoints that query data
+- [InfluxDBEnterpriseExample.java](src/main/java/example/InfluxDBEnterpriseExample.java) - How to use `consistency` parameter for InfluxDB Enterprise
 
 ## Kotlin
 

examples/src/main/java/example/InfluxDBEnterpriseExample.java

@@ -0,0 +1,71 @@
+/*
+ * 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.
+ */
+package example;
+
+import com.influxdb.client.InfluxDBClient;
+import com.influxdb.client.InfluxDBClientFactory;
+import com.influxdb.client.WriteApiBlocking;
+import com.influxdb.client.domain.WriteConsistency;
+import com.influxdb.client.domain.WritePrecision;
+import com.influxdb.client.write.WriteParameters;
+
+/**
+ * How to use `consistency` parameter for InfluxDB Enterprise.
+ * 
+ * @author Jakub Bednar (12/04/2022 11:00)
+ */
+public class InfluxDBEnterpriseExample {
+
+    private static final String URL = "http://ec2-13-57-181-120.us-west-1.compute.amazonaws.com:8086";
+    /**
+     * Credentials
+     */
+    private static final String USERNAME = "username";
+    private static final String PASSWORD = "password";
+    /**
+     * Database name
+     */
+    private static final String DB = "benchmark_db";
+    /**
+     * Retention policy name
+     */
+    private static final String RP = "autogen";
+
+    public static void main(final String[] args) {
+
+        try (InfluxDBClient client = InfluxDBClientFactory.createV1(URL, USERNAME, PASSWORD.toCharArray(), DB, RP)) {
+
+            System.out.println("--- Write Record ---");
+
+            // Initialize Blocking API
+            WriteApiBlocking writeApi = client.getWriteApiBlocking();
+
+            // Configure precision and consistency
+            WriteParameters parameters = new WriteParameters(WritePrecision.NS, WriteConsistency.ALL);
+
+            // Write record
+            writeApi.writeRecord("cpu_load_short,host=server02 value=0.67", parameters);
+
+            System.out.println("--- Written data with consistency set to: ALL ---");
+        }
+    }
+}