PostgresqlClientCompositeOperations

class oci.psql.PostgresqlClientCompositeOperations(client, **kwargs)

This class provides a wrapper around PostgresqlClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Methods:

__init__(client, **kwargs)

Creates a new PostgresqlClientCompositeOperations object

backup_copy_and_wait_for_state(backup_id, ...)

Calls backup_copy() and waits for the WorkRequest to enter the given state(s).

change_backup_compartment_and_wait_for_state(...)

Calls change_backup_compartment() and waits for the WorkRequest to enter the given state(s).

change_db_system_compartment_and_wait_for_state(...)

Calls change_db_system_compartment() and waits for the WorkRequest to enter the given state(s).

change_role_to_replica_and_wait_for_state(...)

Calls change_role_to_replica() and waits for the WorkRequest to enter the given state(s).

change_role_to_standalone_and_wait_for_state(...)

Calls change_role_to_standalone() and waits for the WorkRequest to enter the given state(s).

create_backup_and_wait_for_state(...[, ...])

Calls create_backup() and waits for the WorkRequest to enter the given state(s).

create_configuration_and_wait_for_state(...)

Calls create_configuration() and waits for the Configuration acted upon to enter the given state(s).

create_db_system_and_wait_for_state(...[, ...])

Calls create_db_system() and waits for the WorkRequest to enter the given state(s).

delete_backup_and_wait_for_state(backup_id)

Calls delete_backup() and waits for the WorkRequest to enter the given state(s).

delete_configuration_and_wait_for_state(...)

Calls delete_configuration() and waits for the Configuration acted upon to enter the given state(s).

delete_db_system_and_wait_for_state(db_system_id)

Calls delete_db_system() and waits for the WorkRequest to enter the given state(s).

failover_db_system_and_wait_for_state(...[, ...])

Calls failover_db_system() and waits for the WorkRequest to enter the given state(s).

patch_db_system_and_wait_for_state(...[, ...])

Calls patch_db_system() and waits for the WorkRequest to enter the given state(s).

reset_master_user_password_and_wait_for_state(...)

Calls reset_master_user_password() and waits for the WorkRequest to enter the given state(s).

restart_db_instance_in_db_system_and_wait_for_state(...)

Calls restart_db_instance_in_db_system() and waits for the WorkRequest to enter the given state(s).

restore_db_system_and_wait_for_state(...[, ...])

Calls restore_db_system() and waits for the WorkRequest to enter the given state(s).

start_db_system_and_wait_for_state(...[, ...])

Calls start_db_system() and waits for the WorkRequest to enter the given state(s).

stop_db_system_and_wait_for_state(db_system_id)

Calls stop_db_system() and waits for the WorkRequest to enter the given state(s).

switch_over_and_wait_for_state(...[, ...])

Calls switch_over() and waits for the WorkRequest to enter the given state(s).

update_backup_and_wait_for_state(backup_id, ...)

Calls update_backup() and waits for the Backup acted upon to enter the given state(s).

update_configuration_and_wait_for_state(...)

Calls update_configuration() and waits for the Configuration acted upon to enter the given state(s).

update_db_system_and_wait_for_state(...[, ...])

Calls update_db_system() and waits for the WorkRequest to enter the given state(s).

update_db_system_db_instance_and_wait_for_state(...)

Calls update_db_system_db_instance() and waits for the WorkRequest to enter the given state(s).

upgrade_db_system_and_wait_for_state(...[, ...])

Calls upgrade_db_system() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new PostgresqlClientCompositeOperations object

Parameters

client (PostgresqlClient) – The service client which will be wrapped by this object

backup_copy_and_wait_for_state(backup_id, backup_copy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls backup_copy() and waits for the WorkRequest to enter the given state(s).

Parameters
  • backup_id (str) – (required) A unique identifier for the backup.

  • backup_copy_details (oci.psql.models.BackupCopyDetails) – (required) The information to be updated.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to backup_copy()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_backup_compartment_and_wait_for_state(backup_id, change_backup_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_backup_compartment() and waits for the WorkRequest to enter the given state(s).

Parameters
  • backup_id (str) – (required) A unique identifier for the backup.

  • change_backup_compartment_details (oci.psql.models.ChangeBackupCompartmentDetails) – (required) The information to be updated.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_backup_compartment()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_db_system_compartment_and_wait_for_state(db_system_id, change_db_system_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_db_system_compartment() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • change_db_system_compartment_details (oci.psql.models.ChangeDbSystemCompartmentDetails) – (required) The information to be updated.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_db_system_compartment()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_role_to_replica_and_wait_for_state(change_role_to_replica_details, db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_role_to_replica() and waits for the WorkRequest to enter the given state(s).

Parameters
  • change_role_to_replica_details (oci.psql.models.ChangeRoleToReplicaDetails) – (required) Change a standalone database system’s role to warm-standby replica parameters.

  • db_system_id (str) – (required) A unique identifier for the database system.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_role_to_replica()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_role_to_standalone_and_wait_for_state(change_role_to_standalone_details, db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_role_to_standalone() and waits for the WorkRequest to enter the given state(s).

Parameters
  • change_role_to_standalone_details (oci.psql.models.ChangeRoleToStandaloneDetails) – (required) Change a replica database system’s role to standalone parameters.

  • db_system_id (str) – (required) A unique identifier for the database system.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_role_to_standalone()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_backup_and_wait_for_state(create_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_backup() and waits for the WorkRequest to enter the given state(s).

Parameters
  • create_backup_details (oci.psql.models.CreateBackupDetails) – (required) Details for the new backup.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_configuration_and_wait_for_state(create_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_configuration() and waits for the Configuration acted upon to enter the given state(s).

Parameters
  • create_configuration_details (oci.psql.models.CreateConfigurationDetails) – (required) Details for the new configuration.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_configuration()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_db_system_and_wait_for_state(create_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • create_db_system_details (oci.psql.models.CreateDbSystemDetails) – (required) Details for the new database system.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_backup_and_wait_for_state(backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_backup() and waits for the WorkRequest to enter the given state(s).

Parameters
  • backup_id (str) – (required) A unique identifier for the backup.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_configuration_and_wait_for_state(configuration_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_configuration() and waits for the Configuration acted upon to enter the given state(s).

Parameters
  • configuration_id (str) – (required) A unique identifier for the configuration.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_configuration()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_db_system_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

failover_db_system_and_wait_for_state(db_system_id, failover_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls failover_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • failover_db_system_details (oci.psql.models.FailoverDbSystemDetails) – (required) The information to be updated.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to failover_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

patch_db_system_and_wait_for_state(db_system_id, patch_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls patch_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • patch_db_system_details (oci.psql.models.PatchDbSystemDetails) – (required) The information to be modified.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to patch_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

reset_master_user_password_and_wait_for_state(db_system_id, reset_master_user_password_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls reset_master_user_password() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • reset_master_user_password_details (oci.psql.models.ResetMasterUserPasswordDetails) – (required) The information to be updated.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to reset_master_user_password()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

restart_db_instance_in_db_system_and_wait_for_state(db_system_id, restart_db_instance_in_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls restart_db_instance_in_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • restart_db_instance_in_db_system_details (oci.psql.models.RestartDbInstanceInDbSystemDetails) – (required) Database instance node restart parameters.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to restart_db_instance_in_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

restore_db_system_and_wait_for_state(db_system_id, restore_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls restore_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • restore_db_system_details (oci.psql.models.RestoreDbSystemDetails) – (required) Database system restore parameters.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to restore_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

start_db_system_and_wait_for_state(db_system_id, start_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls start_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • start_db_system_details (oci.psql.models.StartDbSystemDetails) – (required) The information to be updated the DB System while starting DB System after stop.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to start_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

stop_db_system_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls stop_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to stop_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

switch_over_and_wait_for_state(switch_over_details, db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls switch_over() and waits for the WorkRequest to enter the given state(s).

Parameters
  • switch_over_details (oci.psql.models.SwitchOverDetails) – (required) Switchover the primary and replica role parameters.

  • db_system_id (str) – (required) A unique identifier for the database system.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to switch_over()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_backup_and_wait_for_state(backup_id, update_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_backup() and waits for the Backup acted upon to enter the given state(s).

Parameters
  • backup_id (str) – (required) A unique identifier for the backup.

  • update_backup_details (oci.psql.models.UpdateBackupDetails) – (required) The information to be updated.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_configuration_and_wait_for_state(configuration_id, update_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_configuration() and waits for the Configuration acted upon to enter the given state(s).

Parameters
  • configuration_id (str) – (required) A unique identifier for the configuration.

  • update_configuration_details (oci.psql.models.UpdateConfigurationDetails) – (required) Details for updating display name or description for a configuration.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_configuration()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_db_system_and_wait_for_state(db_system_id, update_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • update_db_system_details (oci.psql.models.UpdateDbSystemDetails) – (required) The information to be updated.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_db_system_db_instance_and_wait_for_state(db_system_id, db_instance_id, update_db_system_db_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_db_system_db_instance() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • db_instance_id (str) – (required) A unique identifier for the database instance node.

  • update_db_system_db_instance_details (oci.psql.models.UpdateDbSystemDbInstanceDetails) – (required) Database instance node update parameters.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_db_system_db_instance()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

upgrade_db_system_and_wait_for_state(db_system_id, upgrade_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls upgrade_db_system() and waits for the WorkRequest to enter the given state(s).

Parameters
  • db_system_id (str) – (required) A unique identifier for the database system.

  • upgrade_db_system_details (oci.psql.models.UpgradeDbSystemDetails) – (required) Database system upgrade parameters.

  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to upgrade_db_system()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait