Add in delta support to Java PlanRun, update with more documentation …

…for PlanRun methods
data-catering · Jun 11, 2024 · 823f1f4 · 823f1f4
1 parent af179ee
commit 823f1f4
Show file tree

Hide file tree

Showing 4 changed files with 437 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -77,11 +77,11 @@ the full roadmap](#roadmap).
 | Database         | Elasticsearch                      | ❌       | ✅    |
 | Database         | MongoDB                            | ❌       | ✅    |
 | File             | CSV                                | ✅       | ✅    |
+| File             | Delta Lake                         | ✅       | ✅    |
 | File             | JSON                               | ✅       | ✅    |
 | File             | Iceberg                            | ✅       | ✅    |
 | File             | ORC                                | ✅       | ✅    |
 | File             | Parquet                            | ✅       | ✅    |
-| File             | Delta Lake                         | ✅       | ✅    |
 | File             | Hudi                               | ❌       | ✅    |
 | HTTP             | REST API                           | ✅       | ❌    |
 | Messaging        | Kafka                              | ✅       | ❌    |

diff --git a/api/src/main/java/io/github/datacatering/datacaterer/javaapi/api/PlanRun.java b/api/src/main/java/io/github/datacatering/datacaterer/javaapi/api/PlanRun.java
@@ -373,6 +373,29 @@ public FileBuilder iceberg(
         return basePlanRun.iceberg(name, path, tableName, catalogType, catalogUri, toScalaMap(options));
     }
 
+    /**
+     * Creates a FileBuilder instance for a Delta Lake file with the provided name, path, and options.
+     *
+     * @param name    The name of the FileBuilder instance.
+     * @param path    The path to the Delta Lake file.
+     * @param options A map of options to be used for the Delta Lake file.
+     * @return A FileBuilder instance for the Delta Lake file.
+     */
+    public FileBuilder delta(String name, String path, Map<String, String> options) {
+        return basePlanRun.delta(name, path, toScalaMap(options));
+    }
+
+    /**
+     * Creates a FileBuilder instance for a Delta Lake file with the provided name and path.
+     *
+     * @param name The name of the FileBuilder instance.
+     * @param path The path to the Delta Lake file.
+     * @return A FileBuilder instance for the Delta Lake file.
+     */
+    public FileBuilder delta(String name, String path) {
+        return delta(name, path, Collections.emptyMap());
+    }
+
     /**
      * Creates a PostgresBuilder instance with the provided name, URL, username, password, and options.
      *