STARTMETMODELEXPORTASSCRIPT()`¶

About StartMetadataModelExportAsScript¶

Queues an export of metadata models (database objects such as tables, views, and procedures) as a data definition language (DDL) script. The script is stored as a ZIP archive in the Amazon S3 bucket associated with the migration project. If other requests created by Start* operations are already in the migration project's queue, the export begins after they complete.

When exporting from the target metadata tree, the export applies only to metadata models created by conversion. Metadata models imported from the database are skipped.

To check the status of the export request, call DescribeMetadataModelExportsAsScript using the returned RequestIdentifier as a filter.

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

Method Signature¶

METHODS /AWS1/IF_DMG~STARTMETMODELEXPORTASSCRIPT
  IMPORTING
    !IV_MIGRATIONPROJECTID TYPE /AWS1/DMGMIGRATIONPROJECTID OPTIONAL
    !IV_SELECTIONRULES TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_ORIGIN TYPE /AWS1/DMGORIGINTYPEVALUE OPTIONAL
    !IV_FILENAME TYPE /AWS1/DMGSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgstrtmetmdelexpas01
  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 export as a SQL script. 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 export from.

Optional arguments:¶

`iv_filename` `TYPE /AWS1/DMGSTRING` `/AWS1/DMGSTRING`¶

The name for the exported file. When you omit this parameter, the service generates a name from the data provider engine name and an export timestamp.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dmgstrtmetmdelexpas01` `/AWS1/CL_DMGSTRTMETMDELEXPAS01`¶

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->startmetmodelexportasscript(
  iv_filename = |string|
  iv_migrationprojectid = |string|
  iv_origin = |string|
  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.

Export converted metadata models as DDL scripts¶

The following example queues an export of converted metadata models for all objects in the ExampleSchema schema as data definition language (DDL) scripts to the S3 bucket associated with the migration project.

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

/AWS1/IF_DMG=>STARTMETMODELEXPORTASSCRIPT()¶