kb-cloud-client-typescript 2.3.0-alpha.225 → 2.3.0-alpha.227

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (190) hide show
  1. package/dist/adminapi/apis/aiagent-api.d.ts +41 -179
  2. package/dist/adminapi/apis/aiagent-api.d.ts.map +1 -1
  3. package/dist/adminapi/apis/aiagent-api.js +98 -180
  4. package/dist/adminapi/apis/aiagent-api.js.map +1 -1
  5. package/dist/adminapi/apis/dms-api.d.ts +81 -0
  6. package/dist/adminapi/apis/dms-api.d.ts.map +1 -1
  7. package/dist/adminapi/apis/dms-api.js +85 -0
  8. package/dist/adminapi/apis/dms-api.js.map +1 -1
  9. package/dist/adminapi/apis/shared-api.d.ts +81 -0
  10. package/dist/adminapi/apis/shared-api.d.ts.map +1 -1
  11. package/dist/adminapi/apis/shared-api.js +85 -0
  12. package/dist/adminapi/apis/shared-api.js.map +1 -1
  13. package/dist/adminapi/models/dms-execution-plan-edge-rows.d.ts +31 -0
  14. package/dist/adminapi/models/dms-execution-plan-edge-rows.d.ts.map +1 -0
  15. package/dist/adminapi/models/dms-execution-plan-edge-rows.js +16 -0
  16. package/dist/adminapi/models/dms-execution-plan-edge-rows.js.map +1 -0
  17. package/dist/adminapi/models/dms-execution-plan-edge.d.ts +56 -0
  18. package/dist/adminapi/models/dms-execution-plan-edge.d.ts.map +1 -0
  19. package/dist/adminapi/models/dms-execution-plan-edge.js +16 -0
  20. package/dist/adminapi/models/dms-execution-plan-edge.js.map +1 -0
  21. package/dist/adminapi/models/dms-execution-plan-mode.d.ts +24 -0
  22. package/dist/adminapi/models/dms-execution-plan-mode.d.ts.map +1 -0
  23. package/dist/adminapi/models/dms-execution-plan-mode.js +28 -0
  24. package/dist/adminapi/models/dms-execution-plan-mode.js.map +1 -0
  25. package/dist/adminapi/models/dms-execution-plan-node-category.d.ts +31 -0
  26. package/dist/adminapi/models/dms-execution-plan-node-category.d.ts.map +1 -0
  27. package/dist/adminapi/models/dms-execution-plan-node-category.js +35 -0
  28. package/dist/adminapi/models/dms-execution-plan-node-category.js.map +1 -0
  29. package/dist/adminapi/models/dms-execution-plan-node-conditions.d.ts +49 -0
  30. package/dist/adminapi/models/dms-execution-plan-node-conditions.d.ts.map +1 -0
  31. package/dist/adminapi/models/dms-execution-plan-node-conditions.js +16 -0
  32. package/dist/adminapi/models/dms-execution-plan-node-conditions.js.map +1 -0
  33. package/dist/adminapi/models/dms-execution-plan-node-cost.d.ts +43 -0
  34. package/dist/adminapi/models/dms-execution-plan-node-cost.d.ts.map +1 -0
  35. package/dist/adminapi/models/dms-execution-plan-node-cost.js +16 -0
  36. package/dist/adminapi/models/dms-execution-plan-node-cost.js.map +1 -0
  37. package/dist/adminapi/models/dms-execution-plan-node-rows.d.ts +49 -0
  38. package/dist/adminapi/models/dms-execution-plan-node-rows.d.ts.map +1 -0
  39. package/dist/adminapi/models/dms-execution-plan-node-rows.js +16 -0
  40. package/dist/adminapi/models/dms-execution-plan-node-rows.js.map +1 -0
  41. package/dist/adminapi/models/dms-execution-plan-node-timing.d.ts +43 -0
  42. package/dist/adminapi/models/dms-execution-plan-node-timing.d.ts.map +1 -0
  43. package/dist/adminapi/models/dms-execution-plan-node-timing.js +16 -0
  44. package/dist/adminapi/models/dms-execution-plan-node-timing.js.map +1 -0
  45. package/dist/adminapi/models/dms-execution-plan-node.d.ts +122 -0
  46. package/dist/adminapi/models/dms-execution-plan-node.d.ts.map +1 -0
  47. package/dist/adminapi/models/dms-execution-plan-node.js +16 -0
  48. package/dist/adminapi/models/dms-execution-plan-node.js.map +1 -0
  49. package/dist/adminapi/models/dms-execution-plan-raw-format.d.ts +24 -0
  50. package/dist/adminapi/models/dms-execution-plan-raw-format.d.ts.map +1 -0
  51. package/dist/adminapi/models/dms-execution-plan-raw-format.js +28 -0
  52. package/dist/adminapi/models/dms-execution-plan-raw-format.js.map +1 -0
  53. package/dist/adminapi/models/dms-execution-plan-result.d.ts +106 -0
  54. package/dist/adminapi/models/dms-execution-plan-result.d.ts.map +1 -0
  55. package/dist/adminapi/models/dms-execution-plan-result.js +16 -0
  56. package/dist/adminapi/models/dms-execution-plan-result.js.map +1 -0
  57. package/dist/adminapi/models/dms-execution-plan-summary.d.ts +67 -0
  58. package/dist/adminapi/models/dms-execution-plan-summary.d.ts.map +1 -0
  59. package/dist/adminapi/models/dms-execution-plan-summary.js +16 -0
  60. package/dist/adminapi/models/dms-execution-plan-summary.js.map +1 -0
  61. package/dist/adminapi/models/dms-execution-plan-warning-severity.d.ts +23 -0
  62. package/dist/adminapi/models/dms-execution-plan-warning-severity.d.ts.map +1 -0
  63. package/dist/adminapi/models/dms-execution-plan-warning-severity.js +27 -0
  64. package/dist/adminapi/models/dms-execution-plan-warning-severity.js.map +1 -0
  65. package/dist/adminapi/models/dms-execution-plan-warning.d.ts +44 -0
  66. package/dist/adminapi/models/dms-execution-plan-warning.d.ts.map +1 -0
  67. package/dist/adminapi/models/dms-execution-plan-warning.js +16 -0
  68. package/dist/adminapi/models/dms-execution-plan-warning.js.map +1 -0
  69. package/dist/adminapi/models/dms-visual-explain-request.d.ts +37 -0
  70. package/dist/adminapi/models/dms-visual-explain-request.d.ts.map +1 -0
  71. package/dist/adminapi/models/dms-visual-explain-request.js +16 -0
  72. package/dist/adminapi/models/dms-visual-explain-request.js.map +1 -0
  73. package/dist/adminapi/models/index.d.ts +15 -0
  74. package/dist/adminapi/models/index.d.ts.map +1 -1
  75. package/dist/adminapi/models/index.js +15 -0
  76. package/dist/adminapi/models/index.js.map +1 -1
  77. package/dist/openapi/apis/dms-api.d.ts +81 -0
  78. package/dist/openapi/apis/dms-api.d.ts.map +1 -1
  79. package/dist/openapi/apis/dms-api.js +85 -0
  80. package/dist/openapi/apis/dms-api.js.map +1 -1
  81. package/dist/openapi/apis/shared-api.d.ts +81 -0
  82. package/dist/openapi/apis/shared-api.d.ts.map +1 -1
  83. package/dist/openapi/apis/shared-api.js +85 -0
  84. package/dist/openapi/apis/shared-api.js.map +1 -1
  85. package/dist/openapi/models/dms-execution-plan-edge-rows.d.ts +31 -0
  86. package/dist/openapi/models/dms-execution-plan-edge-rows.d.ts.map +1 -0
  87. package/dist/openapi/models/dms-execution-plan-edge-rows.js +16 -0
  88. package/dist/openapi/models/dms-execution-plan-edge-rows.js.map +1 -0
  89. package/dist/openapi/models/dms-execution-plan-edge.d.ts +56 -0
  90. package/dist/openapi/models/dms-execution-plan-edge.d.ts.map +1 -0
  91. package/dist/openapi/models/dms-execution-plan-edge.js +16 -0
  92. package/dist/openapi/models/dms-execution-plan-edge.js.map +1 -0
  93. package/dist/openapi/models/dms-execution-plan-mode.d.ts +24 -0
  94. package/dist/openapi/models/dms-execution-plan-mode.d.ts.map +1 -0
  95. package/dist/openapi/models/dms-execution-plan-mode.js +28 -0
  96. package/dist/openapi/models/dms-execution-plan-mode.js.map +1 -0
  97. package/dist/openapi/models/dms-execution-plan-node-category.d.ts +31 -0
  98. package/dist/openapi/models/dms-execution-plan-node-category.d.ts.map +1 -0
  99. package/dist/openapi/models/dms-execution-plan-node-category.js +35 -0
  100. package/dist/openapi/models/dms-execution-plan-node-category.js.map +1 -0
  101. package/dist/openapi/models/dms-execution-plan-node-conditions.d.ts +49 -0
  102. package/dist/openapi/models/dms-execution-plan-node-conditions.d.ts.map +1 -0
  103. package/dist/openapi/models/dms-execution-plan-node-conditions.js +16 -0
  104. package/dist/openapi/models/dms-execution-plan-node-conditions.js.map +1 -0
  105. package/dist/openapi/models/dms-execution-plan-node-cost.d.ts +43 -0
  106. package/dist/openapi/models/dms-execution-plan-node-cost.d.ts.map +1 -0
  107. package/dist/openapi/models/dms-execution-plan-node-cost.js +16 -0
  108. package/dist/openapi/models/dms-execution-plan-node-cost.js.map +1 -0
  109. package/dist/openapi/models/dms-execution-plan-node-rows.d.ts +49 -0
  110. package/dist/openapi/models/dms-execution-plan-node-rows.d.ts.map +1 -0
  111. package/dist/openapi/models/dms-execution-plan-node-rows.js +16 -0
  112. package/dist/openapi/models/dms-execution-plan-node-rows.js.map +1 -0
  113. package/dist/openapi/models/dms-execution-plan-node-timing.d.ts +43 -0
  114. package/dist/openapi/models/dms-execution-plan-node-timing.d.ts.map +1 -0
  115. package/dist/openapi/models/dms-execution-plan-node-timing.js +16 -0
  116. package/dist/openapi/models/dms-execution-plan-node-timing.js.map +1 -0
  117. package/dist/openapi/models/dms-execution-plan-node.d.ts +122 -0
  118. package/dist/openapi/models/dms-execution-plan-node.d.ts.map +1 -0
  119. package/dist/openapi/models/dms-execution-plan-node.js +16 -0
  120. package/dist/openapi/models/dms-execution-plan-node.js.map +1 -0
  121. package/dist/openapi/models/dms-execution-plan-raw-format.d.ts +24 -0
  122. package/dist/openapi/models/dms-execution-plan-raw-format.d.ts.map +1 -0
  123. package/dist/openapi/models/dms-execution-plan-raw-format.js +28 -0
  124. package/dist/openapi/models/dms-execution-plan-raw-format.js.map +1 -0
  125. package/dist/openapi/models/dms-execution-plan-result.d.ts +106 -0
  126. package/dist/openapi/models/dms-execution-plan-result.d.ts.map +1 -0
  127. package/dist/openapi/models/dms-execution-plan-result.js +16 -0
  128. package/dist/openapi/models/dms-execution-plan-result.js.map +1 -0
  129. package/dist/openapi/models/dms-execution-plan-summary.d.ts +67 -0
  130. package/dist/openapi/models/dms-execution-plan-summary.d.ts.map +1 -0
  131. package/dist/openapi/models/dms-execution-plan-summary.js +16 -0
  132. package/dist/openapi/models/dms-execution-plan-summary.js.map +1 -0
  133. package/dist/openapi/models/dms-execution-plan-warning-severity.d.ts +23 -0
  134. package/dist/openapi/models/dms-execution-plan-warning-severity.d.ts.map +1 -0
  135. package/dist/openapi/models/dms-execution-plan-warning-severity.js +27 -0
  136. package/dist/openapi/models/dms-execution-plan-warning-severity.js.map +1 -0
  137. package/dist/openapi/models/dms-execution-plan-warning.d.ts +44 -0
  138. package/dist/openapi/models/dms-execution-plan-warning.d.ts.map +1 -0
  139. package/dist/openapi/models/dms-execution-plan-warning.js +16 -0
  140. package/dist/openapi/models/dms-execution-plan-warning.js.map +1 -0
  141. package/dist/openapi/models/dms-visual-explain-request.d.ts +37 -0
  142. package/dist/openapi/models/dms-visual-explain-request.d.ts.map +1 -0
  143. package/dist/openapi/models/dms-visual-explain-request.js +16 -0
  144. package/dist/openapi/models/dms-visual-explain-request.js.map +1 -0
  145. package/dist/openapi/models/index.d.ts +15 -0
  146. package/dist/openapi/models/index.d.ts.map +1 -1
  147. package/dist/openapi/models/index.js +15 -0
  148. package/dist/openapi/models/index.js.map +1 -1
  149. package/package.json +1 -1
  150. package/src/adminapi/.openapi-generator/FILES +15 -0
  151. package/src/adminapi/apis/aiagent-api.ts +101 -304
  152. package/src/adminapi/apis/dms-api.ts +142 -0
  153. package/src/adminapi/apis/shared-api.ts +142 -0
  154. package/src/adminapi/models/dms-execution-plan-edge-rows.ts +36 -0
  155. package/src/adminapi/models/dms-execution-plan-edge.ts +63 -0
  156. package/src/adminapi/models/dms-execution-plan-mode.ts +33 -0
  157. package/src/adminapi/models/dms-execution-plan-node-category.ts +40 -0
  158. package/src/adminapi/models/dms-execution-plan-node-conditions.ts +54 -0
  159. package/src/adminapi/models/dms-execution-plan-node-cost.ts +48 -0
  160. package/src/adminapi/models/dms-execution-plan-node-rows.ts +54 -0
  161. package/src/adminapi/models/dms-execution-plan-node-timing.ts +48 -0
  162. package/src/adminapi/models/dms-execution-plan-node.ts +137 -0
  163. package/src/adminapi/models/dms-execution-plan-raw-format.ts +33 -0
  164. package/src/adminapi/models/dms-execution-plan-result.ts +125 -0
  165. package/src/adminapi/models/dms-execution-plan-summary.ts +72 -0
  166. package/src/adminapi/models/dms-execution-plan-warning-severity.ts +32 -0
  167. package/src/adminapi/models/dms-execution-plan-warning.ts +53 -0
  168. package/src/adminapi/models/dms-visual-explain-request.ts +42 -0
  169. package/src/adminapi/models/index.ts +15 -0
  170. package/src/adminapi.yaml +394 -94
  171. package/src/openapi/.openapi-generator/FILES +15 -0
  172. package/src/openapi/apis/dms-api.ts +142 -0
  173. package/src/openapi/apis/shared-api.ts +142 -0
  174. package/src/openapi/models/dms-execution-plan-edge-rows.ts +36 -0
  175. package/src/openapi/models/dms-execution-plan-edge.ts +63 -0
  176. package/src/openapi/models/dms-execution-plan-mode.ts +33 -0
  177. package/src/openapi/models/dms-execution-plan-node-category.ts +40 -0
  178. package/src/openapi/models/dms-execution-plan-node-conditions.ts +54 -0
  179. package/src/openapi/models/dms-execution-plan-node-cost.ts +48 -0
  180. package/src/openapi/models/dms-execution-plan-node-rows.ts +54 -0
  181. package/src/openapi/models/dms-execution-plan-node-timing.ts +48 -0
  182. package/src/openapi/models/dms-execution-plan-node.ts +137 -0
  183. package/src/openapi/models/dms-execution-plan-raw-format.ts +33 -0
  184. package/src/openapi/models/dms-execution-plan-result.ts +125 -0
  185. package/src/openapi/models/dms-execution-plan-summary.ts +72 -0
  186. package/src/openapi/models/dms-execution-plan-warning-severity.ts +32 -0
  187. package/src/openapi/models/dms-execution-plan-warning.ts +53 -0
  188. package/src/openapi/models/dms-visual-explain-request.ts +42 -0
  189. package/src/openapi/models/index.ts +15 -0
  190. package/src/openapi.yaml +377 -0
@@ -32,6 +32,8 @@ import type { DataImport200Response } from '../models';
32
32
  // @ts-ignore
33
33
  import type { Datasource } from '../models';
34
34
  // @ts-ignore
35
+ import type { DmsExecutionPlanResult } from '../models';
36
+ // @ts-ignore
35
37
  import type { DmsExplainRequest } from '../models';
36
38
  // @ts-ignore
37
39
  import type { DmsExportRequest } from '../models';
@@ -64,6 +66,8 @@ import type { DmsTaskInfo } from '../models';
64
66
  // @ts-ignore
65
67
  import type { DmsTaskList } from '../models';
66
68
  // @ts-ignore
69
+ import type { DmsVisualExplainRequest } from '../models';
70
+ // @ts-ignore
67
71
  import type { MongoAggregateRequest } from '../models';
68
72
  // @ts-ignore
69
73
  import type { MongoCollectionInfo } from '../models';
@@ -4040,6 +4044,61 @@ export const DmsApiAxiosParamCreator = function (configuration?: Configuration)
4040
4044
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4041
4045
  localVarRequestOptions.data = serializeDataIfNeeded(datasource, localVarRequestOptions, configuration)
4042
4046
 
4047
+ return {
4048
+ url: toPathString(localVarUrlObj),
4049
+ options: localVarRequestOptions,
4050
+ };
4051
+ },
4052
+ /**
4053
+ *
4054
+ * @summary explain a SQL as a normalized visual execution plan
4055
+ * @param {string} orgName name of the Org
4056
+ * @param {string} clusterName name of the cluster
4057
+ * @param {string} id id of the datasource
4058
+ * @param {DmsVisualExplainRequest} dmsVisualExplainRequest
4059
+ * @param {*} [options] Override http request option.
4060
+ * @throws {RequiredError}
4061
+ */
4062
+ visualSqlExplain: async (orgName: string, clusterName: string, id: string, dmsVisualExplainRequest: DmsVisualExplainRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4063
+ // verify required parameter 'orgName' is not null or undefined
4064
+ assertParamExists('visualSqlExplain', 'orgName', orgName)
4065
+ // verify required parameter 'clusterName' is not null or undefined
4066
+ assertParamExists('visualSqlExplain', 'clusterName', clusterName)
4067
+ // verify required parameter 'id' is not null or undefined
4068
+ assertParamExists('visualSqlExplain', 'id', id)
4069
+ // verify required parameter 'dmsVisualExplainRequest' is not null or undefined
4070
+ assertParamExists('visualSqlExplain', 'dmsVisualExplainRequest', dmsVisualExplainRequest)
4071
+ const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/sqlExplain/visual`
4072
+ .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
4073
+ .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
4074
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
4075
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4076
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4077
+ let baseOptions;
4078
+ if (configuration) {
4079
+ baseOptions = configuration.baseOptions;
4080
+ }
4081
+
4082
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
4083
+ const localVarHeaderParameter = {} as any;
4084
+ const localVarQueryParameter = {} as any;
4085
+
4086
+ // authentication BearerToken required
4087
+ // http bearer authentication required
4088
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
4089
+
4090
+ // authentication DigestAuth required
4091
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4092
+
4093
+
4094
+
4095
+ localVarHeaderParameter['Content-Type'] = 'application/json';
4096
+
4097
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4098
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4099
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4100
+ localVarRequestOptions.data = serializeDataIfNeeded(dmsVisualExplainRequest, localVarRequestOptions, configuration)
4101
+
4043
4102
  return {
4044
4103
  url: toPathString(localVarUrlObj),
4045
4104
  options: localVarRequestOptions,
@@ -5189,6 +5248,22 @@ export const DmsApiFp = function(configuration?: Configuration) {
5189
5248
  const localVarOperationServerBasePath = operationServerMap['DmsApi.updateDataSourceV2']?.[localVarOperationServerIndex]?.url;
5190
5249
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5191
5250
  },
5251
+ /**
5252
+ *
5253
+ * @summary explain a SQL as a normalized visual execution plan
5254
+ * @param {string} orgName name of the Org
5255
+ * @param {string} clusterName name of the cluster
5256
+ * @param {string} id id of the datasource
5257
+ * @param {DmsVisualExplainRequest} dmsVisualExplainRequest
5258
+ * @param {*} [options] Override http request option.
5259
+ * @throws {RequiredError}
5260
+ */
5261
+ async visualSqlExplain(orgName: string, clusterName: string, id: string, dmsVisualExplainRequest: DmsVisualExplainRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DmsExecutionPlanResult>> {
5262
+ const localVarAxiosArgs = await localVarAxiosParamCreator.visualSqlExplain(orgName, clusterName, id, dmsVisualExplainRequest, options);
5263
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5264
+ const localVarOperationServerBasePath = operationServerMap['DmsApi.visualSqlExplain']?.[localVarOperationServerIndex]?.url;
5265
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5266
+ },
5192
5267
  }
5193
5268
  };
5194
5269
 
@@ -5881,6 +5956,16 @@ export const DmsApiFactory = function (configuration?: Configuration, basePath?:
5881
5956
  updateDataSourceV2(requestParameters: DmsApiUpdateDataSourceV2Request, options?: RawAxiosRequestConfig): AxiosPromise<Datasource> {
5882
5957
  return localVarFp.updateDataSourceV2(requestParameters.orgName, requestParameters.clusterName, requestParameters.datasource, options).then((request) => request(axios, basePath));
5883
5958
  },
5959
+ /**
5960
+ *
5961
+ * @summary explain a SQL as a normalized visual execution plan
5962
+ * @param {DmsApiVisualSqlExplainRequest} requestParameters Request parameters.
5963
+ * @param {*} [options] Override http request option.
5964
+ * @throws {RequiredError}
5965
+ */
5966
+ visualSqlExplain(requestParameters: DmsApiVisualSqlExplainRequest, options?: RawAxiosRequestConfig): AxiosPromise<DmsExecutionPlanResult> {
5967
+ return localVarFp.visualSqlExplain(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.dmsVisualExplainRequest, options).then((request) => request(axios, basePath));
5968
+ },
5884
5969
  };
5885
5970
  };
5886
5971
 
@@ -6572,6 +6657,16 @@ export interface DmsApiInterface {
6572
6657
  */
6573
6658
  updateDataSourceV2(requestParameters: DmsApiUpdateDataSourceV2Request, options?: RawAxiosRequestConfig): AxiosPromise<Datasource>;
6574
6659
 
6660
+ /**
6661
+ *
6662
+ * @summary explain a SQL as a normalized visual execution plan
6663
+ * @param {DmsApiVisualSqlExplainRequest} requestParameters Request parameters.
6664
+ * @param {*} [options] Override http request option.
6665
+ * @throws {RequiredError}
6666
+ * @memberof DmsApiInterface
6667
+ */
6668
+ visualSqlExplain(requestParameters: DmsApiVisualSqlExplainRequest, options?: RawAxiosRequestConfig): AxiosPromise<DmsExecutionPlanResult>;
6669
+
6575
6670
  }
6576
6671
 
6577
6672
  /**
@@ -9262,6 +9357,41 @@ export interface DmsApiUpdateDataSourceV2Request {
9262
9357
  readonly datasource: Datasource
9263
9358
  }
9264
9359
 
9360
+ /**
9361
+ * Request parameters for visualSqlExplain operation in DmsApi.
9362
+ * @export
9363
+ * @interface DmsApiVisualSqlExplainRequest
9364
+ */
9365
+ export interface DmsApiVisualSqlExplainRequest {
9366
+ /**
9367
+ * name of the Org
9368
+ * @type {string}
9369
+ * @memberof DmsApiVisualSqlExplain
9370
+ */
9371
+ readonly orgName: string
9372
+
9373
+ /**
9374
+ * name of the cluster
9375
+ * @type {string}
9376
+ * @memberof DmsApiVisualSqlExplain
9377
+ */
9378
+ readonly clusterName: string
9379
+
9380
+ /**
9381
+ * id of the datasource
9382
+ * @type {string}
9383
+ * @memberof DmsApiVisualSqlExplain
9384
+ */
9385
+ readonly id: string
9386
+
9387
+ /**
9388
+ *
9389
+ * @type {DmsVisualExplainRequest}
9390
+ * @memberof DmsApiVisualSqlExplain
9391
+ */
9392
+ readonly dmsVisualExplainRequest: DmsVisualExplainRequest
9393
+ }
9394
+
9265
9395
  /**
9266
9396
  * DmsApi - object-oriented interface
9267
9397
  * @export
@@ -10086,5 +10216,17 @@ export class DmsApi extends BaseAPI implements DmsApiInterface {
10086
10216
  public updateDataSourceV2(requestParameters: DmsApiUpdateDataSourceV2Request, options?: RawAxiosRequestConfig) {
10087
10217
  return DmsApiFp(this.configuration).updateDataSourceV2(requestParameters.orgName, requestParameters.clusterName, requestParameters.datasource, options).then((request) => request(this.axios, this.basePath));
10088
10218
  }
10219
+
10220
+ /**
10221
+ *
10222
+ * @summary explain a SQL as a normalized visual execution plan
10223
+ * @param {DmsApiVisualSqlExplainRequest} requestParameters Request parameters.
10224
+ * @param {*} [options] Override http request option.
10225
+ * @throws {RequiredError}
10226
+ * @memberof DmsApi
10227
+ */
10228
+ public visualSqlExplain(requestParameters: DmsApiVisualSqlExplainRequest, options?: RawAxiosRequestConfig) {
10229
+ return DmsApiFp(this.configuration).visualSqlExplain(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.dmsVisualExplainRequest, options).then((request) => request(this.axios, this.basePath));
10230
+ }
10089
10231
  }
10090
10232
 
@@ -136,6 +136,8 @@ import type { Datasource } from '../models';
136
136
  // @ts-ignore
137
137
  import type { DbTDERequest } from '../models';
138
138
  // @ts-ignore
139
+ import type { DmsExecutionPlanResult } from '../models';
140
+ // @ts-ignore
139
141
  import type { DmsExplainRequest } from '../models';
140
142
  // @ts-ignore
141
143
  import type { DmsExportRequest } from '../models';
@@ -174,6 +176,8 @@ import type { DmsTaskInfo } from '../models';
174
176
  // @ts-ignore
175
177
  import type { DmsTaskList } from '../models';
176
178
  // @ts-ignore
179
+ import type { DmsVisualExplainRequest } from '../models';
180
+ // @ts-ignore
177
181
  import type { ESPutSecurityUserRequest } from '../models';
178
182
  // @ts-ignore
179
183
  import type { ESSecurityPasswordRequest } from '../models';
@@ -15374,6 +15378,61 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
15374
15378
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
15375
15379
  localVarRequestOptions.data = serializeDataIfNeeded(backupView, localVarRequestOptions, configuration)
15376
15380
 
15381
+ return {
15382
+ url: toPathString(localVarUrlObj),
15383
+ options: localVarRequestOptions,
15384
+ };
15385
+ },
15386
+ /**
15387
+ *
15388
+ * @summary explain a SQL as a normalized visual execution plan
15389
+ * @param {string} orgName name of the Org
15390
+ * @param {string} clusterName name of the cluster
15391
+ * @param {string} id id of the datasource
15392
+ * @param {DmsVisualExplainRequest} dmsVisualExplainRequest
15393
+ * @param {*} [options] Override http request option.
15394
+ * @throws {RequiredError}
15395
+ */
15396
+ visualSqlExplain: async (orgName: string, clusterName: string, id: string, dmsVisualExplainRequest: DmsVisualExplainRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
15397
+ // verify required parameter 'orgName' is not null or undefined
15398
+ assertParamExists('visualSqlExplain', 'orgName', orgName)
15399
+ // verify required parameter 'clusterName' is not null or undefined
15400
+ assertParamExists('visualSqlExplain', 'clusterName', clusterName)
15401
+ // verify required parameter 'id' is not null or undefined
15402
+ assertParamExists('visualSqlExplain', 'id', id)
15403
+ // verify required parameter 'dmsVisualExplainRequest' is not null or undefined
15404
+ assertParamExists('visualSqlExplain', 'dmsVisualExplainRequest', dmsVisualExplainRequest)
15405
+ const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/sqlExplain/visual`
15406
+ .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
15407
+ .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
15408
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
15409
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
15410
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
15411
+ let baseOptions;
15412
+ if (configuration) {
15413
+ baseOptions = configuration.baseOptions;
15414
+ }
15415
+
15416
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
15417
+ const localVarHeaderParameter = {} as any;
15418
+ const localVarQueryParameter = {} as any;
15419
+
15420
+ // authentication BearerToken required
15421
+ // http bearer authentication required
15422
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
15423
+
15424
+ // authentication DigestAuth required
15425
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
15426
+
15427
+
15428
+
15429
+ localVarHeaderParameter['Content-Type'] = 'application/json';
15430
+
15431
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
15432
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
15433
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
15434
+ localVarRequestOptions.data = serializeDataIfNeeded(dmsVisualExplainRequest, localVarRequestOptions, configuration)
15435
+
15377
15436
  return {
15378
15437
  url: toPathString(localVarUrlObj),
15379
15438
  options: localVarRequestOptions,
@@ -19743,6 +19802,22 @@ export const SharedApiFp = function(configuration?: Configuration) {
19743
19802
  const localVarOperationServerBasePath = operationServerMap['SharedApi.viewBackup']?.[localVarOperationServerIndex]?.url;
19744
19803
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19745
19804
  },
19805
+ /**
19806
+ *
19807
+ * @summary explain a SQL as a normalized visual execution plan
19808
+ * @param {string} orgName name of the Org
19809
+ * @param {string} clusterName name of the cluster
19810
+ * @param {string} id id of the datasource
19811
+ * @param {DmsVisualExplainRequest} dmsVisualExplainRequest
19812
+ * @param {*} [options] Override http request option.
19813
+ * @throws {RequiredError}
19814
+ */
19815
+ async visualSqlExplain(orgName: string, clusterName: string, id: string, dmsVisualExplainRequest: DmsVisualExplainRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DmsExecutionPlanResult>> {
19816
+ const localVarAxiosArgs = await localVarAxiosParamCreator.visualSqlExplain(orgName, clusterName, id, dmsVisualExplainRequest, options);
19817
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19818
+ const localVarOperationServerBasePath = operationServerMap['SharedApi.visualSqlExplain']?.[localVarOperationServerIndex]?.url;
19819
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19820
+ },
19746
19821
  }
19747
19822
  };
19748
19823
 
@@ -22517,6 +22592,16 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
22517
22592
  viewBackup(requestParameters: SharedApiViewBackupRequest, options?: RawAxiosRequestConfig): AxiosPromise<FileEntryList> {
22518
22593
  return localVarFp.viewBackup(requestParameters.orgName, requestParameters.backupId, requestParameters.backupView, options).then((request) => request(axios, basePath));
22519
22594
  },
22595
+ /**
22596
+ *
22597
+ * @summary explain a SQL as a normalized visual execution plan
22598
+ * @param {SharedApiVisualSqlExplainRequest} requestParameters Request parameters.
22599
+ * @param {*} [options] Override http request option.
22600
+ * @throws {RequiredError}
22601
+ */
22602
+ visualSqlExplain(requestParameters: SharedApiVisualSqlExplainRequest, options?: RawAxiosRequestConfig): AxiosPromise<DmsExecutionPlanResult> {
22603
+ return localVarFp.visualSqlExplain(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.dmsVisualExplainRequest, options).then((request) => request(axios, basePath));
22604
+ },
22520
22605
  };
22521
22606
  };
22522
22607
 
@@ -25290,6 +25375,16 @@ export interface SharedApiInterface {
25290
25375
  */
25291
25376
  viewBackup(requestParameters: SharedApiViewBackupRequest, options?: RawAxiosRequestConfig): AxiosPromise<FileEntryList>;
25292
25377
 
25378
+ /**
25379
+ *
25380
+ * @summary explain a SQL as a normalized visual execution plan
25381
+ * @param {SharedApiVisualSqlExplainRequest} requestParameters Request parameters.
25382
+ * @param {*} [options] Override http request option.
25383
+ * @throws {RequiredError}
25384
+ * @memberof SharedApiInterface
25385
+ */
25386
+ visualSqlExplain(requestParameters: SharedApiVisualSqlExplainRequest, options?: RawAxiosRequestConfig): AxiosPromise<DmsExecutionPlanResult>;
25387
+
25293
25388
  }
25294
25389
 
25295
25390
  /**
@@ -34385,6 +34480,41 @@ export interface SharedApiViewBackupRequest {
34385
34480
  readonly backupView?: BackupView
34386
34481
  }
34387
34482
 
34483
+ /**
34484
+ * Request parameters for visualSqlExplain operation in SharedApi.
34485
+ * @export
34486
+ * @interface SharedApiVisualSqlExplainRequest
34487
+ */
34488
+ export interface SharedApiVisualSqlExplainRequest {
34489
+ /**
34490
+ * name of the Org
34491
+ * @type {string}
34492
+ * @memberof SharedApiVisualSqlExplain
34493
+ */
34494
+ readonly orgName: string
34495
+
34496
+ /**
34497
+ * name of the cluster
34498
+ * @type {string}
34499
+ * @memberof SharedApiVisualSqlExplain
34500
+ */
34501
+ readonly clusterName: string
34502
+
34503
+ /**
34504
+ * id of the datasource
34505
+ * @type {string}
34506
+ * @memberof SharedApiVisualSqlExplain
34507
+ */
34508
+ readonly id: string
34509
+
34510
+ /**
34511
+ *
34512
+ * @type {DmsVisualExplainRequest}
34513
+ * @memberof SharedApiVisualSqlExplain
34514
+ */
34515
+ readonly dmsVisualExplainRequest: DmsVisualExplainRequest
34516
+ }
34517
+
34388
34518
  /**
34389
34519
  * SharedApi - object-oriented interface
34390
34520
  * @export
@@ -37709,5 +37839,17 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
37709
37839
  public viewBackup(requestParameters: SharedApiViewBackupRequest, options?: RawAxiosRequestConfig) {
37710
37840
  return SharedApiFp(this.configuration).viewBackup(requestParameters.orgName, requestParameters.backupId, requestParameters.backupView, options).then((request) => request(this.axios, this.basePath));
37711
37841
  }
37842
+
37843
+ /**
37844
+ *
37845
+ * @summary explain a SQL as a normalized visual execution plan
37846
+ * @param {SharedApiVisualSqlExplainRequest} requestParameters Request parameters.
37847
+ * @param {*} [options] Override http request option.
37848
+ * @throws {RequiredError}
37849
+ * @memberof SharedApi
37850
+ */
37851
+ public visualSqlExplain(requestParameters: SharedApiVisualSqlExplainRequest, options?: RawAxiosRequestConfig) {
37852
+ return SharedApiFp(this.configuration).visualSqlExplain(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.dmsVisualExplainRequest, options).then((request) => request(this.axios, this.basePath));
37853
+ }
37712
37854
  }
37713
37855
 
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface DmsExecutionPlanEdgeRows
21
+ */
22
+ export interface DmsExecutionPlanEdgeRows {
23
+ /**
24
+ *
25
+ * @type {number}
26
+ * @memberof DmsExecutionPlanEdgeRows
27
+ */
28
+ 'estimated'?: number | null;
29
+ /**
30
+ *
31
+ * @type {number}
32
+ * @memberof DmsExecutionPlanEdgeRows
33
+ */
34
+ 'actual'?: number | null;
35
+ }
36
+
@@ -0,0 +1,63 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { DmsExecutionPlanEdgeRows } from './dms-execution-plan-edge-rows';
19
+
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface DmsExecutionPlanEdge
24
+ */
25
+ export interface DmsExecutionPlanEdge {
26
+ /**
27
+ *
28
+ * @type {string}
29
+ * @memberof DmsExecutionPlanEdge
30
+ */
31
+ 'id'?: string;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof DmsExecutionPlanEdge
36
+ */
37
+ 'source'?: string;
38
+ /**
39
+ *
40
+ * @type {string}
41
+ * @memberof DmsExecutionPlanEdge
42
+ */
43
+ 'target'?: string;
44
+ /**
45
+ *
46
+ * @type {DmsExecutionPlanEdgeRows}
47
+ * @memberof DmsExecutionPlanEdge
48
+ */
49
+ 'rows'?: DmsExecutionPlanEdgeRows;
50
+ /**
51
+ *
52
+ * @type {number}
53
+ * @memberof DmsExecutionPlanEdge
54
+ */
55
+ 'widthWeight'?: number | null;
56
+ /**
57
+ *
58
+ * @type {string}
59
+ * @memberof DmsExecutionPlanEdge
60
+ */
61
+ 'label'?: string | null;
62
+ }
63
+
@@ -0,0 +1,33 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const DmsExecutionPlanMode = {
24
+ estimate: 'estimate',
25
+ analyze: 'analyze',
26
+ actual: 'actual',
27
+ autotrace: 'autotrace'
28
+ } as const;
29
+
30
+ export type DmsExecutionPlanMode = typeof DmsExecutionPlanMode[keyof typeof DmsExecutionPlanMode];
31
+
32
+
33
+
@@ -0,0 +1,40 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const DmsExecutionPlanNodeCategory = {
24
+ result: 'result',
25
+ sort: 'sort',
26
+ join: 'join',
27
+ table_scan: 'table_scan',
28
+ index_scan: 'index_scan',
29
+ lookup: 'lookup',
30
+ materialize: 'materialize',
31
+ aggregate: 'aggregate',
32
+ exchange: 'exchange',
33
+ modify: 'modify',
34
+ other: 'other'
35
+ } as const;
36
+
37
+ export type DmsExecutionPlanNodeCategory = typeof DmsExecutionPlanNodeCategory[keyof typeof DmsExecutionPlanNodeCategory];
38
+
39
+
40
+
@@ -0,0 +1,54 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface DmsExecutionPlanNodeConditions
21
+ */
22
+ export interface DmsExecutionPlanNodeConditions {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof DmsExecutionPlanNodeConditions
27
+ */
28
+ 'filter'?: string | null;
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof DmsExecutionPlanNodeConditions
33
+ */
34
+ 'indexCond'?: string | null;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof DmsExecutionPlanNodeConditions
39
+ */
40
+ 'joinCond'?: string | null;
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof DmsExecutionPlanNodeConditions
45
+ */
46
+ 'hashCond'?: string | null;
47
+ /**
48
+ *
49
+ * @type {Array<string>}
50
+ * @memberof DmsExecutionPlanNodeConditions
51
+ */
52
+ 'sortKey'?: Array<string>;
53
+ }
54
+
@@ -0,0 +1,48 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Admin API
5
+ * The Admin API is used to manage the ApeCloud platform.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@apecloud.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface DmsExecutionPlanNodeCost
21
+ */
22
+ export interface DmsExecutionPlanNodeCost {
23
+ /**
24
+ *
25
+ * @type {number}
26
+ * @memberof DmsExecutionPlanNodeCost
27
+ */
28
+ 'startup'?: number | null;
29
+ /**
30
+ *
31
+ * @type {number}
32
+ * @memberof DmsExecutionPlanNodeCost
33
+ */
34
+ 'total'?: number | null;
35
+ /**
36
+ *
37
+ * @type {number}
38
+ * @memberof DmsExecutionPlanNodeCost
39
+ */
40
+ 'self'?: number | null;
41
+ /**
42
+ *
43
+ * @type {number}
44
+ * @memberof DmsExecutionPlanNodeCost
45
+ */
46
+ 'percent'?: number | null;
47
+ }
48
+