doc(FileTransform): improved examples for FileTransform task

kestra-io · Mar 12, 2024 · 98974ea · 98974ea
1 parent 4586ca7
commit 98974ea
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 16 deletions.
diff --git a/plugin-script-groovy/src/main/java/io/kestra/plugin/scripts/groovy/FileTransform.java b/plugin-script-groovy/src/main/java/io/kestra/plugin/scripts/groovy/FileTransform.java
@@ -1,5 +1,6 @@
 package io.kestra.plugin.scripts.groovy;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -14,6 +15,9 @@
 @EqualsAndHashCode
 @Getter
 @NoArgsConstructor
+@Schema(
+    title = "Transform ion format file from Kestra's internal storage with a Groovy script."
+)
 @Plugin(
     examples = {
         @Example(
@@ -23,11 +27,12 @@
                 "script: |",
                 "  logger.info('row: {}', row)",
                 "",
-                "  if (row.get('name') == 'richard') {",
-                "    row = null",
-                "  } else {",
-                "    row.put('email', row.get('name') + '@kestra.io')",
-                "  }"
+                "  // remove a column",
+                "  row.remove('useless_column')",
+                "  // update a column",
+                "  row['email'] = row['name'] + '@kestra.io'",
+                "  // set a column to null",
+                "  row['last_update'] = null"
             }
         ),
         @Example(

diff --git a/plugin-script-jython/src/main/java/io/kestra/plugin/scripts/jython/FileTransform.java b/plugin-script-jython/src/main/java/io/kestra/plugin/scripts/jython/FileTransform.java
@@ -1,5 +1,6 @@
 package io.kestra.plugin.scripts.jython;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -14,6 +15,9 @@
 @EqualsAndHashCode
 @Getter
 @NoArgsConstructor
+@Schema(
+    title = "Transform ion format file from Kestra's internal storage with a Jython script."
+)
 @Plugin(
     examples = {
         @Example(
@@ -51,16 +55,18 @@
 """
         ),           
         @Example(
-            title = "Transform with file from internal storage.",
+            title = "Convert row by row of a file from Kestra's internal storage.",
             code = {
                 "from: \"{{ outputs['avro-to-gcs'] }}\"",
                 "script: |",
                 "  logger.info('row: {}', row)",
                 "",
-                "  if row['name'] == 'richard': ",
-                "    row = None",
-                "  else: ",
-                "    row['email'] = row['name'] + '@kestra.io'\n"
+                "  // remove a column",
+                "  del row['useless_column']",
+                "  // update a column",
+                "  row['email'] = row['name'] + '@kestra.io'",
+                "  // set a column to null",
+                "  row['last_update'] = None"
             }
         ),
         @Example(

diff --git a/plugin-script-nashorn/src/main/java/io/kestra/plugin/scripts/nashorn/FileTransform.java b/plugin-script-nashorn/src/main/java/io/kestra/plugin/scripts/nashorn/FileTransform.java
@@ -18,17 +18,18 @@
 @Plugin(
     examples = {
         @Example(
-            title = "Transform with file from internal storage",
+            title = "Convert row by row of a file from Kestra's internal storage.",
             code = {
                 "from: \"{{ outputs['avro-to-gcs'] }}\"",
                 "script: |",
                 "  logger.info('row: {}', row)",
                 "",
-                "  if (row['name'] === 'richard') {",
-                "    row = null",
-                "  } else {",
-                "    row['email'] = row['name'] + '@kestra.io'",
-                "  }"
+                "  # remove a column",
+                "  delete row['useless_column']",
+                "  # update a column",
+                "  row['email'] = row['name'] + '@kestra.io'",
+                "  # set a column to null",
+                "  row['last_update'] = null"
             }
         ),
         @Example(