Skip to main content

Dry plan

Rewrite SQL using manifest information without executing the query. This API allows you to rewrite SQL using only the manifest information.

POST /v2/ibis/dry-plan

Request body​

  • manifestStr: string, required. This is a base64 encoded string. Please refer to the Manifest documentation for more information.
  • sql: string, required
{
  "manifestStr": "eyJjYXRhbG9nIjoibXlfY2F0YWxvZyIsInN......",
  "sql": "SELECT orderkey FROM \"Orders\" LIMIT 1"
}

Request response​

The API will return a string containing the rewritten SQL query.

Dry plan with data source​

Rewrite SQL using manifest information and transpile it into the specified data source's dialect.

POST /v2/ibis/{data_source}/dry-plan

Path parameters​

  • data_source: string, required. Specifies the data source. Refer to the Data source documentation for available options.

Request body​

  • manifestStr: string, required. This is a base64 encoded string. Please refer to the Manifest documentation for more information.
  • sql: string, required
{
  "manifestStr": "eyJjYXRhbG9nIjoibXlfY2F0YWxvZyIsInN......",
  "sql": "SELECT orderkey, order_cust_key FROM \"Orders\" LIMIT 1"
}

Request response​

The API will return a string containing the rewritten SQL query transpiled into the specified data source's dialect.