SDKClient

Streams

SDK reference for streams — Stream resources and related APIs.

Stream resources and related APIs.

listStreams

List stream definitions for a project (merged across deployments by stream name)

GET

Usage:

const result = await swirls.client.streams.listStreams({
  projectId: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes

queryStreamOutputs

Query persisted rows for a stream name and version across all deployments in the project

GET

Usage:

const result = await swirls.client.streams.queryStreamOutputs({
  projectId: '...',
  streamName: '...',
  version: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes
appNamestringNo
streamNamestringYes
versionstringYes
filterobjectNo

schema

Column layout for a stream version (JSON Schema properties plus created_at)

GET

Usage:

const result = await swirls.client.streams.schema({
  projectId: '...',
  streamName: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes
appNamestringNo
streamNamestringYes
versionstringNo

Output:

FieldTypeDescription
namestring
versionstring
versionKeysstring[]
columnsobject[]

listRows

Page persisted stream rows with AND filters, ILIKE search, and offset paging

GET

Usage:

const result = await swirls.client.streams.listRows({
  projectId: '...',
  streamName: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes
appNamestringNo
streamNamestringYes
versionstringNo
limitnumberNo
offsetnumberNo
filtersobject[]No
searchstringNo
orderByobjectNo

Output:

FieldTypeDescription
versionstring
columnsobject[]
rowsobject[]
totalCountnumber

On this page