psql
========

Description
-----------
Use the OCI Database with PostgreSQL CLI to manage resources such as database systems, database nodes, backups, and configurations.
For information, see the user guide documentation for the `service <https://docs.cloud.oracle.com/iaas/Content/postgresql/home.htm>`__.

Available Commands
------------------
* :doc:`backup </cmdref/psql/backup>`

  * :doc:`backup-copy </cmdref/psql/backup/backup-copy>`
  * :doc:`change-compartment </cmdref/psql/backup/change-compartment>`
  * :doc:`create </cmdref/psql/backup/create>`
  * :doc:`delete </cmdref/psql/backup/delete>`
  * :doc:`get </cmdref/psql/backup/get>`
  * :doc:`update </cmdref/psql/backup/update>`

* :doc:`backup-collection </cmdref/psql/backup-collection>`

  * :doc:`list-backups </cmdref/psql/backup-collection/list-backups>`

* :doc:`configuration </cmdref/psql/configuration>`

  * :doc:`change-compartment </cmdref/psql/configuration/change-compartment>`
  * :doc:`create </cmdref/psql/configuration/create>`
  * :doc:`delete </cmdref/psql/configuration/delete>`
  * :doc:`get </cmdref/psql/configuration/get>`
  * :doc:`update </cmdref/psql/configuration/update>`

* :doc:`configuration-collection </cmdref/psql/configuration-collection>`

  * :doc:`list-configurations </cmdref/psql/configuration-collection/list-configurations>`

* :doc:`connection-details </cmdref/psql/connection-details>`

  * :doc:`get </cmdref/psql/connection-details/get>`

* :doc:`db-system </cmdref/psql/db-system>`

  * :doc:`change-compartment </cmdref/psql/db-system/change-compartment>`
  * :doc:`change-role-to-replica </cmdref/psql/db-system/change-role-to-replica>`
  * :doc:`change-role-to-standalone </cmdref/psql/db-system/change-role-to-standalone>`
  * :doc:`create </cmdref/psql/db-system/create>`
  * :doc:`create-db-system-backup-source-details </cmdref/psql/db-system/create-db-system-backup-source-details>`
  * :doc:`create-db-system-disabled-insight-details </cmdref/psql/db-system/create-db-system-disabled-insight-details>`
  * :doc:`create-db-system-enabled-insight-details </cmdref/psql/db-system/create-db-system-enabled-insight-details>`
  * :doc:`create-db-system-none-source-details </cmdref/psql/db-system/create-db-system-none-source-details>`
  * :doc:`create-db-system-oci-optimized-storage-details </cmdref/psql/db-system/create-db-system-oci-optimized-storage-details>`
  * :doc:`create-db-system-point-in-time-db-system-source-details </cmdref/psql/db-system/create-db-system-point-in-time-db-system-source-details>`
  * :doc:`create-db-system-primary-db-system-source-details </cmdref/psql/db-system/create-db-system-primary-db-system-source-details>`
  * :doc:`delete </cmdref/psql/db-system/delete>`
  * :doc:`failover </cmdref/psql/db-system/failover>`
  * :doc:`get </cmdref/psql/db-system/get>`
  * :doc:`get-primary-db-instance </cmdref/psql/db-system/get-primary-db-instance>`
  * :doc:`patch </cmdref/psql/db-system/patch>`
  * :doc:`reset-master-user-password </cmdref/psql/db-system/reset-master-user-password>`
  * :doc:`reset-master-user-password-plain-text-password-details </cmdref/psql/db-system/reset-master-user-password-plain-text-password-details>`
  * :doc:`reset-master-user-password-vault-secret-password-details </cmdref/psql/db-system/reset-master-user-password-vault-secret-password-details>`
  * :doc:`restart-db-instance-in </cmdref/psql/db-system/restart-db-instance-in>`
  * :doc:`restore </cmdref/psql/db-system/restore>`
  * :doc:`start </cmdref/psql/db-system/start>`
  * :doc:`stop </cmdref/psql/db-system/stop>`
  * :doc:`switch-over </cmdref/psql/db-system/switch-over>`
  * :doc:`update </cmdref/psql/db-system/update>`
  * :doc:`update-db-system-db-instance </cmdref/psql/db-system/update-db-system-db-instance>`
  * :doc:`update-db-system-disabled-insight-details </cmdref/psql/db-system/update-db-system-disabled-insight-details>`
  * :doc:`update-db-system-disabled-kerberos-auth-details </cmdref/psql/db-system/update-db-system-disabled-kerberos-auth-details>`
  * :doc:`update-db-system-enabled-insight-details </cmdref/psql/db-system/update-db-system-enabled-insight-details>`
  * :doc:`update-db-system-enabled-kerberos-auth-details </cmdref/psql/db-system/update-db-system-enabled-kerberos-auth-details>`

* :doc:`db-system-collection </cmdref/psql/db-system-collection>`

  * :doc:`list-db-systems </cmdref/psql/db-system-collection/list-db-systems>`

* :doc:`db-system-replica-collection </cmdref/psql/db-system-replica-collection>`

  * :doc:`list-db-system-replicas </cmdref/psql/db-system-replica-collection/list-db-system-replicas>`

* :doc:`default-configuration </cmdref/psql/default-configuration>`

  * :doc:`get </cmdref/psql/default-configuration/get>`

* :doc:`default-configuration-collection </cmdref/psql/default-configuration-collection>`

  * :doc:`list-default-configurations </cmdref/psql/default-configuration-collection/list-default-configurations>`

* :doc:`insight-capability-summary </cmdref/psql/insight-capability-summary>`

  * :doc:`list-insight-capabilities </cmdref/psql/insight-capability-summary/list-insight-capabilities>`

* :doc:`pitr-details </cmdref/psql/pitr-details>`

  * :doc:`get </cmdref/psql/pitr-details/get>`

* :doc:`shape-summary </cmdref/psql/shape-summary>`

  * :doc:`list-shapes </cmdref/psql/shape-summary/list-shapes>`

* :doc:`work-request </cmdref/psql/work-request>`

  * :doc:`get </cmdref/psql/work-request/get>`
  * :doc:`list </cmdref/psql/work-request/list>`

* :doc:`work-request-error </cmdref/psql/work-request-error>`

  * :doc:`list </cmdref/psql/work-request-error/list>`

* :doc:`work-request-log-entry </cmdref/psql/work-request-log-entry>`

  * :doc:`list-work-request-logs </cmdref/psql/work-request-log-entry/list-work-request-logs>`


.. toctree::
    :hidden:

    /cmdref/psql/backup
    /cmdref/psql/backup-collection
    /cmdref/psql/configuration
    /cmdref/psql/configuration-collection
    /cmdref/psql/connection-details
    /cmdref/psql/db-system
    /cmdref/psql/db-system-collection
    /cmdref/psql/db-system-replica-collection
    /cmdref/psql/default-configuration
    /cmdref/psql/default-configuration-collection
    /cmdref/psql/insight-capability-summary
    /cmdref/psql/pitr-details
    /cmdref/psql/shape-summary
    /cmdref/psql/work-request
    /cmdref/psql/work-request-error
    /cmdref/psql/work-request-log-entry