Skip to content

Commit

Permalink
Adding documentation for public static VectorSchemaRoot sqlToArrow(Re…
Browse files Browse the repository at this point in the history
…sultSet resultSet, JdbcToArrowConfig config)
  • Loading branch information
Mike Pigott committed Dec 8, 2018
1 parent df632e3 commit 4f1260c
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,14 @@ public static VectorSchemaRoot sqlToArrow(ResultSet resultSet, BaseAllocator all
return sqlToArrow(resultSet, new JdbcToArrowConfig(allocator, calendar));
}

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

0 comments on commit 4f1260c

Please sign in to comment.