Merge pull request #1683 from ClickHouse/add_metrics_to_recrods

Added metrics to the Records class

Author: chernser

client-v2/src/main/java/com/clickhouse/client/api/query/Records.java

@@ -4,6 +4,8 @@
 import com.clickhouse.client.api.data_formats.ClickHouseBinaryFormatReader;
 import com.clickhouse.client.api.data_formats.RowBinaryWithNamesAndTypesFormatReader;
 import com.clickhouse.client.api.data_formats.internal.BinaryReaderBackedRecord;
+import com.clickhouse.client.api.metrics.OperationMetrics;
+import com.clickhouse.client.api.metrics.ServerMetrics;
 import com.clickhouse.data.ClickHouseFormat;
 
 import java.util.Iterator;
@@ -69,4 +71,61 @@ boolean isEmpty() {
     Stream<GenericRecord> stream() {
         return StreamSupport.stream(spliterator(), false);
     }
+
+    /**
+     * Returns the metrics of this operation.
+     *
+     * @return metrics of this operation
+     */
+    public OperationMetrics getMetrics() {
+        return response.getMetrics();
+    }
+
+    /**
+     * Alias for {@link ServerMetrics#NUM_ROWS_READ}
+     * @return number of rows read by server from the storage
+     */
+    public long getReadRows() {
+        return response.getMetrics().getMetric(ServerMetrics.NUM_ROWS_READ).getLong();
+    }
+
+    /**
+     * Alias for {@link ServerMetrics#NUM_BYTES_READ}
+     * @return number of bytes read by server from the storage
+     */
+    public long getReadBytes() {
+        return response.getMetrics().getMetric(ServerMetrics.NUM_BYTES_READ).getLong();
+    }
+
+    /**
+     * Alias for {@link ServerMetrics#NUM_ROWS_WRITTEN}
+     * @return number of rows written by server to the storage
+     */
+    public long getWrittenRows() {
+        return response.getMetrics().getMetric(ServerMetrics.NUM_ROWS_WRITTEN).getLong();
+    }
+
+    /**
+     * Alias for {@link ServerMetrics#NUM_BYTES_WRITTEN}
+     * @return number of bytes written by server to the storage
+     */
+    public long getWrittenBytes() {
+        return response.getMetrics().getMetric(ServerMetrics.NUM_BYTES_WRITTEN).getLong();
+    }
+
+    /**
+     * Alias for {@link ServerMetrics#ELAPSED_TIME}
+     * @return elapsed time in nanoseconds
+     */
+    public long getServerTime() {
+        return response.getMetrics().getMetric(ServerMetrics.ELAPSED_TIME).getLong();
+    }
+
+    /**
+     * Alias for {@link ServerMetrics#RESULT_ROWS}
+     * @return number of returned rows
+     */
+    public long getResultRows() {
+        return response.getMetrics().getMetric(ServerMetrics.RESULT_ROWS).getLong();
+    }
 }

client-v2/src/test/java/com/clickhouse/client/query/QueryTests.java

@@ -118,7 +118,7 @@ public void testReadRecords() throws Exception {
         prepareDataSet(DATASET_TABLE, DATASET_COLUMNS, DATASET_VALUE_GENERATORS, 10);
 
         Records records = client.queryRecords("SELECT * FROM " + DATASET_TABLE).get(3, TimeUnit.SECONDS);
-
+        Assert.assertTrue(records.getResultRows() == 10, "Unexpected number of rows");
         for (GenericRecord record : records) {
             record.getString(3); // string column col3
         }