SDK API Reference / JobSDK
Class: JobSDK
Job API - manage and execute jobs
Methods
getUserInfo()
getUserInfo():
Promise<UserInfo>
Get current user information
Returns
Promise<UserInfo>
User information including email
kill()
kill(
jobId):Promise<void>
Kill a job
Parameters
jobId
string
Job ID to kill
Returns
Promise<void>
list()
list(
options?):Promise<Job[]>
List jobs
Parameters
options?
Optional pagination and filter options
from?
number
Starting offset (inclusive, default: 0)
status?
string
Filter by job status (queued, running, success, error)
to?
number
Ending offset (inclusive)
Returns
Promise<Job[]>
Array of jobs with normalized timestamps
result()
result<
T>(jobId):Promise<T[]>
Get job results
Type Parameters
T
T = unknown
Parameters
jobId
string
Job ID
Returns
Promise<T[]>
Array of result rows
show()
show(
jobId):Promise<Job>
Show job details
Parameters
jobId
string
Job ID
Returns
Promise<Job>
Job details with normalized timestamps
submit()
submit(
database,query,jobType?,result?):Promise<{job_id:string; }>
Submit a job
Parameters
database
string
Database name
query
string
SQL query to execute
jobType?
"trino" | "hive"
Job type (trino or hive)
result?
string
Returns
Promise<{ job_id: string; }>
Job submission response with job_id