STARTMETADATAMODELIMPORT()`¶

About StartMetadataModelImport¶

Queues an import of metadata models (database objects such as tables, views, and procedures) from your data provider into the metadata tree. If other requests created by Start* operations are already in the migration project's queue, the import begins after they complete.

To check the status of the import request, call DescribeMetadataModelImports using the returned RequestIdentifier as a filter.

Required permissions: dms:StartMetadataModelImport. For more information, see Actions, resources, and condition keys for Database Migration Service.

Method Signature¶

METHODS /AWS1/IF_DMG~STARTMETADATAMODELIMPORT
  IMPORTING
    !IV_MIGRATIONPROJECTID TYPE /AWS1/DMGMIGRATIONPROJECTID OPTIONAL
    !IV_SELECTIONRULES TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_ORIGIN TYPE /AWS1/DMGORIGINTYPEVALUE OPTIONAL
    !IV_REFRESH TYPE /AWS1/DMGBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgstrtmetmodelimprsp
  RAISING
    /AWS1/CX_DMGACCESSDENIEDFAULT
    /AWS1/CX_DMGINVRESRCSTATEFAULT
    /AWS1/CX_DMGKMSKEYNOTACCIBLE00
    /AWS1/CX_DMGRESRCALRDYEXFAULT
    /AWS1/CX_DMGRESRCNOTFOUNDFAULT
    /AWS1/CX_DMGRESRCQUOTAEXCDFA00
    /AWS1/CX_DMGS3ACCDENIEDFAULT
    /AWS1/CX_DMGS3RESRCNOTFNDFAULT
    /AWS1/CX_DMGCLIENTEXC
    /AWS1/CX_DMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_migrationprojectid` `TYPE /AWS1/DMGMIGRATIONPROJECTID` `/AWS1/DMGMIGRATIONPROJECTID`¶

The migration project name or Amazon Resource Name (ARN).

`iv_selectionrules` `TYPE /AWS1/DMGSTRING` `/AWS1/DMGSTRING`¶

A JSON string that identifies the metadata models to import from the data provider. For the selection rule format and examples, see Selection rules in DMS Schema Conversion.

Usage:

Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider.

Supports explicit, include, and exclude rule actions.

`iv_origin` `TYPE /AWS1/DMGORIGINTYPEVALUE` `/AWS1/DMGORIGINTYPEVALUE`¶

Specifies the metadata tree to import into.

You cannot import from a virtual target data provider.

Optional arguments:¶

`iv_refresh` `TYPE /AWS1/DMGBOOLEAN` `/AWS1/DMGBOOLEAN`¶

Specifies whether to refresh the selected metadata models from the data provider.

When true, the import reloads the selected metadata models with current definitions and removes their existing subtree.

When false (default), the import loads the full subtree that has not yet been loaded into the metadata tree.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dmgstrtmetmodelimprsp` `/AWS1/CL_DMGSTRTMETMODELIMPRSP`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startmetadatamodelimport(
  iv_migrationprojectid = |string|
  iv_origin = |string|
  iv_refresh = ABAP_TRUE
  iv_selectionrules = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_requestidentifier( ).
ENDIF.

Import metadata from the source database¶

The following example queues a metadata import for all objects in the ExampleSchema schema from the source database.

DATA(lo_result) = lo_client->startmetadatamodelimport(
  iv_migrationprojectid = |arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS|
  iv_origin = |SOURCE|
  iv_refresh = ABAP_FALSE
  iv_selectionrules = |{"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema"},"rule-action": "explicit"}]}|
).

/AWS1/IF_DMG=>STARTMETADATAMODELIMPORT()¶