DistributedAutonomousDatabase¶

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

Bases: object

Globally distributed autonomous database.

Attributes

`DB_DEPLOYMENT_TYPE_ADB_D`	A constant which can be used with the db_deployment_type property of a DistributedAutonomousDatabase.
`DB_WORKLOAD_DW`	A constant which can be used with the db_workload property of a DistributedAutonomousDatabase.
`DB_WORKLOAD_OLTP`	A constant which can be used with the db_workload property of a DistributedAutonomousDatabase.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase.
`REPLICATION_METHOD_DG`	A constant which can be used with the replication_method property of a DistributedAutonomousDatabase.
`REPLICATION_METHOD_RAFT`	A constant which can be used with the replication_method property of a DistributedAutonomousDatabase.
`SHARDING_METHOD_SYSTEM`	A constant which can be used with the sharding_method property of a DistributedAutonomousDatabase.
`SHARDING_METHOD_USER`	A constant which can be used with the sharding_method property of a DistributedAutonomousDatabase.
`catalog_details`	Gets the catalog_details of this DistributedAutonomousDatabase.
`character_set`	[Required] Gets the character_set of this DistributedAutonomousDatabase.
`chunks`	Gets the chunks of this DistributedAutonomousDatabase.
`compartment_id`	[Required] Gets the compartment_id of this DistributedAutonomousDatabase.
`connection_strings`	Gets the connection_strings of this DistributedAutonomousDatabase.
`database_version`	[Required] Gets the database_version of this DistributedAutonomousDatabase.
`db_deployment_type`	[Required] Gets the db_deployment_type of this DistributedAutonomousDatabase.
`db_workload`	[Required] Gets the db_workload of this DistributedAutonomousDatabase.
`defined_tags`	Gets the defined_tags of this DistributedAutonomousDatabase.
`display_name`	[Required] Gets the display_name of this DistributedAutonomousDatabase.
`freeform_tags`	Gets the freeform_tags of this DistributedAutonomousDatabase.
`gsm_details`	Gets the gsm_details of this DistributedAutonomousDatabase.
`id`	[Required] Gets the id of this DistributedAutonomousDatabase.
`latest_gsm_image`	Gets the latest_gsm_image of this DistributedAutonomousDatabase.
`lifecycle_details`	[Required] Gets the lifecycle_details of this DistributedAutonomousDatabase.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DistributedAutonomousDatabase.
`listener_port`	[Required] Gets the listener_port of this DistributedAutonomousDatabase.
`listener_port_tls`	Gets the listener_port_tls of this DistributedAutonomousDatabase.
`metadata`	Gets the metadata of this DistributedAutonomousDatabase.
`ncharacter_set`	[Required] Gets the ncharacter_set of this DistributedAutonomousDatabase.
`ons_port_local`	[Required] Gets the ons_port_local of this DistributedAutonomousDatabase.
`ons_port_remote`	[Required] Gets the ons_port_remote of this DistributedAutonomousDatabase.
`prefix`	[Required] Gets the prefix of this DistributedAutonomousDatabase.
`private_endpoint_ids`	[Required] Gets the private_endpoint_ids of this DistributedAutonomousDatabase.
`replication_factor`	Gets the replication_factor of this DistributedAutonomousDatabase.
`replication_method`	Gets the replication_method of this DistributedAutonomousDatabase.
`replication_unit`	Gets the replication_unit of this DistributedAutonomousDatabase.
`shard_details`	Gets the shard_details of this DistributedAutonomousDatabase.
`sharding_method`	[Required] Gets the sharding_method of this DistributedAutonomousDatabase.
`system_tags`	Gets the system_tags of this DistributedAutonomousDatabase.
`time_created`	[Required] Gets the time_created of this DistributedAutonomousDatabase.
`time_updated`	[Required] Gets the time_updated of this DistributedAutonomousDatabase.

Methods

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

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DistributedAutonomousDatabase. This constant has a value of “UPDATING”

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

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

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

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

__init__(**kwargs)¶

Initializes a new DistributedAutonomousDatabase 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 DistributedAutonomousDatabase.
compartment_id (str) – The value to assign to the compartment_id property of this DistributedAutonomousDatabase.
display_name (str) – The value to assign to the display_name property of this DistributedAutonomousDatabase.
time_created (datetime) – The value to assign to the time_created property of this DistributedAutonomousDatabase.
time_updated (datetime) – The value to assign to the time_updated property of this DistributedAutonomousDatabase.
database_version (str) – The value to assign to the database_version property of this DistributedAutonomousDatabase.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DistributedAutonomousDatabase. Allowed values for this property are: “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “INACTIVE”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DistributedAutonomousDatabase.
connection_strings (oci.distributed_database.models.DistributedAutonomousDatabaseConnectionString) – The value to assign to the connection_strings property of this DistributedAutonomousDatabase.
prefix (str) – The value to assign to the prefix property of this DistributedAutonomousDatabase.
private_endpoint_ids (list[str]) – The value to assign to the private_endpoint_ids property of this DistributedAutonomousDatabase.
sharding_method (str) – The value to assign to the sharding_method property of this DistributedAutonomousDatabase. 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_workload (str) – The value to assign to the db_workload property of this DistributedAutonomousDatabase. 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’.
character_set (str) – The value to assign to the character_set property of this DistributedAutonomousDatabase.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this DistributedAutonomousDatabase.
chunks (int) – The value to assign to the chunks property of this DistributedAutonomousDatabase.
listener_port (int) – The value to assign to the listener_port property of this DistributedAutonomousDatabase.
listener_port_tls (int) – The value to assign to the listener_port_tls property of this DistributedAutonomousDatabase.
ons_port_local (int) – The value to assign to the ons_port_local property of this DistributedAutonomousDatabase.
ons_port_remote (int) – The value to assign to the ons_port_remote property of this DistributedAutonomousDatabase.
replication_method (str) – The value to assign to the replication_method property of this DistributedAutonomousDatabase. 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 DistributedAutonomousDatabase.
replication_unit (int) – The value to assign to the replication_unit property of this DistributedAutonomousDatabase.
latest_gsm_image (oci.distributed_database.models.DistributedAutonomousDatabaseGsmImage) – The value to assign to the latest_gsm_image property of this DistributedAutonomousDatabase.
db_deployment_type (str) – The value to assign to the db_deployment_type property of this DistributedAutonomousDatabase. Allowed values for this property are: “ADB_D”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
shard_details (list[oci.distributed_database.models.DistributedAutonomousDatabaseShard]) – The value to assign to the shard_details property of this DistributedAutonomousDatabase.
catalog_details (list[oci.distributed_database.models.DistributedAutonomousDatabaseCatalog]) – The value to assign to the catalog_details property of this DistributedAutonomousDatabase.
gsm_details (list[oci.distributed_database.models.DistributedAutonomousDatabaseGsm]) – The value to assign to the gsm_details property of this DistributedAutonomousDatabase.
metadata (oci.distributed_database.models.DistributedAutonomousDbMetadata) – The value to assign to the metadata property of this DistributedAutonomousDatabase.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DistributedAutonomousDatabase.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DistributedAutonomousDatabase.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DistributedAutonomousDatabase.

catalog_details¶

Gets the catalog_details of this DistributedAutonomousDatabase. Collection of catalogs associated with the Globally distributed autonomous database.

Returns:	The catalog_details of this DistributedAutonomousDatabase.
Return type:	list[oci.distributed_database.models.DistributedAutonomousDatabaseCatalog]

character_set¶

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

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

chunks¶

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

compartment_id¶

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

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

connection_strings¶

Gets the connection_strings of this DistributedAutonomousDatabase.

Returns:	The connection_strings of this DistributedAutonomousDatabase.
Return type:	oci.distributed_database.models.DistributedAutonomousDatabaseConnectionString

database_version¶

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

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

db_deployment_type¶

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

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

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

db_workload¶

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

gsm_details¶

Gets the gsm_details of this DistributedAutonomousDatabase. Collection of catalogs associated with the Globally distributed autonomous database.

Returns:	The gsm_details of this DistributedAutonomousDatabase.
Return type:	list[oci.distributed_database.models.DistributedAutonomousDatabaseGsm]

id¶

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

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

latest_gsm_image¶

Gets the latest_gsm_image of this DistributedAutonomousDatabase.

Returns:	The latest_gsm_image of this DistributedAutonomousDatabase.
Return type:	oci.distributed_database.models.DistributedAutonomousDatabaseGsmImage

lifecycle_details¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DistributedAutonomousDatabase. Lifecycle states for the Globally distributed autonomous database.

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

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

listener_port¶

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

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

listener_port_tls¶

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

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

metadata¶

Gets the metadata of this DistributedAutonomousDatabase.

Returns:	The metadata of this DistributedAutonomousDatabase.
Return type:	oci.distributed_database.models.DistributedAutonomousDbMetadata

ncharacter_set¶

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

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

ons_port_local¶

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

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

ons_port_remote¶

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

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

prefix¶

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

private_endpoint_ids¶

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

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

replication_factor¶

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

replication_method¶

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

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

replication_unit¶

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

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

shard_details¶

Gets the shard_details of this DistributedAutonomousDatabase. Collection of shards associated with the Globally distributed autonomous database.

Returns:	The shard_details of this DistributedAutonomousDatabase.
Return type:	list[oci.distributed_database.models.DistributedAutonomousDatabaseShard]

sharding_method¶

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

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 DistributedAutonomousDatabase.
Return type:	str

system_tags¶

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

time_created¶

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

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

time_updated¶

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

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