Skip to content

Rest api

Jump to bottom
johnchronis edited this page Mar 24, 2016 · 17 revisions

Functionality

Through our REST API a user is able to:

  • to request the execution plan from Exareme
  • submit queries
  • retrieve results

##Settings A POST request is used to perform any of the tasks described in Functionality.

  • Exareme listens on port 9090
  • Content Type should be application/x-www-form-uriencoded
  • Every request should contain a form with the following values:
    • db : path to the database
    • query : the ExaDFL query
    • mode : _json _or viz (applicable on when requesting the execution plan from Exareme

##Endpoints

  • :9090/query/ : to perform a query
  • :9090/explain/ : to request the execution plan from Exareme

##Example Exareme on its default settings listen on port 9090.

With the following request you can get the execution query plan:

URL: http://localhost:9090/query/

With the following request you can submit queries:

URL: http://localhost:9090/explain/

-- mode: json or viz

##Notes The explain endpoint when used with the viz mode returns a html page that shows a graphic representation of the execution plan, same colors represent same workers.

Clone this wiki locally