@alicloud/gpdb20160503 3.5.0 → 3.7.0

package/src/models/CreateBranchRequest.ts

@@ -0,0 +1,200 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateBranchRequestTag extends $dara.Model {
+  /**
+   * @remarks
+   * The tag key.
+   * 
+   * @example
+   * env
+   */
+  key?: string;
+  /**
+   * @remarks
+   * The tag value.
+   * 
+   * @example
+   * dev
+   */
+  value?: string;
+  static names(): { [key: string]: string } {
+    return {
+      key: 'Key',
+      value: 'Value',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      key: 'string',
+      value: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateBranchRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The branch name.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * dev
+   */
+  branchName?: string;
+  /**
+   * @remarks
+   * The client idempotency token. This token ensures the idempotence of retry requests.
+   * 
+   * @example
+   * 123e4567-e89b-12d3-a456-426614174000
+   */
+  clientToken?: string;
+  /**
+   * @remarks
+   * The branch description.
+   * 
+   * @example
+   * test branch
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The time at which the branch automatically expires and is deleted. The value is in ISO 8601 UTC format.
+   * 
+   * @example
+   * 2026-10-08T09:11:12Z
+   */
+  expiresAt?: string;
+  /**
+   * @remarks
+   * The initialization source of the branch.
+   * 
+   * Valid values:
+   * - ParentData: copies the schema and data from the parent branch. This is the default value.
+   * - SchemaOnly: copies only the schema structure.
+   * 
+   * @example
+   * ParentData
+   */
+  initSource?: string;
+  /**
+   * @remarks
+   * The parent branch ID. This parameter specifies the parent branch for the new branch or query condition.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * br-main
+   */
+  parentBranchId?: string;
+  /**
+   * @remarks
+   * The log sequence number (LSN) from the parent branch at which the branch is created.
+   * 
+   * @example
+   * 0/3522648
+   */
+  parentLsn?: string;
+  /**
+   * @remarks
+   * The point in time for data synchronization from the parent branch when creating the branch. The value is in ISO 8601 UTC format.
+   * 
+   * Default value: the current time.
+   * 
+   * @example
+   * 2026-04-08T09:11:12Z
+   */
+  parentTimestamp?: string;
+  /**
+   * @remarks
+   * The Supabase project ID that corresponds to the primary branch.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * spb-xxxx
+   */
+  projectId?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable branch protection.
+   * 
+   * Valid values:
+   * - true: Enables branch protection.
+   * - false: Disables branch protection. This is the default value.
+   * 
+   * @example
+   * false
+   */
+  protected?: boolean;
+  /**
+   * @remarks
+   * The region ID. This parameter is required when you create a primary branch. When you create a child branch, the region is inherited from the primary branch by default.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The list of branch tags.
+   */
+  tag?: CreateBranchRequestTag[];
+  static names(): { [key: string]: string } {
+    return {
+      branchName: 'BranchName',
+      clientToken: 'ClientToken',
+      description: 'Description',
+      expiresAt: 'ExpiresAt',
+      initSource: 'InitSource',
+      parentBranchId: 'ParentBranchId',
+      parentLsn: 'ParentLsn',
+      parentTimestamp: 'ParentTimestamp',
+      projectId: 'ProjectId',
+      protected: 'Protected',
+      regionId: 'RegionId',
+      tag: 'Tag',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      branchName: 'string',
+      clientToken: 'string',
+      description: 'string',
+      expiresAt: 'string',
+      initSource: 'string',
+      parentBranchId: 'string',
+      parentLsn: 'string',
+      parentTimestamp: 'string',
+      projectId: 'string',
+      protected: 'boolean',
+      regionId: 'string',
+      tag: { 'type': 'array', 'itemType': CreateBranchRequestTag },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.tag)) {
+      $dara.Model.validateArray(this.tag);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateBranchResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateBranchResponseBody } from "./CreateBranchResponseBody";
+
+
+export class CreateBranchResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateBranchResponseBody;
+  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: CreateBranchResponseBody,
+    };
+  }
+
+  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/CreateBranchResponseBody.ts

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateBranchResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The branch ID. This ID uniquely identifies a Supabase branch.
+   * 
+   * @example
+   * br-xxxx
+   */
+  branchId?: string;
+  /**
+   * @remarks
+   * The Supabase project ID that corresponds to the primary branch.
+   * 
+   * @example
+   * spb-xxxx
+   */
+  projectId?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * ABB39CC3-4488-4857-905D-2E4A051D****
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      branchId: 'BranchId',
+      projectId: 'ProjectId',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      branchId: 'string',
+      projectId: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateCollectionRequest.ts

@@ -3,8 +3,53 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateCollectionRequestSparseVectorIndexConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The vector index algorithm.
+   * 
+   * Valid values:
+   * 
+   * - `hnswflat`: (Default) An HNSW index without quantization compression.
+   * 
+   * - `novam`: A graph index without quantization compression. This algorithm is suitable for high-performance scenarios, such as real-time recommendations.
+   * 
+   * @example
+   * hnswflat
+   */
   algorithm?: string;
+  /**
+   * @remarks
+   * The size of the candidate set for HNSW index construction. The value must be an integer from 4 to 1,000. The default is 64.
+   * 
+   * > This parameter is required only for AnalyticDB for PostgreSQL V7.0 instances, and its value must be greater than or equal to `2 * HnswM`.
+   * 
+   * @example
+   * 128
+   */
   hnswEfConstruction?: number;
+  /**
+   * @remarks
+   * The maximum number of neighbors for the HNSW algorithm. You do not typically need to set this parameter, as the system automatically determines a value based on the vector dimension.
+   * 
+   * > Value range:
+   * >
+   * > - For AnalyticDB for PostgreSQL V6.0 instances: 1 to 1000.
+   * >
+   * > - For AnalyticDB for PostgreSQL V7.0 instances: 2 to 100. The default value is 16.
+   * 
+   * > We recommend that you set this parameter based on the vector dimension:
+   * >
+   * > - 16 for dimensions less than or equal to 384.
+   * >
+   * > - 32 for dimensions greater than 384 and less than or equal to 768.
+   * >
+   * > - 64 for dimensions greater than 768 and less than or equal to 1024.
+   * >
+   * > - 128 for dimensions greater than 1024.
+   * 
+   * @example
+   * 64
+   */
   hnswM?: number;
   static names(): { [key: string]: string } {
     return {
@@ -32,7 +77,21 @@ export class CreateCollectionRequestSparseVectorIndexConfig extends $dara.Model
 }
 
 export class CreateCollectionRequestVectorIndexConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The number of lists (partitions) for a `novad` index. The value must be an integer from 2 to 1,073,741,824. The default is 256.
+   * 
+   * @example
+   * 256
+   */
   nlist?: number;
+  /**
+   * @remarks
+   * The number of bits for `rabitq` compression. The value must be an integer from 1 to 8. The default is 3.
+   * 
+   * @example
+   * 3
+   */
   rabitqBits?: number;
   static names(): { [key: string]: string } {
     return {
@@ -58,12 +117,27 @@ export class CreateCollectionRequestVectorIndexConfig extends $dara.Model {
 }
 
 export class CreateCollectionRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The vector index algorithm.
+   * 
+   * Valid values:
+   * 
+   * - `hnswflat`: (Default) An HNSW index without quantization compression.
+   * 
+   * - `novam`: A graph index without quantization compression. This algorithm is suitable for high-performance scenarios, such as real-time recommendations.
+   * 
+   * - `novad`: A partitioned index with `rabitq` quantization. This algorithm is suitable for large-scale, low-cost retrieval scenarios.
+   * 
+   * @example
+   * hnswflat
+   */
   algorithm?: string;
   /**
    * @remarks
-   * The name of the collection that you want to create.
+   * The name of the collection to create.
    * 
-   * >  The name must comply with the naming conventions of PostgreSQL objects.
+   * > The name must comply with PostgreSQL object naming conventions.
    * 
    * This parameter is required.
    * 
@@ -75,17 +149,17 @@ export class CreateCollectionRequest extends $dara.Model {
    * @remarks
    * The instance ID.
    * 
-   * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.
    * 
    * @example
-   * gp-xxxxxxxxx
+   * gp-bp152460513z****
    */
   DBInstanceId?: string;
   /**
    * @remarks
-   * The number of vector dimensions.
+   * The vector dimension.
    * 
-   * >  If you specify this parameter, an index is created. When you call the [UpsertCollectionData](https://help.aliyun.com/document_detail/2401493.html) operation, make sure that the length of the Rows.Vector parameter is the same as the value of this parameter. If you do not specify this parameter, you can call the [CreateVectorIndex](https://help.aliyun.com/document_detail/2401499.html) operation to create an index.
+   * > If you specify this parameter, a vector index is created. In subsequent calls to the [UpsertCollectionData](https://help.aliyun.com/document_detail/2401493.html) operation, the length of `Rows.Vector` must match this dimension. If you do not specify this parameter, you must call the [CreateVectorIndex](https://help.aliyun.com/document_detail/2401499.html) operation to create an index later.
    * 
    * @example
    * 1024
@@ -93,13 +167,17 @@ export class CreateCollectionRequest extends $dara.Model {
   dimension?: number;
   /**
    * @remarks
-   * Specifies whether to use the memory mapping technology to create HNSW indexes. Valid values: 0 and 1. Default value: 0. We recommend that you set the value to 1 in scenarios that require upload speed but not data deletion.
+   * Specifies whether to use `mmap` to build the HNSW index. The default value is 0. We recommend setting this to 1 if your data does not require deletion and you need high-performance data ingestion.
    * 
-   * > 
+   * Valid values:
    * 
-   * *   0: uses segmented paging storage to create indexes. This method uses the shared buffer of PostgreSQL for caching and supports the delete and update operations.
+   * - `0`: (Default) Builds the index by using segmented page storage. This mode can use the `shared_buffer` in PostgreSQL for caching and supports `DELETE` and `UPDATE` operations.
    * 
-   * *   1: uses the memory mapping technology to create indexes. This method does not support the delete or update operation.
+   * - `1`: Builds the index by using `mmap`. This mode does not support `DELETE` or `UPDATE` operations.
+   * 
+   * >Notice: 
+   * 
+   * The `ExternalStorage` parameter is available only for AnalyticDB for PostgreSQL v6.0 instances and is not supported in v7.0.
    * 
    * @example
    * 0
@@ -107,26 +185,45 @@ export class CreateCollectionRequest extends $dara.Model {
   externalStorage?: number;
   /**
    * @remarks
-   * The fields used for full-text search. Separate multiple fields with commas (,). These fields must be keys defined in Metadata.
+   * The fields to use for full-text search. Use commas (`,`) to separate multiple field names. These fields must be keys defined in the `Metadata` parameter.
    * 
    * @example
    * title,content
    */
   fullTextRetrievalFields?: string;
-  hnswEfConstruction?: string;
   /**
    * @remarks
-   * The maximum number of neighbors for the Hierarchical Navigable Small World (HNSW) algorithm. Valid values: 1 to 1000. In most cases, this parameter is automatically configured based on the value of the Dimension parameter. You do not need to configure this parameter.
-   * 
-   * >  We recommend that you configure this parameter based on the value of the Dimension parameter.
+   * The size of the candidate set for HNSW index construction. The value must be greater than or equal to `2 * HnswM`.
    * 
-   * *If you set Dimension to a value less than or equal to 384, set the value of HnswM to 16.
+   * > Value range:
+   * >
+   * > - For AnalyticDB for PostgreSQL V6.0 instances: 40 to 4000.
+   * >
+   * > - For AnalyticDB for PostgreSQL V7.0 instances: 4 to 1000. The default value is 64.
    * 
-   * *If you set Dimension to a value greater than 384 and less than or equal to 768, set the value of HnswM to 32.
-   * 
-   * *If you set Dimension to a value greater than 768 and less than or equal to 1024, set the value of HnswM to 64.
-   * 
-   * *If you set Dimension to a value greater than 1024, set the value of HnswM to 128.
+   * @example
+   * 128
+   */
+  hnswEfConstruction?: string;
+  /**
+   * @remarks
+   * The maximum number of neighbors for the HNSW algorithm. You do not typically need to set this parameter, as the system automatically determines a value based on the vector dimension.
+   * 
+   * > Value range:
+   * >
+   * > - For AnalyticDB for PostgreSQL V6.0 instances: 1 to 1000.
+   * >
+   * > - For AnalyticDB for PostgreSQL V7.0 instances: 2 to 100. The default value is 16.
+   * 
+   * > We recommend that you set this parameter based on the vector dimension:
+   * >
+   * > - 16 for dimensions less than or equal to 384.
+   * >
+   * > - 32 for dimensions greater than 384 and less than or equal to 768.
+   * >
+   * > - 64 for dimensions greater than 768 and less than or equal to 1024.
+   * >
+   * > - 128 for dimensions greater than 1024.
    * 
    * @example
    * 64
@@ -134,9 +231,9 @@ export class CreateCollectionRequest extends $dara.Model {
   hnswM?: number;
   /**
    * @remarks
-   * Name of the management account with rds_superuser permissions.
+   * The name of the management account that has the `rds_superuser` privilege.
    * 
-   * > You can create an account through the console -> Account Management, or by using the [CreateAccount](https://help.aliyun.com/document_detail/2361789.html) API.
+   * > You can call the [CreateAccount](https://help.aliyun.com/document_detail/2361789.html) operation to create an account.
    * 
    * This parameter is required.
    * 
@@ -146,7 +243,7 @@ export class CreateCollectionRequest extends $dara.Model {
   managerAccount?: string;
   /**
    * @remarks
-   * The password of the manager account.
+   * The password of the management account.
    * 
    * This parameter is required.
    * 
@@ -156,17 +253,17 @@ export class CreateCollectionRequest extends $dara.Model {
   managerAccountPassword?: string;
   /**
    * @remarks
-   * The metadata of the vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type.
-   * 
-   * >  Supported data types:
+   * A JSON string that defines the metadata schema as a map. The keys are field names, and the values are their corresponding data types.
    * 
-   * *   For information about the supported data types, see [Data types](https://www.alibabacloud.com/help/zh/analyticdb/analyticdb-for-postgresql/developer-reference/data-types-1/).
+   * > Supported data types
+   * >
+   * > - For a list of supported data types, see [Data types](https://help.aliyun.com/document_detail/424383.html).
+   * >
+   * > - The `money` data type is not supported.
    * 
-   * *   The money data type is not supported.
+   * >Warning: 
    * 
-   * **
-   * 
-   * **Warning** Reserved fields such as id, vector, to_tsvector, and source cannot be used.
+   * The field names `id`, `vector`, `to_tsvector`, and `source` are reserved and cannot be used.
    * 
    * This parameter is required.
    * 
@@ -176,7 +273,7 @@ export class CreateCollectionRequest extends $dara.Model {
   metadata?: string;
   /**
    * @remarks
-   * The scalar index fields. Separate multiple fields with commas (,). These fields must be keys defined in Metadata.
+   * The scalar index fields. Separate multiple fields with commas (`,`). The fields must be keys that are defined in `Metadata`.
    * 
    * @example
    * title
@@ -184,11 +281,13 @@ export class CreateCollectionRequest extends $dara.Model {
   metadataIndices?: string;
   /**
    * @remarks
-   * The method that is used to create vector indexes. Valid values:
+   * The distance metric used to build the vector index. Valid values:
+   * 
+   * - `l2`: Euclidean distance.
    * 
-   * *   l2: Euclidean distance.
-   * *   ip: inner product distance.
-   * *   cosine: cosine similarity.
+   * - `ip`: dot product.
+   * 
+   * - `cosine`: cosine similarity.
    * 
    * @example
    * cosine
@@ -196,9 +295,9 @@ export class CreateCollectionRequest extends $dara.Model {
   metrics?: string;
   /**
    * @remarks
-   * The name of the namespace.
+   * The namespace.
    * 
-   * >  You can call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation to create a namespace and call the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to query a list of namespaces.
+   * > You can call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation to create a namespace or the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to list existing namespaces.
    * 
    * @example
    * mynamespace
@@ -207,7 +306,7 @@ export class CreateCollectionRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The analyzer that is used for full-text search.
+   * The parser for full-text search. The default is `zh_cn`.
    * 
    * @example
    * zh_cn
@@ -215,18 +314,19 @@ export class CreateCollectionRequest extends $dara.Model {
   parser?: string;
   /**
    * @remarks
-   * Specifies whether to enable the product quantization (PQ) feature for index acceleration. We recommend that you enable this feature for more than 500,000 rows of data. Valid values:
+   * Specifies whether to enable Product Quantization (PQ) for index acceleration. This is recommended for datasets with more than 500,000 entries. Valid values:
+   * 
+   * - `0`: Disabled.
    * 
-   * *   0: no.
-   * *   1 (default): yes.
+   * - `1`: (Default) Enabled.
    * 
    * @example
-   * 0
+   * 1
    */
   pqEnable?: number;
   /**
    * @remarks
-   * The region ID of the instance.
+   * The ID of the region where the instance is located.
    * 
    * This parameter is required.
    * 
@@ -234,12 +334,27 @@ export class CreateCollectionRequest extends $dara.Model {
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The configuration for the sparse vector index. If specified, a sparse vector index is created.
+   */
   sparseVectorIndexConfig?: CreateCollectionRequestSparseVectorIndexConfig;
+  /**
+   * @remarks
+   * Specifies whether to enable support for sparse vectors. The default value is `false`.
+   * 
+   * @example
+   * true
+   */
   supportSparse?: boolean;
+  /**
+   * @remarks
+   * The configuration for the dense vector index.
+   */
   vectorIndexConfig?: CreateCollectionRequestVectorIndexConfig;
   /**
    * @remarks
-   * The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.
+   * The ID of the workspace, which contains multiple database instances. You must specify either `WorkspaceId` or `DBInstanceId`. If both are specified, `WorkspaceId` takes precedence.
    * 
    * @example
    * gp-ws-*****

package/src/models/CreateCollectionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCollectionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * create successfully
@@ -23,8 +23,9 @@ export class CreateCollectionResponseBody extends $dara.Model {
    * @remarks
    * The status of the operation. Valid values:
    * 
-   * *   **success**
-   * *   **fail**
+   * - **success**: The operation succeeded.
+   * 
+   * - **fail**: The operation failed.
    * 
    * @example
    * success