db
======

Description
-----------
The CLI for the Database Service. Use this CLI to manage resources such as databases and DB Systems. For more information, see `Overview of the Database Service <https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databaseoverview.htm>`__.

Available Commands
------------------
* :doc:`autonomous-container-database </cmdref/db/autonomous-container-database>`

  * :doc:`change-compartment </cmdref/db/autonomous-container-database/change-compartment>`
  * :doc:`create </cmdref/db/autonomous-container-database/create>`
  * :doc:`get </cmdref/db/autonomous-container-database/get>`
  * :doc:`list </cmdref/db/autonomous-container-database/list>`
  * :doc:`restart </cmdref/db/autonomous-container-database/restart>`
  * :doc:`terminate </cmdref/db/autonomous-container-database/terminate>`
  * :doc:`update </cmdref/db/autonomous-container-database/update>`

* :doc:`autonomous-data-warehouse </cmdref/db/autonomous-data-warehouse>`

  * :doc:`create </cmdref/db/autonomous-data-warehouse/create>`
  * :doc:`delete </cmdref/db/autonomous-data-warehouse/delete>`
  * :doc:`generate-wallet </cmdref/db/autonomous-data-warehouse/generate-wallet>`
  * :doc:`get </cmdref/db/autonomous-data-warehouse/get>`
  * :doc:`list </cmdref/db/autonomous-data-warehouse/list>`
  * :doc:`restore </cmdref/db/autonomous-data-warehouse/restore>`
  * :doc:`start </cmdref/db/autonomous-data-warehouse/start>`
  * :doc:`stop </cmdref/db/autonomous-data-warehouse/stop>`
  * :doc:`update </cmdref/db/autonomous-data-warehouse/update>`

* :doc:`autonomous-data-warehouse-backup </cmdref/db/autonomous-data-warehouse-backup>`

  * :doc:`create </cmdref/db/autonomous-data-warehouse-backup/create>`
  * :doc:`get </cmdref/db/autonomous-data-warehouse-backup/get>`
  * :doc:`list </cmdref/db/autonomous-data-warehouse-backup/list>`

* :doc:`autonomous-database </cmdref/db/autonomous-database>`

  * :doc:`change-compartment </cmdref/db/autonomous-database/change-compartment>`
  * :doc:`create </cmdref/db/autonomous-database/create>`
  * :doc:`create-from-backup-id </cmdref/db/autonomous-database/create-from-backup-id>`
  * :doc:`create-from-backup-timestamp </cmdref/db/autonomous-database/create-from-backup-timestamp>`
  * :doc:`create-from-clone </cmdref/db/autonomous-database/create-from-clone>`
  * :doc:`data-safe </cmdref/db/autonomous-database/data-safe>`

    * :doc:`deregister </cmdref/db/autonomous-database/data-safe/deregister>`
    * :doc:`register </cmdref/db/autonomous-database/data-safe/register>`

  * :doc:`delete </cmdref/db/autonomous-database/delete>`
  * :doc:`generate-wallet </cmdref/db/autonomous-database/generate-wallet>`
  * :doc:`get </cmdref/db/autonomous-database/get>`
  * :doc:`list </cmdref/db/autonomous-database/list>`
  * :doc:`restart </cmdref/db/autonomous-database/restart>`
  * :doc:`restore </cmdref/db/autonomous-database/restore>`
  * :doc:`start </cmdref/db/autonomous-database/start>`
  * :doc:`stop </cmdref/db/autonomous-database/stop>`
  * :doc:`update </cmdref/db/autonomous-database/update>`

* :doc:`autonomous-database-backup </cmdref/db/autonomous-database-backup>`

  * :doc:`create </cmdref/db/autonomous-database-backup/create>`
  * :doc:`get </cmdref/db/autonomous-database-backup/get>`
  * :doc:`list </cmdref/db/autonomous-database-backup/list>`

* :doc:`autonomous-database-wallet </cmdref/db/autonomous-database-wallet>`

  * :doc:`get-metadata </cmdref/db/autonomous-database-wallet/get-metadata>`
  * :doc:`get-regional-wallet-metadata </cmdref/db/autonomous-database-wallet/get-regional-wallet-metadata>`
  * :doc:`rotate </cmdref/db/autonomous-database-wallet/rotate>`
  * :doc:`rotate-regional-wallet </cmdref/db/autonomous-database-wallet/rotate-regional-wallet>`

* :doc:`autonomous-db-preview-version </cmdref/db/autonomous-db-preview-version>`

  * :doc:`list </cmdref/db/autonomous-db-preview-version/list>`

* :doc:`autonomous-db-version </cmdref/db/autonomous-db-version>`

  * :doc:`list </cmdref/db/autonomous-db-version/list>`

* :doc:`autonomous-exadata-infrastructure </cmdref/db/autonomous-exadata-infrastructure>`

  * :doc:`change-compartment </cmdref/db/autonomous-exadata-infrastructure/change-compartment>`
  * :doc:`get </cmdref/db/autonomous-exadata-infrastructure/get>`
  * :doc:`launch </cmdref/db/autonomous-exadata-infrastructure/launch>`
  * :doc:`list </cmdref/db/autonomous-exadata-infrastructure/list>`
  * :doc:`terminate </cmdref/db/autonomous-exadata-infrastructure/terminate>`
  * :doc:`update </cmdref/db/autonomous-exadata-infrastructure/update>`

* :doc:`autonomous-exadata-infrastructure-shape </cmdref/db/autonomous-exadata-infrastructure-shape>`

  * :doc:`list </cmdref/db/autonomous-exadata-infrastructure-shape/list>`

* :doc:`autonomous-vm-cluster </cmdref/db/autonomous-vm-cluster>`

  * :doc:`change-compartment </cmdref/db/autonomous-vm-cluster/change-compartment>`
  * :doc:`create </cmdref/db/autonomous-vm-cluster/create>`
  * :doc:`delete </cmdref/db/autonomous-vm-cluster/delete>`
  * :doc:`get </cmdref/db/autonomous-vm-cluster/get>`
  * :doc:`list </cmdref/db/autonomous-vm-cluster/list>`
  * :doc:`update </cmdref/db/autonomous-vm-cluster/update>`

* :doc:`backup </cmdref/db/backup>`

  * :doc:`create </cmdref/db/backup/create>`
  * :doc:`delete </cmdref/db/backup/delete>`
  * :doc:`get </cmdref/db/backup/get>`
  * :doc:`list </cmdref/db/backup/list>`

* :doc:`backup-destination </cmdref/db/backup-destination>`

  * :doc:`change-compartment </cmdref/db/backup-destination/change-compartment>`
  * :doc:`create-nfs-details </cmdref/db/backup-destination/create-nfs-details>`
  * :doc:`create-recovery-appliance-details </cmdref/db/backup-destination/create-recovery-appliance-details>`
  * :doc:`delete </cmdref/db/backup-destination/delete>`
  * :doc:`get </cmdref/db/backup-destination/get>`
  * :doc:`update </cmdref/db/backup-destination/update>`

* :doc:`console-connection </cmdref/db/console-connection>`

  * :doc:`create </cmdref/db/console-connection/create>`
  * :doc:`delete </cmdref/db/console-connection/delete>`
  * :doc:`get </cmdref/db/console-connection/get>`
  * :doc:`list </cmdref/db/console-connection/list>`

* :doc:`data-guard-association </cmdref/db/data-guard-association>`

  * :doc:`create </cmdref/db/data-guard-association/create>`

    * :doc:`from-existing-db-system </cmdref/db/data-guard-association/create/from-existing-db-system>`
    * :doc:`with-new-db-system </cmdref/db/data-guard-association/create/with-new-db-system>`

  * :doc:`failover </cmdref/db/data-guard-association/failover>`
  * :doc:`get </cmdref/db/data-guard-association/get>`
  * :doc:`list </cmdref/db/data-guard-association/list>`
  * :doc:`reinstate </cmdref/db/data-guard-association/reinstate>`
  * :doc:`switchover </cmdref/db/data-guard-association/switchover>`

* :doc:`database </cmdref/db/database>`

  * :doc:`create </cmdref/db/database/create>`
  * :doc:`create-database-from-backup </cmdref/db/database/create-database-from-backup>`
  * :doc:`create-from-backup </cmdref/db/database/create-from-backup>`
  * :doc:`create-from-database </cmdref/db/database/create-from-database>`
  * :doc:`delete </cmdref/db/database/delete>`
  * :doc:`get </cmdref/db/database/get>`
  * :doc:`list </cmdref/db/database/list>`
  * :doc:`patch </cmdref/db/database/patch>`
  * :doc:`restore </cmdref/db/database/restore>`
  * :doc:`update </cmdref/db/database/update>`

* :doc:`db-home </cmdref/db/db-home>`

  * :doc:`create </cmdref/db/db-home/create>`
  * :doc:`delete </cmdref/db/db-home/delete>`
  * :doc:`get </cmdref/db/db-home/get>`
  * :doc:`list </cmdref/db/db-home/list>`

* :doc:`exadata-infrastructure </cmdref/db/exadata-infrastructure>`

  * :doc:`activate </cmdref/db/exadata-infrastructure/activate>`
  * :doc:`change-compartment </cmdref/db/exadata-infrastructure/change-compartment>`
  * :doc:`create </cmdref/db/exadata-infrastructure/create>`
  * :doc:`delete </cmdref/db/exadata-infrastructure/delete>`
  * :doc:`download-exadata-infrastructure-config-file </cmdref/db/exadata-infrastructure/download-exadata-infrastructure-config-file>`
  * :doc:`generate-recommended-vm-cluster-network </cmdref/db/exadata-infrastructure/generate-recommended-vm-cluster-network>`
  * :doc:`get </cmdref/db/exadata-infrastructure/get>`
  * :doc:`get-compute-units </cmdref/db/exadata-infrastructure/get-compute-units>`
  * :doc:`list </cmdref/db/exadata-infrastructure/list>`
  * :doc:`update </cmdref/db/exadata-infrastructure/update>`

* :doc:`external-backup-job </cmdref/db/external-backup-job>`

  * :doc:`complete </cmdref/db/external-backup-job/complete>`
  * :doc:`create </cmdref/db/external-backup-job/create>`
  * :doc:`get </cmdref/db/external-backup-job/get>`

* :doc:`gi-version </cmdref/db/gi-version>`

  * :doc:`list </cmdref/db/gi-version/list>`

* :doc:`maintenance-run </cmdref/db/maintenance-run>`

  * :doc:`get </cmdref/db/maintenance-run/get>`
  * :doc:`list </cmdref/db/maintenance-run/list>`
  * :doc:`update </cmdref/db/maintenance-run/update>`

* :doc:`node </cmdref/db/node>`

  * :doc:`get </cmdref/db/node/get>`
  * :doc:`list </cmdref/db/node/list>`
  * :doc:`reset </cmdref/db/node/reset>`
  * :doc:`soft-reset </cmdref/db/node/soft-reset>`
  * :doc:`start </cmdref/db/node/start>`
  * :doc:`stop </cmdref/db/node/stop>`

* :doc:`patch </cmdref/db/patch>`

  * :doc:`get </cmdref/db/patch/get>`

    * :doc:`by-database </cmdref/db/patch/get/by-database>`
    * :doc:`by-db-system </cmdref/db/patch/get/by-db-system>`

  * :doc:`get-db-home </cmdref/db/patch/get-db-home>`
  * :doc:`get-vm-cluster </cmdref/db/patch/get-vm-cluster>`
  * :doc:`list </cmdref/db/patch/list>`

    * :doc:`by-database </cmdref/db/patch/list/by-database>`
    * :doc:`by-db-system </cmdref/db/patch/list/by-db-system>`

  * :doc:`list-db-home </cmdref/db/patch/list-db-home>`
  * :doc:`list-vm-cluster </cmdref/db/patch/list-vm-cluster>`

* :doc:`patch-history </cmdref/db/patch-history>`

  * :doc:`get </cmdref/db/patch-history/get>`

    * :doc:`by-database </cmdref/db/patch-history/get/by-database>`
    * :doc:`by-db-system </cmdref/db/patch-history/get/by-db-system>`

  * :doc:`get-db-home </cmdref/db/patch-history/get-db-home>`
  * :doc:`get-vm-cluster </cmdref/db/patch-history/get-vm-cluster>`
  * :doc:`list </cmdref/db/patch-history/list>`

    * :doc:`by-database </cmdref/db/patch-history/list/by-database>`
    * :doc:`by-db-system </cmdref/db/patch-history/list/by-db-system>`

  * :doc:`list-db-home </cmdref/db/patch-history/list-db-home>`
  * :doc:`list-vm-cluster </cmdref/db/patch-history/list-vm-cluster>`

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

  * :doc:`change-compartment </cmdref/db/system/change-compartment>`
  * :doc:`get </cmdref/db/system/get>`
  * :doc:`get-exadata-iorm-config </cmdref/db/system/get-exadata-iorm-config>`
  * :doc:`launch </cmdref/db/system/launch>`
  * :doc:`launch-from-backup </cmdref/db/system/launch-from-backup>`
  * :doc:`list </cmdref/db/system/list>`
  * :doc:`patch </cmdref/db/system/patch>`
  * :doc:`terminate </cmdref/db/system/terminate>`
  * :doc:`update </cmdref/db/system/update>`
  * :doc:`update-exadata-iorm-config </cmdref/db/system/update-exadata-iorm-config>`

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

  * :doc:`list </cmdref/db/system-shape/list>`

* :doc:`version </cmdref/db/version>`

  * :doc:`list </cmdref/db/version/list>`

* :doc:`vm-cluster </cmdref/db/vm-cluster>`

  * :doc:`change-compartment </cmdref/db/vm-cluster/change-compartment>`
  * :doc:`create </cmdref/db/vm-cluster/create>`
  * :doc:`delete </cmdref/db/vm-cluster/delete>`
  * :doc:`get </cmdref/db/vm-cluster/get>`
  * :doc:`list </cmdref/db/vm-cluster/list>`
  * :doc:`update </cmdref/db/vm-cluster/update>`

* :doc:`vm-cluster-network </cmdref/db/vm-cluster-network>`

  * :doc:`create </cmdref/db/vm-cluster-network/create>`
  * :doc:`delete </cmdref/db/vm-cluster-network/delete>`
  * :doc:`download-vm-cluster-network-config-file </cmdref/db/vm-cluster-network/download-vm-cluster-network-config-file>`
  * :doc:`get </cmdref/db/vm-cluster-network/get>`
  * :doc:`list </cmdref/db/vm-cluster-network/list>`
  * :doc:`update </cmdref/db/vm-cluster-network/update>`
  * :doc:`validate </cmdref/db/vm-cluster-network/validate>`


.. toctree::
    :hidden:

    /cmdref/db/autonomous-container-database
    /cmdref/db/autonomous-data-warehouse
    /cmdref/db/autonomous-data-warehouse-backup
    /cmdref/db/autonomous-database
    /cmdref/db/autonomous-database-backup
    /cmdref/db/autonomous-database-wallet
    /cmdref/db/autonomous-db-preview-version
    /cmdref/db/autonomous-db-version
    /cmdref/db/autonomous-exadata-infrastructure
    /cmdref/db/autonomous-exadata-infrastructure-shape
    /cmdref/db/autonomous-vm-cluster
    /cmdref/db/backup
    /cmdref/db/backup-destination
    /cmdref/db/console-connection
    /cmdref/db/data-guard-association
    /cmdref/db/database
    /cmdref/db/db-home
    /cmdref/db/exadata-infrastructure
    /cmdref/db/external-backup-job
    /cmdref/db/gi-version
    /cmdref/db/maintenance-run
    /cmdref/db/node
    /cmdref/db/patch
    /cmdref/db/patch-history
    /cmdref/db/system
    /cmdref/db/system-shape
    /cmdref/db/version
    /cmdref/db/vm-cluster
    /cmdref/db/vm-cluster-network