This example shows how to use the Oracle NoSQL Database Migrator to copy data and the schema definition of a NoSQL table from Oracle NoSQL Database Cloud Service (NDCS) to a JSON file.

1. Open the command prompt and navigate to the directory where you extracted the NoSQL Database Migrator utility.
2. To generate the configuration file using the NoSQL Database Migrator, run the runMigrator command without any runtime parameters.

   [~/nosqlMigrator]$./runMigrator

3. As you did not provide the configuration file as a runtime parameter, the utility prompts if you want to generate the configuration now. Type y.

   Configuration file is not provided. Do you want to generate
   configuration? (y/n) [n]: y
   
   Generating a configuration file interactively.
   
   

4. Based on the prompts from the utility, choose your options for the Source configuration.

   Enter a location for your config [./migrator-config.json]: /home/<user>/nosqlMigrator/NDCS2JSON
   Select the source: 
   1) nosqldb
   2) nosqldb_cloud
   3) file
   4) object_storage_oci
   5) aws_s3
   #? 2
   
   Configuration for source type=nosqldb_cloud
   Enter endpoint URL or region ID of the Oracle NoSQL Database Cloud: us-phoenix-1
   Select the authentication type: 
   1) credentials_file
   2) instance_principal
   3) delegation_token
   #? 1
   Enter path to the file containing OCI credentials [/home/<user>/.oci/config]:
   Enter the profile name in OCI credentials file [DEFAULT]: 
   Enter the compartment name or id of the table []: developers
   Enter table name: myTable
   Include TTL data? If you select 'yes' TTL of rows will also 
   be included in the exported data.(y/n) [n]: 
   Enter percentage of table read units to be used for migration operation. (1-100) [90]:
   Enter store operation timeout in milliseconds. (1-30000) [5000]:

5. Based on the prompts from the utility, choose your options for the Sink configuration.

   Select the sink:
   1) nosqldb
   2) nosqldb_cloud
   3) file
   #? 3
   Configuration for sink type=file
   Enter path to a directory to store JSON data: /home/<user>/nosqlMigrator
   would you like to export data to multiple files for each source?(y/n) [y]: n
   Would you like to store JSON in pretty format? (y/n) [n]: y
   Would you like to migrate the table schema also? (y/n) [y]: y
   Enter path to a file to store table schema: /home/<user>/nosqlMigrator/myTableSchema

6. Based on the prompts from the utility, choose your options for the source data transformations. The default value is n.

   Would you like to add transformations to source data? (y/n) [n]:

7. Enter your choice to determine whether to proceed with the migration in case any record fails to migrate.

   Would you like to continue migration in case of any record/row is failed to migrate?: (y/n) [n]:
   

8. The utility displays the generated configuration on the screen.

   generated configuration is:
   {
     "source": {
       "type": "nosqldb_cloud",
       "endpoint": "us-phoenix-1",
       "table": "myTable",
       "compartment": "developers",
       "credentials": "/home/<user>/.oci/config",
       "credentialsProfile": "DEFAULT",
       "readUnitsPercent": 90,
       "requestTimeoutMs": 5000
     },
     "sink": {
       "type": "file",
       "format": "json",
       "useMultiFiles" : false,
       "schemaPath": "/home/<user>/nosqlMigrator/myTableSchema",
       "pretty": true,
       "dataPath": "/home/<user>/nosqlMigrator"
     },
     "abortOnError": true,
     "migratorVersion": "1.6.5"
   }

9. Finally, the utility prompts for your choice to decide whether to proceed with the migration with the generated configuration file or not. The default option is y.

   Note:

   If you select n, you can use the generated configuration file to run the migration using the ./runMigrator -c or the ./runMigrator --config option.

   would you like to run the migration with above configuration?
   If you select no, you can use the generated configuration file to run the migration using
   ./runMigrator --config /home/<user>/nosqlMigrator/NDCS2JSON
   (y/n) [y]:

10. The NoSQL Database Migrator migrates your data and schema from NDCS to the JSON file.

    Records provided by source=10,Records written to sink=10,Records failed=0,Records skipped=0.
    Elapsed time: 0min 1sec 277ms
    Migration completed.

-- Exported myTable Data. JSON files are created in the supplied data path
 
[~/nosqlMigrator]$cat myTable_1_5.json
{
  "id" : 10,
  "document" : {
    "course" : "Computer Science",
    "name" : "Neena",
    "studentid" : 105
  }
}
{
  "id" : 3,
  "document" : {
  "course" : "Computer Science",
    "name" : "John",
    "studentid" : 107
  }
}
{
  "id" : 4,
  "document" : {
    "course" : "Computer Science",
    "name" : "Ruby",
    "studentid" : 100
  }
}
{
  "id" : 6,
  "document" : {
    "course" : "Bio-Technology",
    "name" : "Rekha",
    "studentid" : 104
  }
}
{
  "id" : 7,
  "document" : {
    "course" : "Computer Science",
    "name" : "Ruby",
    "studentid" : 100
  }
}
{
  "id" : 5,
  "document" : {
    "course" : "Journalism",
    "name" : "Rani",
    "studentid" : 106
  }
}
{
  "id" : 8,
  "document" : {
    "course" : "Computer Science",
    "name" : "Tom",
    "studentid" : 103
  }
}
{
  "id" : 9,
  "document" : {
    "course" : "Computer Science",
    "name" : "Peter",
    "studentid" : 109
  }
}
{
  "id" : 1,
  "document" : {
    "course" : "Journalism",
    "name" : "Tracy",
    "studentid" : 110
  }
}
{
  "id" : 2,
  "document" : {
    "course" : "Bio-Technology",
    "name" : "Raja",
    "studentid" : 108
  }
}

-- Exported myTable Schema
 
[~/nosqlMigrator]$cat myTableSchema
CREATE TABLE IF NOT EXISTS myTable (id INTEGER, document JSON, PRIMARY KEY(SHARD(id)))