feat: add HTTP proxy and custom headers support (#30)

* feat: add HTTP proxy and custom headers support

* fix: uniform client API (#31)

Author: alespour

CHANGELOG.md

@@ -3,6 +3,11 @@
 ### Features
 
 1. [#27](https://github.com/InfluxCommunity/influxdb3-java/pull/27): Add GZIP support
+1. [#30](https://github.com/InfluxCommunity/influxdb3-java/pull/30): Add HTTP proxy and custom headers support
+
+### Breaking Changes
+
+1. [#31](https://github.com/InfluxCommunity/influxdb3-java/pull/31): Renamed config types and some options
 
 ## 0.1.0 [2023-06-08]
 

README.md

@@ -68,16 +68,16 @@ import java.time.Instant;
 import java.util.stream.Stream;
 
 import com.influxdb.v3.client.InfluxDBClient;
-import com.influxdb.v3.client.query.QueryParameters;
+import com.influxdb.v3.client.query.QueryOptions;
 import com.influxdb.v3.client.write.Point;
 
 public class IOxExample {
     public static void main(String[] args) throws Exception {
-        String hostUrl = "https://us-east-1-1.aws.cloud2.influxdata.com";
-        char[] authToken = "my-token".toCharArray();
+        String host = "https://us-east-1-1.aws.cloud2.influxdata.com";
+        char[] token = "my-token".toCharArray();
         String database = "database";
 
-        try (InfluxDBClient client = InfluxDBClient.getInstance(hostUrl, authToken, database)) {
+        try (InfluxDBClient client = InfluxDBClient.getInstance(host, token, database)) {
             // ...
         }
     }
@@ -128,7 +128,7 @@ System.out.printf("| %-16s | %-18s |%n", "time", "mean");
 System.out.printf("-----------------------------------------%n");
 
 String influxQL = "select MEAN(value) from temperature group by time(1d) fill(none) order by time desc limit 10";
-try (Stream<Object[]> stream = client.query(influxQL, QueryParameters.INFLUX_QL)) {
+try (Stream<Object[]> stream = client.query(influxQL, QueryOptions.INFLUX_QL)) {
     stream.forEach(row -> System.out.printf("| %-16s | %-18s |%n", row[1], row[2]));
 }
 

examples/src/main/java/com/influxdb/v3/IOxExample.java

@@ -25,7 +25,7 @@
 import java.util.stream.Stream;
 
 import com.influxdb.v3.client.InfluxDBClient;
-import com.influxdb.v3.client.query.QueryParameters;
+import com.influxdb.v3.client.query.QueryOptions;
 import com.influxdb.v3.client.write.Point;
 
 /**
@@ -37,11 +37,11 @@ private IOxExample() {
     }
 
     public static void main(final String[] args) throws Exception {
-        String hostUrl = "https://us-east-1-1.aws.cloud2.influxdata.com";
-        char[] authToken = "my-token".toCharArray();
-        String database = "database";
+        String host = "https://us-east-1-1.aws.cloud2.influxdata.com";
+        String token = "my-token";
+        String database = "my-database";
 
-        try (InfluxDBClient client = InfluxDBClient.getInstance(hostUrl, authToken, database)) {
+        try (InfluxDBClient client = InfluxDBClient.getInstance(host, token.toCharArray(), database)) {
 
             //
             // Write by Point
@@ -81,7 +81,7 @@ public static void main(final String[] args) throws Exception {
 
             String influxQL =
                     "select MEAN(value) from temperature group by time(1d) fill(none) order by time desc limit 10";
-            try (Stream<Object[]> stream = client.query(influxQL, QueryParameters.INFLUX_QL)) {
+            try (Stream<Object[]> stream = client.query(influxQL, QueryOptions.INFLUX_QL)) {
                 stream.forEach(row -> System.out.printf("| %-16s | %-18s |%n", row[1], row[2]));
             }
 

src/main/java/com/influxdb/v3/client/InfluxDBClient.java

@@ -28,11 +28,11 @@
 
 import org.apache.arrow.vector.VectorSchemaRoot;
 
-import com.influxdb.v3.client.config.InfluxDBClientConfigs;
+import com.influxdb.v3.client.config.ClientConfig;
 import com.influxdb.v3.client.internal.InfluxDBClientImpl;
-import com.influxdb.v3.client.query.QueryParameters;
+import com.influxdb.v3.client.query.QueryOptions;
 import com.influxdb.v3.client.write.Point;
-import com.influxdb.v3.client.write.WriteParameters;
+import com.influxdb.v3.client.write.WriteOptions;
 
 /**
  * The InfluxDBClient interface provides a client for interact with InfluxDB 3.
@@ -51,10 +51,10 @@ public interface InfluxDBClient extends AutoCloseable {
     /**
      * Write a record specified in the InfluxDB Line Protocol to the InfluxDB server.
      *
-     * @param record     the record specified in the InfluxDB Line Protocol, can be null
-     * @param parameters the parameters for writing data to InfluxDB
+     * @param record    the record specified in the InfluxDB Line Protocol, can be null
+     * @param options  the options for writing data to InfluxDB
      */
-    void writeRecord(@Nullable final String record, @Nonnull final WriteParameters parameters);
+    void writeRecord(@Nullable final String record, @Nonnull final WriteOptions options);
 
     /**
      * Write records specified in the InfluxDB Line Protocol to the InfluxDB server.
@@ -67,9 +67,9 @@ public interface InfluxDBClient extends AutoCloseable {
      * Write records specified in the InfluxDB Line Protocol to the InfluxDB server.
      *
      * @param records    the records specified in the InfluxDB Line Protocol, cannot be null
-     * @param parameters the parameters for writing data to InfluxDB
+     * @param options the options for writing data to InfluxDB
      */
-    void writeRecords(@Nonnull final List<String> records, @Nonnull final WriteParameters parameters);
+    void writeRecords(@Nonnull final List<String> records, @Nonnull final WriteOptions options);
 
     /**
      * Write a {@link Point} to the InfluxDB server.
@@ -82,9 +82,9 @@ public interface InfluxDBClient extends AutoCloseable {
      * Write a {@link Point} to the InfluxDB server.
      *
      * @param point      the {@link Point} to write, can be null
-     * @param parameters the parameters for writing data to InfluxDB
+     * @param options the options for writing data to InfluxDB
      */
-    void writePoint(@Nullable final Point point, @Nonnull final WriteParameters parameters);
+    void writePoint(@Nullable final Point point, @Nonnull final WriteOptions options);
 
     /**
      * Write a list of {@link Point} to the InfluxDB server.
@@ -97,9 +97,9 @@ public interface InfluxDBClient extends AutoCloseable {
      * Write a list of {@link Point} to the InfluxDB server.
      *
      * @param points     the list of {@link Point} to write, cannot be null
-     * @param parameters the parameters for writing data to InfluxDB
+     * @param options the options for writing data to InfluxDB
      */
-    void writePoints(@Nonnull final List<Point> points, @Nonnull final WriteParameters parameters);
+    void writePoints(@Nonnull final List<Point> points, @Nonnull final WriteOptions options);
 
     /**
      * Query data from InfluxDB IOx using FlightSQL.
@@ -124,19 +124,19 @@ public interface InfluxDBClient extends AutoCloseable {
      * <p>
      * The result stream should be closed after use, you can use try-resource pattern to close it automatically:
      * <pre>
-     * try (Stream&lt;Object[]&gt; rows = client.query("select * from cpu", parameters)) {
+     * try (Stream&lt;Object[]&gt; rows = client.query("select * from cpu", options)) {
      *      rows.forEach(row -&gt; {
      *          // process row
      *      }
      * });
      * </pre>
      *
      * @param query      the SQL query string to execute, cannot be null
-     * @param parameters the parameters for querying data from InfluxDB
+     * @param options the options for querying data from InfluxDB
      * @return Batches of rows returned by the query
      */
     @Nonnull
-    Stream<Object[]> query(@Nonnull final String query, @Nonnull final QueryParameters parameters);
+    Stream<Object[]> query(@Nonnull final String query, @Nonnull final QueryOptions options);
 
     /**
      * Query data from InfluxDB IOx using FlightSQL.
@@ -159,52 +159,52 @@ public interface InfluxDBClient extends AutoCloseable {
     /**
      * Query data from InfluxDB IOx using FlightSQL.
      * <pre>
-     * try (Stream&lt;VectorSchemaRoot&gt; batches = client.queryBatches("select * from cpu", parameters)) {
+     * try (Stream&lt;VectorSchemaRoot&gt; batches = client.queryBatches("select * from cpu", options)) {
      *      batches.forEach(batch -&gt; {
      *          // process batch
      *      }
      * });
      * </pre>
      *
      * @param query      the SQL query string to execute, cannot be null
-     * @param parameters the parameters for querying data from InfluxDB
+     * @param options the options for querying data from InfluxDB
      * @return Batches of rows returned by the query
      */
     @Nonnull
-    Stream<VectorSchemaRoot> queryBatches(@Nonnull final String query, @Nonnull final QueryParameters parameters);
+    Stream<VectorSchemaRoot> queryBatches(@Nonnull final String query, @Nonnull final QueryOptions options);
 
     /**
      * Creates a new instance of the {@link InfluxDBClient} for interacting with an InfluxDB server, simplifying
      * common operations such as writing, querying.
      *
-     * @param hostUrl   the hostname or IP address of the InfluxDB server
-     * @param authToken the authentication token for accessing the InfluxDB server, can be null
+     * @param host the URL of the InfluxDB server
+     * @param token the authentication token for accessing the InfluxDB server, can be null
      * @param database  the database to be used for InfluxDB operations, can be null
      * @return new instance of the {@link InfluxDBClient}
      */
     @Nonnull
-    static InfluxDBClient getInstance(@Nonnull final String hostUrl,
-                                      @Nullable final char[] authToken,
+    static InfluxDBClient getInstance(@Nonnull final String host,
+                                      @Nullable final char[] token,
                                       @Nullable final String database) {
-        InfluxDBClientConfigs configs = new InfluxDBClientConfigs.Builder()
-                .hostUrl(hostUrl)
-                .authToken(authToken)
+        ClientConfig config = new ClientConfig.Builder()
+                .host(host)
+                .token(token)
                 .database(database)
                 .build();
 
-        return getInstance(configs);
+        return getInstance(config);
     }
 
     /**
      * Creates a new instance of the {@link InfluxDBClient} for interacting with an InfluxDB server, simplifying
      * common operations such as writing, querying.
-     * For possible configuration options see {@link InfluxDBClientConfigs}.
+     * For possible configuration options see {@link ClientConfig}.
      *
-     * @param configs the configuration for the InfluxDB client
+     * @param config the configuration for the InfluxDB client
      * @return new instance of the {@link InfluxDBClient}
      */
     @Nonnull
-    static InfluxDBClient getInstance(@Nonnull final InfluxDBClientConfigs configs) {
-        return new InfluxDBClientImpl(configs);
+    static InfluxDBClient getInstance(@Nonnull final ClientConfig config) {
+        return new InfluxDBClientImpl(config);
     }
 }