Modify javadoc

kvargha · Jan 16, 2025 · db2738e · db2738e
1 parent fe149a4
commit db2738e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/clients/da-vinci-client/src/main/java/com/linkedin/davinci/DaVinciBackend.java b/clients/da-vinci-client/src/main/java/com/linkedin/davinci/DaVinciBackend.java
@@ -9,8 +9,8 @@
 
 import com.linkedin.davinci.blobtransfer.BlobTransferManager;
 import com.linkedin.davinci.blobtransfer.BlobTransferUtil;
-import com.linkedin.davinci.client.DaVinciRecordTransformerConfig;
 import com.linkedin.davinci.blobtransfer.BlobTransferUtils.BlobTransferTableFormat;
+import com.linkedin.davinci.client.DaVinciRecordTransformerConfig;
 import com.linkedin.davinci.compression.StorageEngineBackedCompressorFactory;
 import com.linkedin.davinci.config.StoreBackendConfig;
 import com.linkedin.davinci.config.VeniceConfigLoader;

diff --git a/...s/da-vinci-client/src/main/java/com/linkedin/davinci/client/DaVinciRecordTransformer.java b/...s/da-vinci-client/src/main/java/com/linkedin/davinci/client/DaVinciRecordTransformer.java
@@ -41,7 +41,7 @@ public abstract class DaVinciRecordTransformer<K, V, O> {
   private final boolean storeRecordsInDaVinci;
 
   /**
-   * The key schema, which is immutable.
+   * The key schema, which is immutable inside DaVinciClient. Users can modify the key if they are storing records in an external storage engine, but this must be managed by the user.
    */
   private final Schema keySchema;
 
@@ -59,7 +59,7 @@ public abstract class DaVinciRecordTransformer<K, V, O> {
 
   /**
    * @param storeVersion the version of the store
-   * @param keySchema the key schema, which is immutable
+   * @param keySchema the key schema, which is immutable inside DaVinciClient. Users can modify the key if they are storing records in an external storage engine, but this must be managed by the user
    * @param inputValueSchema the value schema before transformation
    * @param outputValueSchema the value schema after transformation
    * @param storeRecordsInDaVinci set this to false if you intend to store records in a custom storage,