Add empty impl and IT for desc skipping index

Signed-off-by: Chen Dai <daichen@amazon.com>
opensearch-project · Jun 26, 2023 · 8d5c964 · 8d5c964
1 parent 102c8c8
commit 8d5c964
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 6 deletions.
diff --git a/flint/flint-spark-integration/src/main/antlr4/FlintSparkSqlExtensions.g4 b/flint/flint-spark-integration/src/main/antlr4/FlintSparkSqlExtensions.g4
@@ -19,7 +19,12 @@ statement
     ;
 
 skippingIndexStatement
-    : dropSkippingIndexStatement
+    : describeSkippingIndexStatement
+    | dropSkippingIndexStatement
+    ;
+
+describeSkippingIndexStatement
+    : (DESC | DESCRIBE) SKIPPING INDEX ON tableName=multipartIdentifier
     ;
 
 dropSkippingIndexStatement

diff --git a/flint/flint-spark-integration/src/main/antlr4/SparkSqlBase.g4 b/flint/flint-spark-integration/src/main/antlr4/SparkSqlBase.g4
@@ -113,6 +113,8 @@ SKIPPING : 'SKIPPING';
 
 SEMICOLON: ';';
 
+DESC: 'DESC';
+DESCRIBE: 'DESCRIBE';
 DOT: '.';
 DROP: 'DROP';
 INDEX: 'INDEX';

diff --git a/...k-integration/src/main/scala/org/opensearch/flint/spark/sql/FlintSparkSqlAstBuilder.scala b/...k-integration/src/main/scala/org/opensearch/flint/spark/sql/FlintSparkSqlAstBuilder.scala
@@ -6,7 +6,7 @@
 package org.opensearch.flint.spark.sql
 
 import org.opensearch.flint.spark.skipping.FlintSparkSkippingIndex.getSkippingIndexName
-import org.opensearch.flint.spark.sql.FlintSparkSqlExtensionsParser.DropSkippingIndexStatementContext
+import org.opensearch.flint.spark.sql.FlintSparkSqlExtensionsParser.{DescribeSkippingIndexStatementContext, DropSkippingIndexStatementContext}
 
 import org.apache.spark.sql.catalyst.plans.logical.Command
 
@@ -15,15 +15,19 @@ import org.apache.spark.sql.catalyst.plans.logical.Command
  */
 class FlintSparkSqlAstBuilder extends FlintSparkSqlExtensionsBaseVisitor[Command] {
 
-  override def visitDropSkippingIndexStatement(
-      ctx: DropSkippingIndexStatementContext): Command = {
+  override def visitDescribeSkippingIndexStatement(
+      ctx: DescribeSkippingIndexStatementContext): Command =
+    FlintSparkSqlCommand { flint =>
+      Seq.empty
+    }
+
+  override def visitDropSkippingIndexStatement(ctx: DropSkippingIndexStatementContext): Command =
     FlintSparkSqlCommand { flint =>
       val tableName = ctx.tableName.getText // TODO: handle schema name
       val indexName = getSkippingIndexName(tableName)
       flint.deleteIndex(indexName)
       Seq.empty
     }
-  }
 
   override def aggregateResult(aggregate: Command, nextResult: Command): Command =
     if (nextResult != null) nextResult else aggregate;

diff --git a/flint/integ-test/src/test/scala/org/opensearch/flint/spark/FlintSparkSqlSuite.scala b/flint/integ-test/src/test/scala/org/opensearch/flint/spark/FlintSparkSqlSuite.scala
@@ -48,13 +48,29 @@ class FlintSparkSqlSuite extends QueryTest with FlintSuite with OpenSearchSuite
            |""".stripMargin)
   }
 
-  test("drop skipping index") {
+  protected override def beforeEach(): Unit = {
+    super.beforeEach()
+
     flint
       .skippingIndex()
       .onTable(testTable)
       .addPartitions("year")
       .create()
+  }
+
+  protected override def afterEach(): Unit = {
+    super.afterEach()
+
+    flint.deleteIndex(testIndex)
+  }
+
+  test("describe skipping index") {
+    val result = sql(s"DESC SKIPPING INDEX ON $testTable")
 
+    checkAnswer(result, Seq())
+  }
+
+  test("drop skipping index") {
     sql(s"DROP SKIPPING INDEX ON $testTable")
 
     flint.describeIndex(testIndex) shouldBe empty