Add support for new syntax for CREATE INDEX (#45) (#46)

* Add support for new syntax for CREATE INDEX (#45)

* Classify whole CREATE INDEX commands as tokens

This ensures that certain keywords, such as "range",
are classified correctly depending on whether they
are used as index type or function call.

Author: albertoventurini

language/cypher/src/main/java/com/albertoventurini/graphdbplugin/language/cypher/formatter/converter/KeywordCaseConverter.java

@@ -34,9 +34,12 @@ public class KeywordCaseConverter extends AbstractCypherConverter {
             CypherTypes.K_SINGLE
     );
 
-    private static final Map<IElementType, String> SPECIAL_FUNCTIONS = Map.of(
+    private static final Map<IElementType, String> SPECIAL_KEYWORDS = Map.of(
             CypherTypes.K_SHORTESTPATH, "shortestPath",
-            CypherTypes.K_ALLSHORTESTPATHS, "allShortestPaths"
+            CypherTypes.K_ALLSHORTESTPATHS, "allShortestPaths",
+            CypherTypes.K_ON_TYPE, "ON type",
+            CypherTypes.K_ON_EACH_TYPE, "ON EACH type",
+            CypherTypes.K_ON_EACH_LABELS, "ON EACH labels"
     );
 
     public KeywordCaseConverter(CypherPreFormatter.FormatterTask formatterTask, @NotNull Document document) {
@@ -59,8 +62,8 @@ protected String convert(PsiElement element) {
                     return null;
                 }
 
-                if (SPECIAL_FUNCTIONS.containsKey(type)) {
-                    return SPECIAL_FUNCTIONS.get(type);
+                if (SPECIAL_KEYWORDS.containsKey(type)) {
+                    return SPECIAL_KEYWORDS.get(type);
                 }
 
                 if (TO_LOWER_CASE_SPECIAL.contains(type)) {

language/cypher/src/main/java/com/albertoventurini/graphdbplugin/language/cypher/lexer/Cypher.bnf

@@ -66,6 +66,11 @@ private statement_recover::= !(';'
                         | K_UNWIND
                         | K_MERGE
                         | K_CREATE
+                        | K_CREATE_INDEX
+                        | K_CREATE_RANGE_INDEX
+                        | K_CREATE_LOOKUP_INDEX
+                        | K_CREATE_POINT_INDEX
+                        | K_CREATE_TEXT_INDEX
                         | K_DROP
                         | K_SET
                         | K_DELETE
@@ -110,10 +115,6 @@ Command ::= CreateIndex
           | CreateRelationshipPropertyExistenceConstraint
           | DropRelationshipPropertyExistenceConstraint
 
-CreateIndex ::= K_CREATE IndexSyntax
-DropIndex ::= K_DROP IndexSyntax
-IndexSyntax ::= K_INDEX K_ON NodeLabel "(" PropertyKeyNames ")"
-
 CreateUniqueConstraint ::= K_CREATE UniqueConstraintSyntax
 DropUniqueConstraint ::= K_DROP UniqueConstraintSyntax
 UniqueConstraintSyntax ::= K_CONSTRAINT K_ON "(" Variable NodeLabel ")" K_ASSERT PropertyExpression K_IS K_UNIQUE
@@ -129,6 +130,50 @@ RelationshipPatternSyntax ::= ("(" ")" "-" "[" Variable RelType "]" "-" "(" ")")
       | ("(" ")" "-" "[" Variable RelType "]" "-" ">" "(" ")")
       | ("(" ")" "<" "-" "[" Variable RelType "]" "-" "(" ")")
 
+/*************************
+ * Indexes
+ */
+
+CreateIndex ::= CreateRangeIndex
+              | CreateTextIndex
+              | CreatePointIndex
+              | CreateLookupIndex
+
+CreateRangeIndex ::= CreateNamedRangeIndex | CreateUnnamedRangeIndex
+private CreateNamedRangeIndex ::= (K_CREATE_INDEX | K_CREATE_RANGE_INDEX) IndexName CreateIndexBody
+private CreateUnnamedRangeIndex ::= (K_CREATE_INDEX | K_CREATE_RANGE_INDEX) CreateIndexBody
+
+CreateTextIndex ::= CreateNamedTextIndex | CreateUnnamedTextIndex
+private CreateNamedTextIndex ::= K_CREATE_TEXT_INDEX IndexName CreateIndexBody
+private CreateUnnamedTextIndex ::= K_CREATE_TEXT_INDEX CreateIndexBody
+
+CreatePointIndex ::= CreateNamedPointIndex | CreateUnnamedPointIndex
+private CreateNamedPointIndex ::= K_CREATE_POINT_INDEX IndexName CreateIndexBody
+private CreateUnnamedPointIndex ::= K_CREATE_POINT_INDEX CreateIndexBody
+
+IndexName ::= SymbolicNameString
+
+private CreateIndexBody ::= K_IF_NOT_EXISTS? CreateIndexForPart CreateIndexOnPropertiesPart CreateIndexOptionsPart?
+
+private CreateIndexForPart ::= K_FOR (CreateIndexForNodePart | CreateIndexForRelationshipPart)
+CreateIndexForNodePart ::= "(" Variable NodeLabel ")"
+CreateIndexForRelationshipPart ::= "(" ")" "-" "[" Variable RelType "]" "-" "(" ")"
+
+CreateIndexOnPropertiesPart ::= K_ON "(" Variable "." PropertyKeyName ("," Variable "." PropertyKeyName)* ")"
+
+// CREATE LOOKUP INDEX is a little different, so it is handled separately
+CreateLookupIndex ::= CreateNamedLookupIndex | CreateUnnamedLookupIndex
+private CreateNamedLookupIndex ::= K_CREATE_LOOKUP_INDEX IndexName CreateLookupIndexBody
+private CreateUnnamedLookupIndex ::= K_CREATE_LOOKUP_INDEX CreateLookupIndexBody
+
+private CreateLookupIndexBody ::= K_IF_NOT_EXISTS? (CreateLookupIndexForNodePart | CreateLookupIndexForRelationshipPart) CreateIndexOptionsPart?
+CreateLookupIndexForNodePart ::= K_FOR "(" Variable ")" K_ON_EACH_LABELS "(" Variable ")"
+CreateLookupIndexForRelationshipPart ::= K_FOR "(" ")" "-" "[" Variable "]" "-" "(" ")" (K_ON_EACH_TYPE|K_ON_TYPE) "(" Variable ")"
+
+CreateIndexOptionsPart ::= K_OPTIONS "{" LiteralEntry? ("," LiteralEntry)* "}"
+
+DropIndex ::= K_DROP K_INDEX IndexName K_IF_EXISTS?
+
 /*************************
  * Query
  */

language/cypher/src/main/java/com/albertoventurini/graphdbplugin/language/cypher/lexer/CypherLexer.flex

@@ -112,6 +112,28 @@ K_MANDATORY=[Mm][Aa][Nn][Dd][Aa][Tt][Oo][Rr][Yy]
 K_SCALAR=[Ss][Cc][Aa][Ll][Aa][Rr]
 K_OF=[Oo][Ff]
 K_ADD=[Aa][Dd][Dd]
+K_OPTIONS=[Oo][Pp][Tt][Ii][Oo][Nn][Ss]
+
+_EACH=[Ee][Aa][Cc][Hh]
+_IF=[Ii][Ff]
+_RANGE=[Rr][Aa][Nn][Gg][Ee]
+_LOOKUP=[Ll][Oo][Oo][Kk][Uu][Pp]
+_TEXT=[Tt][Ee][Xx][Tt]
+_POINT=[Pp][Oo][Ii][Nn][Tt]
+_LABELS=[Ll][Aa][Bb][Ee][Ll][Ss]
+_TYPE=[Tt][Yy][Pp][Ee]
+
+K_CREATE_INDEX={K_CREATE}{WHITE_SPACE}{K_INDEX}
+K_CREATE_RANGE_INDEX={K_CREATE}{WHITE_SPACE}{_RANGE}{WHITE_SPACE}{K_INDEX}
+K_CREATE_LOOKUP_INDEX={K_CREATE}{WHITE_SPACE}{_LOOKUP}{WHITE_SPACE}{K_INDEX}
+K_CREATE_TEXT_INDEX={K_CREATE}{WHITE_SPACE}{_TEXT}{WHITE_SPACE}{K_INDEX}
+K_CREATE_POINT_INDEX={K_CREATE}{WHITE_SPACE}{_POINT}{WHITE_SPACE}{K_INDEX}
+K_IF_EXISTS={_IF}{WHITE_SPACE}{K_EXISTS}
+K_IF_NOT_EXISTS={_IF}{WHITE_SPACE}{K_NOT}{WHITE_SPACE}{K_EXISTS}
+K_ON_EACH_LABELS={K_ON}{WHITE_SPACE}{_EACH}{WHITE_SPACE}{_LABELS}
+K_ON_EACH_TYPE={K_ON}{WHITE_SPACE}{_EACH}{WHITE_SPACE}{_TYPE}
+K_ON_TYPE={K_ON}{WHITE_SPACE}{_TYPE}
+
 L_IDENTIFIER=[a-zA-Z_][a-zA-Z_$0-9]*
 L_IDENTIFIER_TEXT=\`[^`]+\`
 L_DECIMAL=(0|[1-9][0-9]*)\.[0-9]+
@@ -245,6 +267,19 @@ BLOCK_COMMENT = "/*" ( ([^"*"]|[\r\n])* ("*"+ [^"*""/"] )? )* ("*" | "*"+"/")?
   {K_OF}                    { return K_OF; }
   {K_ADD}                   { return K_ADD; }
 
+  {K_OPTIONS}               { return K_OPTIONS; }
+
+  {K_CREATE_INDEX}          { return K_CREATE_INDEX; }
+  {K_CREATE_RANGE_INDEX}    { return K_CREATE_RANGE_INDEX; }
+  {K_CREATE_LOOKUP_INDEX}   { return K_CREATE_LOOKUP_INDEX; }
+  {K_CREATE_TEXT_INDEX}     { return K_CREATE_TEXT_INDEX; }
+  {K_CREATE_POINT_INDEX}    { return K_CREATE_POINT_INDEX; }
+  {K_IF_EXISTS}             { return K_IF_EXISTS; }
+  {K_IF_NOT_EXISTS}         { return K_IF_NOT_EXISTS; }
+  {K_ON_EACH_LABELS}        { return K_ON_EACH_LABELS; }
+  {K_ON_EACH_TYPE}          { return K_ON_EACH_TYPE; }
+  {K_ON_TYPE}               { return K_ON_TYPE; }
+
   {L_IDENTIFIER}            { return L_IDENTIFIER; }
   {L_IDENTIFIER_TEXT}       { return L_IDENTIFIER_TEXT; }
   {L_DECIMAL}               { return L_DECIMAL; }

testing/integration-neo4j/src/test/java/com/albertoventurini/graphdbplugin/test/integration/neo4j/tests/cypher/formatting/CypherFormattingTest.java

@@ -222,7 +222,7 @@ public void ignoreNestedWhereOnNewLineAndIndented() {
 
     //negative line-breaking tests
     public void testNoBreakOnIndexOn() {
-        doTest("create index on :Person(name)", "CREATE INDEX ON :Person(name)");
+        doTest("create index for (n:Person) on (n.name)", "CREATE INDEX FOR (n:Person) ON (n.name)");
     }
 
     public void testNoBreakOnConstraintOn() {
@@ -378,4 +378,9 @@ public void testAssertFormatting() {
         doTest("CALL apoc.schema.assert({}, {});",
                 "CALL apoc.schema.assert({}, {});");
     }
+
+    public void testCreateLookupIndex() {
+        doTest("create lookup index node_label_lookup_index for (n) on each LABELS(n)",
+                "CREATE LOOKUP INDEX node_label_lookup_index FOR (n) ON EACH labels(n)");
+    }
 }

testing/integration-neo4j/src/test/java/com/albertoventurini/graphdbplugin/test/integration/neo4j/tests/cypher/parsing/CommandParsingTest.java

@@ -37,12 +37,4 @@ public void testConstraintPropertyUniqueCreate() {
     public void testConstraintPropertyUniqueDrop() {
         doTest(true);
     }
-
-    public void testIndexCreate() {
-        doTest(true);
-    }
-
-    public void testIndexDrop() {
-        doTest(true);
-    }
 }

testing/integration-neo4j/src/test/java/com/albertoventurini/graphdbplugin/test/integration/neo4j/tests/cypher/parsing/IndexCommandParsingTest.java

@@ -0,0 +1,50 @@
+package com.albertoventurini.graphdbplugin.test.integration.neo4j.tests.cypher.parsing;
+
+import com.albertoventurini.graphdbplugin.test.integration.neo4j.tests.cypher.util.BaseParsingTest;
+
+public class IndexCommandParsingTest extends BaseParsingTest {
+
+    public IndexCommandParsingTest() {
+        super("indexes");
+    }
+
+    public void testCreateNamedIndex() {
+        doTest(true);
+    }
+
+    public void testCreateUnnamedIndex() {
+        doTest(true);
+    }
+
+    public void testCreateIndexOnRelationships() {
+        doTest(true);
+    }
+
+    public void testCreateIndexWithOptions() {
+        doTest(true);
+    }
+
+    public void testCreateIndexIfNotExists() {
+        doTest(true);
+    }
+
+    public void testCreateRangeIndex() {
+        doTest(true);
+    }
+
+    public void testCreateLookupIndex() {
+        doTest(true);
+    }
+
+    public void testCreatePointIndex() {
+        doTest(true);
+    }
+
+    public void testCreateTextIndex() {
+        doTest(true);
+    }
+
+    public void testDropIndex() {
+        doTest(true);
+    }
+}