Adding documentation for public static VectorSchemaRoot sqlToArrow(Re…

…sultSet resultSet, JdbcToArrowConfig config)
apache · Dec 8, 2018 · 4f1260c · 4f1260c
1 parent df632e3
commit 4f1260c
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrow.java b/java/adapter/jdbc/src/main/java/org/apache/arrow/adapter/jdbc/JdbcToArrow.java
@@ -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");