Skip to content

DatabaseProps

Properties for defining a Database.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardbx-database

Initializer

import { DatabaseProps } from '@alicloud/ros-cdk-polardbx'
const databaseProps: DatabaseProps = { ... }

Properties

Name Type Description
accounts @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AccountsProperty[] Property accounts: List of accounts.
characterSetName string | @alicloud/ros-cdk-core.IResolvable Property characterSetName: Character set, which supports the following character sets: - utf8 * * - gbk - latin1 * * - *utf8mb4 * .
databaseName string | @alicloud/ros-cdk-core.IResolvable Property databaseName: The name of the database.
dbInstanceId string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceId: The ID of the instance.
databaseDescription string | @alicloud/ros-cdk-core.IResolvable Property databaseDescription: Database description information.
mode string | @alicloud/ros-cdk-core.IResolvable Property mode: The mode selected when creating the database.

accountsRequired

public readonly accounts: IResolvable | IResolvable | AccountsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AccountsProperty[]

Property accounts: List of accounts.


characterSetNameRequired

public readonly characterSetName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property characterSetName: Character set, which supports the following character sets: - utf8 * * - gbk - latin1 * * - *utf8mb4 * .


databaseNameRequired

public readonly databaseName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property databaseName: The name of the database.


dbInstanceIdRequired

public readonly dbInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceId: The ID of the instance.


databaseDescriptionOptional

public readonly databaseDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property databaseDescription: Database description information.


modeOptional

public readonly mode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property mode: The mode selected when creating the database.

The values are as follows: - auto: The database in this mode supports automatic partitioning, that is, you do not need to specify a partition key when creating a table; - drds: databases in this mode do not support automatic partitioning. When creating tables, you must use the dedicated database Shard syntax and specify the database shard key.