Add fields option to ProxySpace

Closes #236

Author: ArtDu

CHANGELOG.md

@@ -45,6 +45,7 @@
 - Added options parameter to Tarantool Space API ([#266](https://github.com/tarantool/cartridge-java/pull/266))
 - Added bucket id parameter to Tarantool Space API ([#270](https://github.com/tarantool/cartridge-java/pull/270))
 - Added support for insert_many and replace_many CRUD operations ([#259](https://github.com/tarantool/cartridge-java/issues/259))
+- Added `fields` option to ProxySpace ([#236](https://github.com/tarantool/cartridge-java/pull/236))
 
 ## [0.8.2] - 2022-09-16
 

src/main/java/io/tarantool/driver/api/space/TarantoolSpaceOperations.java

@@ -139,7 +139,7 @@ default CompletableFuture<R> replaceMany(Collection<T> tuples, ReplaceManyOption
     }
 
     /**
-     * Select tuples matching the specified query with options.
+     * Search for a tuple or a set of tuples with a specific conditions.
      *
      * @param conditions query with options
      * @return a future that will contain all corresponding tuples once completed
@@ -148,7 +148,7 @@ default CompletableFuture<R> replaceMany(Collection<T> tuples, ReplaceManyOption
     CompletableFuture<R> select(Conditions conditions) throws TarantoolClientException;
 
     /**
-     * Select tuples matching the specified query with specified conditions and options.
+     * Search for a tuple or a set of tuples with a specific conditions and additional options.
      *
      * @param conditions specified conditions
      * @param options    operation options

src/main/java/io/tarantool/driver/api/space/options/DeleteOptions.java

@@ -6,5 +6,5 @@
  * @author Artyom Dubinin
  * @author Alexey Kuzin
  */
-public interface DeleteOptions extends OperationWithBucketIdOptions {
+public interface DeleteOptions extends OperationWithBucketIdOptions, OperationWithFieldsOptions {
 }

src/main/java/io/tarantool/driver/api/space/options/InsertManyOptions.java

@@ -7,7 +7,7 @@
  *
  * @author Alexey Kuzin
  */
-public interface InsertManyOptions extends OperationWithTimeoutOptions {
+public interface InsertManyOptions extends OperationWithFieldsOptions {
     /**
      * Return whether all changes should not be saved if any tuple insertion
      * was unsuccesful.

src/main/java/io/tarantool/driver/api/space/options/InsertOptions.java

@@ -6,5 +6,5 @@
  * @author Artyom Dubinin
  * @author Alexey Kuzin
  */
-public interface InsertOptions extends OperationWithBucketIdOptions {
+public interface InsertOptions extends OperationWithBucketIdOptions, OperationWithFieldsOptions {
 }

src/main/java/io/tarantool/driver/api/space/options/OperationWithFieldsOptions.java

@@ -0,0 +1,18 @@
+package io.tarantool.driver.api.space.options;
+
+import java.util.List;
+import java.util.Optional;
+
+/**
+ * Base interface for all operation options that may have a configurable return.
+ *
+ * @author Artyom Dubinin
+ */
+public interface OperationWithFieldsOptions extends OperationWithTimeoutOptions {
+    /**
+     * Return list of fields names for getting only a subset of fields.
+     *
+     * @return list of fields string names
+     */
+    Optional<List> getFields();
+}

src/main/java/io/tarantool/driver/api/space/options/ReplaceManyOptions.java

@@ -7,7 +7,7 @@
  *
  * @author Alexey Kuzin
  */
-public interface ReplaceManyOptions extends OperationWithTimeoutOptions {
+public interface ReplaceManyOptions extends OperationWithFieldsOptions {
     /**
      * Return whether all changes should not be saved if any tuple replace
      * was unsuccesful.

src/main/java/io/tarantool/driver/api/space/options/ReplaceOptions.java

@@ -6,5 +6,5 @@
  * @author Artyom Dubinin
  * @author Alexey Kuzin
  */
-public interface ReplaceOptions extends OperationWithBucketIdOptions {
+public interface ReplaceOptions extends OperationWithBucketIdOptions, OperationWithFieldsOptions {
 }

src/main/java/io/tarantool/driver/api/space/options/SelectOptions.java

@@ -8,7 +8,7 @@
  * @author Artyom Dubinin
  * @author Alexey Kuzin
  */
-public interface SelectOptions extends OperationWithBucketIdOptions {
+public interface SelectOptions extends OperationWithBucketIdOptions, OperationWithFieldsOptions {
     /**
      * Return the internal size of batch for transferring data between
      * storage and router nodes.

src/main/java/io/tarantool/driver/api/space/options/UpdateOptions.java

@@ -6,5 +6,5 @@
  * @author Artyom Dubinin
  * @author Alexey Kuzin
  */
-public interface UpdateOptions extends OperationWithBucketIdOptions {
+public interface UpdateOptions extends OperationWithBucketIdOptions, OperationWithFieldsOptions {
 }

src/main/java/io/tarantool/driver/api/space/options/UpsertOptions.java

@@ -6,5 +6,5 @@
  * @author Artyom Dubinin
  * @author Alexey Kuzin
  */
-public interface UpsertOptions extends OperationWithBucketIdOptions {
+public interface UpsertOptions extends OperationWithBucketIdOptions, OperationWithFieldsOptions {
 }

src/main/java/io/tarantool/driver/api/space/options/proxy/ProxyDeleteOptions.java

@@ -2,6 +2,9 @@
 
 import io.tarantool.driver.api.space.options.DeleteOptions;
 
+import java.util.List;
+import java.util.Optional;
+
 /**
  * Represent options for delete cluster proxy operation
  *
@@ -10,6 +13,8 @@
  */
 public final class ProxyDeleteOptions extends ProxyBucketIdOptions<ProxyDeleteOptions> implements DeleteOptions {
 
+    public static final String FIELDS = "fields";
+
     private ProxyDeleteOptions() {
     }
 
@@ -22,8 +27,25 @@ public static ProxyDeleteOptions create() {
         return new ProxyDeleteOptions();
     }
 
+    /**
+     * Specifies list of fields names for getting only a subset of fields.
+     * By default, all fields are returned.
+     *
+     * @param fields list of string field names
+     * @return this options instance
+     */
+    public ProxyDeleteOptions withFields(List<String> fields) {
+        addOption(FIELDS, fields);
+        return self();
+    }
+
     @Override
     protected ProxyDeleteOptions self() {
         return this;
     }
+
+    @Override
+    public Optional<List> getFields() {
+        return getOption(FIELDS, List.class);
+    }
 }

src/main/java/io/tarantool/driver/api/space/options/proxy/ProxyInsertManyOptions.java

@@ -9,7 +9,7 @@
  *
  * @author Alexey Kuzin
  */
-public final class ProxyInsertManyOptions extends ProxyBaseOptions<ProxyInsertManyOptions>
+public final class ProxyInsertManyOptions extends ProxyReturnOptions<ProxyInsertManyOptions>
     implements InsertManyOptions {
 
     public static final String ROLLBACK_ON_ERROR = "rollback_on_error";

src/main/java/io/tarantool/driver/api/space/options/proxy/ProxyInsertOptions.java

@@ -2,6 +2,9 @@
 
 import io.tarantool.driver.api.space.options.InsertOptions;
 
+import java.util.List;
+import java.util.Optional;
+
 /**
  * Represent options for insert cluster proxy operation
  *
@@ -10,6 +13,8 @@
  */
 public final class ProxyInsertOptions extends ProxyBucketIdOptions<ProxyInsertOptions> implements InsertOptions {
 
+    public static final String FIELDS = "fields";
+
     private ProxyInsertOptions() {
     }
 
@@ -22,8 +27,25 @@ public static ProxyInsertOptions create() {
         return new ProxyInsertOptions();
     }
 
+    /**
+     * Specifies list of fields names for getting only a subset of fields.
+     * By default, all fields are returned.
+     *
+     * @param fields list of string field names
+     * @return this options instance
+     */
+    public ProxyInsertOptions withFields(List<String> fields) {
+        addOption(FIELDS, fields);
+        return self();
+    }
+
     @Override
     protected ProxyInsertOptions self() {
         return this;
     }
+
+    @Override
+    public Optional<List> getFields() {
+        return getOption(FIELDS, List.class);
+    }
 }

src/main/java/io/tarantool/driver/api/space/options/proxy/ProxyReplaceManyOptions.java

@@ -9,7 +9,7 @@
  *
  * @author Alexey Kuzin
  */
-public final class ProxyReplaceManyOptions extends ProxyBaseOptions<ProxyReplaceManyOptions>
+public final class ProxyReplaceManyOptions extends ProxyReturnOptions<ProxyReplaceManyOptions>
     implements ReplaceManyOptions {
 
     public static final String ROLLBACK_ON_ERROR = "rollback_on_error";

src/main/java/io/tarantool/driver/api/space/options/proxy/ProxyReplaceOptions.java

@@ -2,6 +2,9 @@
 
 import io.tarantool.driver.api.space.options.ReplaceOptions;
 
+import java.util.List;
+import java.util.Optional;
+
 /**
  * Represent options for replace cluster proxy operation
  *
@@ -10,6 +13,8 @@
  */
 public final class ProxyReplaceOptions extends ProxyBucketIdOptions<ProxyReplaceOptions> implements ReplaceOptions {
 
+    public static final String FIELDS = "fields";
+
     private ProxyReplaceOptions() {
     }
 
@@ -22,8 +27,25 @@ public static ProxyReplaceOptions create() {
         return new ProxyReplaceOptions();
     }
 
+    /**
+     * Specifies list of fields names for getting only a subset of fields.
+     * By default, all fields are returned.
+     *
+     * @param fields list of string field names
+     * @return this options instance
+     */
+    public ProxyReplaceOptions withFields(List<String> fields) {
+        addOption(FIELDS, fields);
+        return self();
+    }
+
     @Override
     protected ProxyReplaceOptions self() {
         return this;
     }
+
+    @Override
+    public Optional<List> getFields() {
+        return getOption(FIELDS, List.class);
+    }
 }

src/main/java/io/tarantool/driver/api/space/options/proxy/ProxyReturnOptions.java

@@ -0,0 +1,35 @@
+package io.tarantool.driver.api.space.options.proxy;
+
+import io.tarantool.driver.api.space.options.OperationWithFieldsOptions;
+
+import java.util.List;
+import java.util.Optional;
+
+/**
+ * Represent options for functions which return values.
+ *
+ * @author Alexey Kuzin
+ * @author Artyom Dubinin
+ */
+abstract class ProxyReturnOptions<B extends ProxyReturnOptions<B>> extends ProxyBaseOptions<B>
+        implements OperationWithFieldsOptions {
+
+    public static final String FIELDS = "fields";
+
+    /**
+     * Specifies list of fields names for getting only a subset of fields.
+     * By default, all fields are returned.
+     *
+     * @param fields list of string field names
+     * @return this options instance
+     */
+    public B withFields(List<String> fields) {
+        addOption(FIELDS, fields);
+        return self();
+    }
+
+    @Override
+    public Optional<List> getFields() {
+        return getOption(FIELDS, List.class);
+    }
+}

src/main/java/io/tarantool/driver/api/space/options/proxy/ProxySelectOptions.java

@@ -2,6 +2,7 @@
 
 import io.tarantool.driver.api.space.options.SelectOptions;
 
+import java.util.List;
 import java.util.Optional;
 
 /**
@@ -13,6 +14,7 @@
 public final class ProxySelectOptions extends ProxyBucketIdOptions<ProxySelectOptions> implements SelectOptions {
 
     public static final String BATCH_SIZE = "batch_size";
+    public static final String FIELDS = "fields";
 
     private ProxySelectOptions() {
     }
@@ -40,6 +42,18 @@ public ProxySelectOptions withBatchSize(int batchSize) {
         return self();
     }
 
+    /**
+     * Specifies list of fields names for getting only a subset of fields.
+     * By default, all fields are returned.
+     *
+     * @param fields list of string field names
+     * @return this options instance
+     */
+    public ProxySelectOptions withFields(List<String> fields) {
+        addOption(FIELDS, fields);
+        return self();
+    }
+
     @Override
     protected ProxySelectOptions self() {
         return this;
@@ -49,4 +63,9 @@ protected ProxySelectOptions self() {
     public Optional<Integer> getBatchSize() {
         return getOption(BATCH_SIZE, Integer.class);
     }
+
+    @Override
+    public Optional<List> getFields() {
+        return getOption(FIELDS, List.class);
+    }
 }

src/main/java/io/tarantool/driver/api/space/options/proxy/ProxyUpdateOptions.java

@@ -2,6 +2,9 @@
 
 import io.tarantool.driver.api.space.options.UpdateOptions;
 
+import java.util.List;
+import java.util.Optional;
+
 /**
  * Represent options for update cluster proxy operation
  *
@@ -10,6 +13,8 @@
  */
 public final class ProxyUpdateOptions extends ProxyBucketIdOptions<ProxyUpdateOptions> implements UpdateOptions {
 
+    public static final String FIELDS = "fields";
+
     private ProxyUpdateOptions() {
     }
 
@@ -22,8 +27,25 @@ public static ProxyUpdateOptions create() {
         return new ProxyUpdateOptions();
     }
 
+    /**
+     * Specifies list of fields names for getting only a subset of fields.
+     * By default, all fields are returned.
+     *
+     * @param fields list of string field names
+     * @return this options instance
+     */
+    public ProxyUpdateOptions withFields(List<String> fields) {
+        addOption(FIELDS, fields);
+        return self();
+    }
+
     @Override
     protected ProxyUpdateOptions self() {
         return this;
     }
+
+    @Override
+    public Optional<List> getFields() {
+        return getOption(FIELDS, List.class);
+    }
 }