Preview Operations

Create a SQL preview.

Requires a bearer token for starting a data plane preview issued by the control plane API.

post/sql/preview

Request

Base URL
https://replace-with-account.api.data.decodable.co/v1alpha2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/decodable/apis/decodable-data-plane/docs/sql/preview/post.ts
A function with typed inputs. Its response is checked against the schema.

preview_idstring required

The id for the preview to use

rewritten_sqlstring required

The sql for the preview to run.

stream_metadataobject[] required

A preview creation response.

idstring required

An opaque ID, created by Decodable, that uniquely identifies a resource.

output_stream_type'APPEND' | 'CHANGE'

resultsobject[]

Result rows from preview.

next_tokenstring

A token used to fetch the next available results.

{
  "id": "abcd1234"
}

No recorded changes to this operation across all 1 revision of this API.