Data Engine
Runs a read-only SQL query against your organization's Data Engine.
bridge.executeDataEngineQuery(options) // → Promise<DataEngineResult>The query runs against your organization's data. The widget's bound device controls the request lifetime only — it does not scope the rows, and the call accepts no device or organization ID. SQL and server authorization decide what is readable.
Parameters
options.sql
string
yes
1 to 5000 characters, not blank
options.limit
number
no
Integer from 0 to 100000. 0 (the default) means the server's row cap
options.offset
number
no
Integer from 0 to 2147483647. Default 0
options must be a plain object with only these three properties, and the serialized request must not exceed 64 KB.
Resolves with
{
meta: Array<{ name: string }>, // columns, in result order
rows: Array<Array<null | boolean | number | string | object | unknown[]>>,
offset: number, // echoes the request
hasMore: boolean
}Paginate with nextOffset = result.offset + result.rows.length while hasMore is true. Use a deterministic ORDER BY — each page is an independent query with no snapshot guarantee. There is no automatic refresh; run the query again when you need fresh rows.
Rejects with
invalid_request
options isn't an object, has an unknown property (Unknown request property '<name>'), sql isn't a string, or the request is too large
invalid_options
sql is empty or too long, or limit / offset is out of range
invalid_selector
limit or offset isn't an integer
invalid_response
The host returned a malformed or mismatched result
request_timeout
No result within 35 seconds
too_many_requests
Too many queries pending at once
device_unavailable
The host doesn't provide Data Engine queries
transport_disconnected
The result couldn't be fetched
server_error
The query failed without a specific code; SQL error details may be in details
bridge_destroyed
Called after destroy()
Permission: QUERY_DATA_ENGINE (organization scope). The response must not exceed 5 MiB.
Example
Was this helpful?

