Protocol Testing

Building Avatica clients in a variety of languages is one of the primarygoals of Avatica. There are various tools which can help in this process,but one of the most useful is a reference for how clients interact withthe Avatica server.

Testing with cURL

A trivial way to interact with an Avatica server is using cURL and the JSONserialization. The below was tested to work with Avatica 1.10.0:

  1. #!/usr/bin/env bash
  3. set -u
  5. AVATICA=$1
  6. SQL=$2
  8. CONNECTION_ID="conn-$(whoami)-$(date +%s)"
  9. MAX_ROW_COUNT=100
  10. NUM_ROWS=2
  11. OFFSET=0
  13. echo "Open connection"
  14. openConnectionReq="{\"request\": \"openConnection\",\"connectionId\": \"${CONNECTION_ID}\"}"
  15. # Example of how to set connection properties with info key
  16. # openConnectionReqWithProperties="{\"request\": \"openConnection\",\"connectionId\": \"${CONNECTION_ID}\",\"info\": {\"user\": \"SCOTT\",\"password\": \"TIGER\"}}"
  17. curl -i -w "\n" "$AVATICA" -H "Content-Type: application/json" --data "$openConnectionReq"
  18. echo
  20. echo "Create statement"
  21. STATEMENTRSP=$(curl -s "$AVATICA" -H "Content-Type: application/json" --data "{\"request\": \"createStatement\",\"connectionId\": \"${CONNECTION_ID}\"}")
  22. STATEMENTID=$(echo "$STATEMENTRSP" | jq .statementId)
  23. echo
  25. echo "PrepareAndExecuteRequest"
  26. curl -i -w "\n" "$AVATICA" -H "Content-Type: application/json" --data "{\"request\": \"prepareAndExecute\",\"connectionId\": \"${CONNECTION_ID}\",\"statementId\": $STATEMENTID,\"sql\": \"$SQL\",\"maxRowCount\": ${MAX_ROW_COUNT}, \"maxRowsInFirstFrame\": ${NUM_ROWS}}"
  27. echo
  29. # Loop through all the results
  30. ISDONE=false
  31. while ! $ISDONE; do
  32.   OFFSET=$((OFFSET + NUM_ROWS))
  33.   echo "FetchRequest - Offset=$OFFSET"
  34.   FETCHRSP=$(curl -s "$AVATICA" -H "Content-Type: application/json" --data "{\"request\": \"fetch\",\"connectionId\": \"${CONNECTION_ID}\",\"statementId\": $STATEMENTID,\"offset\": ${OFFSET},\"fetchMaxRowCount\": ${NUM_ROWS}}")
  35.   echo "$FETCHRSP"
  36.   ISDONE=$(echo "$FETCHRSP" | jq .frame.done)
  37.   echo
  38. done
  40. echo "Close statement"
  41. curl -i -w "\n" "$AVATICA" -H "Content-Type: application/json" --data "{\"request\": \"closeStatement\",\"connectionId\": \"${CONNECTION_ID}\",\"statementId\": $STATEMENTID}"
  42. echo
  44. echo "Close connection"
  45. curl -i -w "\n" "$AVATICA" -H "Content-Type: application/json" --data "{\"request\": \"closeConnection\",\"connectionId\": \"${CONNECTION_ID}\"}"
  46. echo