Merge pull request #100 from pradeepmaripala/spark-2.4

Added Cache Argument Method for Spark 2.4

README.md

@@ -60,28 +60,30 @@ The Almaren Framework provides a simplified consistent minimalistic layer over A
 To add Almaren Framework dependency to your sbt build:
 
 ```
-libraryDependencies += "com.github.music-of-the-ainur" %% "almaren-framework" % "0.9.10-2.4"
+libraryDependencies += "com.github.music-of-the-ainur" %% "almaren-framework" % "0.9.11-2.4"
 ```
 
 To run in spark-shell:
 
 ```
-spark-shell --packages "com.github.music-of-the-ainur:almaren-framework_2.12:0.9.10-2.4"
+spark-shell --packages "com.github.music-of-the-ainur:almaren-framework_2.12:0.9.11-2.4"
 ```
 
 Almaren connector is available in
 [Maven Central](https://mvnrepository.com/artifact/com.github.music-of-the-ainur) repository. 
 
-| version                    | Connector Artifact                                               |
-|----------------------------|------------------------------------------------------------------|
-| Spark 3.4.x and scala 2.13 | `com.github.music-of-the-ainur:almaren-framework_2.13:0.9.10-3.4` |
-| Spark 3.4.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.10-3.4` |
-| Spark 3.3.x and scala 2.13 | `com.github.music-of-the-ainur:almaren-framework_2.13:0.9.10-3.3` |
-| Spark 3.3.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.10-3.3` |
-| Spark 3.2.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.10-3.2` |
-| Spark 3.1.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.10-3.1` |
-| Spark 2.4.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.10-2.4` |
-| Spark 2.4.x and scala 2.11 | `com.github.music-of-the-ainur:almaren-framework_2.11:0.9.10-2.4` |
+| version                    | Connector Artifact                                                |
+|----------------------------|-------------------------------------------------------------------|
+| Spark 3.5.x and scala 2.13 | `com.github.music-of-the-ainur:almaren-framework_2.13:0.9.11-3.5` |
+| Spark 3.5.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.11-3.5` |
+| Spark 3.4.x and scala 2.13 | `com.github.music-of-the-ainur:almaren-framework_2.13:0.9.11-3.4` |
+| Spark 3.4.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.11-3.4` |
+| Spark 3.3.x and scala 2.13 | `com.github.music-of-the-ainur:almaren-framework_2.13:0.9.11-3.3` |
+| Spark 3.3.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.11-3.3` |
+| Spark 3.2.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.11-3.2` |
+| Spark 3.1.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.11-3.1` |
+| Spark 2.4.x and scala 2.12 | `com.github.music-of-the-ainur:almaren-framework_2.12:0.9.11-2.4` |
+| Spark 2.4.x and scala 2.11 | `com.github.music-of-the-ainur:almaren-framework_2.11:0.9.11-2.4` |
 
 ### Batch Example
 ```scala
@@ -350,6 +352,11 @@ Cache/Uncache both DataFrame or Table
 ```scala
 cache(true)
 ```
+Cache Dataframe with Storage Level
+
+```scala
+cache(true,storageLevel = MEMORY_AND_DISK)
+```
 
 #### Coalesce
 

build.sbt

@@ -21,8 +21,8 @@ libraryDependencies ++= Seq(
   "org.apache.spark" %% "spark-avro" % sparkVersion,
   "com.databricks" %% "spark-xml" % "0.13.0",
   "com.github.music-of-the-ainur" %% "quenya-dsl" % s"1.2.3-${majorVersion}",
-  "org.scalatest" %% "scalatest" % "3.2.14" % "test",
-  "org.postgresql" % "postgresql" % "42.2.8" % "test"
+  "org.scalatest" %% "scalatest" % "3.2.17" % "test",
+  "org.postgresql" % "postgresql" % "42.6.0" % "test"
 )
 
 enablePlugins(GitVersioning)

project/build.properties

@@ -1 +1 @@
-sbt.version=1.3.7
+sbt.version=1.9.6

src/main/scala/com/github/music/of/the/ainur/almaren/builder/core/Main.scala

@@ -4,6 +4,7 @@ import com.github.music.of.the.ainur.almaren.Tree
 import com.github.music.of.the.ainur.almaren.builder.Core
 import com.github.music.of.the.ainur.almaren.state.core._
 import org.apache.spark.sql.Column
+import org.apache.spark.storage.StorageLevel
 
 private[almaren] trait Main extends Core {
   def sql(sql: String): Option[Tree] =
@@ -12,8 +13,8 @@ private[almaren] trait Main extends Core {
   def alias(alias:String): Option[Tree] =
     Alias(alias)
 
-  def cache(opType:Boolean = true,tableName:Option[String] = None): Option[Tree] = 
-    Cache(opType, tableName)
+  def cache(opType:Boolean = true,tableName:Option[String] = None,storageLevel: Option[StorageLevel] = None): Option[Tree] =
+    Cache(opType, tableName = tableName, storageLevel = storageLevel)
 
   def coalesce(size:Int): Option[Tree] =
     Coalesce(size)

src/main/scala/com/github/music/of/the/ainur/almaren/state/core/Main.scala

@@ -3,6 +3,7 @@ package com.github.music.of.the.ainur.almaren.state.core
 import com.github.music.of.the.ainur.almaren.State
 import com.github.music.of.the.ainur.almaren.util.Constants
 import org.apache.spark.sql.{Column, DataFrame}
+import org.apache.spark.storage.StorageLevel
 
 private[almaren] abstract class Main extends State {
   override def executor(df: DataFrame): DataFrame = core(df)
@@ -82,22 +83,29 @@ case class Alias(alias:String) extends Main {
   }
 }
 
-case class Cache(opType:Boolean = true,tableName:Option[String] = None) extends Main {
+case class Cache(opType: Boolean = true, tableName: Option[String] = None, storageLevel: Option[StorageLevel] = None) extends Main {
   override def core(df: DataFrame): DataFrame = cache(df)
+
   def cache(df: DataFrame): DataFrame = {
-    logger.info(s"opType:{$opType}, tableName{$tableName}")
+    logger.info(s"opType:{$opType}, tableName:{$tableName}, StorageType:{$storageLevel}")
     tableName match {
-      case Some(t) => cacheTable(df,t)
-      case None => cacheDf(df)
+      case Some(t) => cacheTable(df, t)
+      case None => cacheDf(df, storageLevel)
     }
     df
   }
-  private def cacheDf(df:DataFrame): Unit = opType match {
-    case true => df.persist()
+  private def cacheDf(df: DataFrame, storageLevel: Option[StorageLevel]): Unit = opType match {
+    case true => {
+      storageLevel match {
+        case Some(value) => df.persist(value)
+        case None => df.persist()
+      }
+    }
     case false => df.unpersist()
 
   }
-  private def cacheTable(df:DataFrame,tableName: String): Unit =
+
+  private def cacheTable(df: DataFrame, tableName: String): Unit =
     opType match {
       case true => df.sqlContext.cacheTable(tableName)
       case false => df.sqlContext.uncacheTable(tableName)

src/test/scala/com/github/music/of/the/ainur/almaren/Test.scala

@@ -9,7 +9,7 @@ import org.scalatest._
 import java.io.File
 import scala.collection.immutable._
 import org.scalatest.funsuite.AnyFunSuite
-
+import org.apache.spark.storage.StorageLevel._
 
 class Test extends AnyFunSuite with BeforeAndAfter {
   val almaren = Almaren("App Test")
@@ -385,6 +385,18 @@ class Test extends AnyFunSuite with BeforeAndAfter {
       assert(bool_cache)
     }
 
+    val testCacheDfStorage: DataFrame = almaren.builder.sourceSql("select * from cache_test").cache(true,storageLevel = Some(MEMORY_ONLY)).batch
+    val bool_cache_storage = testCacheDfStorage.storageLevel.useMemory
+    test("Testing Cache Memory Storage") {
+      assert(bool_cache_storage)
+    }
+
+    val testCacheDfDiskStorage: DataFrame = almaren.builder.sourceSql("select * from cache_test").cache(true, storageLevel = Some(DISK_ONLY)).batch
+    val bool_cache_disk_storage = testCacheDfDiskStorage.storageLevel.useDisk
+    test("Testing Cache Disk Storage") {
+      assert(bool_cache_disk_storage)
+    }
+
     val testUnCacheDf = almaren.builder.sourceSql("select * from cache_test").cache(false).batch
     val bool_uncache = testUnCacheDf.storageLevel.useMemory
     test("Testing Uncache") {