@alicloud/dms20250414 4.0.0 → 4.2.0

package/src/models/AgenticTableColumnEngineMeta.ts

@@ -5,52 +5,82 @@ import * as $dara from '@darabonba/typescript';
 export class AgenticTableColumnEngineMeta extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the column uses auto-increment.
+   * Specifies whether the field is auto-incremented.
+   * 
+   * @example
+   * false
    */
   autoIncrement?: boolean;
   /**
    * @remarks
-   * The data length of the column. This parameter typically applies to string and binary data types.
+   * The defined length of the field.
+   * 
+   * @example
+   * 20
    */
   dataLength?: number;
   /**
    * @remarks
-   * The data precision of the column, which is the total number of digits in a numeric type.
+   * The precision of the numeric field.
+   * 
+   * @example
+   * 10
    */
   dataPrecision?: number;
   /**
    * @remarks
-   * The data scale of the column, which is the number of digits to the right of the decimal point in a numeric type.
+   * The scale of the numeric field, which is the number of decimal places.
+   * 
+   * @example
+   * 2
    */
   dataScale?: number;
   /**
    * @remarks
-   * The default value of the column.
+   * The default value of the field.
+   * 
+   * @example
+   * 0
    */
   defaultValue?: string;
   /**
    * @remarks
-   * The character encoding of the column.
+   * The character set of the field.
+   * 
+   * @example
+   * utf8mb4
    */
   encoding?: string;
   /**
    * @remarks
-   * Engine-specific attributes or flags for the column.
+   * The additional information of the field, such as auto_increment.
+   * 
+   * @example
+   * auto_increment
    */
   extra?: string;
   /**
    * @remarks
-   * Indicates whether the column is a generated column.
+   * Specifies whether the field is a generated column.
+   * 
+   * @example
+   * false
    */
   generationColumn?: boolean;
   /**
    * @remarks
-   * The expression used to generate the column\\"s value. Applies only if `GenerationColumn` is `true`.
+   * The calculation expression of the generated column.
+   * 
+   * @example
+   * price * quantity
    */
   generationExpression?: string;
   /**
    * @remarks
-   * Indicates whether the column is nullable.
+   * Specifies whether the field allows null values.
+   * 
+   * @example
+   * false
    */
   nullable?: boolean;
   static names(): { [key: string]: string } {

package/src/models/AgenticTableEngineMeta.ts

@@ -5,62 +5,98 @@ import * as $dara from '@darabonba/typescript';
 export class AgenticTableEngineMeta extends $dara.Model {
   /**
    * @remarks
-   * A checksum to verify the table\\"s data integrity.
+   * The checksum of the table metadata.
+   * 
+   * @example
+   * 9f86d081884c7d65****
    */
   checksum?: string;
   /**
    * @remarks
-   * The time the table was created, in UTC format (`YYYY-MM-DDThh:mm:ssZ`).
+   * The time when the table was created. The format is yyyy-MM-dd HH:mm:ss.
+   * 
+   * @example
+   * 2025-01-01 10:00:00
    */
   createTime?: string;
   /**
    * @remarks
-   * The total size of the table\\"s data, in bytes.
+   * The data size of the table. Unit: bytes.
+   * 
+   * @example
+   * 786432
    */
   dataBytes?: number;
   /**
    * @remarks
-   * The character encoding of the table.
+   * The character set encoding of the table.
+   * 
+   * @example
+   * utf8mb4
    */
   encoding?: string;
   /**
    * @remarks
-   * The table\\"s storage engine, such as `InnoDB`.
+   * The storage engine of the table.
+   * 
+   * @example
+   * InnoDB
    */
   engine?: string;
   /**
    * @remarks
-   * A checksum of the table\\"s data and indexes.
+   * The full checksum of the table metadata.
+   * 
+   * @example
+   * 2c26b46b68ffc68f****
    */
   fullChecksum?: string;
   /**
    * @remarks
-   * The total size of the table\\"s indexes, in bytes.
+   * The index size of the table. Unit: bytes.
+   * 
+   * @example
+   * 262144
    */
   indexBytes?: number;
   /**
    * @remarks
-   * The timestamp of the last DDL (Data Definition Language) operation, in UTC format (`YYYY-MM-DDThh:mm:ssZ`).
+   * The time when the last DDL operation was executed on the table. The format is yyyy-MM-dd HH:mm:ss.
+   * 
+   * @example
+   * 2025-01-02 10:00:00
    */
   lastDdlTime?: string;
   /**
    * @remarks
    * The number of rows in the table.
+   * 
+   * @example
+   * 10000
    */
   numRows?: number;
   /**
    * @remarks
-   * The table\\"s reference information.
+   * The reference information of the table.
+   * 
+   * @example
+   * order_db.orders_view
    */
   refInfo?: string;
   /**
    * @remarks
-   * The table\\"s total storage capacity, in bytes.
+   * The storage capacity of the table. Unit: MB.
+   * 
+   * @example
+   * 16
    */
   storageCapacity?: number;
   /**
    * @remarks
-   * The name of the table schema.
+   * The name of the schema to which the table belongs.
+   * 
+   * @example
+   * public
    */
   tableSchemaName?: string;
   static names(): { [key: string]: string } {

package/src/models/AgenticTableIndex.ts

@@ -5,37 +5,58 @@ import * as $dara from '@darabonba/typescript';
 export class AgenticTableIndex extends $dara.Model {
   /**
    * @remarks
-   * An array of column names included in the index.
+   * The list of fields included in the index. Fields with a specified prefix length include a length expression, such as name(10).
    */
   columnNames?: string[];
   /**
    * @remarks
-   * An optional, user-defined description for the index.
+   * The index description.
+   * 
+   * @example
+   * Index on user_id
    */
   description?: string;
   /**
    * @remarks
-   * The unique name of the index within the table.
+   * The index name.
+   * 
+   * @example
+   * idx_user_id
    */
   indexName?: string;
   /**
    * @remarks
-   * The type of the index, such as PRIMARY, UNIQUE, or NORMAL.
+   * The index type. Valid values:
+   * 
+   * - **Primary**: primary key index
+   * - **Unique**: unique index
+   * - **Normal**: normal index
+   * - **FullText**: full-text index
+   * - **Spatial**: spatial index
+   * 
+   * @example
+   * Normal
    */
   indexType?: string;
   /**
    * @remarks
-   * Specifies if the index is the primary key. A table can have only one primary key.
+   * Specifies whether the index is a primary key index.
+   * 
+   * @example
+   * false
    */
   primary?: boolean;
   /**
    * @remarks
-   * An array of physical column names from the database. Use this parameter when the names in ColumnNames are aliases or logical names.
+   * The list of actual field names referenced by the index, with prefix length expressions removed from ColumnNames.
    */
   realColumnNames?: string[];
   /**
    * @remarks
-   * Specifies if the index enforces a unique constraint, requiring all its values to be unique across rows.
+   * Specifies whether the index is a unique index.
+   * 
+   * @example
+   * false
    */
   unique?: boolean;
   static names(): { [key: string]: string } {

package/src/models/CreateAgenticSqlExecuteCredentialRequest.ts

@@ -0,0 +1,67 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateAgenticSqlExecuteCredentialRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the instance.
+   * 
+   * @example
+   * rm-bp1xxxxxxxx
+   */
+  catalogName?: string;
+  /**
+   * @remarks
+   * The UUID of the instance.
+   * 
+   * @example
+   * 9f8e7d6c-xxxx-xxxx-xxxx-1a2b3c4d5e6f
+   */
+  catalogUuid?: string;
+  /**
+   * @remarks
+   * The UUID of the database. If you specify this parameter, the credential is restricted to this database. You can call the ListDatabases operation to obtain the UUID.
+   * 
+   * @example
+   * 6c4e8a2b-xxxx-xxxx-xxxx-0f1d2e3c4b5a
+   */
+  databaseUuid?: string;
+  /**
+   * @remarks
+   * The fully qualified name of the database. This parameter must be used together with CatalogUuid or CatalogName.
+   * 
+   * - MySQL database: The value is the same as the database name.
+   * - PostgreSQL database or other databases with schemas: The value is in the database.schema format.
+   * 
+   * @example
+   * test_db
+   */
+  qualifiedName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      catalogName: 'CatalogName',
+      catalogUuid: 'CatalogUuid',
+      databaseUuid: 'DatabaseUuid',
+      qualifiedName: 'QualifiedName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      catalogName: 'string',
+      catalogUuid: 'string',
+      databaseUuid: 'string',
+      qualifiedName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAgenticSqlExecuteCredentialResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateAgenticSqlExecuteCredentialResponseBody } from "./CreateAgenticSqlExecuteCredentialResponseBody";
+
+
+export class CreateAgenticSqlExecuteCredentialResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateAgenticSqlExecuteCredentialResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: CreateAgenticSqlExecuteCredentialResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAgenticSqlExecuteCredentialResponseBody.ts

@@ -0,0 +1,177 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateAgenticSqlExecuteCredentialResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The AccessKey of the credential.
+   * 
+   * @example
+   * ak_xxxxxxxx
+   */
+  accessKey?: string;
+  /**
+   * @remarks
+   * The AccessKey secret of the credential. This value is returned only once when the credential is created. Keep it secure.
+   * 
+   * @example
+   * xxxxxxxx
+   */
+  accessSecret?: string;
+  /**
+   * @remarks
+   * The name of the instance.
+   * 
+   * @example
+   * rm-bp1xxxxxxxx
+   */
+  catalogName?: string;
+  /**
+   * @remarks
+   * The UUID of the instance.
+   * 
+   * @example
+   * 9f8e7d6c-xxxx-xxxx-xxxx-1a2b3c4d5e6f
+   */
+  catalogUuid?: string;
+  /**
+   * @remarks
+   * The UUID of the database. If the credential is at the instance level, this value is empty.
+   * 
+   * @example
+   * 6c4e8a2b-xxxx-xxxx-xxxx-0f1d2e3c4b5a
+   */
+  databaseUuid?: string;
+  /**
+   * @remarks
+   * The expiration time of the credential. Format: yyyy-MM-dd HH:mm:ss.
+   * 
+   * @example
+   * 2026-10-13 12:00:00
+   */
+  expireTime?: string;
+  /**
+   * @remarks
+   * The total number of connections supported by the credential.
+   * 
+   * @example
+   * 500
+   */
+  maxConnectTimes?: number;
+  /**
+   * @remarks
+   * The fully qualified name of the database. If the credential is at the instance level, this value is empty.
+   * 
+   * @example
+   * test_db
+   */
+  qualifiedName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      accessKey: 'AccessKey',
+      accessSecret: 'AccessSecret',
+      catalogName: 'CatalogName',
+      catalogUuid: 'CatalogUuid',
+      databaseUuid: 'DatabaseUuid',
+      expireTime: 'ExpireTime',
+      maxConnectTimes: 'MaxConnectTimes',
+      qualifiedName: 'QualifiedName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      accessKey: 'string',
+      accessSecret: 'string',
+      catalogName: 'string',
+      catalogUuid: 'string',
+      databaseUuid: 'string',
+      expireTime: 'string',
+      maxConnectTimes: 'number',
+      qualifiedName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateAgenticSqlExecuteCredentialResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The temporary credential information.
+   */
+  data?: CreateAgenticSqlExecuteCredentialResponseBodyData;
+  /**
+   * @remarks
+   * The error code.
+   * 
+   * @example
+   * INVALID_PARAMETER
+   */
+  errorCode?: string;
+  /**
+   * @remarks
+   * The error message returned if the call fails.
+   * 
+   * @example
+   * UnknownError
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 34E01EDD-6A16-4CF0-9541-C644D1BE01AA
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is successful. Valid values:
+   * 
+   * - **true**: The request is successful.                                 
+   * - **false**: The request fails.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      errorCode: 'ErrorCode',
+      errorMessage: 'ErrorMessage',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: CreateAgenticSqlExecuteCredentialResponseBodyData,
+      errorCode: 'string',
+      errorMessage: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+