@alicloud/adb20211201 4.1.0 → 4.1.2

package/src/models/DescribeSqlpatternsRequest.ts

@@ -115,6 +115,7 @@ export class DescribeSQLPatternsRequest extends $dara.Model {
    * 2022-09-06T03:06:00Z
    */
   startTime?: string;
+  userName?: string;
   static names(): { [key: string]: string } {
     return {
       DBClusterId: 'DBClusterId',
@@ -126,6 +127,7 @@ export class DescribeSQLPatternsRequest extends $dara.Model {
       pageSize: 'PageSize',
       regionId: 'RegionId',
       startTime: 'StartTime',
+      userName: 'UserName',
     };
   }
 
@@ -140,6 +142,7 @@ export class DescribeSQLPatternsRequest extends $dara.Model {
       pageSize: 'number',
       regionId: 'string',
       startTime: 'string',
+      userName: 'string',
     };
   }
 

package/src/models/DescribeSqlwebSocketDomainRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSQLWebSocketDomainRequest extends $dara.Model {
   /**
    * @remarks
+   * The cluster ID.
+   * 
+   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,10 @@ export class DescribeSQLWebSocketDomainRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
+   * The region ID
+   * 
+   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the most recent region list.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeSqlwebSocketDomainResponseBody.ts

@@ -4,26 +4,47 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSQLWebSocketDomainResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.
+   * 
    * @example
    * 200
    */
   code?: number;
   /**
+   * @remarks
+   * The domain name.
+   * 
    * @example
    * adb-ws-beijing.console.aliyun.com/query
    */
   domain?: string;
   /**
+   * @remarks
+   * The returned message. Valid values:
+   * 
+   * *   If the request was successful, a success message is returned.****
+   * *   If the request failed, an error message is returned.
+   * 
    * @example
    * Success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * E03F0806-A67B-5B24-8562-9589F20DEEB5
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   **true**
+   * *   **false**
+   * 
    * @example
    * true
    */

package/src/models/DescribeTableStatisticsRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeTableStatisticsRequest extends $dara.Model {
   /**
    * @remarks
+   * The cluster ID.
+   * 
+   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,31 +16,69 @@ export class DescribeTableStatisticsRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * The keyword that is used to query information by table name.
+   * 
    * @example
    * you_table_name
    */
   keyword?: string;
   /**
+   * @remarks
+   * The order by which to sort query results. Specify the parameter value in the JSON format.
+   * 
+   * Example:
+   * 
+   *     [
+   * 
+   *         {
+   * 
+   *             "Field":"Name",
+   * 
+   *             "Type":"Asc"
+   * 
+   *         }
+   * 
+   *     ]
+   * 
+   * Field specifies the field by which to sort the query results. Set the value to Name. Type specifies the sorting order. Valid values: Desc and Asc.
+   * 
+   * Field and Type are case-insensitive.
+   * 
    * @example
    * [{"Field":"SchemaName","Type":"Desc"}]
    */
   order?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The region ID
+   * 
+   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/612393.html) operation to query the most recent region list.
+   * 
    * @example
    * cn-beijing
    */
   regionId?: string;
   /**
+   * @remarks
+   * The name of the database.
+   * 
    * @example
    * test
    */

package/src/models/DescribeTableStatisticsResponseBody.ts

@@ -5,32 +5,54 @@ import { DescribeTableStatisticsResponseBodyItems } from "./DescribeTableStatist
 
 export class DescribeTableStatisticsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The cluster ID.
+   * 
    * @example
    * am-****************
    */
   DBClusterId?: string;
+  /**
+   * @remarks
+   * The queried table statistics.
+   */
   items?: DescribeTableStatisticsResponseBodyItems;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: string;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 30
    */
   pageSize?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 4C4433FF-5D3A-4C3E-A19C-6D93B2******
    */
   requestId?: string;
   /**
+   * @remarks
+   * The names of databases.
+   * 
    * @example
    * [\\"adb_platform\\", \\"adb_ai\\", \\"adb_data\\"]
    */
   schemaNames?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 693
    */

package/src/models/DescribeTableStatisticsResponseBodyItemsTableStatisticRecords.ts

@@ -4,61 +4,106 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeTableStatisticsResponseBodyItemsTableStatisticRecords extends $dara.Model {
   /**
+   * @remarks
+   * The size of cold data. Unit: bytes.
+   * 
+   * >  This parameter is supported only for AnalyticDB for MySQL clusters of V3.1.3.4 or later.
+   * 
    * @example
    * 4428120064
    */
   coldDataSize?: number;
   /**
+   * @remarks
+   * The data size of the table. Unit: bytes.
+   * 
    * @example
    * 15592
    */
   dataSize?: number;
   /**
+   * @remarks
+   * The size of hot data. Unit: bytes.
+   * 
    * @example
    * 1048576
    */
   hotDataSize?: number;
   /**
+   * @remarks
+   * The data size of indexes. Unit: bytes.
+   * 
    * @example
    * 3076
    */
   indexSize?: number;
   /**
+   * @remarks
+   * The data size of other data. Unit: bytes.
+   * 
    * @example
    * 1048576
    */
   otherSize?: number;
   /**
+   * @remarks
+   * The number of partitions.
+   * 
    * @example
    * 1
    */
   partitionCount?: number;
   /**
+   * @remarks
+   * The data size of the primary key index. Unit: bytes.
+   * 
    * @example
    * 16340
    */
   primaryKeyIndexSize?: number;
   /**
+   * @remarks
+   * The number of rows in the table.
+   * 
    * @example
    * 3
    */
   rowCount?: number;
   /**
+   * @remarks
+   * The name of the database.
+   * 
    * @example
    * test_schema
    */
   schemaName?: string;
   /**
+   * @remarks
+   * The percentage of the table size. Unit: %.
+   * 
+   * >  Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.
+   * 
    * @example
    * 66.23
    */
   spaceRatio?: number;
   /**
+   * @remarks
+   * The name of the table.
+   * 
    * @example
    * test_table
    */
   tableName?: string;
   /**
+   * @remarks
+   * The total data size of the table. Unit: bytes.
+   * 
+   * >  The following formulas can be used to calculate the total data size:
+   * 
+   * *   Formula 1: Total data size = Hot data size + Cold data size.
+   * *   Formula 2: Total data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.
+   * 
    * @example
    * 1577
    */

package/src/models/GetDatabaseObjectsResponseBody.ts

@@ -6,7 +6,7 @@ import { GetDatabaseObjectsResponseBodyData } from "./GetDatabaseObjectsResponse
 export class GetDatabaseObjectsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The queried databases.
+   * The returned data.
    */
   data?: GetDatabaseObjectsResponseBodyData;
   /**

package/src/models/GetDatabaseObjectsResponseBodyData.ts

@@ -6,7 +6,7 @@ import { DatabaseSummaryModel } from "./DatabaseSummaryModel";
 export class GetDatabaseObjectsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The queried database.
+   * The queried databases.
    */
   databaseSummaryModels?: DatabaseSummaryModel[];
   /**

package/src/models/GetTableColumnsResponseBody.ts

@@ -6,7 +6,7 @@ import { GetTableColumnsResponseBodyData } from "./GetTableColumnsResponseBodyDa
 export class GetTableColumnsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The queried data.
+   * The returned data.
    */
   data?: GetTableColumnsResponseBodyData;
   /**

package/src/models/GetViewObjectsRequest.ts

@@ -102,6 +102,10 @@ export class GetViewObjectsRequest extends $dara.Model {
    * adb_demo
    */
   schemaName?: string;
+  /**
+   * @example
+   * true
+   */
   showMvBaseTable?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/KillProcessRequest.ts

@@ -19,7 +19,7 @@ export class KillProcessRequest extends $dara.Model {
    * @remarks
    * The query ID.
    * 
-   * >  You can call the [DescribeProcessList](https://help.aliyun.com/document_detail/143382.html) operation to query the IDs of queries that are being executed.
+   * >  You can call the [DescribeProcessList](https://help.aliyun.com/document_detail/612277.html) operation to query the IDs of queries that are being executed.
    * 
    * @example
    * 202011191048151921681492420315100****

package/src/models/ModifyClusterAccessWhiteListRequest.ts

@@ -7,7 +7,7 @@ export class ModifyClusterAccessWhiteListRequest extends $dara.Model {
    * @remarks
    * The attribute of the IP address whitelist. By default, this parameter is empty.
    * 
-   * > Whitelists with the hidden attribute are not displayed in the console. Those whitelists are used to access Data Transmission Service (DTS) and PolarDB.
+   * >  IP address whitelists with the hidden attribute are not displayed in the console. Those whitelists are used to access Data Transmission Service (DTS) and PolarDB.
    * 
    * @example
    * hidden

package/src/models/SubmitResultExportJobRequest.ts

@@ -25,7 +25,10 @@ export class SubmitResultExportJobRequest extends $dara.Model {
   engine?: string;
   /**
    * @remarks
-   * The export type.
+   * The type of the result set export job.
+   * 
+   * @example
+   * SLS
    */
   exportType?: string;
   /**

package/src/models/SubmitSparkAppRequest.ts

@@ -41,7 +41,7 @@ export class SubmitSparkAppRequest extends $dara.Model {
   appType?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
+   * The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.
    * 
    * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
    *