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

package/src/openapi/models/dms-execution-plan-node-rows.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DmsExecutionPlanNodeRows
+ */
+export interface DmsExecutionPlanNodeRows {
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNodeRows
+     */
+    'estimated'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNodeRows
+     */
+    'actual'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNodeRows
+     */
+    'actualPerLoop'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNodeRows
+     */
+    'removedByFilter'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNodeRows
+     */
+    'mismatchRatio'?: number | null;
+}
+

package/src/openapi/models/dms-execution-plan-node-timing.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DmsExecutionPlanNodeTiming
+ */
+export interface DmsExecutionPlanNodeTiming {
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNodeTiming
+     */
+    'startupMs'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNodeTiming
+     */
+    'totalMs'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNodeTiming
+     */
+    'selfMs'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNodeTiming
+     */
+    'loops'?: number | null;
+}
+

package/src/openapi/models/dms-execution-plan-node.ts

@@ -0,0 +1,137 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanNodeCategory } from './dms-execution-plan-node-category';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanNodeConditions } from './dms-execution-plan-node-conditions';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanNodeCost } from './dms-execution-plan-node-cost';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanNodeRows } from './dms-execution-plan-node-rows';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanNodeTiming } from './dms-execution-plan-node-timing';
+
+/**
+ * 
+ * @export
+ * @interface DmsExecutionPlanNode
+ */
+export interface DmsExecutionPlanNode {
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanNode
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DmsExecutionPlanNode
+     */
+    'parentIds'?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DmsExecutionPlanNode
+     */
+    'childIds'?: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanNode
+     */
+    'order'?: number | null;
+    /**
+     * 
+     * @type {DmsExecutionPlanNodeCategory}
+     * @memberof DmsExecutionPlanNode
+     */
+    'category'?: DmsExecutionPlanNodeCategory;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanNode
+     */
+    'nodeType'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanNode
+     */
+    'label'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanNode
+     */
+    'relationName'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanNode
+     */
+    'schemaName'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanNode
+     */
+    'alias'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanNode
+     */
+    'indexName'?: string | null;
+    /**
+     * 
+     * @type {DmsExecutionPlanNodeCost}
+     * @memberof DmsExecutionPlanNode
+     */
+    'cost'?: DmsExecutionPlanNodeCost;
+    /**
+     * 
+     * @type {DmsExecutionPlanNodeRows}
+     * @memberof DmsExecutionPlanNode
+     */
+    'rows'?: DmsExecutionPlanNodeRows;
+    /**
+     * 
+     * @type {DmsExecutionPlanNodeTiming}
+     * @memberof DmsExecutionPlanNode
+     */
+    'timing'?: DmsExecutionPlanNodeTiming;
+    /**
+     * 
+     * @type {DmsExecutionPlanNodeConditions}
+     * @memberof DmsExecutionPlanNode
+     */
+    'conditions'?: DmsExecutionPlanNodeConditions;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof DmsExecutionPlanNode
+     */
+    'details'?: { [key: string]: any; };
+}
+
+
+

package/src/openapi/models/dms-execution-plan-raw-format.ts

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const DmsExecutionPlanRawFormat = {
+    json: 'json',
+    xml: 'xml',
+    text: 'text',
+    table: 'table'
+} as const;
+
+export type DmsExecutionPlanRawFormat = typeof DmsExecutionPlanRawFormat[keyof typeof DmsExecutionPlanRawFormat];
+
+
+

package/src/openapi/models/dms-execution-plan-result.ts

@@ -0,0 +1,125 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanEdge } from './dms-execution-plan-edge';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanMode } from './dms-execution-plan-mode';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanNode } from './dms-execution-plan-node';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanRawFormat } from './dms-execution-plan-raw-format';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanSummary } from './dms-execution-plan-summary';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanWarning } from './dms-execution-plan-warning';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsQueryResponse } from './dms-query-response';
+
+/**
+ * 
+ * @export
+ * @interface DmsExecutionPlanResult
+ */
+export interface DmsExecutionPlanResult {
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanResult
+     */
+    'originSQL'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanResult
+     */
+    'explainSQL'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanResult
+     */
+    'engineType'?: string;
+    /**
+     * 
+     * @type {DmsExecutionPlanMode}
+     * @memberof DmsExecutionPlanResult
+     */
+    'mode'?: DmsExecutionPlanMode;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DmsExecutionPlanResult
+     */
+    'hasActualStats'?: boolean;
+    /**
+     * 
+     * @type {DmsExecutionPlanRawFormat}
+     * @memberof DmsExecutionPlanResult
+     */
+    'rawFormat'?: DmsExecutionPlanRawFormat;
+    /**
+     * Engine-native raw plan payload exposed for fallback display. SDKs model it as a free-form JSON object.
+     * @type {{ [key: string]: any; }}
+     * @memberof DmsExecutionPlanResult
+     */
+    'rawPlan'?: { [key: string]: any; };
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DmsExecutionPlanResult
+     */
+    'rootNodeIds'?: Array<string>;
+    /**
+     * 
+     * @type {Array<DmsExecutionPlanNode>}
+     * @memberof DmsExecutionPlanResult
+     */
+    'nodes'?: Array<DmsExecutionPlanNode>;
+    /**
+     * 
+     * @type {Array<DmsExecutionPlanEdge>}
+     * @memberof DmsExecutionPlanResult
+     */
+    'edges'?: Array<DmsExecutionPlanEdge>;
+    /**
+     * 
+     * @type {DmsExecutionPlanSummary}
+     * @memberof DmsExecutionPlanResult
+     */
+    'summary'?: DmsExecutionPlanSummary;
+    /**
+     * 
+     * @type {Array<DmsExecutionPlanWarning>}
+     * @memberof DmsExecutionPlanResult
+     */
+    'warnings'?: Array<DmsExecutionPlanWarning>;
+    /**
+     * 
+     * @type {DmsQueryResponse}
+     * @memberof DmsExecutionPlanResult
+     */
+    'fallbackTable'?: DmsQueryResponse;
+}
+
+
+

package/src/openapi/models/dms-execution-plan-summary.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DmsExecutionPlanSummary
+ */
+export interface DmsExecutionPlanSummary {
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanSummary
+     */
+    'totalCost'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanSummary
+     */
+    'totalActualTimeMs'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanSummary
+     */
+    'planRows'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanSummary
+     */
+    'actualRows'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsExecutionPlanSummary
+     */
+    'nodeCount'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanSummary
+     */
+    'maxCostNodeId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanSummary
+     */
+    'maxRowsNodeId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanSummary
+     */
+    'maxTimeNodeId'?: string | null;
+}
+

package/src/openapi/models/dms-execution-plan-warning-severity.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const DmsExecutionPlanWarningSeverity = {
+    info: 'info',
+    warning: 'warning',
+    critical: 'critical'
+} as const;
+
+export type DmsExecutionPlanWarningSeverity = typeof DmsExecutionPlanWarningSeverity[keyof typeof DmsExecutionPlanWarningSeverity];
+
+
+

package/src/openapi/models/dms-execution-plan-warning.ts

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanWarningSeverity } from './dms-execution-plan-warning-severity';
+
+/**
+ * 
+ * @export
+ * @interface DmsExecutionPlanWarning
+ */
+export interface DmsExecutionPlanWarning {
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanWarning
+     */
+    'code'?: string;
+    /**
+     * 
+     * @type {DmsExecutionPlanWarningSeverity}
+     * @memberof DmsExecutionPlanWarning
+     */
+    'severity'?: DmsExecutionPlanWarningSeverity;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanWarning
+     */
+    'nodeId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsExecutionPlanWarning
+     */
+    'message'?: string;
+}
+
+
+

package/src/openapi/models/dms-visual-explain-request.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DmsVisualExplainRequest
+ */
+export interface DmsVisualExplainRequest {
+    /**
+     * the sql string
+     * @type {string}
+     * @memberof DmsVisualExplainRequest
+     */
+    'query'?: string;
+    /**
+     * the database for explaining the SQL
+     * @type {string}
+     * @memberof DmsVisualExplainRequest
+     */
+    'database'?: string;
+    /**
+     * whether to run an actual/analyze plan when the engine supports it
+     * @type {boolean}
+     * @memberof DmsVisualExplainRequest
+     */
+    'analyze'?: boolean;
+}
+

package/src/openapi/models/index.ts

@@ -291,6 +291,20 @@ export * from './dm-tablespace';
 export * from './dms-check-constraint';
 export * from './dms-exclude-constraint';
 export * from './dms-exclude-constraint-exclude-inner';
+export * from './dms-execution-plan-edge';
+export * from './dms-execution-plan-edge-rows';
+export * from './dms-execution-plan-mode';
+export * from './dms-execution-plan-node';
+export * from './dms-execution-plan-node-category';
+export * from './dms-execution-plan-node-conditions';
+export * from './dms-execution-plan-node-cost';
+export * from './dms-execution-plan-node-rows';
+export * from './dms-execution-plan-node-timing';
+export * from './dms-execution-plan-raw-format';
+export * from './dms-execution-plan-result';
+export * from './dms-execution-plan-summary';
+export * from './dms-execution-plan-warning';
+export * from './dms-execution-plan-warning-severity';
 export * from './dms-explain-request';
 export * from './dms-export-request';
 export * from './dms-foreign-key';
@@ -326,6 +340,7 @@ export * from './dms-task-info';
 export * from './dms-task-list';
 export * from './dms-unique-key';
 export * from './dms-view-metadata';
+export * from './dms-visual-explain-request';
 export * from './esput-security-user-request';
 export * from './essecurity-application-privileges';
 export * from './essecurity-field-security';