ReferenceSDKClient
Storage
SDK reference for storage — Manage saved SQL queries and execute queries against project storage.
Manage saved SQL queries and execute queries against project storage.
listQueries
GET
Usage:
const result = await swirls.client.storage.listQueries({
projectId: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes |
getQuery
GET
Usage:
const result = await swirls.client.storage.getQuery({
id: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
createQuery
POST
Usage:
const result = await swirls.client.storage.createQuery({
projectId: '...',
name: '...',
sql: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | |
name | string | Yes | |
sql | string | Yes |
Output:
| Field | Type | Description |
|---|---|---|
id | string | |
projectId | string | |
name | string | |
sql | string | |
createdAt | unknown | |
orgId | string | null | |
userId | string |
updateQuery
PUT
Usage:
const result = await swirls.client.storage.updateQuery({
id: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | No | |
sql | string | No |
Output:
| Field | Type | Description |
|---|---|---|
id | string | |
projectId | string | |
name | string | |
sql | string | |
createdAt | unknown | |
orgId | string | null | |
userId | string |
deleteQuery
DELETE
Usage:
const result = await swirls.client.storage.deleteQuery({
id: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
executeQuery
POST
Usage:
const result = await swirls.client.storage.executeQuery({
projectId: '...',
sql: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | |
sql | string | Yes |
Output:
| Field | Type | Description |
|---|---|---|
columns | string[] | |
rows | unknown[][] |