DistributedDatabaseSummary¶

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

Bases: object

Globally distributed database.

Attributes

`DB_DEPLOYMENT_TYPE_EXADB_XS`	A constant which can be used with the db_deployment_type property of a DistributedDatabaseSummary.
`character_set`	[Required] Gets the character_set of this DistributedDatabaseSummary.
`chunks`	Gets the chunks of this DistributedDatabaseSummary.
`compartment_id`	[Required] Gets the compartment_id of this DistributedDatabaseSummary.
`connection_strings`	Gets the connection_strings of this DistributedDatabaseSummary.
`database_version`	[Required] Gets the database_version of this DistributedDatabaseSummary.
`db_deployment_type`	[Required] Gets the db_deployment_type of this DistributedDatabaseSummary.
`defined_tags`	Gets the defined_tags of this DistributedDatabaseSummary.
`display_name`	[Required] Gets the display_name of this DistributedDatabaseSummary.
`freeform_tags`	Gets the freeform_tags of this DistributedDatabaseSummary.
`id`	[Required] Gets the id of this DistributedDatabaseSummary.
`lifecycle_details`	[Required] Gets the lifecycle_details of this DistributedDatabaseSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DistributedDatabaseSummary.
`listener_port`	[Required] Gets the listener_port of this DistributedDatabaseSummary.
`listener_port_tls`	Gets the listener_port_tls of this DistributedDatabaseSummary.
`metadata`	Gets the metadata of this DistributedDatabaseSummary.
`ncharacter_set`	[Required] Gets the ncharacter_set of this DistributedDatabaseSummary.
`ons_port_local`	[Required] Gets the ons_port_local of this DistributedDatabaseSummary.
`ons_port_remote`	[Required] Gets the ons_port_remote of this DistributedDatabaseSummary.
`prefix`	[Required] Gets the prefix of this DistributedDatabaseSummary.
`private_endpoint_ids`	[Required] Gets the private_endpoint_ids of this DistributedDatabaseSummary.
`replication_factor`	Gets the replication_factor of this DistributedDatabaseSummary.
`replication_method`	Gets the replication_method of this DistributedDatabaseSummary.
`replication_unit`	Gets the replication_unit of this DistributedDatabaseSummary.
`sharding_method`	[Required] Gets the sharding_method of this DistributedDatabaseSummary.
`system_tags`	Gets the system_tags of this DistributedDatabaseSummary.
`time_created`	[Required] Gets the time_created of this DistributedDatabaseSummary.
`time_updated`	[Required] Gets the time_updated of this DistributedDatabaseSummary.

Methods

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

__init__(**kwargs)¶

Initializes a new DistributedDatabaseSummary object with values from keyword arguments. 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 DistributedDatabaseSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DistributedDatabaseSummary.
display_name (str) – The value to assign to the display_name property of this DistributedDatabaseSummary.
time_created (datetime) – The value to assign to the time_created property of this DistributedDatabaseSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DistributedDatabaseSummary.
database_version (str) – The value to assign to the database_version property of this DistributedDatabaseSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DistributedDatabaseSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DistributedDatabaseSummary.
connection_strings (oci.distributed_database.models.DistributedDbConnectionString) – The value to assign to the connection_strings property of this DistributedDatabaseSummary.
prefix (str) – The value to assign to the prefix property of this DistributedDatabaseSummary.
private_endpoint_ids (list[str]) – The value to assign to the private_endpoint_ids property of this DistributedDatabaseSummary.
sharding_method (str) – The value to assign to the sharding_method property of this DistributedDatabaseSummary.
character_set (str) – The value to assign to the character_set property of this DistributedDatabaseSummary.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this DistributedDatabaseSummary.
chunks (int) – The value to assign to the chunks property of this DistributedDatabaseSummary.
listener_port (int) – The value to assign to the listener_port property of this DistributedDatabaseSummary.
listener_port_tls (int) – The value to assign to the listener_port_tls property of this DistributedDatabaseSummary.
ons_port_local (int) – The value to assign to the ons_port_local property of this DistributedDatabaseSummary.
ons_port_remote (int) – The value to assign to the ons_port_remote property of this DistributedDatabaseSummary.
replication_method (str) – The value to assign to the replication_method property of this DistributedDatabaseSummary.
replication_factor (int) – The value to assign to the replication_factor property of this DistributedDatabaseSummary.
replication_unit (int) – The value to assign to the replication_unit property of this DistributedDatabaseSummary.
db_deployment_type (str) – The value to assign to the db_deployment_type property of this DistributedDatabaseSummary. Allowed values for this property are: “EXADB_XS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
metadata (oci.distributed_database.models.DistributedDbMetadata) – The value to assign to the metadata property of this DistributedDatabaseSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DistributedDatabaseSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DistributedDatabaseSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DistributedDatabaseSummary.

character_set¶

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

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

chunks¶

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

compartment_id¶

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

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

connection_strings¶

Gets the connection_strings of this DistributedDatabaseSummary.

Returns:	The connection_strings of this DistributedDatabaseSummary.
Return type:	oci.distributed_database.models.DistributedDbConnectionString

database_version¶

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

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

db_deployment_type¶

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

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

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

id¶

[Required] Gets the id of this DistributedDatabaseSummary. The OCID of the Globally distributed database.

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

lifecycle_details¶

[Required] Gets the lifecycle_details of this DistributedDatabaseSummary. The lifecycleDetails for the Globally distributed database.

Returns:	The lifecycle_details of this DistributedDatabaseSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DistributedDatabaseSummary. Lifecycle state of sharded database.

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

listener_port¶

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

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

listener_port_tls¶

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

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

metadata¶

Gets the metadata of this DistributedDatabaseSummary.

Returns:	The metadata of this DistributedDatabaseSummary.
Return type:	oci.distributed_database.models.DistributedDbMetadata

ncharacter_set¶

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

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

ons_port_local¶

[Required] Gets the ons_port_local of this DistributedDatabaseSummary. Ons local port number for the Globally distributed database.

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

ons_port_remote¶

[Required] Gets the ons_port_remote of this DistributedDatabaseSummary. Ons remote port number for the Globally distributed database.

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

prefix¶

[Required] Gets the prefix of this DistributedDatabaseSummary. 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 DistributedDatabaseSummary.
Return type:	str

private_endpoint_ids¶

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

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

replication_factor¶

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

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

replication_method¶

Gets the replication_method of this DistributedDatabaseSummary. 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.

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

replication_unit¶

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

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

sharding_method¶

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

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

system_tags¶

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

time_created¶

[Required] Gets the time_created of this DistributedDatabaseSummary. The time the Globally distributed database was created. An RFC3339 formatted datetime string

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

time_updated¶

[Required] Gets the time_updated of this DistributedDatabaseSummary. The time the Globally distributed database was last updated. An RFC3339 formatted datetime string

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