SWIRLS_
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:

ParameterTypeRequiredDescription
projectIdstringYes

getQuery

GET

Usage:

const result = await swirls.client.storage.getQuery({
  id: '...',
})

Input:

ParameterTypeRequiredDescription
idstringYes

createQuery

POST

Usage:

const result = await swirls.client.storage.createQuery({
  projectId: '...',
  name: '...',
  sql: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes
namestringYes
sqlstringYes

Output:

FieldTypeDescription
idstring
projectIdstring
namestring
sqlstring
createdAtunknown
orgIdstring | null
userIdstring

updateQuery

PUT

Usage:

const result = await swirls.client.storage.updateQuery({
  id: '...',
})

Input:

ParameterTypeRequiredDescription
idstringYes
namestringNo
sqlstringNo

Output:

FieldTypeDescription
idstring
projectIdstring
namestring
sqlstring
createdAtunknown
orgIdstring | null
userIdstring

deleteQuery

DELETE

Usage:

const result = await swirls.client.storage.deleteQuery({
  id: '...',
})

Input:

ParameterTypeRequiredDescription
idstringYes

executeQuery

POST

Usage:

const result = await swirls.client.storage.executeQuery({
  projectId: '...',
  sql: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes
sqlstringYes

Output:

FieldTypeDescription
columnsstring[]
rowsunknown[][]

On this page