Merge pull request #1318 from partiql/planner-udf

Adds UDF scalar signatures to planner

CHANGELOG.md

@@ -28,6 +28,7 @@ Thank you to all who have contributed!
 ## [Unreleased]
 
 ### Added
+- Adds the ability to pass a user-defined-function signature to the planner.
 
 ### Changed
 

partiql-planner/src/main/kotlin/org/partiql/planner/PartiQLPlannerBuilder.kt

@@ -1,6 +1,7 @@
 package org.partiql.planner
 
 import org.partiql.spi.connector.ConnectorMetadata
+import org.partiql.types.function.FunctionSignature
 
 /**
  * PartiQLPlannerBuilder is used to programmatically construct a [PartiQLPlanner] implementation.
@@ -13,7 +14,7 @@ import org.partiql.spi.connector.ConnectorMetadata
  */
 public class PartiQLPlannerBuilder {
 
-    private var headers: MutableList<Header> = mutableListOf(PartiQLHeader)
+    private var fns: MutableList<FunctionSignature.Scalar> = mutableListOf()
     private var catalogs: MutableMap<String, ConnectorMetadata> = mutableMapOf()
     private var passes: List<PartiQLPlannerPass> = emptyList()
 
@@ -22,7 +23,17 @@ public class PartiQLPlannerBuilder {
      *
      * @return
      */
-    public fun build(): PartiQLPlanner = PartiQLPlannerDefault(headers, catalogs, passes)
+    public fun build(): PartiQLPlanner {
+        val headers = mutableListOf<Header>(PartiQLHeader)
+        if (fns.isNotEmpty()) {
+            val h = object : Header() {
+                override val namespace: String = "UDF"
+                override val functions = fns
+            }
+            headers.add(h)
+        }
+        return PartiQLPlannerDefault(headers, catalogs, passes)
+    }
 
     /**
      * Java style method for assigning a Catalog name to [ConnectorMetadata].
@@ -45,6 +56,26 @@ public class PartiQLPlannerBuilder {
         this.catalogs = mutableMapOf(*catalogs)
     }
 
+    /**
+     * Java style method for adding a user-defined-function.
+     *
+     * @param function
+     * @return
+     */
+    public fun addFunction(function: FunctionSignature.Scalar): PartiQLPlannerBuilder = this.apply {
+        this.fns.add(function)
+    }
+
+    /**
+     * Kotlin style method for setting the user-defined functions. This replaces all existing user-defined functions previously passed to the builder.
+     *
+     * @param function
+     * @return
+     */
+    public fun functions(vararg functions: FunctionSignature.Scalar): PartiQLPlannerBuilder = this.apply {
+        this.fns = mutableListOf(*functions)
+    }
+
     public fun passes(passes: List<PartiQLPlannerPass>): PartiQLPlannerBuilder = this.apply {
         this.passes = passes
     }