提交SQL语句
功能介绍
在MRS集群中提交并执行一条SQL语句。
接口约束
无
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/clusters/{cluster_id}/sql-execution
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sql_type |
是 |
String |
参数解释: SQL类型。目前仅支持“presto”类型的SQL。 约束限制:
取值范围: 不涉及 默认取值: 不涉及 |
sql_content |
是 |
String |
参数解释: 待执行的SQL语句。目前仅支持执行单条语句,语句中不包含“;”。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
database |
否 |
String |
参数解释: 执行SQL所在的数据库。 约束限制: 不涉及 取值范围: 不涉及 默认取值: default |
archive_path |
否 |
String |
参数解释: SQL执行结果的转储文件夹。只有select语句才会转储查询的结果。当前仅支持转储到OBS中。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: SQL的执行id。执行select、show和desc语句时才会生成id,其他操作id为空。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
message |
String |
参数解释: 错误信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
statement |
String |
参数解释: 执行的SQL语句。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
status |
String |
参数解释: SQL的执行状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
result_location |
String |
参数解释: SQL查询语句的最终结果归档路径。只有select的语句才会在将SQL的执行结果转储到result_location中。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
content |
Array<Array<String>> |
参数解释: SQL的执行结果。只有非select的语句才会在content中返回结果,如果SQL中没有结果,content为空。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
提交一个presto类型的SQL语句
POST https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/sql-execution { "sql_type" : "presto", "sql_content" : "show tables", "database" : "default", "archive_path" : "obs://my-bucket/path" }
响应示例
状态码: 200
提交SQL语句成功
{ "id" : "20190909_011820_00151_xxxxx", "statement" : "show tables", "status" : "FINISHED", "result_location" : " obs://my_bucket/uuid_date/xxxx.csv", "content" : [ [ "t1", null ], [ null, "t2" ], [ null, "t3" ] ] }
状态码: 400
提交SQL语句失败
{ "error_code" : "MRS.0011", "message" : "提交SQL到Executor上失败,集群ID为xxxx" }
SDK代码示例
SDK代码示例如下。
提交一个presto类型的SQL语句
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.mrs.v2.region.MrsRegion; import com.huaweicloud.sdk.mrs.v2.*; import com.huaweicloud.sdk.mrs.v2.model.*; public class ExecuteSqlSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); MrsClient client = MrsClient.newBuilder() .withCredential(auth) .withRegion(MrsRegion.valueOf("<YOUR REGION>")) .build(); ExecuteSqlRequest request = new ExecuteSqlRequest(); request.withClusterId("{cluster_id}"); SqlExecutionReq body = new SqlExecutionReq(); body.withArchivePath("obs://my-bucket/path"); body.withDatabase("default"); body.withSqlContent("show tables"); body.withSqlType("presto"); request.withBody(body); try { ExecuteSqlResponse response = client.executeSql(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
提交一个presto类型的SQL语句
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmrs.v2.region.mrs_region import MrsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmrs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = MrsClient.new_builder() \ .with_credentials(credentials) \ .with_region(MrsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ExecuteSqlRequest() request.cluster_id = "{cluster_id}" request.body = SqlExecutionReq( archive_path="obs://my-bucket/path", database="default", sql_content="show tables", sql_type="presto" ) response = client.execute_sql(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
提交一个presto类型的SQL语句
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" mrs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := mrs.NewMrsClient( mrs.MrsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ExecuteSqlRequest{} request.ClusterId = "{cluster_id}" archivePathSqlExecutionReq:= "obs://my-bucket/path" databaseSqlExecutionReq:= "default" request.Body = &model.SqlExecutionReq{ ArchivePath: &archivePathSqlExecutionReq, Database: &databaseSqlExecutionReq, SqlContent: "show tables", SqlType: "presto", } response, err := client.ExecuteSql(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
提交SQL语句成功 |
400 |
提交SQL语句失败 |
错误码
请参见错误码。