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/joule/query/list

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('/joule/query/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Fetch events by offset and page size

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

Path parameters

schema*string

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

Example: "standardQuoteAnalyticsStream"

table*string

Table to trigger data export

Example: "quotes"

Query parameters

Response

200400500

OK

Body

application/json

eventTypestring

lineageobject

eventTime*integer (int64)

ingestTime*integer (int64)

valueobject

uUIDstring

subTypeobject

dictionaryobject

snapshotOptional (object)

Request

JavaScriptCurlPython

const response = await fetch('/joule/query/{schema}/{table}?offset=1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "eventType": "text",
    "uUID": "text",
    "snapshot": {
      "present": false,
      "empty": false
    }
  }
]

Trigger export table process using date time constraint.

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

Path parameters

schema*string

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

Example: "standardQuoteAnalyticsStream"

table*string

Table to trigger data export upon.

Example: "processed"

type*string

The data export type. Supported types parquet and csv.

Example: "parquet"

Query parameters

Response

200400500

OK

Request

JavaScriptCurlPython

const response = await fetch('/joule/export/{schema}/{table}/{type}?from=2022-10-14+17%3A00%3A00&to=2022-10-14+18%3A00%3A00&path=%7E%2Fquotes.parquet', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Trigger table delete process using date time constraints.

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

Path parameters

schema*string

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

Example: "standardQuoteAnalyticsStream"

table*string

Table to trigger data delete upon.

Example: "processed"

Query parameters

Response

200400500

OK

Request

JavaScriptCurlPython

const response = await fetch('/joule/delete/{schema}/{table}?from=2022-10-14+17%3A00%3A00&to=2022-10-14+18%3A00%3A00', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();