README.md

@@ -41,6 +41,28 @@ CREATE OR REPLACE FUNCTION st_simplify as 'com.azavea.hiveless.spatial.ST_Simpli
 
 The full list of supported functions can be found [here](./spatial/sql/createUDFs.sql).
 
+## Spatial Query Optimizations
+
+There are two types of supported optimizations: `ST_Intersects` and `ST_Contains`, which allow Spark to push down predicates when possible.
+
+To enable optimizations:
+
+```scala
+import com.azavea.hiveless.spark.sql.rules.SpatialFilterPushdownRules
+
+val spark: SparkSession = ???
+SpatialFilterPushdownRules.registerOptimizations(sparkContext.sqlContext)
+```
+
+It is also possible to set it through the Spark configuration via the optimizations injector:
+
+```scala
+import com.azavea.hiveless.spark.sql.SpatialFilterPushdownOptimizations
+
+val conf: SparkConfig = ???
+config.set("spark.sql.extensions", classOf[SpatialFilterPushdownOptimizations].getName)
+```
+
 ## License
 Code is provided under the Apache 2.0 license available at http://opensource.org/licenses/Apache-2.0,
 as well as in the LICENSE file. This is the same license used as Spark.

core/src/main/scala/com/azavea/hiveless/HUDF.scala

@@ -16,13 +16,14 @@
 
 package com.azavea.hiveless
 
-import com.azavea.hiveless.serializers.{GenericDeserializer, HDeserialier, HSerializer}
+import com.azavea.hiveless.serializers.{HDeserializer, HSerializer}
 import org.apache.hadoop.hive.ql.udf.generic.GenericUDF
 import org.apache.spark.sql.types.DataType
 
 import scala.util.{Failure, Success, Try}
 
-abstract class HUDF[P, R](implicit d: GenericDeserializer[Try, P], s: HSerializer[R]) extends HGenericUDF[R] {
+abstract class HUDF[P, R](implicit d: HDeserializer[Try, P], s: HSerializer[R]) extends HGenericUDF[R] {
+  def name: String        = this.getClass.getName.split("\\.").last
   def dataType: DataType  = s.dataType
   def serialize: R => Any = s.serialize
   def function: P => R
@@ -33,7 +34,7 @@ abstract class HUDF[P, R](implicit d: GenericDeserializer[Try, P], s: HSerialize
       // if arguments are null we can't deserialize it
       // however nulls can appear due to filtering results (that's how it is handled)
       // that is not an error state
-      case Failure(HDeserialier.Errors.NullArgument) => null.asInstanceOf[R]
-      case Failure(e)                                => throw e
+      case Failure(HDeserializer.Errors.NullArgument) => null.asInstanceOf[R]
+      case Failure(e)                                 => throw e
     }
 }