CreateDistributedDatabaseDetails¶

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

Bases: object

Details required for creation of the Globally distributed database.

Attributes

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

Methods

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

DB_DEPLOYMENT_TYPE_EXADB_XS = 'EXADB_XS'¶: A constant which can be used with the db_deployment_type property of a CreateDistributedDatabaseDetails. This constant has a value of “EXADB_XS”

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

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

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

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

__init__(**kwargs)¶

Initializes a new CreateDistributedDatabaseDetails 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 CreateDistributedDatabaseDetails.
display_name (str) – The value to assign to the display_name property of this CreateDistributedDatabaseDetails.
database_version (str) – The value to assign to the database_version property of this CreateDistributedDatabaseDetails.
prefix (str) – The value to assign to the prefix property of this CreateDistributedDatabaseDetails.
private_endpoint_ids (list[str]) – The value to assign to the private_endpoint_ids property of this CreateDistributedDatabaseDetails.
sharding_method (str) – The value to assign to the sharding_method property of this CreateDistributedDatabaseDetails. Allowed values for this property are: “USER”, “SYSTEM”
character_set (str) – The value to assign to the character_set property of this CreateDistributedDatabaseDetails.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this CreateDistributedDatabaseDetails.
chunks (int) – The value to assign to the chunks property of this CreateDistributedDatabaseDetails.
listener_port (int) – The value to assign to the listener_port property of this CreateDistributedDatabaseDetails.
listener_port_tls (int) – The value to assign to the listener_port_tls property of this CreateDistributedDatabaseDetails.
ons_port_local (int) – The value to assign to the ons_port_local property of this CreateDistributedDatabaseDetails.
ons_port_remote (int) – The value to assign to the ons_port_remote property of this CreateDistributedDatabaseDetails.
replication_method (str) – The value to assign to the replication_method property of this CreateDistributedDatabaseDetails. Allowed values for this property are: “RAFT”, “DG”
replication_factor (int) – The value to assign to the replication_factor property of this CreateDistributedDatabaseDetails.
replication_unit (int) – The value to assign to the replication_unit property of this CreateDistributedDatabaseDetails.
db_deployment_type (str) – The value to assign to the db_deployment_type property of this CreateDistributedDatabaseDetails. Allowed values for this property are: “EXADB_XS”
shard_details (list[oci.distributed_database.models.CreateDistributedDatabaseShardDetails]) – The value to assign to the shard_details property of this CreateDistributedDatabaseDetails.
catalog_details (list[oci.distributed_database.models.CreateDistributedDatabaseCatalogDetails]) – The value to assign to the catalog_details property of this CreateDistributedDatabaseDetails.
gsm_ssh_public_key (str) – The value to assign to the gsm_ssh_public_key property of this CreateDistributedDatabaseDetails.
db_backup_config (oci.distributed_database.models.DistributedDbBackupConfig) – The value to assign to the db_backup_config property of this CreateDistributedDatabaseDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDistributedDatabaseDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDistributedDatabaseDetails.

catalog_details¶

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

Returns:	The catalog_details of this CreateDistributedDatabaseDetails.
Return type:	list[oci.distributed_database.models.CreateDistributedDatabaseCatalogDetails]

character_set¶

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

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

chunks¶

Gets the chunks of this CreateDistributedDatabaseDetails. 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 CreateDistributedDatabaseDetails.
Return type:	int

compartment_id¶

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

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

database_version¶

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

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

db_backup_config¶

Gets the db_backup_config of this CreateDistributedDatabaseDetails.

Returns:	The db_backup_config of this CreateDistributedDatabaseDetails.
Return type:	oci.distributed_database.models.DistributedDbBackupConfig

db_deployment_type¶

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

Allowed values for this property are: “EXADB_XS”

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

defined_tags¶

Gets the defined_tags of this CreateDistributedDatabaseDetails. 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 CreateDistributedDatabaseDetails.
Return type:	dict(str, dict(str, object))

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this CreateDistributedDatabaseDetails. 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 CreateDistributedDatabaseDetails.
Return type:	dict(str, str)

gsm_ssh_public_key¶

Gets the gsm_ssh_public_key of this CreateDistributedDatabaseDetails. The SSH public key for Global service manager instances.

Returns:	The gsm_ssh_public_key of this CreateDistributedDatabaseDetails.
Return type:	str

listener_port¶

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

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

listener_port_tls¶

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

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

ncharacter_set¶

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

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

ons_port_local¶

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

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

ons_port_remote¶

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

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

prefix¶

[Required] Gets the prefix of this CreateDistributedDatabaseDetails. Unique name prefix for the Globally distributed 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 CreateDistributedDatabaseDetails.
Return type:	str

private_endpoint_ids¶

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

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

replication_factor¶

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

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

replication_method¶

Gets the replication_method of this CreateDistributedDatabaseDetails. The Replication method for Globally distributed 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 CreateDistributedDatabaseDetails.
Return type:	str

replication_unit¶

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

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

shard_details¶

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

Returns:	The shard_details of this CreateDistributedDatabaseDetails.
Return type:	list[oci.distributed_database.models.CreateDistributedDatabaseShardDetails]

sharding_method¶

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

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

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