Migrating Data Virtualization data by using the cpd-cli

To export your Data Virtualization data, complete these steps.

1. Create a new values.yaml file to specify which Data Virtualization objects to export.
   1. Specify the following required input values in the values.yaml file. Ensure that identifiers consist only of alphanumeric characters.
      Note: By default, all of the data sets associated with users, groups, caches, and audit are exported.

      • If you specify only connections, then its schema, and schema and name is exported.
      • If you specify only schemas, then its associated database objects and dependent connection (if it's not specified) is exported.
      • To stop exporting a data set, specify an empty array. For example: "users": [],
      • users: Specify a comma-separated list of users that you want to export.
      • groups: Specify a comma-separated list of group names that you want to export.
      • caches: Specify a comma-separated list of cache IDs that you want to export.
      • audit: Specify a comma-separated list of audit policy names that you want to export.
      • objects: Export values that the engine needs before it can run.
      • encryptionKey: The encryption key that is used to generate another encryption key, which encrypts your exported engine data (i.e. schemas, tables, and connections). If the objects exist, then specify an encryption key of your choice.
      • identifier: Add an identifier to the export. This value uses the IBM Software Hub export job ID by default.
      • (Optional) includeDepedencies: Export all related objects, including connections that the objects depend on. For example, if a view depends on a nickname and a table, all three are exported if you specify includeDepedencies=TRUE. Additionally, the connections that are associated with the nickname and table are also exported. This option is false by default.
        Note: includeDependencies might cause more schemas and connections to be included than in the original specification.
      • (Optional) includeStatistics: Run and include statistic statements for exported database objects. These statistics statements are re-created during the import process for its associated object. This option is false by default.
      • exportObjects: Provide details and optional comments about the connections and schemas that you want to export.
        • connection: Specify the Data Virtualization connection ID (for example: DB210000).
        • schema or schema and name: Specify the schema name to export the whole schema, or export a specific object within a schema by specifying the schema name and the name of the object name in that schema.
      Example values.yaml file:

      {
        "users": ["user1", "user2", "user3"],
        "groups": ["group1", "group2", "group3"],
        "caches": ["cacheID1", "cacheID2", "cacheID3"],
        "audit": ["auditPolicy1", "auditPolicy2", "auditPolicy3"],
        "objects": {
          "encryptionKey": "myEncryptionKey",
          "identifier": "myExport123",
          "includeDependencies": true,
          "includeStatistics": true,
          "exportObjects": [
            {
              "_comment": "comment about the exported connection",
              "connection": "connectionID"
            },
            {
              "_comment": "comment about the exported schema",
              "schema": "schemaName"
            },
            {
              "_comment": "comment about the exported object",
              "schema": "schemaName",
              "name": "mytable1"
            }
          ]
        }
      }

   2. Format the input values into a single line.
      Note: Use jq -c to compact the JSON objects into a single line.

      cat <<EOF | jq -c
      {
        "objects": {
          "encryptionKey": "myEncryptionKey",
          "includeStatistics": false,
          "exportObjects": [
            {
              "_comment": "CPADMIN Schema",
              "schema": "CPADMIN"
            }
          ]
        },
        "caches": [
          "DVxxxx",
          "DVyyyy"
        ]
      } 
      EOF

      An example of the JSON objects as a single line:

      {"objects":{"encryptionKey":"myEncryptionKey","includeStatistics":false,"exportObjects":[{"_comment":"CPADMIN Schema","schema":"CPADMIN"}]},"caches":["DVxxxx","DVyyyy"]}

   3. Format and save the values.yaml file that is passed to cpd-cli as a dv-aux JSON object wrapped in single quotation marks:

      dv-aux:
        values: '{"objects":{"encryptionKey":"myEncryptionKey","includeStatistics":false,"exportObjects":[{"_comment":"CPADMIN
          Schema","schema":"CPADMIN"}]},"caches":["DVxxxx","DVyyyy"]}'

2. Run the following command to pass the values.yaml values in cpd-cli.
   • Replace <cpd_import_name> with the name of the export to create. The name of the export in the following examples is myexport1.

   cpd-cli export-import export create <cpd_export_name> \
   --profile=cpadmin \
   --service-type dv \
   --instance-name ${service_instance_name}  \
   --namespace ${SERVICE_INSTANCE_NAMESPACE} \
   --values values.yaml \
   --backoff-limit 0

   Example:

   cpd-cli export-import export create myexport1 \
   --profile=cpadmin \
   --service-type dv \
   --instance-name ${service_instance_name}  \
   --namespace ${SERVICE_INSTANCE_NAMESPACE} \
   --values values.yaml \
   --backoff-limit 0

   The name of the export data prints.

   Note: To check the name of the exported data, use the export list command. See export-import export list.
3. Check whether the export job succeeded, failed, or is still in active progress by running this command:

   cpd-cli export-import export status myexport1 \
   --namespace=${PROJECT_CPD_INST_OPERANDS} \
   --profile=${CPD_PROFILE_NAME} \
   --arch=${CPU_ARCH}

4. Download the exported data from IBM Software Hub to a compressed TAR file in the current working directory:

   cpd-cli export-import export download myexport1 \
   --namespace=${PROJECT_CPD_INST_OPERANDS} \
   --profile=${CPD_PROFILE_NAME} \
   --arch=${CPU_ARCH}

• To troubleshoot cpd-cli specific migration errors, see Troubleshooting data migration errors in Data Virtualization.
• For a list of all the cpd-cli commands for export and import, see export-import.
• For more information on options, see the Option section in cpd-cli command syntax conventions.
• For more information on migrating data between IBM Software Hub installations, see Migrating data between IBM Software Hub installations.