[DB] Support SQL Field Query in Alcor

docs/modules/ROOT/pages/performance/sql_and_scan_query_perf_comp.csv

@@ -0,0 +1,7 @@
+OPERATION TYPE             MIN              MAX          AVG          MEDIAN       MODE         P99
+SQL_QUERY_EXEC             1.0000       16.0000       1.8739       1.0000       1.0000       1.0000
+SCAN_QUERY_EXEC       530182.0000   785735.0000  561550.7678  552705.0000  543704.0000  531308.3565
+SQL_CURSOR_FETCH           0.0000       1.0000       0.6717       1.0000       1.0000       0.0000
+SCAN_CURSOR_FETCH          0.0000       8.0000       0.1411       0.0000       0.0000       0.0000
+SQL_INSERT                 0.0000  929676278.00     929.676278    0.0          0.0          0.0
+SCAN_INSERT                0.0000  812451365.00     812.451365    0.0          0.0          0.0

docs/modules/ROOT/pages/performance/sql_and_scan_query_pref_comp.adoc

@@ -0,0 +1,51 @@
+= SQL Fields Query and Scan Query Performance Comparision
+Prasad Kommoju <[email protected]>
+2021-11-30
+:toc: right
+:imagesdir: ../../images
+
+
+== Introduction
+In Alcor there are some cases where queries are made on the cases using a field other than the key. Since Ignite is the KV database, these types of queries will require full scan (linear search) of the cache in question and this introduces big latencies as the number of entries in the cache grows.
+
+Ignite supports secondary keys, called QuerySqlFields which will use a tradional B+Tree indexes which can answer point lookup and also range, minumum, maximum, greater than, and less than queries mush faster.
+
+This report is about comparing the performance of the queries on non-key fields using Ignite's SCAN query and through SQL queries.
+
+== Test setup
+Operations are on NodeInfo object. Benchmark tool, DPM, NCM and NMM run on the same physical machine in the lab. Ignite is run on two different physical machines in the lab (partitioned).
+Number of entries in both SQL and Scan are 1M, 1000 entries are queried on.
+
+The first query always takes way too much time compared to the subsequent
+ones and hence ignored when computing the statistics.
+
+All times are in micro seconds. Time axis (y) in the histogram is in logscale.
+
+SQL_QUERY_EXEC time represents time required to execute the SQLFieldsQuery
+(cache.query() API).
+
+SQL_CURSOR_FETCH time represents time required to extract the result from
+result set (cursor, cursor.get() API).
+
+SCAN_QUERY_EXEC time represents time required to execute (QueryCursor
+instantiation, cache.withKeepBinary().query(...)
+
+SCAN_CURSOR_FETCH time represents time required to extract the result from
+result set (cursor, cursor.getAll() API).
+
+For Insert operation, MAX represents total time to insert 1M entires into the cache and AVG represents the average time to insert one single entry. All other statistcs for Insert are not relevant and are shown as zero.
+
+== Results
+|===
+|OPERATION TYPE|             MIN|          MAX|          AVG| MEDIAN|       MODE|         P99
+|SQL_QUERY_EXEC|             1.0000|      16.0000|       1.8739| 1.0000|       1.0000|       1.0000
+|SCAN_QUERY_EXEC|       530182.0000|  785735.0000|  561550.7678|  552705.0000|  543704.0000|  531308.3565
+|SQL_CURSOR_FETCH|           0.0000|       1.0000|       0.6717|   1.0000|       1.0000|       0.0000
+|SCAN_CURSOR_FETCH|          0.0000 |      8.0000 |       0.1411|       0.0000|       0.0000|       0.0000
+|SQL_INSERT|                 0.0000 | 929676278.00|     929.6762|    0.0|          0.0|          0.0
+|SCAN_INSERT|                0.0000|  812451365.00|     812.4514|    0.0|          0.0|          0.0
+|===
+
+== Plot of the results
+image::sql_and_scan_query_perf_comp.png[]
+

lib/pom.xml

@@ -143,6 +143,12 @@ Copyright(c) 2020 Futurewei Cloud
             <version>2.1.1</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>29.0-jre</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 
     <build>

lib/src/main/java/com/futurewei/alcor/common/db/ignite/IgniteClientCacheFactory.java

@@ -47,23 +47,23 @@ public IgniteClientCacheFactory(IgniteClient igniteClient, int interval, int exp
 
     @Override
     public <K, V> ICache<K, V> getCache(Class<V> v) {
-        return new IgniteClientDbCache<>(igniteClient, v.getName());
+        return new IgniteClientDbCache<K, V>(igniteClient, v, v.getName());
     }
 
     @Override
     public <K, V> ICache<K, V> getCache(Class<V> v, String cacheName) {
-        return new IgniteClientDbCache<>(igniteClient, cacheName);
+        return new IgniteClientDbCache<K, V>(igniteClient, v, cacheName);
     }
 
     @Override
     public <K, V> ICache<K, V> getCache(Class<V> v, CacheConfiguration cacheConfig) {
-        return new IgniteClientDbCache<>(igniteClient, cacheConfig);
+        return new IgniteClientDbCache<>(igniteClient, v, cacheConfig);
     }
 
     @Override
     public <K, V> ICache<K, V> getExpireCache(Class<V> v, long timeout, TimeUnit timeUnit) {
         ExpiryPolicy ep = CreatedExpiryPolicy.factoryOf(new Duration(timeUnit, timeout)).create();
-        return new IgniteClientDbCache<>(igniteClient, v.getName(), ep);
+        return new IgniteClientDbCache<>(igniteClient, v, v.getName(), ep);
     }
 
     @Override
@@ -75,4 +75,4 @@ public <V> IDistributedLock getDistributedLock(Class<V> t) {
     public Transaction getTransaction() {
         return new IgniteClientTransaction(igniteClient);
     }
-}
+}