CreateDistributedAutonomousDatabaseDetails¶

class oci.distributed_database.models.CreateDistributedAutonomousDatabaseDetails(**kwargs)¶

Bases: object

Details required for creation of the Globally distributed autonomous database.

Attributes

`DB_DEPLOYMENT_TYPE_ADB_D`	A constant which can be used with the db_deployment_type property of a CreateDistributedAutonomousDatabaseDetails.
`DB_WORKLOAD_DW`	A constant which can be used with the db_workload property of a CreateDistributedAutonomousDatabaseDetails.
`DB_WORKLOAD_OLTP`	A constant which can be used with the db_workload property of a CreateDistributedAutonomousDatabaseDetails.
`REPLICATION_METHOD_DG`	A constant which can be used with the replication_method property of a CreateDistributedAutonomousDatabaseDetails.
`REPLICATION_METHOD_RAFT`	A constant which can be used with the replication_method property of a CreateDistributedAutonomousDatabaseDetails.
`SHARDING_METHOD_SYSTEM`	A constant which can be used with the sharding_method property of a CreateDistributedAutonomousDatabaseDetails.
`SHARDING_METHOD_USER`	A constant which can be used with the sharding_method property of a CreateDistributedAutonomousDatabaseDetails.
`catalog_details`	[Required] Gets the catalog_details of this CreateDistributedAutonomousDatabaseDetails.
`character_set`	[Required] Gets the character_set of this CreateDistributedAutonomousDatabaseDetails.
`chunks`	Gets the chunks of this CreateDistributedAutonomousDatabaseDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateDistributedAutonomousDatabaseDetails.
`database_version`	[Required] Gets the database_version of this CreateDistributedAutonomousDatabaseDetails.
`db_deployment_type`	[Required] Gets the db_deployment_type of this CreateDistributedAutonomousDatabaseDetails.
`db_workload`	[Required] Gets the db_workload of this CreateDistributedAutonomousDatabaseDetails.
`defined_tags`	Gets the defined_tags of this CreateDistributedAutonomousDatabaseDetails.
`display_name`	[Required] Gets the display_name of this CreateDistributedAutonomousDatabaseDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDistributedAutonomousDatabaseDetails.
`listener_port`	[Required] Gets the listener_port of this CreateDistributedAutonomousDatabaseDetails.
`listener_port_tls`	Gets the listener_port_tls of this CreateDistributedAutonomousDatabaseDetails.
`ncharacter_set`	[Required] Gets the ncharacter_set of this CreateDistributedAutonomousDatabaseDetails.
`ons_port_local`	[Required] Gets the ons_port_local of this CreateDistributedAutonomousDatabaseDetails.
`ons_port_remote`	[Required] Gets the ons_port_remote of this CreateDistributedAutonomousDatabaseDetails.
`prefix`	[Required] Gets the prefix of this CreateDistributedAutonomousDatabaseDetails.
`private_endpoint_ids`	[Required] Gets the private_endpoint_ids of this CreateDistributedAutonomousDatabaseDetails.
`replication_factor`	Gets the replication_factor of this CreateDistributedAutonomousDatabaseDetails.
`replication_method`	Gets the replication_method of this CreateDistributedAutonomousDatabaseDetails.
`replication_unit`	Gets the replication_unit of this CreateDistributedAutonomousDatabaseDetails.
`shard_details`	[Required] Gets the shard_details of this CreateDistributedAutonomousDatabaseDetails.
`sharding_method`	[Required] Gets the sharding_method of this CreateDistributedAutonomousDatabaseDetails.

Methods

__init__(**kwargs) Initializes a new CreateDistributedAutonomousDatabaseDetails object with values from keyword arguments.

DB_DEPLOYMENT_TYPE_ADB_D = 'ADB_D'¶: A constant which can be used with the db_deployment_type property of a CreateDistributedAutonomousDatabaseDetails. This constant has a value of “ADB_D”

DB_WORKLOAD_DW = 'DW'¶: A constant which can be used with the db_workload property of a CreateDistributedAutonomousDatabaseDetails. This constant has a value of “DW”

DB_WORKLOAD_OLTP = 'OLTP'¶: A constant which can be used with the db_workload property of a CreateDistributedAutonomousDatabaseDetails. This constant has a value of “OLTP”

REPLICATION_METHOD_DG = 'DG'¶: A constant which can be used with the replication_method property of a CreateDistributedAutonomousDatabaseDetails. This constant has a value of “DG”

REPLICATION_METHOD_RAFT = 'RAFT'¶: A constant which can be used with the replication_method property of a CreateDistributedAutonomousDatabaseDetails. This constant has a value of “RAFT”

SHARDING_METHOD_SYSTEM = 'SYSTEM'¶: A constant which can be used with the sharding_method property of a CreateDistributedAutonomousDatabaseDetails. This constant has a value of “SYSTEM”

SHARDING_METHOD_USER = 'USER'¶: A constant which can be used with the sharding_method property of a CreateDistributedAutonomousDatabaseDetails. This constant has a value of “USER”

__init__(**kwargs)¶

Initializes a new CreateDistributedAutonomousDatabaseDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreateDistributedAutonomousDatabaseDetails.
display_name (str) – The value to assign to the display_name property of this CreateDistributedAutonomousDatabaseDetails.
database_version (str) – The value to assign to the database_version property of this CreateDistributedAutonomousDatabaseDetails.
prefix (str) – The value to assign to the prefix property of this CreateDistributedAutonomousDatabaseDetails.
private_endpoint_ids (list[str]) – The value to assign to the private_endpoint_ids property of this CreateDistributedAutonomousDatabaseDetails.
sharding_method (str) – The value to assign to the sharding_method property of this CreateDistributedAutonomousDatabaseDetails. Allowed values for this property are: “USER”, “SYSTEM”
db_workload (str) – The value to assign to the db_workload property of this CreateDistributedAutonomousDatabaseDetails. Allowed values for this property are: “OLTP”, “DW”
character_set (str) – The value to assign to the character_set property of this CreateDistributedAutonomousDatabaseDetails.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this CreateDistributedAutonomousDatabaseDetails.
chunks (int) – The value to assign to the chunks property of this CreateDistributedAutonomousDatabaseDetails.
listener_port (int) – The value to assign to the listener_port property of this CreateDistributedAutonomousDatabaseDetails.
listener_port_tls (int) – The value to assign to the listener_port_tls property of this CreateDistributedAutonomousDatabaseDetails.
ons_port_local (int) – The value to assign to the ons_port_local property of this CreateDistributedAutonomousDatabaseDetails.
ons_port_remote (int) – The value to assign to the ons_port_remote property of this CreateDistributedAutonomousDatabaseDetails.
replication_method (str) – The value to assign to the replication_method property of this CreateDistributedAutonomousDatabaseDetails. Allowed values for this property are: “RAFT”, “DG”
replication_factor (int) – The value to assign to the replication_factor property of this CreateDistributedAutonomousDatabaseDetails.
replication_unit (int) – The value to assign to the replication_unit property of this CreateDistributedAutonomousDatabaseDetails.
db_deployment_type (str) – The value to assign to the db_deployment_type property of this CreateDistributedAutonomousDatabaseDetails. Allowed values for this property are: “ADB_D”
shard_details (list[oci.distributed_database.models.CreateDistributedAutonomousDatabaseShardDetails]) – The value to assign to the shard_details property of this CreateDistributedAutonomousDatabaseDetails.
catalog_details (list[oci.distributed_database.models.CreateDistributedAutonomousDatabaseCatalogDetails]) – The value to assign to the catalog_details property of this CreateDistributedAutonomousDatabaseDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDistributedAutonomousDatabaseDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDistributedAutonomousDatabaseDetails.

catalog_details¶

[Required] Gets the catalog_details of this CreateDistributedAutonomousDatabaseDetails. Collection of catalog for the Globally distributed autonomous database.

Returns:	The catalog_details of this CreateDistributedAutonomousDatabaseDetails.
Return type:	list[oci.distributed_database.models.CreateDistributedAutonomousDatabaseCatalogDetails]

character_set¶

[Required] Gets the character_set of this CreateDistributedAutonomousDatabaseDetails. The character set for the database.

Returns:	The character_set of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str

chunks¶

Gets the chunks of this CreateDistributedAutonomousDatabaseDetails. The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.

Returns:	The chunks of this CreateDistributedAutonomousDatabaseDetails.
Return type:	int

compartment_id¶

[Required] Gets the compartment_id of this CreateDistributedAutonomousDatabaseDetails. The OCID of the Globally distributed autonomous database compartment.

Returns:	The compartment_id of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str

database_version¶

[Required] Gets the database_version of this CreateDistributedAutonomousDatabaseDetails. Oracle Database version for the shards and catalog used in Globally distributed autonomous database.

Returns:	The database_version of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str

db_deployment_type¶

[Required] Gets the db_deployment_type of this CreateDistributedAutonomousDatabaseDetails. The distributed autonomous database deployment type.

Allowed values for this property are: “ADB_D”

Returns:	The db_deployment_type of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str

db_workload¶

[Required] Gets the db_workload of this CreateDistributedAutonomousDatabaseDetails. Possible workload types.

Allowed values for this property are: “OLTP”, “DW”

Returns:	The db_workload of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateDistributedAutonomousDatabaseDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateDistributedAutonomousDatabaseDetails.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this CreateDistributedAutonomousDatabaseDetails. The display name of the Globally distributed autonomous database.

Returns:	The display_name of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateDistributedAutonomousDatabaseDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateDistributedAutonomousDatabaseDetails.
Return type:	dict(str, str)

listener_port¶

[Required] Gets the listener_port of this CreateDistributedAutonomousDatabaseDetails. The listener port number for the Globally distributed autonomous database.

Returns:	The listener_port of this CreateDistributedAutonomousDatabaseDetails.
Return type:	int

listener_port_tls¶

Gets the listener_port_tls of this CreateDistributedAutonomousDatabaseDetails. The TLS listener port number for Globally distributed autonomous database.

Returns:	The listener_port_tls of this CreateDistributedAutonomousDatabaseDetails.
Return type:	int

ncharacter_set¶

[Required] Gets the ncharacter_set of this CreateDistributedAutonomousDatabaseDetails. The national character set for the database.

Returns:	The ncharacter_set of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str

ons_port_local¶

[Required] Gets the ons_port_local of this CreateDistributedAutonomousDatabaseDetails. Ons local port number.

Returns:	The ons_port_local of this CreateDistributedAutonomousDatabaseDetails.
Return type:	int

ons_port_remote¶

[Required] Gets the ons_port_remote of this CreateDistributedAutonomousDatabaseDetails. Ons remote port number.

Returns:	The ons_port_remote of this CreateDistributedAutonomousDatabaseDetails.
Return type:	int

prefix¶

[Required] Gets the prefix of this CreateDistributedAutonomousDatabaseDetails. Unique name prefix for the Globally distributed autonomous databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.

Returns:	The prefix of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str

private_endpoint_ids¶

[Required] Gets the private_endpoint_ids of this CreateDistributedAutonomousDatabaseDetails. The collection of OCID of the private endpoint associated with Globally distributed autonomous database.

Returns:	The private_endpoint_ids of this CreateDistributedAutonomousDatabaseDetails.
Return type:	list[str]

replication_factor¶

Gets the replication_factor of this CreateDistributedAutonomousDatabaseDetails. The Replication factor for RAFT replication based Globally distributed autonomous database. Currently supported values are 3, 5 and 7.

Returns:	The replication_factor of this CreateDistributedAutonomousDatabaseDetails.
Return type:	int

replication_method¶

Gets the replication_method of this CreateDistributedAutonomousDatabaseDetails. The Replication method for Globally distributed autonomous database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.

Allowed values for this property are: “RAFT”, “DG”

Returns:	The replication_method of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str

replication_unit¶

Gets the replication_unit of this CreateDistributedAutonomousDatabaseDetails. For RAFT replication based Globally distributed autonomous database, the value should be atleast twice the number of shards.

Returns:	The replication_unit of this CreateDistributedAutonomousDatabaseDetails.
Return type:	int

shard_details¶

[Required] Gets the shard_details of this CreateDistributedAutonomousDatabaseDetails. Collection of shards for the Globally distributed autonomous database.

Returns:	The shard_details of this CreateDistributedAutonomousDatabaseDetails.
Return type:	list[oci.distributed_database.models.CreateDistributedAutonomousDatabaseShardDetails]

sharding_method¶

[Required] Gets the sharding_method of this CreateDistributedAutonomousDatabaseDetails. Sharding Methods for the Globally distributed autonomous database.

Allowed values for this property are: “USER”, “SYSTEM”

Returns:	The sharding_method of this CreateDistributedAutonomousDatabaseDetails.
Return type:	str