Move the nodeFilter to the procedure configuration

Author: vnickolov

core/src/main/java/org/neo4j/gds/config/WriteLabelConfig.java

@@ -33,4 +33,6 @@ public interface WriteLabelConfig extends BaseConfig, ConcurrencyConfig {
     static WriteLabelConfig of(Map<String, Object> rawConfig) {
         return new WriteLabelConfigImpl(CypherMapWrapper.create(rawConfig));
     }
+
+    String nodeFilter();
 }

…log/GraphWriteNodeLabelFilteredProc.java …gds/catalog/GraphWriteNodeLabelProc.javaproc/catalog/src/main/java/org/neo4j/gds/catalog/GraphWriteNodeLabelFilteredProc.java renamed to proc/catalog/src/main/java/org/neo4j/gds/catalog/GraphWriteNodeLabelProc.java proc/catalog/src/main/java/org/neo4j/gds/catalog/GraphWriteNodeLabelFilteredProc.java renamed to proc/catalog/src/main/java/org/neo4j/gds/catalog/GraphWriteNodeLabelProc.java

@@ -40,17 +40,16 @@
 
 import static org.neo4j.procedure.Mode.WRITE;
 
-public class GraphWriteNodeLabelFilteredProc extends CatalogProc {
+public class GraphWriteNodeLabelProc extends CatalogProc {
 
     @Context
     public NodeLabelExporterBuilder<? extends NodeLabelExporter> nodeLabelExporterBuilder;
 
     @Procedure(name = "gds.alpha.graph.nodeLabel.writeFiltered", mode = WRITE)
     @Description("Writes the given node Label to an online Neo4j database.")
-    public Stream<Result> writeNodeLabelFiltered(
+    public Stream<WriteLabelResult> write(
         @Name(value = "graphName") String graphName,
         @Name(value = "nodeLabel") String nodeLabel,
-        @Name(value = "nodePropertyFilter") String nodePropertyFilter,
         @Name(value = "configuration", defaultValue = "{}") Map<String, Object> configuration
     ) throws ParseException {
 
@@ -59,9 +58,9 @@ public Stream<Result> writeNodeLabelFiltered(
         var procedureConfig = WriteLabelConfig.of(configuration);
 
         var graphStore = graphStoreFromCatalog(graphName).graphStore();
-        var filter = ExpressionParser.parse(nodePropertyFilter, Map.of());
+        var filter = ExpressionParser.parse(procedureConfig.nodeFilter(), Map.of());
 
-        Result.Builder resultBuilder = new Result.Builder(graphName, nodeLabel);
+        WriteLabelResult.Builder resultBuilder = new WriteLabelResult.Builder(graphName, nodeLabel);
         try (ProgressTimer ignored = ProgressTimer.start(resultBuilder::withWriteMillis)) {
             var filteredNodes = NodesFilter.filterNodes(
                 graphStore,
@@ -89,46 +88,4 @@ public Stream<Result> writeNodeLabelFiltered(
 
         return Stream.of(resultBuilder.build());
     }
-
-    @SuppressWarnings("unused")
-    public static class Result {
-        public final long writeMillis;
-        public final String graphName;
-        public final String nodeLabel;
-        public final long nodeLabelsWritten;
-
-        Result(long writeMillis, String graphName, String nodeLabel, long nodeLabelsWritten) {
-            this.writeMillis = writeMillis;
-            this.graphName = graphName;
-            this.nodeLabel = nodeLabel;
-            this.nodeLabelsWritten = nodeLabelsWritten;
-        }
-
-        static class Builder {
-            private final String graphName;
-            private final String nodeLabel;
-            private long nodeLabelsWritten;
-            private long writeMillis;
-
-            Builder(String graphName, String nodeLabel) {
-                this.graphName = graphName;
-                this.nodeLabel = nodeLabel;
-            }
-
-            Builder withWriteMillis(long writeMillis) {
-                this.writeMillis = writeMillis;
-                return this;
-            }
-
-            Builder withNodeLabelsWritten(long propertiesWritten) {
-                this.nodeLabelsWritten = propertiesWritten;
-                return this;
-            }
-
-            Result build() {
-                return new Result(writeMillis, graphName, nodeLabel, nodeLabelsWritten);
-            }
-        }
-    }
-
 }

proc/catalog/src/main/java/org/neo4j/gds/catalog/WriteLabelResult.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.catalog;
+
+public class WriteLabelResult {
+    public final long writeMillis;
+    public final String graphName;
+    public final String nodeLabel;
+    public final long nodeLabelsWritten;
+
+    WriteLabelResult(long writeMillis, String graphName, String nodeLabel, long nodeLabelsWritten) {
+        this.writeMillis = writeMillis;
+        this.graphName = graphName;
+        this.nodeLabel = nodeLabel;
+        this.nodeLabelsWritten = nodeLabelsWritten;
+    }
+
+    static class Builder {
+        private final String graphName;
+        private final String nodeLabel;
+        private long nodeLabelsWritten;
+        private long writeMillis;
+
+        Builder(String graphName, String nodeLabel) {
+            this.graphName = graphName;
+            this.nodeLabel = nodeLabel;
+        }
+
+        Builder withWriteMillis(long writeMillis) {
+            this.writeMillis = writeMillis;
+            return this;
+        }
+
+        Builder withNodeLabelsWritten(long propertiesWritten) {
+            this.nodeLabelsWritten = propertiesWritten;
+            return this;
+        }
+
+        WriteLabelResult build() {
+            return new WriteLabelResult(writeMillis, graphName, nodeLabel, nodeLabelsWritten);
+        }
+    }
+}

…GraphWriteNodeLabelFilteredProcTest.java …catalog/GraphWriteNodeLabelProcTest.javaproc/catalog/src/test/java/org/neo4j/gds/catalog/GraphWriteNodeLabelFilteredProcTest.java renamed to proc/catalog/src/test/java/org/neo4j/gds/catalog/GraphWriteNodeLabelProcTest.java proc/catalog/src/test/java/org/neo4j/gds/catalog/GraphWriteNodeLabelFilteredProcTest.java renamed to proc/catalog/src/test/java/org/neo4j/gds/catalog/GraphWriteNodeLabelProcTest.java

@@ -31,7 +31,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.InstanceOfAssertFactories.LONG;
 
-class GraphWriteNodeLabelFilteredProcTest extends BaseProcTest {
+class GraphWriteNodeLabelProcTest extends BaseProcTest {
 
     @Neo4jGraph(offsetIds = true)
     private static final String DB_CYPHER =
@@ -45,7 +45,7 @@ class GraphWriteNodeLabelFilteredProcTest extends BaseProcTest {
     void setUp() throws Exception {
         registerProcedures(
             GraphProjectProc.class,
-            GraphWriteNodeLabelFilteredProc.class
+            GraphWriteNodeLabelProc.class
         );
     }
 
@@ -65,7 +65,7 @@ void writeFilteredNodeLabels() {
         );
 
         runQuery(
-            "CALL gds.alpha.graph.nodeLabel.writeFiltered('graph', 'TestLabel', 'n:A AND n.p > 1.0', {}) YIELD nodeLabelsWritten",
+            "CALL gds.alpha.graph.nodeLabel.writeFiltered('graph', 'TestLabel', { nodeFilter: 'n:A AND n.p > 1.0' }) YIELD nodeLabelsWritten",
             result -> {
                 assertThat(result.hasNext()).isTrue();