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:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | |
appName | string | No | |
streamName | string | Yes | |
version | string | Yes | |
filter | object | No |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | |
appName | string | No | |
streamName | string | Yes | |
version | string | No |
Output:
| Field | Type | Description |
|---|---|---|
name | string | |
version | string | |
versionKeys | string[] | |
columns | object[] |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | |
appName | string | No | |
streamName | string | Yes | |
version | string | No | |
limit | number | No | |
offset | number | No | |
filters | object[] | No | |
search | string | No | |
orderBy | object | No |
Output:
| Field | Type | Description |
|---|---|---|
version | string | |
columns | object[] | |
rows | object[] | |
totalCount | number |