Merge pull request #1581 from ClickHouse/insert-methods-signatures

WIP Design

Author: Paultagoras

clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseException.java

@@ -1,5 +1,6 @@
 package com.clickhouse.client;
 
+import java.io.IOException;
 import java.net.ConnectException;
 import java.net.SocketTimeoutException;
 import java.net.UnknownHostException;

client-v2/pom.xml

@@ -69,15 +69,12 @@
             <scope>provided</scope>
         </dependency>
 
-        <!-- START: Temporary test dependencies -->
         <dependency>
             <groupId>${project.parent.groupId}</groupId>
             <artifactId>clickhouse-client</artifactId>
             <version>${revision}</version>
-            <type>test-jar</type>
-            <scope>test</scope>
+            <scope>compile</scope>
         </dependency>
-        <!-- END: Temporary test dependencies -->
 
         <dependency>
             <groupId>org.slf4j</groupId>

client-v2/src/main/java/com/clickhouse/client/api/Client.java

@@ -1,22 +1,17 @@
 package com.clickhouse.client.api;
 
-import com.clickhouse.client.ClickHouseClient;
-import com.clickhouse.client.ClickHouseNode;
-import com.clickhouse.client.ClickHouseParameterizedQuery;
-import com.clickhouse.client.ClickHouseProtocol;
-import com.clickhouse.client.ClickHouseRequest;
+import com.clickhouse.client.*;
+import com.clickhouse.data.ClickHouseColumn;
+
+import java.io.InputStream;
+import java.net.SocketException;
+import java.util.*;
 import com.clickhouse.client.api.metadata.TableSchema;
 import com.clickhouse.client.api.internal.TableSchemaParser;
 import com.clickhouse.client.api.query.QueryResponse;
 import com.clickhouse.client.api.query.QuerySettings;
 import com.clickhouse.data.ClickHouseFormat;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.Future;
 
@@ -102,6 +97,36 @@ public boolean ping(int timeout) {
         return clientPing.ping(getServerNode(), timeout);
     }
 
+    /**
+     * Register the POJO
+     */
+    public void register(Class<?> clazz, TableSchema schema) {
+        //This is just a placeholder
+        //Create a new POJOSerializer with static .serialize(object, columns) methods
+    }
+
+    /**
+     * Insert data into ClickHouse using a POJO
+     */
+    public Future<InsertResponse> insert(String tableName,
+                                     List<Object> data,
+                                     InsertSettings settings,
+                                     List<ClickHouseColumn> columns) throws ClickHouseException, SocketException {
+        //Lookup the Serializer for the POJO
+        //Call the static .serialize method on the POJOSerializer for each object in the list
+        return null;//This is just a placeholder
+    }
+
+    /**
+     * Insert data into ClickHouse using a binary stream
+     */
+    public Future<InsertResponse> insert(String tableName,
+                                     InputStream data,
+                                     InsertSettings settings) throws ClickHouseException, SocketException {
+        return null;//This is just a placeholder
+    }
+
+
     /**
      * Sends data query to the server and returns a reference to a result descriptor.
      * Control is returned when server accepted the query and started processing it.

client-v2/src/main/java/com/clickhouse/client/api/InsertResponse.java

@@ -0,0 +1,4 @@
+package com.clickhouse.client.api;
+
+public class InsertResponse {
+}

client-v2/src/main/java/com/clickhouse/client/api/InsertSettings.java

@@ -0,0 +1,44 @@
+package com.clickhouse.client.api;
+
+import com.clickhouse.client.config.ClickHouseClientOption;
+import com.clickhouse.data.ClickHouseFormat;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class InsertSettings {
+    Map<String, Object> rawSettings;
+
+    public InsertSettings() {
+        rawSettings = new HashMap<>();
+    }
+
+    public InsertSettings(Map<String, Object> settings) {
+        rawSettings = new HashMap<>();
+        rawSettings.putAll(settings);
+    }
+
+    public Object getSetting(String option) {
+        return rawSettings.get(option);
+    }
+
+    public void setSetting(String option, Object value) {
+        rawSettings.put(option, value);
+    }
+
+
+    public InsertSettings setFormat(ClickHouseFormat format) {
+        rawSettings.put(ClickHouseClientOption.FORMAT.getKey(), format);
+        return this;
+    }
+
+    public InsertSettings setDeduplicationToken(String deduplicationToken) {
+        rawSettings.put("insert_deduplication_token", deduplicationToken);
+        return this;
+    }
+
+    public InsertSettings setQueryId(String queryId) {
+        rawSettings.put("query_id", queryId);
+        return this;
+    }
+}

client-v2/src/main/java/com/clickhouse/client/api/POJOSerializer.java

@@ -0,0 +1,10 @@
+package com.clickhouse.client.api;
+
+import com.clickhouse.data.ClickHouseColumn;
+
+import java.io.InputStream;
+import java.util.List;
+
+public interface POJOSerializer {
+    InputStream serialize(Object obj, List<ClickHouseColumn> columns);
+}

client-v2/src/main/java/com/clickhouse/client/api/TableSchema.java

@@ -0,0 +1,5 @@
+package com.clickhouse.client.api;
+
+public class TableSchema {
+
+}

client-v2/src/test/java/com/clickhouse/client/InsertTests.java

@@ -0,0 +1,57 @@
+package com.clickhouse.client;
+
+import com.clickhouse.client.api.InsertResponse;
+import com.clickhouse.client.api.InsertSettings;
+import com.clickhouse.client.api.Client;
+import com.clickhouse.client.generators.InsertDataGenerator;
+import com.clickhouse.data.ClickHouseColumn;
+import com.clickhouse.data.ClickHouseFormat;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+
+import java.io.InputStream;
+import java.net.SocketException;
+import java.util.*;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+
+import static org.testng.Assert.assertNotEquals;
+
+public class InsertTests {
+    private Client client;
+
+    @BeforeMethod(groups = { "unit" }, enabled = false)
+    public void setUp() {
+        client = new Client.Builder()
+                .addEndpoint("http://localhost:8123")
+                .addUsername("default")
+                .addPassword("")
+                .build();
+    }
+
+    @Test(groups = { "unit" }, enabled = false)
+    public void insertSimplePOJOs() throws ClickHouseException, SocketException, ExecutionException, InterruptedException {
+        InsertSettings settings = new InsertSettings()
+                .setDeduplicationToken("1234567890")
+                .setQueryId(String.valueOf(UUID.randomUUID()));
+
+        String table = "simple_pojo_table";
+        List<Object> simplePOJOs = InsertDataGenerator.generateSimplePOJOs();
+        List<ClickHouseColumn> columns = new ArrayList<>();
+        Future<InsertResponse> response = client.insert(table, simplePOJOs, settings, columns);
+        assertNotEquals(response.get(), null);
+    }
+
+    @Test(groups = { "unit" }, enabled = false)
+    public void insertSimpleRowBinary() throws ClickHouseException, SocketException, ExecutionException, InterruptedException {
+        InsertSettings settings = new InsertSettings()
+                .setFormat(ClickHouseFormat.RowBinary)
+                .setDeduplicationToken("1234567890")
+                .setQueryId(String.valueOf(UUID.randomUUID()));
+
+        String table = "row_binary_table";
+        InputStream dataStream = InsertDataGenerator.generateSimpleRowBinaryData();
+        Future<InsertResponse> response = client.insert(table, dataStream, settings);
+        assertNotEquals(response.get(), null);
+    }
+}

client-v2/src/test/java/com/clickhouse/client/generators/InsertDataGenerator.java

@@ -0,0 +1,21 @@
+package com.clickhouse.client.generators;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
+
+public class InsertDataGenerator {
+    public static InputStream generateSimpleRowBinaryData() {
+        return new InputStream() {//Placeholder
+            @Override
+            public int read() throws IOException {
+                return 0;
+            }
+        };
+    }
+
+    public static List<Object> generateSimplePOJOs() {
+        return new ArrayList<>();//Placeholder
+    }
+}