DistributedDatabase

class oci.distributed_database.models.DistributedDatabase(**kwargs)

Bases: object

Globally distributed database.

Attributes:

DB_DEPLOYMENT_TYPE_EXADB

A constant which can be used with the db_deployment_type property of a DistributedDatabase.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DistributedDatabase.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a DistributedDatabase.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a DistributedDatabase.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a DistributedDatabase.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a DistributedDatabase.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a DistributedDatabase.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a DistributedDatabase.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a DistributedDatabase.

REPLICATION_METHOD_DG

A constant which can be used with the replication_method property of a DistributedDatabase.

REPLICATION_METHOD_RAFT

A constant which can be used with the replication_method property of a DistributedDatabase.

SHARDING_METHOD_COMPOSITE

A constant which can be used with the sharding_method property of a DistributedDatabase.

SHARDING_METHOD_SYSTEM

A constant which can be used with the sharding_method property of a DistributedDatabase.

SHARDING_METHOD_USER

A constant which can be used with the sharding_method property of a DistributedDatabase.

auto_resource_management_config

Gets the auto_resource_management_config of this DistributedDatabase.

catalog_details

Gets the catalog_details of this DistributedDatabase.

character_set

[Required] Gets the character_set of this DistributedDatabase.

compartment_id

[Required] Gets the compartment_id of this DistributedDatabase.

composite_data_guard_shard_spaces

Gets the composite_data_guard_shard_spaces of this DistributedDatabase.

composite_raft_shard_spaces

Gets the composite_raft_shard_spaces of this DistributedDatabase.

connection_strings

Gets the connection_strings of this DistributedDatabase.

database_version

[Required] Gets the database_version of this DistributedDatabase.

db_backup_config

Gets the db_backup_config of this DistributedDatabase.

db_deployment_type

[Required] Gets the db_deployment_type of this DistributedDatabase.

defined_tags

Gets the defined_tags of this DistributedDatabase.

display_name

[Required] Gets the display_name of this DistributedDatabase.

freeform_tags

Gets the freeform_tags of this DistributedDatabase.

gds_control_node_details

Gets the gds_control_node_details of this DistributedDatabase.

gsm_details

Gets the gsm_details of this DistributedDatabase.

gsm_ssh_public_key

Gets the gsm_ssh_public_key of this DistributedDatabase.

id

[Required] Gets the id of this DistributedDatabase.

latest_gsm_image_details

Gets the latest_gsm_image_details of this DistributedDatabase.

lifecycle_details

[Required] Gets the lifecycle_details of this DistributedDatabase.

lifecycle_state

[Required] Gets the lifecycle_state of this DistributedDatabase.

listener_port

[Required] Gets the listener_port of this DistributedDatabase.

listener_port_tls

Gets the listener_port_tls of this DistributedDatabase.

metadata

Gets the metadata of this DistributedDatabase.

ncharacter_set

[Required] Gets the ncharacter_set of this DistributedDatabase.

notification_topic_ids

Gets the notification_topic_ids of this DistributedDatabase.

ons_port_local

[Required] Gets the ons_port_local of this DistributedDatabase.

ons_port_remote

[Required] Gets the ons_port_remote of this DistributedDatabase.

prefix

[Required] Gets the prefix of this DistributedDatabase.

private_endpoint_ids

[Required] Gets the private_endpoint_ids of this DistributedDatabase.

replication_method

Gets the replication_method of this DistributedDatabase.

scan_listener_port

Gets the scan_listener_port of this DistributedDatabase.

sharding_method

[Required] Gets the sharding_method of this DistributedDatabase.

system_chunk_count

Gets the system_chunk_count of this DistributedDatabase.

system_data_guard_databases

Gets the system_data_guard_databases of this DistributedDatabase.

system_raft_clusters

Gets the system_raft_clusters of this DistributedDatabase.

system_raft_replication_unit_count

Gets the system_raft_replication_unit_count of this DistributedDatabase.

system_tags

Gets the system_tags of this DistributedDatabase.

time_created

[Required] Gets the time_created of this DistributedDatabase.

time_updated

[Required] Gets the time_updated of this DistributedDatabase.

user_shard_spaces

Gets the user_shard_spaces of this DistributedDatabase.

vcn_nsg_ids

Gets the vcn_nsg_ids of this DistributedDatabase.

Methods:

__init__(**kwargs)

Initializes a new DistributedDatabase object with values from keyword arguments.

DB_DEPLOYMENT_TYPE_EXADB = 'EXADB'

A constant which can be used with the db_deployment_type property of a DistributedDatabase. This constant has a value of “EXADB”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DistributedDatabase. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a DistributedDatabase. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DistributedDatabase. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a DistributedDatabase. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a DistributedDatabase. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a DistributedDatabase. 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 DistributedDatabase. 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 DistributedDatabase. This constant has a value of “UPDATING”

REPLICATION_METHOD_DG = 'DG'

A constant which can be used with the replication_method property of a DistributedDatabase. This constant has a value of “DG”

REPLICATION_METHOD_RAFT = 'RAFT'

A constant which can be used with the replication_method property of a DistributedDatabase. This constant has a value of “RAFT”

SHARDING_METHOD_COMPOSITE = 'COMPOSITE'

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

SHARDING_METHOD_SYSTEM = 'SYSTEM'

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

SHARDING_METHOD_USER = 'USER'

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

__init__(**kwargs)

Initializes a new DistributedDatabase 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 DistributedDatabase.

  • compartment_id (str) – The value to assign to the compartment_id property of this DistributedDatabase.

  • display_name (str) – The value to assign to the display_name property of this DistributedDatabase.

  • time_created (datetime) – The value to assign to the time_created property of this DistributedDatabase.

  • time_updated (datetime) – The value to assign to the time_updated property of this DistributedDatabase.

  • database_version (str) – The value to assign to the database_version property of this DistributedDatabase.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DistributedDatabase. 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’.

  • sharding_method (str) – The value to assign to the sharding_method property of this DistributedDatabase. Allowed values for this property are: “USER”, “SYSTEM”, “COMPOSITE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • replication_method (str) – The value to assign to the replication_method property of this DistributedDatabase. 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’.

  • db_deployment_type (str) – The value to assign to the db_deployment_type property of this DistributedDatabase. Allowed values for this property are: “EXADB”, ‘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 DistributedDatabase.

  • connection_strings (oci.distributed_database.models.DistributedDbConnectionString) – The value to assign to the connection_strings property of this DistributedDatabase.

  • prefix (str) – The value to assign to the prefix property of this DistributedDatabase.

  • private_endpoint_ids (list[str]) – The value to assign to the private_endpoint_ids property of this DistributedDatabase.

  • notification_topic_ids (list[str]) – The value to assign to the notification_topic_ids property of this DistributedDatabase.

  • latest_gsm_image_details (oci.distributed_database.models.DistributedDbGsmImage) – The value to assign to the latest_gsm_image_details property of this DistributedDatabase.

  • character_set (str) – The value to assign to the character_set property of this DistributedDatabase.

  • ncharacter_set (str) – The value to assign to the ncharacter_set property of this DistributedDatabase.

  • listener_port (int) – The value to assign to the listener_port property of this DistributedDatabase.

  • listener_port_tls (int) – The value to assign to the listener_port_tls property of this DistributedDatabase.

  • ons_port_local (int) – The value to assign to the ons_port_local property of this DistributedDatabase.

  • ons_port_remote (int) – The value to assign to the ons_port_remote property of this DistributedDatabase.

  • scan_listener_port (int) – The value to assign to the scan_listener_port property of this DistributedDatabase.

  • system_chunk_count (int) – The value to assign to the system_chunk_count property of this DistributedDatabase.

  • system_raft_replication_unit_count (int) – The value to assign to the system_raft_replication_unit_count property of this DistributedDatabase.

  • composite_raft_shard_spaces (list[oci.distributed_database.models.CompositeRaftShardSpace]) – The value to assign to the composite_raft_shard_spaces property of this DistributedDatabase.

  • composite_data_guard_shard_spaces (list[oci.distributed_database.models.CompositeDataGuardShardSpace]) – The value to assign to the composite_data_guard_shard_spaces property of this DistributedDatabase.

  • system_raft_clusters (list[oci.distributed_database.models.SystemRaftCluster]) – The value to assign to the system_raft_clusters property of this DistributedDatabase.

  • system_data_guard_databases (oci.distributed_database.models.SystemDataGuardDatabase) – The value to assign to the system_data_guard_databases property of this DistributedDatabase.

  • user_shard_spaces (list[oci.distributed_database.models.UserShardSpace]) – The value to assign to the user_shard_spaces property of this DistributedDatabase.

  • catalog_details (list[oci.distributed_database.models.DistributedDatabaseCatalog]) – The value to assign to the catalog_details property of this DistributedDatabase.

  • gsm_details (list[oci.distributed_database.models.DistributedDatabaseGsm]) – The value to assign to the gsm_details property of this DistributedDatabase.

  • gds_control_node_details (list[oci.distributed_database.models.DistributedDatabaseGdsControlNode]) – The value to assign to the gds_control_node_details property of this DistributedDatabase.

  • db_backup_config (oci.distributed_database.models.DistributedDbBackupConfig) – The value to assign to the db_backup_config property of this DistributedDatabase.

  • auto_resource_management_config (oci.distributed_database.models.AutoResourceManagementConfigurationDetails) – The value to assign to the auto_resource_management_config property of this DistributedDatabase.

  • gsm_ssh_public_key (str) – The value to assign to the gsm_ssh_public_key property of this DistributedDatabase.

  • vcn_nsg_ids (list[oci.distributed_database.models.VcnNsgIdsDetails]) – The value to assign to the vcn_nsg_ids property of this DistributedDatabase.

  • metadata (oci.distributed_database.models.DistributedDbMetadata) – The value to assign to the metadata property of this DistributedDatabase.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DistributedDatabase.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DistributedDatabase.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DistributedDatabase.

property auto_resource_management_config

Gets the auto_resource_management_config of this DistributedDatabase.

Returns

The auto_resource_management_config of this DistributedDatabase.

Return type

oci.distributed_database.models.AutoResourceManagementConfigurationDetails

property catalog_details

Gets the catalog_details of this DistributedDatabase. Catalog details associated with the distributed database.

Returns

The catalog_details of this DistributedDatabase.

Return type

list[oci.distributed_database.models.DistributedDatabaseCatalog]

property character_set

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

Returns

The character_set of this DistributedDatabase.

Return type

str

property compartment_id

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

Returns

The compartment_id of this DistributedDatabase.

Return type

str

property composite_data_guard_shard_spaces

Gets the composite_data_guard_shard_spaces of this DistributedDatabase. Collection of composite data guard shard spaces.

Returns

The composite_data_guard_shard_spaces of this DistributedDatabase.

Return type

list[oci.distributed_database.models.CompositeDataGuardShardSpace]

property composite_raft_shard_spaces

Gets the composite_raft_shard_spaces of this DistributedDatabase. Collection of composite raft shards.

Returns

The composite_raft_shard_spaces of this DistributedDatabase.

Return type

list[oci.distributed_database.models.CompositeRaftShardSpace]

property connection_strings

Gets the connection_strings of this DistributedDatabase.

Returns

The connection_strings of this DistributedDatabase.

Return type

oci.distributed_database.models.DistributedDbConnectionString

property database_version

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

Returns

The database_version of this DistributedDatabase.

Return type

str

property db_backup_config

Gets the db_backup_config of this DistributedDatabase.

Returns

The db_backup_config of this DistributedDatabase.

Return type

oci.distributed_database.models.DistributedDbBackupConfig

property db_deployment_type

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

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

Returns

The db_deployment_type of this DistributedDatabase.

Return type

str

property defined_tags

Gets the defined_tags of this DistributedDatabase. 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 DistributedDatabase.

Return type

dict(str, dict(str, object))

property display_name

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

Returns

The display_name of this DistributedDatabase.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property gds_control_node_details

Gets the gds_control_node_details of this DistributedDatabase. Global Database Services Control(GDS CTL) instances associated with the distributed database.

Returns

The gds_control_node_details of this DistributedDatabase.

Return type

list[oci.distributed_database.models.DistributedDatabaseGdsControlNode]

property gsm_details

Gets the gsm_details of this DistributedDatabase. Global Service Manager (GSM) instances associated with the distributed database.

Returns

The gsm_details of this DistributedDatabase.

Return type

list[oci.distributed_database.models.DistributedDatabaseGsm]

property gsm_ssh_public_key

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

Returns

The gsm_ssh_public_key of this DistributedDatabase.

Return type

str

property id

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

Returns

The id of this DistributedDatabase.

Return type

str

property latest_gsm_image_details

Gets the latest_gsm_image_details of this DistributedDatabase.

Returns

The latest_gsm_image_details of this DistributedDatabase.

Return type

oci.distributed_database.models.DistributedDbGsmImage

property lifecycle_details

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

Returns

The lifecycle_details of this DistributedDatabase.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DistributedDatabase. Lifecycle states for the Globally distributed 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 DistributedDatabase.

Return type

str

property listener_port

[Required] Gets the listener_port of this DistributedDatabase. The Global service manager listener port number for the Globally distributed database.

Returns

The listener_port of this DistributedDatabase.

Return type

int

property listener_port_tls

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

Returns

The listener_port_tls of this DistributedDatabase.

Return type

int

property metadata

Gets the metadata of this DistributedDatabase.

Returns

The metadata of this DistributedDatabase.

Return type

oci.distributed_database.models.DistributedDbMetadata

property ncharacter_set

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

Returns

The ncharacter_set of this DistributedDatabase.

Return type

str

property notification_topic_ids

Gets the notification_topic_ids of this DistributedDatabase. The collection of OCID for the notification topics associated with the globally distributed database.

Returns

The notification_topic_ids of this DistributedDatabase.

Return type

list[str]

property ons_port_local

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

Returns

The ons_port_local of this DistributedDatabase.

Return type

int

property ons_port_remote

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

Returns

The ons_port_remote of this DistributedDatabase.

Return type

int

property prefix

[Required] Gets the prefix of this DistributedDatabase. 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 DistributedDatabase.

Return type

str

property private_endpoint_ids

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

Returns

The private_endpoint_ids of this DistributedDatabase.

Return type

list[str]

property replication_method

Gets the replication_method of this DistributedDatabase. The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.

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 DistributedDatabase.

Return type

str

property scan_listener_port

Gets the scan_listener_port of this DistributedDatabase. The TCP SCAN listener port for database clusters with source type XS_NEW_VAULT_AND_CLUSTER or XS_NEW_CLUSTER.

Returns

The scan_listener_port of this DistributedDatabase.

Return type

int

property sharding_method

[Required] Gets the sharding_method of this DistributedDatabase. Sharding methods for the Globally distributed database.

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

Returns

The sharding_method of this DistributedDatabase.

Return type

str

property system_chunk_count

Gets the system_chunk_count of this DistributedDatabase. Count of chunks associated with system raft clusters or system data guard databases.

Returns

The system_chunk_count of this DistributedDatabase.

Return type

int

property system_data_guard_databases

Gets the system_data_guard_databases of this DistributedDatabase.

Returns

The system_data_guard_databases of this DistributedDatabase.

Return type

oci.distributed_database.models.SystemDataGuardDatabase

property system_raft_clusters

Gets the system_raft_clusters of this DistributedDatabase. Collection of system raft clusters.

Returns

The system_raft_clusters of this DistributedDatabase.

Return type

list[oci.distributed_database.models.SystemRaftCluster]

property system_raft_replication_unit_count

Gets the system_raft_replication_unit_count of this DistributedDatabase. Number of replication units associated with system raft clusters.

Returns

The system_raft_replication_unit_count of this DistributedDatabase.

Return type

int

property system_tags

Gets the system_tags of this DistributedDatabase. 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 DistributedDatabase.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this DistributedDatabase.

Return type

datetime

property time_updated

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

Returns

The time_updated of this DistributedDatabase.

Return type

datetime

property user_shard_spaces

Gets the user_shard_spaces of this DistributedDatabase. Collection of user defined shard spaces.

Returns

The user_shard_spaces of this DistributedDatabase.

Return type

list[oci.distributed_database.models.UserShardSpace]

property vcn_nsg_ids

Gets the vcn_nsg_ids of this DistributedDatabase. The list of network security group (NSG) details associated with the distributed database.

Returns

The vcn_nsg_ids of this DistributedDatabase.

Return type

list[oci.distributed_database.models.VcnNsgIdsDetails]