DedicatedShardedDatabase¶

class oci.globally_distributed_database.models.DedicatedShardedDatabase(**kwargs)¶

Bases: oci.globally_distributed_database.models.sharded_database.ShardedDatabase

Details of ATP-D 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 DedicatedShardedDatabase.
`DB_WORKLOAD_OLTP`	A constant which can be used with the db_workload property of a DedicatedShardedDatabase.
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_INACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_NEEDS_ATTENTION`	str(object=’’) -> str
`LIFECYCLE_STATE_UNAVAILABLE`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`REPLICATION_METHOD_DG`	A constant which can be used with the replication_method property of a DedicatedShardedDatabase.
`REPLICATION_METHOD_RAFT`	A constant which can be used with the replication_method property of a DedicatedShardedDatabase.
`SHARDING_METHOD_SYSTEM`	A constant which can be used with the sharding_method property of a DedicatedShardedDatabase.
`SHARDING_METHOD_USER`	A constant which can be used with the sharding_method property of a DedicatedShardedDatabase.
`catalog_details`	Gets the catalog_details of this DedicatedShardedDatabase.
`character_set`	[Required] Gets the character_set of this DedicatedShardedDatabase.
`chunks`	Gets the chunks of this DedicatedShardedDatabase.
`cluster_certificate_common_name`	Gets the cluster_certificate_common_name of this DedicatedShardedDatabase.
`compartment_id`	[Required] Gets the compartment_id of this ShardedDatabase.
`connection_strings`	Gets the connection_strings of this DedicatedShardedDatabase.
`db_deployment_type`	[Required] Gets the db_deployment_type of this ShardedDatabase.
`db_version`	[Required] Gets the db_version of this DedicatedShardedDatabase.
`db_workload`	Gets the db_workload of this DedicatedShardedDatabase.
`defined_tags`	Gets the defined_tags of this ShardedDatabase.
`display_name`	[Required] Gets the display_name of this ShardedDatabase.
`freeform_tags`	Gets the freeform_tags of this ShardedDatabase.
`gsms`	Gets the gsms of this DedicatedShardedDatabase.
`id`	[Required] Gets the id of this ShardedDatabase.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ShardedDatabase.
`lifecycle_state_details`	[Required] Gets the lifecycle_state_details of this ShardedDatabase.
`listener_port`	Gets the listener_port of this DedicatedShardedDatabase.
`listener_port_tls`	Gets the listener_port_tls of this DedicatedShardedDatabase.
`ncharacter_set`	[Required] Gets the ncharacter_set of this DedicatedShardedDatabase.
`ons_port_local`	Gets the ons_port_local of this DedicatedShardedDatabase.
`ons_port_remote`	Gets the ons_port_remote of this DedicatedShardedDatabase.
`prefix`	[Required] Gets the prefix of this DedicatedShardedDatabase.
`private_endpoint`	Gets the private_endpoint of this DedicatedShardedDatabase.
`replication_factor`	Gets the replication_factor of this DedicatedShardedDatabase.
`replication_method`	Gets the replication_method of this DedicatedShardedDatabase.
`replication_unit`	Gets the replication_unit of this DedicatedShardedDatabase.
`shard_details`	Gets the shard_details of this DedicatedShardedDatabase.
`sharding_method`	[Required] Gets the sharding_method of this DedicatedShardedDatabase.
`system_tags`	Gets the system_tags of this ShardedDatabase.
`time_created`	[Required] Gets the time_created of this ShardedDatabase.
`time_updated`	[Required] Gets the time_updated of this ShardedDatabase.
`time_zone`	Gets the time_zone of this DedicatedShardedDatabase.

Methods

`__init__`(**kwargs)	Initializes a new DedicatedShardedDatabase 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 DedicatedShardedDatabase. This constant has a value of “DW”

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶

LIFECYCLE_STATE_UNAVAILABLE = 'UNAVAILABLE'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

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

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

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

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

__init__(**kwargs)¶

Initializes a new DedicatedShardedDatabase 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:

id (str) – The value to assign to the id property of this DedicatedShardedDatabase.
compartment_id (str) – The value to assign to the compartment_id property of this DedicatedShardedDatabase.
db_deployment_type (str) – The value to assign to the db_deployment_type property of this DedicatedShardedDatabase. Allowed values for this property are: “DEDICATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this DedicatedShardedDatabase.
time_created (datetime) – The value to assign to the time_created property of this DedicatedShardedDatabase.
time_updated (datetime) – The value to assign to the time_updated property of this DedicatedShardedDatabase.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DedicatedShardedDatabase. Allowed values for this property are: “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “INACTIVE”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, “UNAVAILABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this DedicatedShardedDatabase.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DedicatedShardedDatabase.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DedicatedShardedDatabase.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DedicatedShardedDatabase.
replication_method (str) – The value to assign to the replication_method property of this DedicatedShardedDatabase. Allowed values for this property are: “RAFT”, “DG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
replication_factor (int) – The value to assign to the replication_factor property of this DedicatedShardedDatabase.
replication_unit (int) – The value to assign to the replication_unit property of this DedicatedShardedDatabase.
cluster_certificate_common_name (str) – The value to assign to the cluster_certificate_common_name property of this DedicatedShardedDatabase.
character_set (str) – The value to assign to the character_set property of this DedicatedShardedDatabase.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this DedicatedShardedDatabase.
chunks (int) – The value to assign to the chunks property of this DedicatedShardedDatabase.
db_workload (str) – The value to assign to the db_workload property of this DedicatedShardedDatabase. Allowed values for this property are: “OLTP”, “DW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
sharding_method (str) – The value to assign to the sharding_method property of this DedicatedShardedDatabase. Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
db_version (str) – The value to assign to the db_version property of this DedicatedShardedDatabase.
listener_port (int) – The value to assign to the listener_port property of this DedicatedShardedDatabase.
listener_port_tls (int) – The value to assign to the listener_port_tls property of this DedicatedShardedDatabase.
ons_port_local (int) – The value to assign to the ons_port_local property of this DedicatedShardedDatabase.
ons_port_remote (int) – The value to assign to the ons_port_remote property of this DedicatedShardedDatabase.
prefix (str) – The value to assign to the prefix property of this DedicatedShardedDatabase.
private_endpoint (str) – The value to assign to the private_endpoint property of this DedicatedShardedDatabase.
connection_strings (oci.globally_distributed_database.models.ConnectionString) – The value to assign to the connection_strings property of this DedicatedShardedDatabase.
time_zone (str) – The value to assign to the time_zone property of this DedicatedShardedDatabase.
gsms (list[oci.globally_distributed_database.models.GsmDetails]) – The value to assign to the gsms property of this DedicatedShardedDatabase.
shard_details (list[oci.globally_distributed_database.models.DedicatedShardDetails]) – The value to assign to the shard_details property of this DedicatedShardedDatabase.
catalog_details (list[oci.globally_distributed_database.models.DedicatedCatalogDetails]) – The value to assign to the catalog_details property of this DedicatedShardedDatabase.

catalog_details¶

Gets the catalog_details of this DedicatedShardedDatabase. Details of ATP-D based catalogs.

Returns:	The catalog_details of this DedicatedShardedDatabase.
Return type:	list[oci.globally_distributed_database.models.DedicatedCatalogDetails]

character_set¶

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

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

chunks¶

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

cluster_certificate_common_name¶

Gets the cluster_certificate_common_name of this DedicatedShardedDatabase. 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 DedicatedShardedDatabase.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ShardedDatabase. Identifier of the compartment in which sharded database exists.

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

connection_strings¶

Gets the connection_strings of this DedicatedShardedDatabase.

Returns:	The connection_strings of this DedicatedShardedDatabase.
Return type:	oci.globally_distributed_database.models.ConnectionString

db_deployment_type¶

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

Allowed values for this property are: “DEDICATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

db_version¶

[Required] Gets the db_version of this DedicatedShardedDatabase. Oracle Database version number.

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

db_workload¶

Gets the db_workload of this DedicatedShardedDatabase. Possible workload types.

Allowed values for this property are: “OLTP”, “DW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this ShardedDatabase. 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 ShardedDatabase.
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.

gsms¶

Gets the gsms of this DedicatedShardedDatabase. Details of GSM instances for the sharded database.

Returns:	The gsms of this DedicatedShardedDatabase.
Return type:	list[oci.globally_distributed_database.models.GsmDetails]

id¶

[Required] Gets the id of this ShardedDatabase. Sharded Database identifier

Returns:	The id of this ShardedDatabase.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ShardedDatabase. Lifecycle states for sharded databases.

Allowed values for this property are: “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “INACTIVE”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, “UNAVAILABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this ShardedDatabase.
Return type:	str

lifecycle_state_details¶

[Required] Gets the lifecycle_state_details of this ShardedDatabase. Detailed message for the lifecycle state.

Returns:	The lifecycle_state_details of this ShardedDatabase.
Return type:	str

listener_port¶

Gets the listener_port of this DedicatedShardedDatabase. The GSM listener port number.

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

listener_port_tls¶

Gets the listener_port_tls of this DedicatedShardedDatabase. The TLS listener port number for sharded database.

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

ncharacter_set¶

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

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

ons_port_local¶

Gets the ons_port_local of this DedicatedShardedDatabase. Ons local port number.

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

ons_port_remote¶

Gets the ons_port_remote of this DedicatedShardedDatabase. Ons remote port number.

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

prefix¶

[Required] Gets the prefix of this DedicatedShardedDatabase. Unique prefix for the sharded database.

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

private_endpoint¶

Gets the private_endpoint of this DedicatedShardedDatabase. The OCID of private endpoint being used by the sharded database.

Returns:	The private_endpoint of this DedicatedShardedDatabase.
Return type:	str

replication_factor¶

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

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

replication_method¶

Gets the replication_method of this DedicatedShardedDatabase. The Replication method for sharded 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”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

replication_unit¶

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

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

shard_details¶

Gets the shard_details of this DedicatedShardedDatabase. Details of ATP-D based shards.

Returns:	The shard_details of this DedicatedShardedDatabase.
Return type:	list[oci.globally_distributed_database.models.DedicatedShardDetails]

sharding_method¶

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

Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

system_tags¶

Gets the system_tags of this ShardedDatabase. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ShardedDatabase.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this ShardedDatabase. The time the the Sharded Database was created. An RFC3339 formatted datetime string

Returns:	The time_created of this ShardedDatabase.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ShardedDatabase. The time the Sharded Database was last updated. An RFC3339 formatted datetime string

Returns:	The time_updated of this ShardedDatabase.
Return type:	datetime

time_zone¶

Gets the time_zone of this DedicatedShardedDatabase. Timezone associated with the sharded database.

Returns:	The time_zone of this DedicatedShardedDatabase.
Return type:	str