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.

PreviousData access API NextUpload

Last updated 4 months ago

Was this helpful?

Fetch events by offset and page size

get

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

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

fromstring

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

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

tostring

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 · int32

Number of events to return.

Example: 1000

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/joule/query/{schema}/{table}?offset=1'

200

400

500

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

Trigger export table process using date time constraint.

get

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

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

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/joule/export/{schema}/{table}/{type}?from=2022-10-14+17%3A00%3A00&to=2022-10-14+18%3A00%3A00&path=%7E%2Fquotes.parquet'

200

400

500

No body

Trigger table delete process using date time constraints.

delete

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

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/joule/delete/{schema}/{table}?from=2022-10-14+17%3A00%3A00&to=2022-10-14+18%3A00%3A00'

200

400

500

No body