Database Migrations Functions

Package: DBMS_CLOUD_OCI_DMG_DATABASE_MIGRATION

ABORT_JOB Function

Aborts a Migration Job (either Evaluation or Migration).

Syntax

FUNCTION abort_job (
  job_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_abort_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_MIGRATION_OBJECTS Function

Add excluded/included object to the list.

Syntax

FUNCTION add_migration_objects (
  migration_id varchar2,
  add_migration_objects_details dbms_cloud_oci_database_migration_migration_object_collection_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_add_migration_objects_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`add_migration_objects_details`	(required) Arrays of object.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_AGENT_COMPARTMENT Function

Used to configure an ODMS Agent Compartment ID.

Syntax

FUNCTION change_agent_compartment (
  agent_id varchar2,
  change_agent_compartment_details dbms_cloud_oci_database_migration_change_agent_compartment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_change_agent_compartment_response_t;

Parameters

Parameter	Description
`agent_id`	(required) The OCID of the agent
`change_agent_compartment_details`	(required) Details to change the compartment.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_CONNECTION_COMPARTMENT Function

Used to change the Database Connection compartment.

Syntax

FUNCTION change_connection_compartment (
  connection_id varchar2,
  change_connection_compartment_details dbms_cloud_oci_database_migration_change_connection_compartment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_change_connection_compartment_response_t;

Parameters

Parameter	Description
`connection_id`	(required) The OCID of the database connection
`change_connection_compartment_details`	(required) Details to change the compartment.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MIGRATION_COMPARTMENT Function

Used to change the Migration compartment.

Syntax

FUNCTION change_migration_compartment (
  migration_id varchar2,
  change_migration_compartment_details dbms_cloud_oci_database_migration_change_migration_compartment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_change_migration_compartment_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`change_migration_compartment_details`	(required) Details to change the compartment.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CLONE_MIGRATION Function

Clone a configuration from an existing Migration.

Syntax

FUNCTION clone_migration (
  migration_id varchar2,
  clone_migration_details dbms_cloud_oci_database_migration_clone_migration_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_clone_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`clone_migration_details`	(required) Clone Migration properties.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CONNECTION_DIAGNOSTICS Function

Perform connection test for a database connection.

Syntax

FUNCTION connection_diagnostics (
  connection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_connection_diagnostics_response_t;

Parameters

Parameter	Description
`connection_id`	(required) The OCID of the database connection
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CONNECTION Function

Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.

Syntax

FUNCTION create_connection (
  create_connection_details dbms_cloud_oci_database_migration_create_connection_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_create_connection_response_t;

Parameters

Parameter	Description
`create_connection_details`	(required) Database Connection properties.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MIGRATION Function

Create a Migration resource that contains all the details to perform the database migration operation, such as source and destination database details, credentials, etc.

Syntax

FUNCTION create_migration (
  create_migration_details dbms_cloud_oci_database_migration_create_migration_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_create_migration_response_t;

Parameters

Parameter	Description
`create_migration_details`	(required) Migration properties.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_AGENT Function

Delete the ODMS Agent represented by the specified ODMS Agent ID.

Syntax

FUNCTION delete_agent (
  agent_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_delete_agent_response_t;

Parameters

Parameter	Description
`agent_id`	(required) The OCID of the agent
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CONNECTION Function

Deletes the Database Connection represented by the specified connection ID.

Syntax

FUNCTION delete_connection (
  connection_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_delete_connection_response_t;

Parameters

Parameter	Description
`connection_id`	(required) The OCID of the database connection
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_JOB Function

Deletes the migration job represented by the given job ID.

Syntax

FUNCTION delete_job (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_delete_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MIGRATION Function

Deletes the Migration represented by the specified migration ID.

Syntax

FUNCTION delete_migration (
  migration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_delete_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

EVALUATE_MIGRATION Function

Start Validate Migration job.

Syntax

FUNCTION evaluate_migration (
  migration_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_evaluate_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ADVISOR_REPORT Function

Get the Pre-Migration Advisor report details

Syntax

FUNCTION get_advisor_report (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_get_advisor_report_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AGENT Function

Display the ODMS Agent configuration.

Syntax

FUNCTION get_agent (
  agent_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_get_agent_response_t;

Parameters

Parameter	Description
`agent_id`	(required) The OCID of the agent
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CONNECTION Function

Display Database Connection details.

Syntax

FUNCTION get_connection (
  connection_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_get_connection_response_t;

Parameters

Parameter	Description
`connection_id`	(required) The OCID of the database connection
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB Function

Get a migration job.

Syntax

FUNCTION get_job (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_get_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_OUTPUT_CONTENT Function

Get the migration Job Output content as a String.

Syntax

FUNCTION get_job_output_content (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_get_job_output_content_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MIGRATION Function

Display Migration details.

Syntax

FUNCTION get_migration (
  migration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_get_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the details of a work request.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AGENT_IMAGES Function

Get details of the ODMS Agent Images available to install on-premises.

Syntax

FUNCTION list_agent_images (
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_agent_images_response_t;

Parameters

Parameter	Description
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AGENTS Function

Display the name of all the existing ODMS Agents in the server.

Syntax

FUNCTION list_agents (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_agents_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`lifecycle_state`	(optional) The current state of the Database Migration Deployment. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CONNECTIONS Function

List all Database Connections.

Syntax

FUNCTION list_connections (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_connections_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) The current state of the Database Migration Deployment. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXCLUDED_OBJECTS Function

List the excluded database objects.

Syntax

FUNCTION list_excluded_objects (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  owner varchar2 DEFAULT NULL,
  object varchar2 DEFAULT NULL,
  owner_contains varchar2 DEFAULT NULL,
  object_contains varchar2 DEFAULT NULL,
  reason_category varchar2 DEFAULT NULL,
  source_rule varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_excluded_objects_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for reasonCategory is ascending. If no value is specified reasonCategory is default. Allowed values are: 'type', 'reasonCategory'
`l_type`	(optional) Excluded object type.
`owner`	(optional) Excluded object owner
`object`	(optional) Excluded object name
`owner_contains`	(optional) Excluded object owner which contains provided value.
`object_contains`	(optional) Excluded object name which contains provided value.
`reason_category`	(optional) Reason category for the excluded object Allowed values are: 'ORACLE_MAINTAINED', 'GG_UNSUPPORTED', 'USER_EXCLUDED', 'MANDATORY_EXCLUDED', 'USER_EXCLUDED_TYPE'
`source_rule`	(optional) Exclude object rule that matches the excluded object, if applicable.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOB_OUTPUTS Function

List the Job Outputs

Syntax

FUNCTION list_job_outputs (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_job_outputs_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOBS Function

List all the names of the Migration jobs associated to the specified migration site.

Syntax

FUNCTION list_jobs (
  migration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_jobs_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The ID of the migration in which to list resources.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) The lifecycle state of the Migration Job. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'UNKNOWN', 'TERMINATED', 'FAILED', 'SUCCEEDED', 'WAITING', 'CANCELING', 'CANCELED'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MIGRATION_OBJECT_TYPES Function

Display sample object types to exclude or include for a Migration.

Syntax

FUNCTION list_migration_object_types (
  opc_request_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_migration_object_types_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for name is custom based on it's usage frequency. If no value is specified name is default. Allowed values are: 'name'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MIGRATION_OBJECTS Function

Display excluded/included objects.

Syntax

FUNCTION list_migration_objects (
  migration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_migration_objects_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MIGRATIONS Function

List all Migrations.

Syntax

FUNCTION list_migrations (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  lifecycle_details varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_migrations_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) The lifecycle state of the Migration. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'IN_PROGRESS', 'ACCEPTED', 'SUCCEEDED', 'CANCELED', 'WAITING', 'NEEDS_ATTENTION', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'
`lifecycle_details`	(optional) The lifecycle detailed status of the Migration. Allowed values are: 'READY', 'ABORTING', 'VALIDATING', 'VALIDATED', 'WAITING', 'MIGRATING', 'DONE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Gets the errors for a work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: 'timestamp'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Gets the logs for a work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: 'timestamp'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in a compartment or for a specified resource.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  resource_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`resource_id`	(optional) The OCID of the resource.
`status`	(optional) A filter to return only resources their lifecycleState matches the given OperationStatus. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_MIGRATION_OBJECTS Function

Remove excluded/included objects.

Syntax

FUNCTION remove_migration_objects (
  migration_id varchar2,
  remove_migration_objects_details dbms_cloud_oci_database_migration_migration_object_collection_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_remove_migration_objects_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`remove_migration_objects_details`	(required) Arrays of object.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RESUME_JOB Function

Resume a migration Job.

Syntax

FUNCTION resume_job (
  job_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  resume_job_details dbms_cloud_oci_database_migration_resume_job_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_resume_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`resume_job_details`	(optional) Resume Job options.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RETRIEVE_SUPPORTED_PHASES Function

Display Migration Phases for a specified migration.

Syntax

FUNCTION retrieve_supported_phases (
  migration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_retrieve_supported_phases_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_MIGRATION Function

Start Migration job.

Syntax

FUNCTION start_migration (
  migration_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  start_migration_details dbms_cloud_oci_database_migration_start_migration_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_start_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`start_migration_details`	(optional) Start Migration Job properties.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AGENT Function

Modifies the ODMS Agent represented by the given ODMS Agent ID.

Syntax

FUNCTION update_agent (
  agent_id varchar2,
  update_agent_details dbms_cloud_oci_database_migration_update_agent_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_update_agent_response_t;

Parameters

Parameter	Description
`agent_id`	(required) The OCID of the agent
`update_agent_details`	(required) Update ODMS Agent properties.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_CONNECTION Function

Update Database Connection resource details.

Syntax

FUNCTION update_connection (
  connection_id varchar2,
  update_connection_details dbms_cloud_oci_database_migration_update_connection_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_update_connection_response_t;

Parameters

Parameter	Description
`connection_id`	(required) The OCID of the database connection
`update_connection_details`	(required) Database Connection properties.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_JOB Function

Update Migration Job resource details.

Syntax

FUNCTION update_job (
  job_id varchar2,
  update_job_details dbms_cloud_oci_database_migration_update_job_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_update_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job
`update_job_details`	(required) Migration Job properties.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MIGRATION Function

Update Migration resource details.

Syntax

FUNCTION update_migration (
  migration_id varchar2,
  update_migration_details dbms_cloud_oci_database_migration_update_migration_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dmg_database_migration_update_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) The OCID of the migration
`update_migration_details`	(required) Migration properties.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://odms.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

ABORT_JOB Function 🔗

ADD_MIGRATION_OBJECTS Function 🔗

CHANGE_AGENT_COMPARTMENT Function 🔗

CHANGE_CONNECTION_COMPARTMENT Function 🔗

CHANGE_MIGRATION_COMPARTMENT Function 🔗

CLONE_MIGRATION Function 🔗

CONNECTION_DIAGNOSTICS Function 🔗

CREATE_CONNECTION Function 🔗

CREATE_MIGRATION Function 🔗

DELETE_AGENT Function 🔗

DELETE_CONNECTION Function 🔗

DELETE_JOB Function 🔗

DELETE_MIGRATION Function 🔗

EVALUATE_MIGRATION Function 🔗

GET_ADVISOR_REPORT Function 🔗

GET_AGENT Function 🔗

GET_CONNECTION Function 🔗

GET_JOB Function 🔗

GET_JOB_OUTPUT_CONTENT Function 🔗

GET_MIGRATION Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_AGENT_IMAGES Function 🔗

LIST_AGENTS Function 🔗

LIST_CONNECTIONS Function 🔗

LIST_EXCLUDED_OBJECTS Function 🔗

LIST_JOB_OUTPUTS Function 🔗

LIST_JOBS Function 🔗

LIST_MIGRATION_OBJECT_TYPES Function 🔗

LIST_MIGRATION_OBJECTS Function 🔗

LIST_MIGRATIONS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

REMOVE_MIGRATION_OBJECTS Function 🔗

RESUME_JOB Function 🔗

RETRIEVE_SUPPORTED_PHASES Function 🔗

START_MIGRATION Function 🔗

UPDATE_AGENT Function 🔗

UPDATE_CONNECTION Function 🔗

UPDATE_JOB Function 🔗

UPDATE_MIGRATION Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

ABORT_JOB Function

ADD_MIGRATION_OBJECTS Function

CHANGE_AGENT_COMPARTMENT Function

CHANGE_CONNECTION_COMPARTMENT Function

CHANGE_MIGRATION_COMPARTMENT Function

CLONE_MIGRATION Function

CONNECTION_DIAGNOSTICS Function

CREATE_CONNECTION Function

CREATE_MIGRATION Function

DELETE_AGENT Function

DELETE_CONNECTION Function

DELETE_JOB Function

DELETE_MIGRATION Function

EVALUATE_MIGRATION Function

GET_ADVISOR_REPORT Function

GET_AGENT Function

GET_CONNECTION Function

GET_JOB Function

GET_JOB_OUTPUT_CONTENT Function

GET_MIGRATION Function

GET_WORK_REQUEST Function

LIST_AGENT_IMAGES Function

LIST_AGENTS Function

LIST_CONNECTIONS Function

LIST_EXCLUDED_OBJECTS Function

LIST_JOB_OUTPUTS Function

LIST_JOBS Function

LIST_MIGRATION_OBJECT_TYPES Function

LIST_MIGRATION_OBJECTS Function

LIST_MIGRATIONS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

REMOVE_MIGRATION_OBJECTS Function

RESUME_JOB Function

RETRIEVE_SUPPORTED_PHASES Function

START_MIGRATION Function

UPDATE_AGENT Function

UPDATE_CONNECTION Function

UPDATE_JOB Function

UPDATE_MIGRATION Function