Skip to content

Commit 64aa9df

Browse files
committed
adds warning about what is returned from reader.next()
1 parent d3f4233 commit 64aa9df

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

client-v2/src/main/java/com/clickhouse/client/api/data_formats/ClickHouseBinaryFormatReader.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,12 @@ public interface ClickHouseBinaryFormatReader extends AutoCloseable {
5151
boolean hasNext();
5252

5353
/**
54-
* Moves cursor to the next row. Must be called before reading the first row.
54+
* Moves cursor to the next row. Must be called before reading the first row. Returns reference to
55+
* an internal record representation. It means that next call to the method will affect value in returned Map.
56+
* This is done for memory usage optimization.
57+
* Method is intended to be used only by the client not an application.
5558
*
56-
* @return map filled with column values or null if no more records are available
59+
* @return reference to a map filled with column values or null if no more records are available
5760
*/
5861
Map<String, Object> next();
5962

0 commit comments

Comments
 (0)