Query

Fetch, export, delete and subscribe to data

---

Overview

The Query API allows developers to list available data to query, fetch, export and delete data from the internal in-memory database.

---

Get list of available table queries to execute

get

Responses

200

OK

No content

get

/joule/query/list

HTTPcURLJavaScriptPython

GET /joule/query/list HTTP/1.1
Host: 
Accept: */*

200

OK

No content

Fetch events by offset and page size

get

Path parameters

schemastringRequired

Database schema where the table resides. Dynamically set by the use case DSL as the stream processing name

Example: standardQuoteAnalyticsStream

tablestringRequired

Table to trigger data export

Example: quotes

Query parameters

fromstringOptional

Date time parameter to define point in time to start from.

Example: 2022-10-14 17:00:00

tostringOptional

Date time parameter to define point in time to go too.

Example: 2022-10-14 18:00:00

offsetinteger · int32Required

Page offset to fetch next set of events.

Example: 1

pagesizeinteger · int32Optional

Number of events to return.

Example: 1000

Responses

200

OK

application/json

400

Missing or invalid parameters

500

Internal Joule error. Check log files.

get

/joule/query/{schema}/{table}

HTTPcURLJavaScriptPython

GET /joule/query/{schema}/{table}?offset=1 HTTP/1.1
Host: 
Accept: */*

[
  {
    "eventType": "text",
    "lineage": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "eventTime": 1,
    "ingestTime": 1,
    "value": {},
    "uUID": "text",
    "subType": {},
    "dictionary": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "snapshot": {
      "": {},
      "present": true,
      "empty": true
    }
  }
]

Trigger export table process using date time constraint.

get

Path parameters

schemastringRequired

Database schema where the table resides. Dynamically set by the use case DSL as the stream processing name.

Example: standardQuoteAnalyticsStream

tablestringRequired

Table to trigger data export upon.

Example: processed

typestringRequired

The data export type. Supported types parquet and csv.

Example: parquet

Query parameters

fromstringRequired

Date time parameter to define point in time to start from.

Example: 2022-10-14 17:00:00

tostringRequired

Date time parameter to define point in time to go too.

Example: 2022-10-14 18:00:00

pathstringRequired

Place to land export file too

Example: ~/quotes.parquet

Responses

200

OK

No content

400

Missing or invalid parameters

500

Internal Joule error. Check log files.

get

/joule/export/{schema}/{table}/{type}

HTTPcURLJavaScriptPython

GET /joule/export/{schema}/{table}/{type}?from=2022-10-14+17%3A00%3A00&to=2022-10-14+18%3A00%3A00&path=~%2Fquotes.parquet HTTP/1.1
Host: 
Accept: */*

No content

Trigger table delete process using date time constraints.

delete

Path parameters

schemastringRequired

Database schema where the table resides. Dynamically set by the use case DSL as the stream processing name.

Example: standardQuoteAnalyticsStream

tablestringRequired

Table to trigger data delete upon.

Example: processed

Query parameters

fromstringRequired

Date time parameter to define point in time to start from.

Example: 2022-10-14 17:00:00

tostringRequired

Date time parameter to define point in time to go too.

Example: 2022-10-14 18:00:00

Responses

200

OK

No content

400

Missing or invalid parameters

500

Internal Joule error. Check log files.

delete

/joule/delete/{schema}/{table}

HTTPcURLJavaScriptPython

DELETE /joule/delete/{schema}/{table}?from=2022-10-14+17%3A00%3A00&to=2022-10-14+18%3A00%3A00 HTTP/1.1
Host: 
Accept: */*

No content