Skip to content

Commit 4f1260c

Browse files
author
Mike Pigott
committed
Adding documentation for public static VectorSchemaRoot sqlToArrow(ResultSet resultSet, JdbcToArrowConfig config)
1 parent df632e3 commit 4f1260c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrow.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,14 @@ public static VectorSchemaRoot sqlToArrow(ResultSet resultSet, BaseAllocator all
197197
return sqlToArrow(resultSet, new JdbcToArrowConfig(allocator, calendar));
198198
}
199199

200+
/**
201+
* For the given JDBC {@link ResultSet}, fetch the data from Relational DB and convert it to Arrow objects.
202+
*
203+
* @param resultSet ResultSet to use to fetch the data from underlying database
204+
* @param config Configuration of the conversion from JDBC to Arrow.
205+
* @return Arrow Data Objects {@link VectorSchemaRoot}
206+
* @throws SQLException on error
207+
*/
200208
public static VectorSchemaRoot sqlToArrow(ResultSet resultSet, JdbcToArrowConfig config)
201209
throws SQLException, IOException {
202210
Preconditions.checkNotNull(resultSet, "JDBC ResultSet object can not be null");

0 commit comments

Comments
 (0)