ajantha-bhat commented on a change in pull request #3770:
URL: https://github.com/apache/carbondata/pull/3770#discussion_r434411308



##########
File path: docs/sdk-guide.md
##########
@@ -766,6 +771,41 @@ public VectorSchemaRoot getArrowVectors() throws 
IOException;
 public static ArrowRecordBatch byteArrayToArrowBatch(byte[] batchBytes, 
BufferAllocator bufferAllocator) throws IOException;
 ```
 
+### Class org.apache.carbondata.sdk.file.PaginationCarbonReader
+```
+/**
+* Pagination query with from and to range.
+*
+* @param fromRowNumber must be greater 0 (as row id starts from 1)
+*                      and less than equal to toRowNumber
+* @param toRowNumber must be greater than 0 (as row id starts from 1)
+*                and greater than equals to fromRowNumber and not outside the 
total rows
+* @return array of rows between fromRowNumber and toRowNumber (inclusive)
+* @throws Exception
+*/
+public Object[] read(long fromRowNumber, long toRowNumber) throws IOException, 
InterruptedException;
+```
+
+```
+/**
+* Get total rows in the folder or a list of CarbonData files.
+* It is based on the snapshot of files taken while building the reader.
+*
+* @return total rows from all the files in the reader.
+*/
+public long getTotalRows();
+```
+
+```
+/**
+* Closes the pagination reader, drops the cache and snapshot.
+* Need to build reader again if the files need to be read again.
+* Suggest to call this when new files are added in the folder.

Review comment:
       * call this when the all pagination queries are finished and can the 
drop cache.
   




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


Reply via email to