UPGRADEAPPLIEDSCHEMA()`¶

About UpgradeAppliedSchema¶

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

Method Signature¶

METHODS /AWS1/IF_DIR~UPGRADEAPPLIEDSCHEMA
  IMPORTING
    !IV_PUBLISHEDSCHEMAARN TYPE /AWS1/DIRARN OPTIONAL
    !IV_DIRECTORYARN TYPE /AWS1/DIRARN OPTIONAL
    !IV_DRYRUN TYPE /AWS1/DIRBOOL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dirupgradeappliedsc01
  RAISING
    /AWS1/CX_DIRACCESSDENIEDEX
    /AWS1/CX_DIRINCOMPATIBLESCHEX
    /AWS1/CX_DIRINTERNALSERVICEEX
    /AWS1/CX_DIRINVALIDARNEX
    /AWS1/CX_DIRINVATTACHMENTEX
    /AWS1/CX_DIRRESOURCENOTFOUNDEX
    /AWS1/CX_DIRRETRYABLECONFLIC00
    /AWS1/CX_DIRSCHALRDYEXISTSEX
    /AWS1/CX_DIRVALIDATIONEX
    /AWS1/CX_DIRCLIENTEXC
    /AWS1/CX_DIRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_publishedschemaarn` `TYPE /AWS1/DIRARN` `/AWS1/DIRARN`¶

The revision of the published schema to upgrade the directory to.

`iv_directoryarn` `TYPE /AWS1/DIRARN` `/AWS1/DIRARN`¶

The ARN for the directory to which the upgraded schema will be applied.

Optional arguments:¶

`iv_dryrun` `TYPE /AWS1/DIRBOOL` `/AWS1/DIRBOOL`¶

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dirupgradeappliedsc01` `/AWS1/CL_DIRUPGRADEAPPLIEDSC01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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->upgradeappliedschema(
  iv_directoryarn = |string|
  iv_dryrun = ABAP_TRUE
  iv_publishedschemaarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_upgradedschemaarn( ).
  lv_arn = lo_result->get_directoryarn( ).
ENDIF.

/AWS1/IF_DIR=>UPGRADEAPPLIEDSCHEMA()¶