Add markdown table format for Cypher queries

Author: JohT

scripts/executeQuery.sh

@@ -35,20 +35,21 @@ fi
 cypher_query_file_name=""
 no_source_reference=false
 omit_query_error_highlighting=false
+output_markdown_table=false
 query_parameters=""
 
 # Input Arguments: Function to print usage information
 print_usage() {
-    echo "executeQuery Usage: $0 <filename> [--no-source-reference-column] [--omit-query-error-highlighting]" >&2
+    echo "executeQuery Usage: $0 <filename> [--no-source-reference-column] [--omit-query-error-highlighting] [--output-markdown-table]" >&2
     echo "Options:" >&2
     echo "  --no-source-reference-column: Exclude the source reference column" >&2
     echo "  --omit-query-error-highlighting: Log query errors in same color as infos" >&2
+    echo "  --output-markdown-table: Output the result as markdown table instead of CSV" >&2
 }
 
 # Input Arguments: Parse the command-line arguments
 while [[ $# -gt 0 ]]; do
     arg="$1"
-
     case $arg in
         --no-source-reference-column)
             no_source_reference=true
@@ -58,6 +59,10 @@ while [[ $# -gt 0 ]]; do
             omit_query_error_highlighting=true
             shift
             ;;
+        --output-markdown-table)
+            output_markdown_table=true
+            shift
+            ;;
         *)
             if [[ -z "${cypher_query_file_name}" ]]; then
                 # Input Arguments: Read the first unnamed input argument containing the name of the cypher file
@@ -134,11 +139,35 @@ if [[ -n "${error_message}" ]]; then
   exit 1
 fi
 
-# Output results in CSV format
-if [ "${no_source_reference}" = true ] ; then
-  echo -n "${cypher_query_result}" | jq -r '(.results[0])? | .columns,(.data[].row)? | map(if type == "array" then join(",") else . end) | flatten | @csv'
+if [ "${output_markdown_table}" = "true" ] ; then
+  # Output results in Markdown format
+  echo "executeQuery: Will output in Markdown Table Format" >&2
+  echo -n "${cypher_query_result}" | jq -r '
+    # Take the first query result
+    .results[0] as $result
+
+    # Extract the column names
+    | $result.columns as $columns
+
+    # Build the Markdown header row
+    | ( "| " + ( $columns | join(" | ") ) + " |" )
+
+    # Build the Markdown separator row
+    , ( "| " + ( $columns | map("---") | join(" | ") ) + " |" )
+
+    # Build one row for each data entry
+    , ( $result.data[].row
+        | map(tostring)
+        | "| " + ( join(" | ") ) + " |"
+      )
+  '
 else
-  cypher_query_file_relative_name=${cypher_query_file_name#/**/cypher/}
-  sourceFileReferenceInfo="Source Cypher File: ${cypher_query_file_relative_name}"
-  echo -n "${cypher_query_result}" | jq -r --arg sourceReference "${sourceFileReferenceInfo}" '(.results[0])? | .columns + [$sourceReference], (.data[].row)? + [""]  | map(if type == "array" then join(",") else . end) | flatten | @csv'
+  # Output results in CSV format
+  if [ "${no_source_reference}" = true ] ; then
+    echo -n "${cypher_query_result}" | jq -r '(.results[0])? | .columns,(.data[].row)? | map(if type == "array" then join(",") else . end) | flatten | @csv'
+  else
+    cypher_query_file_relative_name=${cypher_query_file_name#/**/cypher/}
+    sourceFileReferenceInfo="Source Cypher File: ${cypher_query_file_relative_name}"
+    echo -n "${cypher_query_result}" | jq -r --arg sourceReference "${sourceFileReferenceInfo}" '(.results[0])? | .columns + [$sourceReference], (.data[].row)? + [""]  | map(if type == "array" then join(",") else . end) | flatten | @csv'
+  fi
 fi