#374 Improve the description of the getCurrentBatch() metastore inter…

…face.
AbsaOSS · Sep 30, 2024 · f861bf9 · f861bf9
1 parent 64e47b1
commit f861bf9
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/pramen/api/src/main/scala/za/co/absa/pramen/api/MetastoreReader.scala b/pramen/api/src/main/scala/za/co/absa/pramen/api/MetastoreReader.scala
@@ -44,9 +44,10 @@ trait MetastoreReader {
                infoDateTo: Option[LocalDate] = None): DataFrame
 
   /**
-    * Reads the 'current batch' of the table.
+    * Reads the 'current batch' of the table to be processed incrementally.
     *
     * For incremental processing this method returns the current chunk being processed.
+    * It may include multiple chunks from non-processed data if transformer has failed previously.
     *
     * For non-incremental processing the call to this method is equivalent to:
     * {{{
@@ -55,7 +56,7 @@ trait MetastoreReader {
     *
     * which returns all data for the current information date being processed.
     *
-    * This method is the method to use for transformers that
+    * This method is the method to use for transformers that would use 'incremental' schedule.
     *
     * In order to read a table it is not sufficient the table to be registered in the metastore. It also
     * should be defined as input tables of the job. Otherwise, a runtime exception will be thrown.