Merge pull request #42 from JohT/feature/query-parameters

Support query parameters

Author: JohT

COMMANDS.md

@@ -208,16 +208,49 @@ Be sure to replace `path/to/local/neo4j` and `password` with your settings.
 cat ./cypher/Get_Graph_Data_Science_Library_Version.cypher | path/to/local/neo4j/bin/cypher-shell -u neo4j -p password --format plain
 ```
 
+Query parameter can be added with the option `--param`. Here is an example:
+
+```shell
+cat ./cypher/Get_Graph_Data_Science_Library_Version.cypher | path/to/local/neo4j/bin/cypher-shell -u neo4j -p password --format plain --param {a: 1}
+```
+
+For a full list of options use the help function:
+
+```shell
+path/to/local/neo4j/bin/cypher-shell --help
+```
+
 ### HTTP API
 
 Use [executeQuery.sh](./scripts/executeQuery.sh) to execute a Cypher query from the file given as an argument.
-It uses `curl` and `jq` to access the HTTP API of Neo4j.
+It uses `curl` and `jq` to access the [HTTP API of Neo4j](https://neo4j.com/docs/http-api/current/query).
 Here is an example:
 
 ```shell
 ./scripts/executeQuery.sh ./cypher/Get_Graph_Data_Science_Library_Version.cypher
 ```
 
+Query parameters can be added as arguments after the file name. Here is an example:
+
+```shell
+./scripts/executeQuery.sh ./cypher/Get_Graph_Data_Science_Library_Version.cypher a=1
+```
+
+### executeQueryFunctions
+
+The script [executeQueryFunctions.sh](./scripts/executeQueryFunctions.sh) contains functions to simplify the
+call of [executeQuery.sh](./scripts/executeQuery.sh) for different purposes. For example, `execute_cypher_summarized`
+prints out the results on the console in a summarized manner and `execute_cypher_expect_results` fails when there are no results.
+
+The script also provides an API abstraction that defaults to [HTTP](#http-api), but can easily be switched to [cypher-shell](#cypher-shell).
+
+Query parameters can be added as arguments after the file name. Here is an example:
+
+```shell
+source "${SCRIPTS_DIR}/executeQueryFunctions.sh"
+execute_cypher ./cypher/Get_Graph_Data_Science_Library_Version.cypher a=1
+```
+
 ## Stop Neo4j
 
 Use [stopNeo4j.sh](./scripts/stopNeo4j.sh) to stop the locally running Neo4j Graph Database. It does nothing if the database is already stopped. It runs the script with a temporary `NEO4J_HOME` environment variable to not interfere with a possibly globally installed Neo4j installation.

cypher/Centrality/Centrality_0b_Delete_Subraph_Projection.cypher

@@ -0,0 +1,22 @@
+// List the top centrality nodes with a 99.5 percentile or higher 
+
+ MATCH (member)
+ WHERE $dependencies_projection_node IN LABELS(member)
+   AND member[$dependencies_projection_write_property] IS NOT NULL
+  WITH count(DISTINCT member)   AS memberCount
+      ,percentileDisc(member[$dependencies_projection_write_property], 0.995) AS centralityPercentile995
+      ,collect(DISTINCT member) AS members
+UNWIND members AS member
+  WITH memberCount
+      ,centralityPercentile995
+      ,member
+ ORDER BY member[$dependencies_projection_write_property] DESCENDING    
+ WHERE member[$dependencies_projection_write_property] >= centralityPercentile995
+  WITH memberCount
+      ,centralityPercentile995
+      ,max(member[$dependencies_projection_write_property]) AS maxCentrality
+      ,collect(DISTINCT member)       AS topMembers
+ RETURN memberCount
+       ,maxCentrality
+       ,centralityPercentile995
+       ,topMembers

cypher/Centrality/Centrality_1_Create_Projection.cypher

@@ -0,0 +1,12 @@
+// List the top 2% nodes with the highest centrality score.
+
+ MATCH (member)
+ WHERE $dependencies_projection_node IN labels(member)
+   AND member[$dependencies_projection_write_property] IS NOT NULL
+  WITH toInteger(toFloat(count(DISTINCT member)) * 0.02) AS memberCount2Percent
+      ,collect(DISTINCT member) AS members
+UNWIND members AS member
+  WITH memberCount2Percent, member
+ ORDER BY member[$dependencies_projection_write_property] DESCENDING    
+  WITH memberCount2Percent, collect(DISTINCT member)[0..memberCount2Percent] AS topMembers
+ RETURN memberCount2Percent, topMembers

cypher/Centrality/Centrality_1a_List_TopPercentile.cypher

@@ -0,0 +1,11 @@
+// Centrality Label Delete
+
+  CALL db.labels() YIELD label
+ WHERE label = 'Top' + apoc.text.capitalize($dependencies_projection_write_property)
+  WITH collect(label) AS selectedLabels
+ MATCH (member)
+ WHERE $dependencies_projection_node IN LABELS(member) 
+   AND member[$dependencies_projection_write_property] IS NOT NULL
+  WITH collect(member) AS members, selectedLabels
+  CALL apoc.create.removeLabels(members, selectedLabels) YIELD node
+RETURN COUNT(node) AS nodesCount;

cypher/Centrality/Centrality_1b_Create_Subgraph_Without_Empty_Packages.cypher

@@ -0,0 +1,16 @@
+// Centrality Add label to the top 2% nodes with the highest centrality score 
+
+ MATCH (member)
+ WHERE $dependencies_projection_node IN labels(member)
+   AND member[$dependencies_projection_write_property] IS NOT NULL
+  WITH toInteger(toFloat(count(DISTINCT member)) * 0.02) AS memberCount2Percent
+      ,collect(DISTINCT member) AS members
+UNWIND members AS member
+  WITH memberCount2Percent, member
+ ORDER BY member[$dependencies_projection_write_property] DESCENDING    
+  WITH memberCount2Percent
+      ,collect(DISTINCT member)[0..memberCount2Percent] AS topMembers
+      ,'Top' + apoc.text.capitalize($dependencies_projection_write_property) AS labelName
+UNWIND topMembers AS topMember
+  CALL apoc.create.addLabels(topMember, [labelName]) YIELD node
+RETURN count(node) AS nodesCount

cypher/Centrality/Centrality_1b_List_TopPercent.cypher

@@ -1,11 +1,12 @@
 //Centrality 2a Page Rank Estimate Memory
 
-CALL gds.pageRank.write.estimate('package-centrality-without-empty', {
-   writeProperty: 'pageRank'
+CALL gds.pageRank.write.estimate(
+ $dependencies_projection + '-without-empty', {
+   writeProperty: $dependencies_projection_write_property
   ,maxIterations: 50
   ,dampingFactor: 0.85
   ,tolerance: 0.00000001
-  ,relationshipWeightProperty: 'weight25PercentInterfaces'
+  ,relationshipWeightProperty: $dependencies_projection_weight_property
   ,scaler: "L1Norm"
 })
  YIELD nodeCount, relationshipCount, bytesMin, bytesMax, heapPercentageMin, heapPercentageMax, treeView

cypher/Centrality/Centrality_1c_Label_Delete.cypher

@@ -1,10 +1,11 @@
 //Centrality 2b Page Rank Statistics
 
-CALL gds.pageRank.stats('package-centrality-without-empty', {
+CALL gds.pageRank.stats(
+ $dependencies_projection + '-without-empty', {
    maxIterations: 50
   ,dampingFactor: 0.85
   ,tolerance: 0.00000001
-  ,relationshipWeightProperty: 'weight25PercentInterfaces'
+  ,relationshipWeightProperty: $dependencies_projection_weight_property
   ,scaler: "L1Norm"
 })
  YIELD ranIterations