goldengate
==============

Description
-----------
Use the Oracle Cloud Infrastructure GoldenGate CLI to perform data replication operations.

Available Commands
------------------
* :doc:`certificate </cmdref/goldengate/certificate>`

  * :doc:`create </cmdref/goldengate/certificate/create>`
  * :doc:`delete </cmdref/goldengate/certificate/delete>`
  * :doc:`get </cmdref/goldengate/certificate/get>`
  * :doc:`list </cmdref/goldengate/certificate/list>`

* :doc:`connection </cmdref/goldengate/connection>`

  * :doc:`add-lock </cmdref/goldengate/connection/add-lock>`
  * :doc:`change-compartment </cmdref/goldengate/connection/change-compartment>`
  * :doc:`create-amazon-kinesis-connection </cmdref/goldengate/connection/create-amazon-kinesis-connection>`
  * :doc:`create-amazon-redshift-connection </cmdref/goldengate/connection/create-amazon-redshift-connection>`
  * :doc:`create-amazon-s3-connection </cmdref/goldengate/connection/create-amazon-s3-connection>`
  * :doc:`create-azure-data-lake-storage-connection </cmdref/goldengate/connection/create-azure-data-lake-storage-connection>`
  * :doc:`create-azure-synapse-connection </cmdref/goldengate/connection/create-azure-synapse-connection>`
  * :doc:`create-databricks-connection </cmdref/goldengate/connection/create-databricks-connection>`
  * :doc:`create-db2-connection </cmdref/goldengate/connection/create-db2-connection>`
  * :doc:`create-elasticsearch-connection </cmdref/goldengate/connection/create-elasticsearch-connection>`
  * :doc:`create-generic-connection </cmdref/goldengate/connection/create-generic-connection>`
  * :doc:`create-goldengate-connection </cmdref/goldengate/connection/create-goldengate-connection>`
  * :doc:`create-google-big-query-connection </cmdref/goldengate/connection/create-google-big-query-connection>`
  * :doc:`create-google-cloud-storage-connection </cmdref/goldengate/connection/create-google-cloud-storage-connection>`
  * :doc:`create-google-pub-sub-connection </cmdref/goldengate/connection/create-google-pub-sub-connection>`
  * :doc:`create-hdfs-connection </cmdref/goldengate/connection/create-hdfs-connection>`
  * :doc:`create-jms-connection </cmdref/goldengate/connection/create-jms-connection>`
  * :doc:`create-kafka-connection </cmdref/goldengate/connection/create-kafka-connection>`
  * :doc:`create-kafka-schema-registry-connection </cmdref/goldengate/connection/create-kafka-schema-registry-connection>`
  * :doc:`create-microsoft-fabric-connection </cmdref/goldengate/connection/create-microsoft-fabric-connection>`
  * :doc:`create-microsoft-sqlserver-connection </cmdref/goldengate/connection/create-microsoft-sqlserver-connection>`
  * :doc:`create-mongo-db-connection </cmdref/goldengate/connection/create-mongo-db-connection>`
  * :doc:`create-mysql-connection </cmdref/goldengate/connection/create-mysql-connection>`
  * :doc:`create-object-storage-connection </cmdref/goldengate/connection/create-object-storage-connection>`
  * :doc:`create-oracle-connection </cmdref/goldengate/connection/create-oracle-connection>`
  * :doc:`create-oracle-nosql-connection </cmdref/goldengate/connection/create-oracle-nosql-connection>`
  * :doc:`create-postgresql-connection </cmdref/goldengate/connection/create-postgresql-connection>`
  * :doc:`create-redis-connection </cmdref/goldengate/connection/create-redis-connection>`
  * :doc:`create-snowflake-connection </cmdref/goldengate/connection/create-snowflake-connection>`
  * :doc:`delete </cmdref/goldengate/connection/delete>`
  * :doc:`get </cmdref/goldengate/connection/get>`
  * :doc:`list </cmdref/goldengate/connection/list>`
  * :doc:`refresh </cmdref/goldengate/connection/refresh>`
  * :doc:`remove-lock </cmdref/goldengate/connection/remove-lock>`
  * :doc:`update-amazon-kinesis-connection </cmdref/goldengate/connection/update-amazon-kinesis-connection>`
  * :doc:`update-amazon-redshift-connection </cmdref/goldengate/connection/update-amazon-redshift-connection>`
  * :doc:`update-amazon-s3-connection </cmdref/goldengate/connection/update-amazon-s3-connection>`
  * :doc:`update-azure-data-lake-storage-connection </cmdref/goldengate/connection/update-azure-data-lake-storage-connection>`
  * :doc:`update-azure-synapse-connection </cmdref/goldengate/connection/update-azure-synapse-connection>`
  * :doc:`update-databricks-connection </cmdref/goldengate/connection/update-databricks-connection>`
  * :doc:`update-db2-connection </cmdref/goldengate/connection/update-db2-connection>`
  * :doc:`update-elasticsearch-connection </cmdref/goldengate/connection/update-elasticsearch-connection>`
  * :doc:`update-generic-connection </cmdref/goldengate/connection/update-generic-connection>`
  * :doc:`update-goldengate-connection </cmdref/goldengate/connection/update-goldengate-connection>`
  * :doc:`update-google-big-query-connection </cmdref/goldengate/connection/update-google-big-query-connection>`
  * :doc:`update-google-cloud-storage-connection </cmdref/goldengate/connection/update-google-cloud-storage-connection>`
  * :doc:`update-google-pub-sub-connection </cmdref/goldengate/connection/update-google-pub-sub-connection>`
  * :doc:`update-hdfs-connection </cmdref/goldengate/connection/update-hdfs-connection>`
  * :doc:`update-jms-connection </cmdref/goldengate/connection/update-jms-connection>`
  * :doc:`update-kafka-connection </cmdref/goldengate/connection/update-kafka-connection>`
  * :doc:`update-kafka-schema-registry-connection </cmdref/goldengate/connection/update-kafka-schema-registry-connection>`
  * :doc:`update-microsoft-fabric-connection </cmdref/goldengate/connection/update-microsoft-fabric-connection>`
  * :doc:`update-microsoft-sqlserver-connection </cmdref/goldengate/connection/update-microsoft-sqlserver-connection>`
  * :doc:`update-mongo-db-connection </cmdref/goldengate/connection/update-mongo-db-connection>`
  * :doc:`update-mysql-connection </cmdref/goldengate/connection/update-mysql-connection>`
  * :doc:`update-object-storage-connection </cmdref/goldengate/connection/update-object-storage-connection>`
  * :doc:`update-oracle-connection </cmdref/goldengate/connection/update-oracle-connection>`
  * :doc:`update-oracle-nosql-connection </cmdref/goldengate/connection/update-oracle-nosql-connection>`
  * :doc:`update-postgresql-connection </cmdref/goldengate/connection/update-postgresql-connection>`
  * :doc:`update-redis-connection </cmdref/goldengate/connection/update-redis-connection>`
  * :doc:`update-snowflake-connection </cmdref/goldengate/connection/update-snowflake-connection>`

* :doc:`connection-assignment </cmdref/goldengate/connection-assignment>`

  * :doc:`create </cmdref/goldengate/connection-assignment/create>`
  * :doc:`delete </cmdref/goldengate/connection-assignment/delete>`
  * :doc:`get </cmdref/goldengate/connection-assignment/get>`
  * :doc:`list </cmdref/goldengate/connection-assignment/list>`
  * :doc:`test </cmdref/goldengate/connection-assignment/test>`

* :doc:`database-registration </cmdref/goldengate/database-registration>`

  * :doc:`change-compartment </cmdref/goldengate/database-registration/change-compartment>`
  * :doc:`create </cmdref/goldengate/database-registration/create>`
  * :doc:`delete </cmdref/goldengate/database-registration/delete>`
  * :doc:`get </cmdref/goldengate/database-registration/get>`
  * :doc:`list </cmdref/goldengate/database-registration/list>`
  * :doc:`update </cmdref/goldengate/database-registration/update>`

* :doc:`deployment </cmdref/goldengate/deployment>`

  * :doc:`add-lock </cmdref/goldengate/deployment/add-lock>`
  * :doc:`change-compartment </cmdref/goldengate/deployment/change-compartment>`
  * :doc:`collect-diagnostics </cmdref/goldengate/deployment/collect-diagnostics>`
  * :doc:`create </cmdref/goldengate/deployment/create>`
  * :doc:`delete </cmdref/goldengate/deployment/delete>`
  * :doc:`export-wallet </cmdref/goldengate/deployment/export-wallet>`
  * :doc:`generate-library-url </cmdref/goldengate/deployment/generate-library-url>`
  * :doc:`generate-log-reader-component-library-url </cmdref/goldengate/deployment/generate-log-reader-component-library-url>`
  * :doc:`get </cmdref/goldengate/deployment/get>`
  * :doc:`import-wallet </cmdref/goldengate/deployment/import-wallet>`
  * :doc:`list </cmdref/goldengate/deployment/list>`
  * :doc:`remove-lock </cmdref/goldengate/deployment/remove-lock>`
  * :doc:`start </cmdref/goldengate/deployment/start>`
  * :doc:`stop </cmdref/goldengate/deployment/stop>`
  * :doc:`update </cmdref/goldengate/deployment/update>`
  * :doc:`upgrade </cmdref/goldengate/deployment/upgrade>`
  * :doc:`upgrade-to </cmdref/goldengate/deployment/upgrade-to>`
  * :doc:`wallet-exists </cmdref/goldengate/deployment/wallet-exists>`

* :doc:`deployment-backup </cmdref/goldengate/deployment-backup>`

  * :doc:`add-lock </cmdref/goldengate/deployment-backup/add-lock>`
  * :doc:`cancel </cmdref/goldengate/deployment-backup/cancel>`
  * :doc:`change-compartment </cmdref/goldengate/deployment-backup/change-compartment>`
  * :doc:`copy </cmdref/goldengate/deployment-backup/copy>`
  * :doc:`create </cmdref/goldengate/deployment-backup/create>`
  * :doc:`delete </cmdref/goldengate/deployment-backup/delete>`
  * :doc:`get </cmdref/goldengate/deployment-backup/get>`
  * :doc:`list </cmdref/goldengate/deployment-backup/list>`
  * :doc:`remove-lock </cmdref/goldengate/deployment-backup/remove-lock>`
  * :doc:`restore-deployment </cmdref/goldengate/deployment-backup/restore-deployment>`
  * :doc:`update </cmdref/goldengate/deployment-backup/update>`

* :doc:`deployment-environment </cmdref/goldengate/deployment-environment>`

  * :doc:`list </cmdref/goldengate/deployment-environment/list>`

* :doc:`deployment-type-collection </cmdref/goldengate/deployment-type-collection>`

  * :doc:`list-deployment-types </cmdref/goldengate/deployment-type-collection/list-deployment-types>`

* :doc:`deployment-upgrade </cmdref/goldengate/deployment-upgrade>`

  * :doc:`cancel </cmdref/goldengate/deployment-upgrade/cancel>`
  * :doc:`cancel-snooze </cmdref/goldengate/deployment-upgrade/cancel-snooze>`
  * :doc:`get </cmdref/goldengate/deployment-upgrade/get>`
  * :doc:`list </cmdref/goldengate/deployment-upgrade/list>`
  * :doc:`reschedule </cmdref/goldengate/deployment-upgrade/reschedule>`
  * :doc:`rollback </cmdref/goldengate/deployment-upgrade/rollback>`
  * :doc:`snooze </cmdref/goldengate/deployment-upgrade/snooze>`
  * :doc:`upgrade </cmdref/goldengate/deployment-upgrade/upgrade>`

* :doc:`deployment-version </cmdref/goldengate/deployment-version>`

  * :doc:`list </cmdref/goldengate/deployment-version/list>`

* :doc:`deployment-wallets-operation-summary </cmdref/goldengate/deployment-wallets-operation-summary>`

  * :doc:`list-wallet-operations </cmdref/goldengate/deployment-wallets-operation-summary/list-wallet-operations>`

* :doc:`message-summary </cmdref/goldengate/message-summary>`

  * :doc:`list-messages </cmdref/goldengate/message-summary/list-messages>`

* :doc:`pipeline </cmdref/goldengate/pipeline>`

  * :doc:`change-compartment </cmdref/goldengate/pipeline/change-compartment>`
  * :doc:`create-zero-etl-pipeline </cmdref/goldengate/pipeline/create-zero-etl-pipeline>`
  * :doc:`delete </cmdref/goldengate/pipeline/delete>`
  * :doc:`get </cmdref/goldengate/pipeline/get>`
  * :doc:`list </cmdref/goldengate/pipeline/list>`
  * :doc:`list-initialization-steps </cmdref/goldengate/pipeline/list-initialization-steps>`
  * :doc:`list-running-processes </cmdref/goldengate/pipeline/list-running-processes>`
  * :doc:`list-schema-tables </cmdref/goldengate/pipeline/list-schema-tables>`
  * :doc:`list-schemas </cmdref/goldengate/pipeline/list-schemas>`
  * :doc:`start </cmdref/goldengate/pipeline/start>`
  * :doc:`stop </cmdref/goldengate/pipeline/stop>`
  * :doc:`test-connection </cmdref/goldengate/pipeline/test-connection>`
  * :doc:`update-zero-etl-pipeline </cmdref/goldengate/pipeline/update-zero-etl-pipeline>`

* :doc:`pipeline-recipe-collection </cmdref/goldengate/pipeline-recipe-collection>`

  * :doc:`list-recipes </cmdref/goldengate/pipeline-recipe-collection/list-recipes>`

* :doc:`trail-file-summary </cmdref/goldengate/trail-file-summary>`

  * :doc:`list-trail-files </cmdref/goldengate/trail-file-summary/list-trail-files>`

* :doc:`trail-sequence-summary </cmdref/goldengate/trail-sequence-summary>`

  * :doc:`list-trail-sequences </cmdref/goldengate/trail-sequence-summary/list-trail-sequences>`

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

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

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

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

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

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


.. toctree::
    :hidden:

    /cmdref/goldengate/certificate
    /cmdref/goldengate/connection
    /cmdref/goldengate/connection-assignment
    /cmdref/goldengate/database-registration
    /cmdref/goldengate/deployment
    /cmdref/goldengate/deployment-backup
    /cmdref/goldengate/deployment-environment
    /cmdref/goldengate/deployment-type-collection
    /cmdref/goldengate/deployment-upgrade
    /cmdref/goldengate/deployment-version
    /cmdref/goldengate/deployment-wallets-operation-summary
    /cmdref/goldengate/message-summary
    /cmdref/goldengate/pipeline
    /cmdref/goldengate/pipeline-recipe-collection
    /cmdref/goldengate/trail-file-summary
    /cmdref/goldengate/trail-sequence-summary
    /cmdref/goldengate/work-request
    /cmdref/goldengate/work-request-error
    /cmdref/goldengate/work-request-log-entry