CreateDedicatedShardedDatabase

class oci.globally_distributed_database.models.CreateDedicatedShardedDatabase(**kwargs)

Bases: oci.globally_distributed_database.models.create_sharded_database_details.CreateShardedDatabaseDetails

Request details for creation of ATP-Dedicated based sharded database.

Attributes

DB_DEPLOYMENT_TYPE_DEDICATED	str(object=’’) -> str
DB_WORKLOAD_DW	A constant which can be used with the db_workload property of a CreateDedicatedShardedDatabase.
DB_WORKLOAD_OLTP	A constant which can be used with the db_workload property of a CreateDedicatedShardedDatabase.
SHARDING_METHOD_SYSTEM	A constant which can be used with the sharding_method property of a CreateDedicatedShardedDatabase.
SHARDING_METHOD_USER	A constant which can be used with the sharding_method property of a CreateDedicatedShardedDatabase.
catalog_details	[Required] Gets the catalog_details of this CreateDedicatedShardedDatabase.
character_set	[Required] Gets the character_set of this CreateDedicatedShardedDatabase.
chunks	Gets the chunks of this CreateDedicatedShardedDatabase.
cluster_certificate_common_name	Gets the cluster_certificate_common_name of this CreateDedicatedShardedDatabase.
compartment_id	[Required] Gets the compartment_id of this CreateShardedDatabaseDetails.
db_deployment_type	[Required] Gets the db_deployment_type of this CreateShardedDatabaseDetails.
db_version	[Required] Gets the db_version of this CreateDedicatedShardedDatabase.
db_workload	[Required] Gets the db_workload of this CreateDedicatedShardedDatabase.
defined_tags	Gets the defined_tags of this CreateShardedDatabaseDetails.
display_name	[Required] Gets the display_name of this CreateShardedDatabaseDetails.
freeform_tags	Gets the freeform_tags of this CreateShardedDatabaseDetails.
listener_port	[Required] Gets the listener_port of this CreateDedicatedShardedDatabase.
listener_port_tls	[Required] Gets the listener_port_tls of this CreateDedicatedShardedDatabase.
ncharacter_set	[Required] Gets the ncharacter_set of this CreateDedicatedShardedDatabase.
ons_port_local	[Required] Gets the ons_port_local of this CreateDedicatedShardedDatabase.
ons_port_remote	[Required] Gets the ons_port_remote of this CreateDedicatedShardedDatabase.
prefix	[Required] Gets the prefix of this CreateDedicatedShardedDatabase.
replication_factor	Gets the replication_factor of this CreateDedicatedShardedDatabase.
replication_method	Gets the replication_method of this CreateDedicatedShardedDatabase.
replication_unit	Gets the replication_unit of this CreateDedicatedShardedDatabase.
shard_details	[Required] Gets the shard_details of this CreateDedicatedShardedDatabase.
sharding_method	[Required] Gets the sharding_method of this CreateDedicatedShardedDatabase.

Methods

__init__(**kwargs)	Initializes a new CreateDedicatedShardedDatabase object with values from keyword arguments.
get_subtype(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

DB_DEPLOYMENT_TYPE_DEDICATED = 'DEDICATED'

DB_WORKLOAD_DW = 'DW'

A constant which can be used with the db_workload property of a CreateDedicatedShardedDatabase. This constant has a value of “DW”

DB_WORKLOAD_OLTP = 'OLTP'

A constant which can be used with the db_workload property of a CreateDedicatedShardedDatabase. This constant has a value of “OLTP”

SHARDING_METHOD_SYSTEM = 'SYSTEM'

A constant which can be used with the sharding_method property of a CreateDedicatedShardedDatabase. This constant has a value of “SYSTEM”

SHARDING_METHOD_USER = 'USER'

A constant which can be used with the sharding_method property of a CreateDedicatedShardedDatabase. This constant has a value of “USER”

__init__(**kwargs)

Initializes a new CreateDedicatedShardedDatabase object with values from keyword arguments. The default value of the db_deployment_type attribute of this class is DEDICATED and it should not be changed. 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 CreateDedicatedShardedDatabase.
• db_deployment_type (str) – The value to assign to the db_deployment_type property of this CreateDedicatedShardedDatabase. Allowed values for this property are: “DEDICATED”
• display_name (str) – The value to assign to the display_name property of this CreateDedicatedShardedDatabase.
• freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDedicatedShardedDatabase.
• defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDedicatedShardedDatabase.
• replication_method (str) – The value to assign to the replication_method property of this CreateDedicatedShardedDatabase.
• replication_factor (int) – The value to assign to the replication_factor property of this CreateDedicatedShardedDatabase.
• replication_unit (int) – The value to assign to the replication_unit property of this CreateDedicatedShardedDatabase.
• cluster_certificate_common_name (str) – The value to assign to the cluster_certificate_common_name property of this CreateDedicatedShardedDatabase.
• chunks (int) – The value to assign to the chunks property of this CreateDedicatedShardedDatabase.
• db_workload (str) – The value to assign to the db_workload property of this CreateDedicatedShardedDatabase. Allowed values for this property are: “OLTP”, “DW”
• sharding_method (str) – The value to assign to the sharding_method property of this CreateDedicatedShardedDatabase. Allowed values for this property are: “USER”, “SYSTEM”
• db_version (str) – The value to assign to the db_version property of this CreateDedicatedShardedDatabase.
• character_set (str) – The value to assign to the character_set property of this CreateDedicatedShardedDatabase.
• ncharacter_set (str) – The value to assign to the ncharacter_set property of this CreateDedicatedShardedDatabase.
• listener_port (int) – The value to assign to the listener_port property of this CreateDedicatedShardedDatabase.
• listener_port_tls (int) – The value to assign to the listener_port_tls property of this CreateDedicatedShardedDatabase.
• ons_port_local (int) – The value to assign to the ons_port_local property of this CreateDedicatedShardedDatabase.
• ons_port_remote (int) – The value to assign to the ons_port_remote property of this CreateDedicatedShardedDatabase.
• prefix (str) – The value to assign to the prefix property of this CreateDedicatedShardedDatabase.
• shard_details (list[oci.globally_distributed_database.models.CreateDedicatedShardDetail]) – The value to assign to the shard_details property of this CreateDedicatedShardedDatabase.
• catalog_details (list[oci.globally_distributed_database.models.CreateDedicatedCatalogDetail]) – The value to assign to the catalog_details property of this CreateDedicatedShardedDatabase.

catalog_details

[Required] Gets the catalog_details of this CreateDedicatedShardedDatabase. Collection of ATP-Dedicated catalogs that needs to be created.

Returns:The catalog_details of this CreateDedicatedShardedDatabase. Return type:list[oci.globally_distributed_database.models.CreateDedicatedCatalogDetail]

character_set

[Required] Gets the character_set of this CreateDedicatedShardedDatabase. The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets

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

chunks

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

cluster_certificate_common_name

Gets the cluster_certificate_common_name of this CreateDedicatedShardedDatabase. The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.

Returns:The cluster_certificate_common_name of this CreateDedicatedShardedDatabase. Return type:str

compartment_id

[Required] Gets the compartment_id of this CreateShardedDatabaseDetails. Identifier of the compartment where sharded database is to be created.

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

db_deployment_type

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

Allowed values for this property are: “DEDICATED”

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

db_version

[Required] Gets the db_version of this CreateDedicatedShardedDatabase. Oracle Database version of the Autonomous Container Database.

Returns:The db_version of this CreateDedicatedShardedDatabase. Return type:str

db_workload

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

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

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

defined_tags

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

display_name

[Required] Gets the display_name of this CreateShardedDatabaseDetails. Oracle sharded database display name.

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

freeform_tags

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

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

listener_port

[Required] Gets the listener_port of this CreateDedicatedShardedDatabase. The listener port number for sharded database.

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

listener_port_tls

[Required] Gets the listener_port_tls of this CreateDedicatedShardedDatabase. The TLS listener port number for sharded database.

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

ncharacter_set

[Required] Gets the ncharacter_set of this CreateDedicatedShardedDatabase. The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets

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

ons_port_local

[Required] Gets the ons_port_local of this CreateDedicatedShardedDatabase. Ons port local for sharded database.

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

ons_port_remote

[Required] Gets the ons_port_remote of this CreateDedicatedShardedDatabase. Ons remote port for sharded database.

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

prefix

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

replication_factor

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

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

replication_method

Gets the replication_method of this CreateDedicatedShardedDatabase. The Replication method for sharded database.

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

replication_unit

Gets the replication_unit of this CreateDedicatedShardedDatabase. For RAFT replication based sharded database, the value should be atleast twice the number of shards.

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

shard_details

[Required] Gets the shard_details of this CreateDedicatedShardedDatabase. Collection of ATP-Dedicated shards that needs to be created.

Returns:The shard_details of this CreateDedicatedShardedDatabase. Return type:list[oci.globally_distributed_database.models.CreateDedicatedShardDetail]

sharding_method

[Required] Gets the sharding_method of this CreateDedicatedShardedDatabase. Sharding Method.

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

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