Support query parameters

Author: JohT

scripts/executeQuery.sh

@@ -1,17 +1,18 @@
 #!/usr/bin/env bash
 
 # Utilizes Neo4j's HTTP API to execute a Cypher query from an input file and provides the results in CSV format.
-# Use it when "cypher-shell" is not present or not flexible enough.
+# Use it when "cypher-shell" is not present, not flexible enough or to avoid an additional dependency.
 
 # It requires "cURL" ( https://curl.se ) and "jq" ( https://stedolan.github.io/jq ) to be installed.
 # The environment variable NEO4J_INITIAL_PASSWORD needs to be set.
 
 # Using "cypher-shell" that comes with Neo4j server is much simpler to use:
-# cat $cypher_query_file_name | $NEO4J_HOME/bin/cypher-shell -u neo4j -p password --format plain
+# cat $cypher_query_file_name | $NEO4J_HOME/bin/cypher-shell -u neo4j -p password --format plain --param "number ⇒ 3"
 
 # Note: These command line arguments are supported:
 # -> "filename" of the cypher query file (required, unnamed first argument)
 # -> "--no_source_reference" to not append the cypher query file name as last CSV column
+# -> any following key=value arguments are used as query parameters
 
 # Overrideable Defaults
 NEO4J_HTTP_PORT=${NEO4J_HTTP_PORT:-"7474"} # Neo4j HTTP API port for executing queries
@@ -26,6 +27,7 @@ fi
 # Input Arguments: Initialize arguments and set default values for optional ones
 cypher_query_file_name=""
 no_source_reference=false
+query_parameters=""
 
 # Input Arguments: Function to print usage information
 print_usage() {
@@ -36,17 +38,17 @@ print_usage() {
 
 # Input Arguments: Parse the command-line arguments
 while [[ $# -gt 0 ]]; do
-    key="$1"
+    arg="$1"
 
-    case $key in
+    case $arg in
         --no-source-reference-column)
             no_source_reference=true
             shift
             ;;
         *)
-            if [[ -z "$cypher_query_file_name" ]]; then
+            if [[ -z "${cypher_query_file_name}" ]]; then
                 # Input Arguments: Read the first unnamed input argument containing the name of the cypher file
-                cypher_query_file_name="$key"
+                cypher_query_file_name="${arg}"
                 #echo "Cypher File: $cypher_query_file_name"
 
                 # Input Arguments: Check the first input argument to be a valid file
@@ -56,18 +58,26 @@ while [[ $# -gt 0 ]]; do
                   exit 1
                 fi
             else
-                echo "Error: Unknown option: $key" >&2
-                print_usage
-                exit 1
+                # Convert key=value argument to JSON "key": "value"
+                json_parameter=$(echo "${arg}" | awk -F'='  '{ print "\""$1"\": \""$2"\""}'|grep -iv '\"#')
+                if [[ -z "${query_parameters}" ]]; then
+                  # Add first query parameter directly
+                  query_parameters="${json_parameter}"
+                else
+                  # Append next query parameter separated by a comma and a space 
+                  query_parameters="${query_parameters}, ${json_parameter}"
+                fi
             fi
             shift
             ;;
     esac
 done
 
+#echo "executeQuery: query_parameters: ${query_parameters}"
+
 # Read the file that contains the Cypher query
 original_cypher_query=$(<"${cypher_query_file_name}")
-#echo "Original Query: $original_cypher_query"
+#echo "executeQuery: Original Query: $original_cypher_query"
 
 # Encode the string containing the Cypher query to be used inside JSON using jq ( https://stedolan.github.io/jq )
 # Be sure to put double quotes around the original Cypher query to prevent newlines from beeing removed. 
@@ -77,11 +87,11 @@ original_cypher_query=$(<"${cypher_query_file_name}")
 # . means "output the root of the JSON document"
 # Source: https://stackoverflow.com/questions/10053678/escaping-characters-in-bash-for-json
 cypher_query=$(echo -n "${original_cypher_query}" | jq -Rsa .)
-#echo "Cypher Query: $cypher_query"
+#echo "executeQuery: Cypher Query: $cypher_query"
 
 # Put the query inside the structure that is expected by the Neo4j HTTP API
-cypher_query_for_api="{\"statements\":[{\"statement\":${cypher_query},\"includeStats\": false}]}"
-#echo "Cypher Query for API: ${cypher_query_for_api}"
+cypher_query_for_api="{\"statements\":[{\"statement\":${cypher_query},\"parameters\":{${query_parameters}},\"includeStats\": false}]}"
+#echo "executeQuery: Cypher Query for API: ${cypher_query_for_api}"
 
 # Calls the Neo4j HTTP API using cURL ( https://curl.se )
 cyper_query_result=$(curl --silent -S --fail-with-body -H Accept:application/json -H Content-Type:application/json \

scripts/executeQueryFunctions.sh

@@ -12,34 +12,29 @@ SCRIPTS_DIR=${SCRIPTS_DIR:-$( CDPATH=. cd -- "$(dirname -- "${BASH_SOURCE[0]}")"
 
 # Function to execute a cypher query from the given file (first argument) with the default method
 execute_cypher() { 
-    execute_cypher_http "${1}" || exit 1
+    echo "executeQueryFunctions/execute_cypher: allArguments: ${allArguments}"
+    execute_cypher_http "${@}" || exit 1 # "${@}": Get all function arguments and forward them
 }
 
 # Function to execute a cypher query from the given file (first argument) with the default method and just return the number of results
 execute_cypher_summarized() { 
-   execute_cypher_http_summarized "${1}" || exit 1
+    execute_cypher_http_summarized "${@}" || exit 1 # "${@}": Get all function arguments and forward them
 }
 
 # Function to execute a cypher query from the given file (first argument) with the default method and fail if there is no result
 execute_cypher_expect_results() { 
-   execute_cypher_http_expect_results "${1}" || exit 1
+    execute_cypher_http_expect_results "${@}" || exit 1 # "${@}": Get all function arguments and forward them
 }
 
 # Function to execute a cypher query from the given file (first and only argument) using Neo4j's HTTP API
 execute_cypher_http() { 
-    # Get the Cypher file name from the first argument
-    cypherFileName="${1}"
-
     # (Neo4j HTTP API Script) Execute the Cyper query contained in the file and print the results as CSV
-    source $SCRIPTS_DIR/executeQuery.sh "${cypherFileName}" || exit 1
+    source $SCRIPTS_DIR/executeQuery.sh "${@}" || exit 1 # "${@}": Get all function arguments and forward them
 }
 
 # Function to execute a cypher query from the given file (first and only argument) with a summarized (console) output using Neo4j's HTTP API
 execute_cypher_http_summarized() { 
-    # Get the Cypher file name from the first argument
-    cypherFileName="${1}"
-
-    results=$( execute_cypher_http ${cypherFileName} | wc -l )
+    results=$( execute_cypher_http "${@}" | wc -l ) # "${@}": Get all function arguments and forward them
     results=$((results - 2))
     echo "$(basename -- "${cypherFileName}") (via http) result lines: ${results}"
 }
@@ -58,9 +53,10 @@ execute_cypher_http_expect_results() {
 }
 
 # Function to execute a cypher query from the given file (first and only argument) using "cypher-shell" provided by Neo4j
+# TODO Support query parameters
 execute_cypher_shell() { 
     # Get the Cypher file name from the first argument
-    cypherFileName=$1
+    cypherFileName="${1}"
 
     # Check if NEO4J_BIN exists
     if [ ! -d "${NEO4J_BIN}" ] ; then
@@ -80,7 +76,7 @@ execute_cypher_shell() {
 # Function to execute a cypher query from the given file (first and only argument) with a summarized (console) output using "cypher-shell" provided by Neo4j
 execute_cypher_shell_summarized() { 
     # Get the Cypher file name from the first argument
-    cypherFileName=$1
+    cypherFileName="${1}"
 
     results=$( execute_cypher_shell ${cypherFileName} | wc -l )
     results=$((results - 2))
@@ -90,7 +86,7 @@ execute_cypher_shell_summarized() {
 # Function to execute a cypher query from the given file (first and only argument) that fails on no result using "cypher-shell" provided by Neo4j
 execute_cypher_shell_expect_results() { 
     # Get the Cypher file name from the first argument
-    cypherFileName=$1
+    cypherFileName="${1}"
 
     results=$( execute_cypher_shell ${cypherFileName} | wc -l )
     results=$((results - 2))