Page History

Examples:

1. DDL request

   Code Block
   title Request
   curl -v http://localhost:19002/query/service -X POST \ -d "statement=create dataverse test;"

   Code Block
   title Response
   < HTTP/1.1 200 OK Content-Type: application/json { "status": "success" "metrics": { "executionTime": "1ms" } }

2. Query which is not executed, but returns logical plan

   Code Block
   title Request
   curl -v http://localhost:19002/query/service -X POST \ -d "statement=for $x in dataset testDS return $x & lossless=true & logical-plan=true & execute-query=false"

   Code Block
   title Response
   < HTTP/1.1 200 OK Content-Type: application/json { "status": "success" "metrics": { "executionTime": "5ms" }, "plans": { "logical_plan": [ {"operator": "distribute_result", "args": [{"exp": "var_ref", "var": "$$0"}]}, {"operator": "datascan", "output_vars": ["$$0", "$$1"]} ] } }

3. Query which synchronously returns CSV (with header) result inside JSON response

   Code Block
   title Request
   curl -v http://localhost:19002/query/service -X POST -H "Accept: text/csv" \ -d "statement=for $x in dataset Tweets return $x & signature=true"

   Code Block
   title Response
   < HTTP/1.1 200 OK Content-Type: application/json { "status": "success", "results": "'id','screen_name','message_text'\n'1','BarackObama','Four more years'" "metrics": { "executionTime": "10ms", "resultCount": 1 } }

4. Query which returns optimizer error

   Code Block
   title Request
   curl -v http://localhost:19002/query/service -X POST \ -d "statement=create dataset Tweets(TweetType) primary key facebook_id"

   Code Block
   title Response
   < HTTP/1.1 400 Bad Request Content-Type: application/json { "status": "error", "error": { "code": 1, "msg": "Field 'facebook_id' cannot be found in datatype 'TweetType'" } "metrics": { "executionTime": "1ms" } }

5. Query which returns runtime error

   Code Block
   title Request
   curl -v http://localhost:19002/query/service -X POST \ -d "statement=create dataset Tweets(TweetType) primary key facebook_id"

   Code Block
   title Response
   < HTTP/1.1 500 Internal Server Error Content-Type: application/json { "status": "fatal", "error": { "code": 99, "msg": "Something happen during query execution", "stacktrace": "java.lang.RuntimeException: \n\r at java.lang.Thread.run(Thread.java:745)" } "metrics": { "executionTime": "1ms" } }

6. Query which runs synchronously, however does not include them in the response, but provides a handle to retrieve them. Request also specifies to include ADM type (signature). 

   Code Block
   title Request
   curl -v http://localhost:19002/query/service -X POST \ -d "statement=for $x in dataset Tweets return $x & include-results=false & signature=true"

   Code Block
   title Response
   < HTTP/1.1 200 OK Content-Type: application/json { "status": "success", "handle": "http://localhost:19002/results/071cde2e-0277-11e6-b512-3e1d05defe78query/service/result/27-2", "signature": { "id": "int64", "screen_name": "string", "message_text": "string" }, "metrics": { "executionTime": "10ms", "resultCount": 2 } }

7. Query which returns lossless-JSON results asynchronously and does not include them in the response, but provides a handle to retrieve them.

   Code Block
   title Request
   curl -v http://localhost:19002/query/service -X POST -H "Accept: application/json" \ -d "statement=for $x in dataset Tweets return $x & lossless=true & mode=asynchronous & include-results=false"

   Code Block
   title Response
   < HTTP/1.1 200 OK Content-Type: application/json { "status": "running", "handle": "http://localhost:19002/query/service/status/bd7a2b0e-0277-11e6-b512-3e1d05defe7827-2" "metrics": { } }