Parameters

The NoSQL Database Migrator requires a configuration file where you define all the parameters to perform the migration activity. A few parameters are common across several sources and sinks. This topic provides a list of these common parameters. For the list of other parameters that are unique to individual sources or sinks, see the corresponding configuration template sections.

Common Configuration Parameters

The following are the common configuration parameters. See the individual configuration template sections for examples.

bucket

  • Purpose: Specifies the name of the OCI Object Storage bucket, which contains the source/sink objects.

    Ensure that the required bucket already exists in the OCI Object Storage instance and has read/write permissions.

  • Data Type: string
  • Mandatory (Y/N): Y

chunkSize

  • Purpose: Specifies the maximum size of a chunk of table data to be stored at the sink. The value is in MB. During migration, a table is split into chunkSize chunks and each chunk is written as a separate file to the sink. A new file is created when the source data that is being migrated exceeds the chunkSize value.

    If not specified, defaults to 32MB. The valid value is an integer between 1 to 1024.

  • Data Type: integer
  • Mandatory (Y/N): N

credentials

  • Purpose: Specifies the absolute path to a file containing OCI credentials. The NoSQL Database Migrator uses this file to connect to the OCI service such as Oracle NoSQL Database Cloud Service, OCI Object Storage, and so on.

    The default value is $HOME/.oci/config

    See Example Configuration for an example of the credentials file.

    Note:

    You can select only one of the authentication options. Therefore, specify only one of these parameters - credentials, useInstancePrincipal, useDelegationToken, useSessionToken, or useOKEWorkloadIdentity in the configuration template.
  • Data Type: string
  • Mandatory (Y/N): N

credentialsProfile

  • Purpose: Specifies the name of the configuration profile to be used to connect to the OCI service such as Oracle NoSQL Database Cloud Service, OCI Object Storage, and so on. User account credentials are referred to as a profile.

    If you do not specify this value, the NoSQL Database Migrator uses the DEFAULT profile.

    Note:

    This parameter is valid only if the credentials parameter is specified.
  • Data Type: string
  • Mandatory (Y/N): N

endpoint

  • Purpose: Specifies one of the following:
    • The Service endpoint URL or the Region ID for the OCI Object Storage service.

      For the list of OCI Object Storage service endpoints, see Object Storage Endpoints.

    • The Service endpoint URL or the Region ID for the Oracle NoSQL Database Cloud Service.

      You can either specify the complete URL or the Region ID alone. For the list of data regions supported for Oracle NoSQL Database Cloud Service, see Data Regions and Associated Service URLs in the Oracle NoSQL Database Cloud Service document.

  • Data Type: string
  • Mandatory (Y/N): Y

format

  • Purpose: Specifies the source/sink format.
  • Data Type: string
  • Mandatory (Y/N): Y

namespace

  • Purpose: Specifies the namespace of the OCI Object Storage service. This is an optional parameter. If you don't specify this parameter, the Migrator utility uses the namespace assigned to the tenancy.

    For example, the namespace parameter is helpful when you want to use an OCI OS from a tenancy that is different from yours. In such cases, the OCI OS tenancy’s namespace is different from your tenancy's namespace. During migration, the Migrator utility defaults to your tenancy's namespace unless specified otherwise. Therefore, to direct the Migrator utility to pick OCI OS tenancy's namespace, you must specify OCI OS tenancy's name in the namespace parameter.

  • Data Type: string
  • Mandatory (Y/N): N

prefix

  • Purpose: The prefix acts as a logical container or directory for storing data in the OCI Object Storage bucket.

    • Source configuration template: If the prefix parameter in specified, all the objects from the directory named in the prefix parameter are migrated. Else, all the objects present in the bucket are migrated.
    • Sink configuration template: If the prefix parameter is specified, a directory with the given prefix is created in the bucket and the objects are migrated into this directory. Else, the table name from the source is used as the prefix. If any object with the same name already exists in the bucket, it is overwritten.

    For more information about prefixes, see Object Naming Using Prefixes and Hierarchies.

  • Data Type: string
  • Mandatory (Y/N): N

requestTimeoutMs

  • Purpose: Specifies the time to wait for each read/write operation from/to the store to complete. This is provided in milliseconds. The default value is 5000. The value can be any positive integer.

  • Data Type: integer
  • Mandatory (Y/N): N

security

  • Purpose: Specifies the absolute path to the security login file that contains your store credentials if your store is a secure store. For more information about the security login file, see Configuring Security with Remote Access in the Administrator's Guide.

    You can use either password file based authentication or wallet based authentication. However, the wallet based authentication is supported only in the Enterprise Edition (EE) of Oracle NoSQL Database. For more information on wallet-based authentication, see Source and Sink Security.

    The Community Edition(CE) edition supports password file based authentication only.

  • Data Type: string
  • Mandatory (Y/N): Y, for a secure store

type

  • Purpose: Identifies the source/sink type.
  • Data Type: string
  • Mandatory (Y/N): Y

useDelegationToken

  • Purpose: Specifies whether or not the NoSQL Database Migrator tool uses a delegation token authentication to connect to the OCI services. You must use the delegation token authentication to run the Migrator utility from the Cloud Shell. The delegation token is automatically created for the user when the Cloud Shell is invoked.

    The default value is false.

  • Data Type: boolean
  • Mandatory (Y/N): N

    Note:

    • The authentication with delegation token is supported only when the NoSQL Database Migrator tool is running from a Cloud Shell.
    • You can select only one of the authentication options. Therefore, specify only one of these parameters - credentials, useInstancePrincipal, useDelegationToken, useSessionToken, or useOKEWorkloadIdentity in the configuration template.
    • The Cloud Shell supports migration only between the following sources and sinks:
      Type Valid source Valid sink

      Oracle NoSQL Database Cloud Service

      (nosqldb_cloud)

      		Y Y
      File (JSON file in the home directory) Y Y

      OCI Object Storage (JSON file)

      (object_storage_oci)

      		Y Y

      OCI Object Storage (Parquet file)

      (object_storage_oci)

      		N Y

useInstancePrincipal

  • Purpose: Specifies whether or not the NoSQL Database Migrator tool uses instance principal authentication to connect to the OCI service such as Oracle NoSQL Database Cloud Service, OCI Object Storage, and so on. For more information on Instance Principal authentication method, see Source and Sink Security.

    The default value is false.

    Note:

    • The authentication with Instance Principals is supported only when the NoSQL Database Migrator tool is running within an OCI compute instance, for example, the NoSQL Database Migrator tool running in a VM hosted on OCI.
    • You can select only one of the authentication options. Therefore, specify only one of these parameters - credentials, useInstancePrincipal, useDelegationToken, useSessionToken, or useOKEWorkloadIdentity in the configuration template.
  • Data Type: boolean
  • Mandatory (Y/N): N

useOKEWorkloadIdentity

  • Purpose: Specifies whether or not the NoSQL Database Migrator tool uses Workload Identity Authentication (WIA) to access OCI Object Storage and Oracle NoSQL Database Cloud Service from an Oracle Kubernetes Engine (OKE) pod.

    The default value is false.

  • Data Type: boolean
  • Mandatory (Y/N): N

For a sample use case, see Migrate from OCI Object Storage to Oracle NoSQL Database Cloud Service Using OKE Authentication.

Note:

You can select only one of the authentication options. Therefore, specify only one of these parameters - credentials, useInstancePrincipal, useDelegationToken, useSessionToken, or useOKEWorkloadIdentity in the configuration template.

useSessionToken

  • Purpose: Specifies whether or not the NoSQL Database Migrator tool uses a session token authentication to connect to OCI services such as OCI Object Storage (OCI OS) and Oracle NoSQL Database Cloud Service. The default value is false.
  • Data Type: boolean
  • Mandatory (Y/N): N

To use the session token-based authentication, you must generate a session token using OCI Command Line Interface (CLI) commands.. For a sample use case, see Migrate from Oracle NoSQL Database to OCI Object Storage Using Session Token Authentication.

Note:

  • While using session token authentication, you must specify the path to the OCI config file in the credentials parameter and the profile used while generating the session token in the credentialsProfile parameter. If you don't set the credentials parameter in configuration template, the Migrator utility looks for the credentials file in the path $HOME/.oci . If you don't set the credentialsProfile parameter in configuration template, the Migrator utility uses the default profile name (DEFAULT) from the OCI config file.

    If the Migrator utility is unable to find the credentials file, the migration fails with an error message conveying the non-existence of the OCI credential file.

  • You can select only one of the authentication options. Therefore, specify only one of these parameters - credentials, useInstancePrincipal, useDelegationToken, useSessionToken, or useOKEWorkloadIdentity in the configuration template.