跳到主要内容
由 Redocly 提供支持的 API 文档

Wren Engine API (0.15.1)

下载 OpenAPI 规范:下载

连接器

干运行计划 已弃用

获取计划的 WrenSQL

请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
manifestStr
必需
string (Manifeststr)

Base64 manifest

sql
必需
string (Sql)

响应

请求示例

内容类型
application/json
{
  • "manifestStr": "string",
  • "sql": "string"
}

响应示例

内容类型
application/json
"string"

数据源干运行计划 已弃用

获取指定数据源的方言 SQL

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
manifestStr
必需
string (Manifeststr)

Base64 manifest

sql
必需
string (Sql)

响应

请求示例

内容类型
application/json
{
  • "manifestStr": "string",
  • "sql": "string"
}

响应示例

内容类型
application/json
"string"

获取约束 已弃用

获取指定数据源的约束

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
必需
BigQueryConnectionInfo (object) 或 CannerConnectionInfo (object) 或 ConnectionUrl (object) 或 MSSqlConnectionInfo (object) 或 MySqlConnectionInfo (object) 或 OracleConnectionInfo (object) 或 PostgresConnectionInfo (object) 或 SnowflakeConnectionInfo (object) 或 TrinoConnectionInfo (object) 或 LocalFileConnectionInfo (object) 或 S3FileConnectionInfo (object) 或 MinioFileConnectionInfo (object) 或 GcsFileConnectionInfo (object) (Connectioninfo)
其中之一
credentials
必需
string <password> (Credentials)

Base64 编码的 credentials.json

dataset_id
必需
string <password> (Dataset Id)

BigQuery dataset id

project_id
必需
string <password> (Project Id)

GCP project id

响应

请求示例

内容类型
application/json
{
  • "connectionInfo": {
    }
}

响应示例

内容类型
application/json
[
  • {
    }
]

获取表列表 已弃用

获取指定数据源的表列表

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
必需
BigQueryConnectionInfo (object) 或 CannerConnectionInfo (object) 或 ConnectionUrl (object) 或 MSSqlConnectionInfo (object) 或 MySqlConnectionInfo (object) 或 OracleConnectionInfo (object) 或 PostgresConnectionInfo (object) 或 SnowflakeConnectionInfo (object) 或 TrinoConnectionInfo (object) 或 LocalFileConnectionInfo (object) 或 S3FileConnectionInfo (object) 或 MinioFileConnectionInfo (object) 或 GcsFileConnectionInfo (object) (Connectioninfo)
其中之一
credentials
必需
string <password> (Credentials)

Base64 编码的 credentials.json

dataset_id
必需
string <password> (Dataset Id)

BigQuery dataset id

project_id
必需
string <password> (Project Id)

GCP project id

响应

请求示例

内容类型
application/json
{
  • "connectionInfo": {
    }
}

响应示例

内容类型
application/json
[
  • {
    }
]

获取数据库版本 已弃用

获取指定数据源的版本

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
请求体 schema: application/json
必需
必需
BigQueryConnectionInfo (object) 或 CannerConnectionInfo (object) 或 ConnectionUrl (object) 或 MSSqlConnectionInfo (object) 或 MySqlConnectionInfo (object) 或 OracleConnectionInfo (object) 或 PostgresConnectionInfo (object) 或 SnowflakeConnectionInfo (object) 或 TrinoConnectionInfo (object) 或 LocalFileConnectionInfo (object) 或 S3FileConnectionInfo (object) 或 MinioFileConnectionInfo (object) 或 GcsFileConnectionInfo (object) (Connectioninfo)
其中之一
credentials
必需
string <password> (Credentials)

Base64 编码的 credentials.json

dataset_id
必需
string <password> (Dataset Id)

BigQuery dataset id

project_id
必需
string <password> (Project Id)

GCP project id

响应

请求示例

内容类型
application/json
{
  • "connectionInfo": {
    }
}

响应示例

内容类型
application/json
"string"

模型替换 已弃用

获取表名已替换的 SQL

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
必需
BigQueryConnectionInfo (object) 或 CannerConnectionInfo (object) 或 ConnectionUrl (object) 或 MSSqlConnectionInfo (object) 或 MySqlConnectionInfo (object) 或 OracleConnectionInfo (object) 或 PostgresConnectionInfo (object) 或 SnowflakeConnectionInfo (object) 或 TrinoConnectionInfo (object) 或 LocalFileConnectionInfo (object) 或 S3FileConnectionInfo (object) 或 MinioFileConnectionInfo (object) 或 GcsFileConnectionInfo (object) (Connectioninfo)
manifestStr
必需
string (Manifeststr)

Base64 manifest

sql
必需
string (Sql)

响应

请求示例

内容类型
application/json
{
  • "connectionInfo": {
    },
  • "manifestStr": "string",
  • "sql": "string"
}

响应示例

内容类型
application/json
"string"

查询 已弃用

查询指定数据源

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
查询参数
dryRun
boolean (Dryrun)
默认值: false

启用 dryRun 模式仅用于验证 SQL

cacheEnable
boolean (Cacheenable)
默认值: false

启用查询缓存模式

Limit (integer) 或 Limit (null) (Limit)

限制返回的行数

请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
必需
BigQueryConnectionInfo (object) 或 CannerConnectionInfo (object) 或 ConnectionUrl (object) 或 MSSqlConnectionInfo (object) 或 MySqlConnectionInfo (object) 或 OracleConnectionInfo (object) 或 PostgresConnectionInfo (object) 或 SnowflakeConnectionInfo (object) 或 TrinoConnectionInfo (object) 或 LocalFileConnectionInfo (object) 或 S3FileConnectionInfo (object) 或 MinioFileConnectionInfo (object) 或 GcsFileConnectionInfo (object) (Connectioninfo)
manifestStr
必需
string (Manifeststr)

Base64 manifest

sql
必需
string (Sql)

响应

请求示例

内容类型
application/json
{
  • "connectionInfo": {
    },
  • "manifestStr": "string",
  • "sql": "string"
}

响应示例

内容类型
application/json
null

验证 已弃用

验证指定规则

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
rule_name
必需
string (Rule Name)
请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
必需
BigQueryConnectionInfo (object) 或 CannerConnectionInfo (object) 或 ConnectionUrl (object) 或 MSSqlConnectionInfo (object) 或 MySqlConnectionInfo (object) 或 OracleConnectionInfo (object) 或 PostgresConnectionInfo (object) 或 SnowflakeConnectionInfo (object) 或 TrinoConnectionInfo (object) 或 LocalFileConnectionInfo (object) 或 S3FileConnectionInfo (object) 或 MinioFileConnectionInfo (object) 或 GcsFileConnectionInfo (object) (Connectioninfo)
manifestStr
必需
string (Manifeststr)

Base64 manifest

必需
object (Parameters)

响应

请求示例

内容类型
application/json
{
  • "connectionInfo": {
    },
  • "manifestStr": "string",
  • "parameters": {
    }
}

响应示例

内容类型
application/json
null

干运行计划

获取计划的 WrenSQL

请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
manifestStr
必需
string (Manifeststr)

Base64 manifest

sql
必需
string (Sql)

响应

请求示例

内容类型
application/json
{
  • "manifestStr": "string",
  • "sql": "string"
}

响应示例

内容类型
application/json
"string"

数据源干运行计划

获取指定数据源的方言 SQL

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
manifestStr
必需
string (Manifeststr)

Base64 manifest

sql
必需
string (Sql)

响应

请求示例

内容类型
application/json
{
  • "manifestStr": "string",
  • "sql": "string"
}

响应示例

内容类型
application/json
"string"

函数

获取指定数据源的可用函数列表

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
请求头参数
请求头 (string) 或 请求头 (null) (Headers)

响应

响应示例

内容类型
application/json
null

模型替换

获取表名已替换的 SQL

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
必需
BigQueryConnectionInfo (object) 或 CannerConnectionInfo (object) 或 ConnectionUrl (object) 或 MSSqlConnectionInfo (object) 或 MySqlConnectionInfo (object) 或 OracleConnectionInfo (object) 或 PostgresConnectionInfo (object) 或 SnowflakeConnectionInfo (object) 或 TrinoConnectionInfo (object) 或 LocalFileConnectionInfo (object) 或 S3FileConnectionInfo (object) 或 MinioFileConnectionInfo (object) 或 GcsFileConnectionInfo (object) (Connectioninfo)
manifestStr
必需
string (Manifeststr)

Base64 manifest

sql
必需
string (Sql)

响应

请求示例

内容类型
application/json
{
  • "connectionInfo": {
    },
  • "manifestStr": "string",
  • "sql": "string"
}

响应示例

内容类型
application/json
"string"

查询

查询指定数据源

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
查询参数
dryRun
boolean (Dryrun)
默认值: false

启用 dryRun 模式仅用于验证 SQL

cacheEnable
boolean (Cacheenable)
默认值: false

启用查询缓存模式

Limit (integer) 或 Limit (null) (Limit)

限制返回的行数

请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
必需
BigQueryConnectionInfo (object) 或 CannerConnectionInfo (object) 或 ConnectionUrl (object) 或 MSSqlConnectionInfo (object) 或 MySqlConnectionInfo (object) 或 OracleConnectionInfo (object) 或 PostgresConnectionInfo (object) 或 SnowflakeConnectionInfo (object) 或 TrinoConnectionInfo (object) 或 LocalFileConnectionInfo (object) 或 S3FileConnectionInfo (object) 或 MinioFileConnectionInfo (object) 或 GcsFileConnectionInfo (object) (Connectioninfo)
manifestStr
必需
string (Manifeststr)

Base64 manifest

sql
必需
string (Sql)

响应

请求示例

内容类型
application/json
{
  • "connectionInfo": {
    },
  • "manifestStr": "string",
  • "sql": "string"
}

响应示例

内容类型
application/json
null

验证

验证指定规则

路径参数
data_source
必需
string (DataSource)
枚举: "bigquery" "canner" "clickhouse" "mssql" "mysql" "oracle" "postgres" "snowflake" "trino" "local_file" "s3_file" "minio_file" "gcs_file"
rule_name
必需
string (Rule Name)
请求头参数
请求头 (string) 或 请求头 (null) (Headers)
请求体 schema: application/json
必需
必需
BigQueryConnectionInfo (object) 或 CannerConnectionInfo (object) 或 ConnectionUrl (object) 或 MSSqlConnectionInfo (object) 或 MySqlConnectionInfo (object) 或 OracleConnectionInfo (object) 或 PostgresConnectionInfo (object) 或 SnowflakeConnectionInfo (object) 或 TrinoConnectionInfo (object) 或 LocalFileConnectionInfo (object) 或 S3FileConnectionInfo (object) 或 MinioFileConnectionInfo (object) 或 GcsFileConnectionInfo (object) (Connectioninfo)
manifestStr
必需
string (Manifeststr)

Base64 manifest

必需
object (Parameters)

响应

请求示例

内容类型
application/json
{
  • "connectionInfo": {
    },
  • "manifestStr": "string",
  • "parameters": {
    }
}

响应示例

内容类型
application/json
null

分析

分析 SQL 已弃用

请求体 schema: application/json
必需
manifestStr
必需
string (Manifeststr)

Base64 manifest

sql
必需
string (Sql)

响应

请求示例

内容类型
application/json
{
  • "manifestStr": "string",
  • "sql": "string"
}

响应示例

内容类型
application/json
[
  • { }
]

批量分析 SQL 已弃用

请求体 schema: application/json
必需
manifestStr
必需
string (Manifeststr)

Base64 manifest

sqls
必需
字符串数组 strings (Sqls)

响应

请求示例

内容类型
application/json
{
  • "manifestStr": "string",
  • "sqls": [
    ]
}

响应示例

内容类型
application/json
[
  • [
    ]
]

BigQueryConnectionInfo

credentials
必需
string <password> (Credentials)

Base64 编码的 credentials.json

dataset_id
必需
string <password> (Dataset Id)

BigQuery dataset id

project_id
必需
string <password> (Project Id)

GCP project id

{
  • "credentials": "eyJ...",
  • "dataset_id": "my_dataset",
  • "project_id": "my-project"
}

CannerConnectionInfo

enableSSL
boolean (Enablessl)
默认值: false

启用 SSL 连接

host
必需
string <password> (Host)

您的数据库的主机名

pat
必需
string <password> (Pat)

您的数据库的个人访问令牌

port
必需
string <password> (Port)

您的数据库的端口

user
必需
string <password> (User)

您的数据库的用户名

workspace
必需
string <password> (Workspace)

您的数据库的工作空间

{
  • "enableSSL": false,
  • "host": "localhost",
  • "pat": "eyJ...",
  • "port": "8080",
  • "user": "admin",
  • "workspace": "default"
}

GcsFileConnectionInfo

bucket
必需
string <password> (Bucket)

GCS 桶的名称

credentials
string <password> (Credentials)

Base64 编码的 credentials.json

format
string (Format)
默认值: "csv"

文件格式

key_id
必需
string <password> (Key Id)

GCS 桶的 key id

secret_key
必需
string <password> (Secret Key)

GCS 桶的 secret key

url
string <password> (Url)
默认值: "/"

GCS 桶的根路径

{
  • "bucket": "my-bucket",
  • "credentials": "eyJ...",
  • "format": "csv",
  • "key_id": "my-key-id",
  • "secret_key": "my-secret-key",
  • "url": "/data"
}

LocalFileConnectionInfo

format
string (Format)
默认值: "csv"

文件格式

url
string <password> (Url)
默认值: "/"

本地文件的根路径

{
  • "format": "csv",
  • "url": "/data"
}

MSSqlConnectionInfo

TDS_Version
string (Tds Version)
默认值: "8.0"

要使用的 TDS 版本

database
必需
string <password> (Database)

您的数据库的数据库名称

driver
string (Driver)
默认值: "ODBC Driver 18 for SQL Server"

要使用的 ODBC 驱动程序

host
必需
string <password> (Host)

您的数据库的主机名

Kwargs (object) 或 Kwargs (null) (Kwargs)

要传递给 PyODBC 的额外关键字参数

Password (string) 或 Password (null) (Password)

您的数据库的密码

port
必需
string <password> (Port)

您的数据库的端口

user
必需
string <password> (User)

您的数据库的用户名

{
  • "TDS_Version": "8.0",
  • "database": "master",
  • "driver": "ODBC Driver 18 for SQL Server",
  • "host": "localhost",
  • "kwargs": {
    },
  • "password": "password",
  • "port": "1433",
  • "user": "sa"
}

MinioFileConnectionInfo

access_key
必需
string <password> (Access Key)

Minio 桶的账号

bucket
必需
string <password> (Bucket)

Minio 桶的名称

endpoint
必需
string <password> (Endpoint)

Minio 桶的端点

format
string (Format)
默认值: "csv"

文件格式

secret_key
必需
string <password> (Secret Key)

Minio 桶的密码

ssl_enabled
boolean (Ssl Enabled)
默认值: false

是否使用 ssl 连接

url
string <password> (Url)
默认值: "/"

Minio 桶的根路径

{
  • "access_key": "my-account",
  • "bucket": "my-bucket",
  • "endpoint": "localhost:9000",
  • "format": "csv",
  • "secret_key": "my-password",
  • "ssl_enabled": true,
  • "url": "/data"
}

MySqlConnectionInfo

database
必需
string <password> (Database)

您的数据库的数据库名称

host
必需
string <password> (Host)

您的数据库的主机名

Kwargs (object) 或 Kwargs (null) (Kwargs)

要传递给 PyMySQL 的额外关键字参数

Password (string) 或 Password (null) (Password)

您的数据库的密码

port
必需
string <password> (Port)

您的数据库的端口

Sslca (string) 或 Sslca (null) (Sslca)

CA 证书文件的路径

Sslmode (string) 或 Sslmode (null) (Sslmode)
默认值: "ENABLED"

是否使用 ssl 连接。默认值为 ENABLED，因为 MySQL 默认使用 caching_sha2_password，而驱动程序 MySQLdb 仅支持带 ssl 的 caching_sha2_password。

user
必需
string <password> (User)

您的数据库的用户名

{
  • "database": "default",
  • "host": "localhost",
  • "kwargs": {
    },
  • "password": "password",
  • "port": "3306",
  • "sslMode": "DISABLED",
  • "user": "root"
}

OracleConnectionInfo

database
必需
string <password> (Database)

您的数据库的数据库名称

host
必需
string <password> (Host)

您的数据库的主机名

Password (string) 或 Password (null) (Password)

您的数据库的密码

port
必需
string <password> (Port)

您的数据库的端口

user
必需
string <password> (User)

您的数据库的用户名

{
  • "database": "orcl",
  • "host": "localhost",
  • "password": "password",
  • "port": 1521,
  • "user": "admin"
}

PostgresConnectionInfo

database
必需
string <password> (Database)

您的数据库的数据库名称

host
必需
string <password> (Host)

您的数据库的主机名

Password (string) 或 Password (null) (Password)

您的数据库的密码

port
必需
string <password> (Port)

您的数据库的端口

user
必需
string <password> (User)

您的数据库的用户名

{
  • "database": "postgres",
  • "host": "localhost",
  • "password": "password",
  • "port": 5432,
  • "user": "postgres"
}

S3FileConnectionInfo

access_key
必需
string <password> (Access Key)

S3 桶的 access key

bucket
必需
string <password> (Bucket)

S3 桶的名称

format
string (Format)
默认值: "csv"

文件格式

region
必需
string <password> (Region)

S3 桶的区域

secret_key
必需
string <password> (Secret Key)

S3 桶的 secret key

url
string <password> (Url)
默认值: "/"

S3 桶的根路径

{
  • "access_key": "my-access-key",
  • "bucket": "my-bucket",
  • "format": "csv",
  • "region": "us-west-2",
  • "secret_key": "my-secret-key",
  • "url": "/data"
}

SnowflakeConnectionInfo

account
必需
string <password> (Account)

您的数据库的账号名称

database
必需
string <password> (Database)

您的数据库的数据库名称

password
必需
string <password> (Password)

您的数据库的密码

schema
必需
string <password> (Schema)

您的数据库的 schema 名称

user
必需
string <password> (User)

您的数据库的用户名

{
  • "account": "myaccount",
  • "database": "mydb",
  • "password": "password",
  • "schema": "myschema",
  • "user": "admin"
}

TrinoConnectionInfo

catalog
必需
string <password> (Catalog)

您的数据库的 catalog 名称

host
必需
string <password> (Host)

您的数据库的主机名

Password (string) 或 Password (null) (Password)

您的数据库的密码

port
string <password> (Port)
默认值: "8080"

您的数据库的端口

schema
必需
string <password> (Schema)

您的数据库的 schema 名称

User (string) 或 User (null) (User)

您的数据库的用户名

{
  • "catalog": "hive",
  • "host": "localhost",
  • "password": "password",
  • "port": "8080",
  • "schema": "default",
  • "user": "admin"
}