Wren Engine API (0.15.1)
Download OpenAPI specification:Download
Dry Plan Deprecated
get the planned WrenSQL
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
| manifestStr required | string (Manifeststr) Base64 manifest |
| sql required | string (Sql) |
Responses
Request samples
- Payload
Content type
application/json
{- "manifestStr": "string",
- "sql": "string"
}Response samples
- 200
- 422
Content type
application/json
"string"Dry Plan For Data Source Deprecated
get the dialect SQL for the specified data source
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
| manifestStr required | string (Manifeststr) Base64 manifest |
| sql required | string (Sql) |
Responses
Request samples
- Payload
Content type
application/json
{- "manifestStr": "string",
- "sql": "string"
}Response samples
- 200
- 422
Content type
application/json
"string"Get Constraints Deprecated
get the constraints of the specified data source
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
required | BigQueryConnectionInfo (object) or CannerConnectionInfo (object) or ConnectionUrl (object) or MSSqlConnectionInfo (object) or MySqlConnectionInfo (object) or OracleConnectionInfo (object) or PostgresConnectionInfo (object) or SnowflakeConnectionInfo (object) or TrinoConnectionInfo (object) or LocalFileConnectionInfo (object) or S3FileConnectionInfo (object) or MinioFileConnectionInfo (object) or GcsFileConnectionInfo (object) (Connectioninfo) | ||||||
Any of
| |||||||
Responses
Request samples
- Payload
Content type
application/json
{- "connectionInfo": {
- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}
}Response samples
- 200
- 422
Content type
application/json
[- {
- "constraintColumn": "string",
- "constraintName": "string",
- "constraintTable": "string",
- "constraintType": "PRIMARY KEY",
- "constraintedColumn": "string",
- "constraintedTable": "string"
}
]Get Table List Deprecated
get the table list of the specified data source
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
required | BigQueryConnectionInfo (object) or CannerConnectionInfo (object) or ConnectionUrl (object) or MSSqlConnectionInfo (object) or MySqlConnectionInfo (object) or OracleConnectionInfo (object) or PostgresConnectionInfo (object) or SnowflakeConnectionInfo (object) or TrinoConnectionInfo (object) or LocalFileConnectionInfo (object) or S3FileConnectionInfo (object) or MinioFileConnectionInfo (object) or GcsFileConnectionInfo (object) (Connectioninfo) | ||||||
Any of
| |||||||
Responses
Request samples
- Payload
Content type
application/json
{- "connectionInfo": {
- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}
}Response samples
- 200
- 422
Content type
application/json
[- {
- "columns": [
- {
- "description": "string",
- "name": "string",
- "nestedColumns": [
- { }
], - "notNull": true,
- "properties": { },
- "type": "string"
}
], - "description": "string",
- "name": "string",
- "primaryKey": "string",
- "properties": {
- "catalog": "string",
- "path": "string",
- "schema": "string",
- "table": "string"
}
}
]Get Db Version Deprecated
get the version of the specified data source
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
Request Body schema: application/jsonrequired
required | BigQueryConnectionInfo (object) or CannerConnectionInfo (object) or ConnectionUrl (object) or MSSqlConnectionInfo (object) or MySqlConnectionInfo (object) or OracleConnectionInfo (object) or PostgresConnectionInfo (object) or SnowflakeConnectionInfo (object) or TrinoConnectionInfo (object) or LocalFileConnectionInfo (object) or S3FileConnectionInfo (object) or MinioFileConnectionInfo (object) or GcsFileConnectionInfo (object) (Connectioninfo) | ||||||
Any of
| |||||||
Responses
Request samples
- Payload
Content type
application/json
{- "connectionInfo": {
- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}
}Response samples
- 200
- 422
Content type
application/json
"string"Model Substitute Deprecated
get the SQL which table name is substituted
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
required | BigQueryConnectionInfo (object) or CannerConnectionInfo (object) or ConnectionUrl (object) or MSSqlConnectionInfo (object) or MySqlConnectionInfo (object) or OracleConnectionInfo (object) or PostgresConnectionInfo (object) or SnowflakeConnectionInfo (object) or TrinoConnectionInfo (object) or LocalFileConnectionInfo (object) or S3FileConnectionInfo (object) or MinioFileConnectionInfo (object) or GcsFileConnectionInfo (object) (Connectioninfo) |
| manifestStr required | string (Manifeststr) Base64 manifest |
| sql required | string (Sql) |
Responses
Request samples
- Payload
Content type
application/json
{- "connectionInfo": {
- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}, - "manifestStr": "string",
- "sql": "string"
}Response samples
- 200
- 422
Content type
application/json
"string"Query Deprecated
query the specified data source
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
query Parameters
| dryRun | boolean (Dryrun) Default: false enable dryRun mode for validating SQL only |
| cacheEnable | boolean (Cacheenable) Default: false enable query cache mode |
Limit (integer) or Limit (null) (Limit) limit the number of rows returned |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
required | BigQueryConnectionInfo (object) or CannerConnectionInfo (object) or ConnectionUrl (object) or MSSqlConnectionInfo (object) or MySqlConnectionInfo (object) or OracleConnectionInfo (object) or PostgresConnectionInfo (object) or SnowflakeConnectionInfo (object) or TrinoConnectionInfo (object) or LocalFileConnectionInfo (object) or S3FileConnectionInfo (object) or MinioFileConnectionInfo (object) or GcsFileConnectionInfo (object) (Connectioninfo) |
| manifestStr required | string (Manifeststr) Base64 manifest |
| sql required | string (Sql) |
Responses
Request samples
- Payload
Content type
application/json
{- "connectionInfo": {
- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}, - "manifestStr": "string",
- "sql": "string"
}Response samples
- 200
- 422
Content type
application/json
nullValidate Deprecated
validate the specified rule
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
| rule_name required | string (Rule Name) |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
required | BigQueryConnectionInfo (object) or CannerConnectionInfo (object) or ConnectionUrl (object) or MSSqlConnectionInfo (object) or MySqlConnectionInfo (object) or OracleConnectionInfo (object) or PostgresConnectionInfo (object) or SnowflakeConnectionInfo (object) or TrinoConnectionInfo (object) or LocalFileConnectionInfo (object) or S3FileConnectionInfo (object) or MinioFileConnectionInfo (object) or GcsFileConnectionInfo (object) (Connectioninfo) |
| manifestStr required | string (Manifeststr) Base64 manifest |
required | object (Parameters) |
Responses
Request samples
- Payload
Content type
application/json
{- "connectionInfo": {
- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}, - "manifestStr": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}
}Response samples
- 200
- 422
Content type
application/json
nullDry Plan
get the planned WrenSQL
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
| manifestStr required | string (Manifeststr) Base64 manifest |
| sql required | string (Sql) |
Responses
Request samples
- Payload
Content type
application/json
{- "manifestStr": "string",
- "sql": "string"
}Response samples
- 200
- 422
Content type
application/json
"string"Dry Plan For Data Source
get the dialect SQL for the specified data source
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
| manifestStr required | string (Manifeststr) Base64 manifest |
| sql required | string (Sql) |
Responses
Request samples
- Payload
Content type
application/json
{- "manifestStr": "string",
- "sql": "string"
}Response samples
- 200
- 422
Content type
application/json
"string"Functions
get the available function list of the specified data source
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
header Parameters
Headers (string) or Headers (null) (Headers) |
Responses
Response samples
- 200
- 422
Content type
application/json
nullModel Substitute
get the SQL which table name is substituted
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
required | BigQueryConnectionInfo (object) or CannerConnectionInfo (object) or ConnectionUrl (object) or MSSqlConnectionInfo (object) or MySqlConnectionInfo (object) or OracleConnectionInfo (object) or PostgresConnectionInfo (object) or SnowflakeConnectionInfo (object) or TrinoConnectionInfo (object) or LocalFileConnectionInfo (object) or S3FileConnectionInfo (object) or MinioFileConnectionInfo (object) or GcsFileConnectionInfo (object) (Connectioninfo) |
| manifestStr required | string (Manifeststr) Base64 manifest |
| sql required | string (Sql) |
Responses
Request samples
- Payload
Content type
application/json
{- "connectionInfo": {
- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}, - "manifestStr": "string",
- "sql": "string"
}Response samples
- 200
- 422
Content type
application/json
"string"Query
query the specified data source
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
query Parameters
| dryRun | boolean (Dryrun) Default: false enable dryRun mode for validating SQL only |
| cacheEnable | boolean (Cacheenable) Default: false enable query cache mode |
Limit (integer) or Limit (null) (Limit) limit the number of rows returned |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
required | BigQueryConnectionInfo (object) or CannerConnectionInfo (object) or ConnectionUrl (object) or MSSqlConnectionInfo (object) or MySqlConnectionInfo (object) or OracleConnectionInfo (object) or PostgresConnectionInfo (object) or SnowflakeConnectionInfo (object) or TrinoConnectionInfo (object) or LocalFileConnectionInfo (object) or S3FileConnectionInfo (object) or MinioFileConnectionInfo (object) or GcsFileConnectionInfo (object) (Connectioninfo) |
| manifestStr required | string (Manifeststr) Base64 manifest |
| sql required | string (Sql) |
Responses
Request samples
- Payload
Content type
application/json
{- "connectionInfo": {
- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}, - "manifestStr": "string",
- "sql": "string"
}Response samples
- 200
- 422
Content type
application/json
nullValidate
validate the specified rule
path Parameters
| data_source required | string (DataSource) Enum: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file" |
| rule_name required | string (Rule Name) |
header Parameters
Headers (string) or Headers (null) (Headers) |
Request Body schema: application/jsonrequired
required | BigQueryConnectionInfo (object) or CannerConnectionInfo (object) or ConnectionUrl (object) or MSSqlConnectionInfo (object) or MySqlConnectionInfo (object) or OracleConnectionInfo (object) or PostgresConnectionInfo (object) or SnowflakeConnectionInfo (object) or TrinoConnectionInfo (object) or LocalFileConnectionInfo (object) or S3FileConnectionInfo (object) or MinioFileConnectionInfo (object) or GcsFileConnectionInfo (object) (Connectioninfo) |
| manifestStr required | string (Manifeststr) Base64 manifest |
required | object (Parameters) |
Responses
Request samples
- Payload
Content type
application/json
{- "connectionInfo": {
- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}, - "manifestStr": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}
}Response samples
- 200
- 422
Content type
application/json
nullAnalyze Sql Deprecated
Request Body schema: application/jsonrequired
| manifestStr required | string (Manifeststr) Base64 manifest |
| sql required | string (Sql) |
Responses
Request samples
- Payload
Content type
application/json
{- "manifestStr": "string",
- "sql": "string"
}Response samples
- 200
- 422
Content type
application/json
[- { }
]Analyze Sql Batch Deprecated
Request Body schema: application/jsonrequired
| manifestStr required | string (Manifeststr) Base64 manifest |
| sqls required | Array of strings (Sqls) |
Responses
Request samples
- Payload
Content type
application/json
{- "manifestStr": "string",
- "sqls": [
- "string"
]
}Response samples
- 200
- 422
Content type
application/json
[- [
- { }
]
]| credentials required | string <password> (Credentials) Base64 encode |
| dataset_id required | string <password> (Dataset Id) BigQuery dataset id |
| project_id required | string <password> (Project Id) GCP project id |
{- "credentials": "eyJ...",
- "dataset_id": "my_dataset",
- "project_id": "my-project"
}| enableSSL | boolean (Enablessl) Default: false Enable SSL connection |
| host required | string <password> (Host) the hostname of your database |
| pat required | string <password> (Pat) the personal access token of your database |
| port required | string <password> (Port) the port of your database |
| user required | string <password> (User) the username of your database |
| workspace required | string <password> (Workspace) the workspace of your database |
{- "enableSSL": false,
- "host": "localhost",
- "pat": "eyJ...",
- "port": "8080",
- "user": "admin",
- "workspace": "default"
}| bucket required | string <password> (Bucket) the name of the gcs bucket |
| credentials | string <password> (Credentials) Base64 encode |
| format | string (Format) Default: "csv" File format |
| key_id required | string <password> (Key Id) the key id of the gcs bucket |
| secret_key required | string <password> (Secret Key) the secret key of the gcs bucket |
| url | string <password> (Url) Default: "/" the root path of the gcs bucket |
{- "bucket": "my-bucket",
- "credentials": "eyJ...",
- "format": "csv",
- "key_id": "my-key-id",
- "secret_key": "my-secret-key",
- "url": "/data"
}| format | string (Format) Default: "csv" File format |
| url | string <password> (Url) Default: "/" the root path of the local file |
{- "format": "csv",
- "url": "/data"
}| TDS_Version | string (Tds Version) Default: "8.0" The TDS version to use |
| database required | string <password> (Database) the database name of your database |
| driver | string (Driver) Default: "ODBC Driver 18 for SQL Server" The ODBC driver to use |
| host required | string <password> (Host) the hostname of your database |
Kwargs (object) or Kwargs (null) (Kwargs) Additional keyword arguments to pass to PyODBC | |
Password (string) or Password (null) (Password) the password of your database | |
| port required | string <password> (Port) the port of your database |
| user required | string <password> (User) the username of your database |
{- "TDS_Version": "8.0",
- "database": "master",
- "driver": "ODBC Driver 18 for SQL Server",
- "host": "localhost",
- "kwargs": {
- "property1": "string",
- "property2": "string"
}, - "password": "password",
- "port": "1433",
- "user": "sa"
}| access_key required | string <password> (Access Key) the account of the minio bucket |
| bucket required | string <password> (Bucket) the name of the minio bucket |
| endpoint required | string <password> (Endpoint) the endpoint of the minio bucket |
| format | string (Format) Default: "csv" File format |
| secret_key required | string <password> (Secret Key) the The password of the minio bucket |
| ssl_enabled | boolean (Ssl Enabled) Default: false use the ssl connection or not |
| url | string <password> (Url) Default: "/" the root path of the minio bucket |
{- "access_key": "my-account",
- "bucket": "my-bucket",
- "endpoint": "localhost:9000",
- "format": "csv",
- "secret_key": "my-password",
- "ssl_enabled": true,
- "url": "/data"
}| database required | string <password> (Database) the database name of your database |
| host required | string <password> (Host) the hostname of your database |
Kwargs (object) or Kwargs (null) (Kwargs) Additional keyword arguments to pass to PyMySQL | |
Password (string) or Password (null) (Password) the password of your database | |
| port required | string <password> (Port) the port of your database |
Sslca (string) or Sslca (null) (Sslca) The path to the CA certificate file | |
Sslmode (string) or Sslmode (null) (Sslmode) Default: "ENABLED" Use ssl connection or not. The default value is | |
| user required | string <password> (User) the username of your database |
{- "database": "default",
- "host": "localhost",
- "kwargs": {
- "property1": "string",
- "property2": "string"
}, - "password": "password",
- "port": "3306",
- "sslMode": "DISABLED",
- "user": "root"
}| database required | string <password> (Database) the database name of your database |
| host required | string <password> (Host) the hostname of your database |
Password (string) or Password (null) (Password) the password of your database | |
| port required | string <password> (Port) the port of your database |
| user required | string <password> (User) the username of your database |
{- "database": "orcl",
- "host": "localhost",
- "password": "password",
- "port": 1521,
- "user": "admin"
}| database required | string <password> (Database) the database name of your database |
| host required | string <password> (Host) the hostname of your database |
Password (string) or Password (null) (Password) the password of your database | |
| port required | string <password> (Port) the port of your database |
| user required | string <password> (User) the username of your database |
{- "database": "postgres",
- "host": "localhost",
- "password": "password",
- "port": 5432,
- "user": "postgres"
}| access_key required | string <password> (Access Key) the access key of the s3 bucket |
| bucket required | string <password> (Bucket) the name of the s3 bucket |
| format | string (Format) Default: "csv" File format |
| region required | string <password> (Region) the region of the s3 bucket |
| secret_key required | string <password> (Secret Key) the secret key of the s3 bucket |
| url | string <password> (Url) Default: "/" the root path of the s3 bucket |
{- "access_key": "my-access-key",
- "bucket": "my-bucket",
- "format": "csv",
- "region": "us-west-2",
- "secret_key": "my-secret-key",
- "url": "/data"
}| account required | string <password> (Account) the account name of your database |
| database required | string <password> (Database) the database name of your database |
| password required | string <password> (Password) the password of your database |
| schema required | string <password> (Schema) the schema name of your database |
| user required | string <password> (User) the username of your database |
{- "account": "myaccount",
- "database": "mydb",
- "password": "password",
- "schema": "myschema",
- "user": "admin"
}| catalog required | string <password> (Catalog) the catalog name of your database |
| host required | string <password> (Host) the hostname of your database |
Password (string) or Password (null) (Password) the password of your database | |
| port | string <password> (Port) Default: "8080" the port of your database |
| schema required | string <password> (Schema) the schema name of your database |
User (string) or User (null) (User) the username of your database |
{- "catalog": "hive",
- "host": "localhost",
- "password": "password",
- "port": "8080",
- "schema": "default",
- "user": "admin"
}