#58: Added UDF script creation examples to user guide (#66)

Author: morazow

doc/changes/changes_3.0.1.md

@@ -4,4 +4,14 @@
 
 ## Documentation
 
+* #58: Added UDF script creation examples to user guide
 * #64: Fixed typo in connection definition example in user guide
+
+## Dependency Updates
+
+* Updated `com.exasol:exasol-testcontainers:3.4.0` to `3.4.1`
+* Updated `mysql:mysql-connector-java:8.0.22` to `8.0.23`
+* Updated `org.mockito:mockito-junit-jupiter:3.7.0` to `3.7.7`
+* Updated `com.exasol:error-code-crawler-maven-plugin:0.1.0` to `0.1.1`
+* Updated `org.codehaus.mojo:versions-maven-plugin:2.7` to `2.8.1`
+* Updated `org.jacoco:jacoco-maven-plugin:0.8.5` to `0.8.6`

doc/user_guide/user_guide.md

@@ -200,6 +200,59 @@ Add `returnsTable()` to the builder if you want the script to return a table.
 
 See section ["Running Scripts"](#executing-scripts) for information about executing scripts.
 
+### Creating UDF Scripts
+
+User defined function (UDF) scripts allow you to run external applications that are implemented using high-level languages such as Java, Python or Lua.
+
+To create an UDF script you need the following:
+
+* UDF script name
+* Programming Language
+* Input type — SCALAR or SET
+* Columns emitted as return type
+* Optional bucket filesystem content
+
+For example, the following code:
+
+```java
+final UdfScript udfScript = schema.createUdfBuilder("UDF_SCRIPT")
+  .language(UdfScript.Language.JAVA)
+  .inputType(UdfScript.InputType.SCALAR)
+  .emits(new Column("COLUMN_NAME", "VARCHAR(2000)"))
+  .bucketFsContent("com.exasol.script.UdfScript", "/buckets/bfsdefault/artifacts/udfscript-1.0.0.jar")
+  .build()
+```
+
+It creates the following UDF script:
+
+```sql
+CREATE JAVA SCALAR SCRIPT UDF_SCRIPT(...) EMITS ("COLUMN_NAME" VARCHAR(2000)) AS
+  %scriptclass com.exasol.script.UdfScript;
+  %jar /buckets/bfsdefault/artifacts/udfscript-1.0.0.jar;
+/
+```
+
+Similarly, the following code snippet:
+
+```java
+final UdfScript udfScript = schema.createUdfBuilder("UDF_SCRIPT")
+  .language(UdfScript.Language.PYTHON)
+  .inputType(UdfScript.InputType.SET)
+  .parameter("INPUT", "VARCHAR(256)")
+  .emits(new Column("COLUMN_ONE", "VARCHAR(256)"), new Column("COLUMN_TWO", "VARCHAR(256)"))
+  .content("print('Hello, World!')")
+  .build();
+```
+
+It creates the following Python UDF script:
+
+```sql
+CREATE PYTHON SET SCRIPT UDF_SCRIPT("INPUT" VARCHAR(256))
+EMITS ("COLUMN_ONE" VARCHAR(256), "COLUMN_TWO" VARCHAR(256)) AS
+  print('Hello, World!')
+/
+```
+
 ### Creating Adapter Scripts
 
 Adapter Scripts are what drive Virtual Schema adapters. They are scoped inside a schema. 

pom.xml

@@ -75,7 +75,7 @@
         <dependency>
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
-            <version>8.0.22</version>
+            <version>8.0.23</version>
             <scope>runtime</scope>
         </dependency>
         <dependency>
@@ -92,7 +92,7 @@
         <dependency>
             <groupId>com.exasol</groupId>
             <artifactId>exasol-testcontainers</artifactId>
-            <version>3.4.0</version>
+            <version>3.4.1</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -140,7 +140,7 @@
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-junit-jupiter</artifactId>
-            <version>3.7.0</version>
+            <version>3.7.7</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -170,7 +170,7 @@
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
-                <version>0.8.5</version>
+                <version>0.8.6</version>
                 <executions>
                     <execution>
                         <id>prepare-agent</id>
@@ -312,7 +312,7 @@
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>versions-maven-plugin</artifactId>
-                <version>2.7</version>
+                <version>2.8.1</version>
                 <executions>
                     <execution>
                         <phase>package</phase>
@@ -393,7 +393,7 @@
             <plugin>
                 <groupId>com.exasol</groupId>
                 <artifactId>error-code-crawler-maven-plugin</artifactId>
-                <version>0.1.0</version>
+                <version>0.1.1</version>
                 <executions>
                     <execution>
                         <goals>
@@ -434,4 +434,4 @@
             </plugins>
         </pluginManagement>
     </build>
-</project>
+</project>