ソース構成テンプレート

有効な各ソースの構成ファイル形式および各構成パラメータの用途について学習します。

JSONファイル

NoSQL Data MigratorのソースとしてのJSONファイルの構成ファイル形式を次に示します。

構成テンプレート

"source" : {
  "type" : "file",
  "format" : "json",
  "dataPath": "</path/to/a/json/file>"
}

ソース・パラメータ

type

  • 用途: ソース・タイプを識別します。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例: "type" : "file"

format

  • 用途: ソースの形式を指定します。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例: "format" : "json"

dataPath

  • 用途: 移行するJSONデータを含むファイルまたはディレクトリへの絶対パスを指定します。

    このデータがシンクで定義されているNoSQL表スキーマと一致することを確認する必要があります。ディレクトリを指定すると、NoSQL Data Migratorによって、そのディレクトリ内の拡張子が.jsonのすべてのファイルが移行対象として識別されます。サブディレクトリはサポートされていません。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例:
    • JSONファイルの指定

      "dataPath" : "/home/user/sample.json"

    • ディレクトリの指定

      "dataPath" : "/home/user"

MongoDB形式のJSONファイル

NoSQL Data MigratorのソースとしてのMongoDB形式のJSONファイルの構成ファイル形式を次に示します。

構成テンプレート

"source" : {
    "type" : "file",
    "format" : "mongodb_json",
    "dataPath": "</path/to/a/json/file>"
}

ソース・パラメータ

type

  • 用途: ソース・タイプを識別します。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例: "type" : "file"

format

  • 用途: ソースの形式を指定します。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例: "format" : "mongodb_json"

dataPath

  • 用途: MongoDBにエクスポートされた、移行するJSONデータを含むファイルまたはディレクトリへの絶対パスを指定します。

    mongoexportツールを使用してこれらのファイルを生成しておく必要があります。詳細は、mongoexportを参照してください。

    mongoexportツールを使用して正規モードまたは緩和モードで生成されるMongoDB形式のJSONファイルを指定できます。どちらのモードも、移行のためにNoSQL Data Migratorでサポートされています。

    ディレクトリを指定すると、NoSQL Data Migratorによって、そのディレクトリ内の拡張子が.jsonのすべてのファイルが移行対象として識別されます。サブディレクトリはサポートされていません。このデータがシンクで定義されているNoSQL表スキーマと一致することを確認する必要があります。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例:
    • MongoDB形式のJSONファイルの指定

      "dataPath" : "/home/user/sample.json"

    • ディレクトリの指定

      "dataPath" : "/home/user"

Oracle NoSQL Database

NoSQL Data MigratorのソースとしてのOracle NoSQL Databaseの構成ファイル形式を次に示します。

構成テンプレート


"source" : {
    "type": "nosqldb",
    "table" : "<fully qualified table name>",
    "storeName" : "<store name>",
    "helperHosts" : ["hostname1:port1","hostname2:port2,..."],
    "security" : "</path/to/store/security/file>",
    "requestTimeoutMs" : 5000
}

type

  • 用途: ソース・タイプを識別します。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例: "type" : "nosqldb"

table

  • 用途: データの移行元の完全修飾表名。

    形式: [namespace_name:]<table_name>

    表がDEFAULTネームスペースにある場合は、namespace_nameを省略できます。この表はストアに存在する必要があります。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例:
    • DEFAULTネームスペース"table" :"mytable"を使用する場合

    • デフォルト以外のネームスペース"table" : "mynamespace:mytable"を使用する場合

storeName

  • 用途: Oracle NoSQL Databaseストアの名前。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例: "storeName" : "kvstore"

helperHosts

  • 用途: hostname:port形式のホストとレジストリ・ポートのペアのリスト。カンマを使用してリスト内の各アイテムを区切ります。ヘルパー・ホストを1つ以上指定する必要があります。

  • データ型: 文字列の配列
  • 必須(Y/N): Y
  • 例: "helperHosts" : ["localhost:5000","localhost:6000"]

security

  • 用途:

    ストアがセキュアなストアの場合は、ストア資格証明を含むセキュリティ・ログイン・ファイルへの絶対パスを指定します。セキュリティ・ログイン・ファイルの詳細は、管理者ガイドリモート・アクセスでのセキュリティの構成を参照してください。

    パスワード・ファイル・ベースの認証またはウォレット・ベースの認証のいずれかを使用できます。ただし、ウォレット・ベースの認証は、Oracle NoSQL DatabaseのEnterprise Edition (EE)でのみサポートされます。

    Community Edition (CE)エディションでは、パスワード・ファイル・ベースの認証のみがサポートされます。

    ウォレットを使用して認証するには、EEインストールの一部である追加のjarファイルが必要です。

    これらのjarファイルがない場合は、次の例外が発生します。

    java.lang.NoClassDefFoundError: oracle/security/pki/OracleSecretStoreException

    前述の例外を回避するには、EEサーバー・パッケージからnosql-migrator-1.0.0/libディレクトリに次のjarファイルをコピーする必要があります。
    • oraclepki.jar
    • osdt_core.jar
    • osdt_cert.jar
  • データ型: 文字列
  • 必須(Y/N): Y (セキュアなストアの場合)
  • 例:

    "security" : "/home/user/client.credentials"

    パスワード・ファイル・ベースの認証のセキュリティ・ファイルの内容の例:

    oracle.kv.password.noPrompt=true
    oracle.kv.auth.username=admin
    oracle.kv.auth.pwdfile.file=/home/nosql/login.passwd
    oracle.kv.transport=ssl
    oracle.kv.ssl.trustStore=/home/nosql/client.trust
    oracle.kv.ssl.protocols=TLSv1.2,TLSv1.1,TLSv1
    oracle.kv.ssl.hostnameVerifier=dnmatch(CN\=NoSQL)

    ウォレット・ベースの認証のセキュリティ・ファイルの内容の例:

    oracle.kv.password.noPrompt=true
    oracle.kv.auth.username=admin
    oracle.kv.auth.wallet.dir=/home/nosql/login.wallet
    oracle.kv.transport=ssl
    oracle.kv.ssl.trustStore=/home/nosql/client.trust
    oracle.kv.ssl.protocols=TLSv1.2,TLSv1.1,TLSv1
    oracle.kv.ssl.hostnameVerifier=dnmatch(CN\=NoSQL)

requestTimeoutMs

  • 用途: ストアからの各読取り操作が完了するまで待機する時間を指定します。これはミリ秒単位で指定します。デフォルト値は5000です。値には任意の正の整数を指定できます。

  • データ型: 整数
  • 必須(Y/N): N
  • 例: "requestTimeoutMs" : 5000

Oracle NoSQL Database Cloud Service

NoSQL Data MigratorのソースとしてのOracle NoSQL Database Cloud Serviceの構成ファイル形式を次に示します。

構成テンプレート

"source" : {
  "type" : "nosqldb_cloud",
  "endpoint" : "<Oracle NoSQL Cloud Service Endpoint. You can either specify  the complete URL or the Region ID alone.>",
  "table" : "<table name>",
  "compartment" : "<OCI compartment name or id>",
  "credentials" : "</path/to/oci/credential/file>",
  "credentialsProfile" : "<oci credentials profile name>",
  "readUnitsPercent" : <table readunits percent>,
  "requestTimeoutMs" : <timeout in milli seconds>
}

type

  • 用途: ソース・タイプを識別します。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例: "type" : "nosqldb_cloud"

endpoint

  • 用途: Oracle NoSQL Database Cloud Serviceのサービス・エンドポイントを指定します。

    完全なURLまたはリージョンIDのみを指定できます。Oracle NoSQL Database Cloud Serviceでサポートされているデータ・リージョンのリストは、Oracle NoSQL Database Cloud Serviceの使用データ・リージョンと関連サービスのURLを参照してください。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例:
    • リージョンID: "endpoint" : "us-ashburn-1"

    • URL形式: "endpoint" : "https://nosql.us-ashburn-1.oci.oraclecloud.com/"

table

  • 用途: データの移行元となる表の名前。

  • データ型: 文字列
  • 必須(Y/N): Y
  • 例: "table" :"myTable"

compartment

  • 用途: 表が存在するコンパートメントの名前またはOCIDを指定します。

    値を指定しない場合は、デフォルトでルート・コンパートメントに設定されます。

    コンパートメントのOCIDは、OCI Cloudコンソールの「Governance」のコンパートメント・エクスプローラ・ウィンドウから確認できます。

  • データ型: 文字列
  • 必須(Y/N): Y (表がテナンシのルート・コンパートメントにない場合)。
  • 例:
    • コンパートメント名

      "compartment" : "mycompartment"

    • 親コンパートメントで修飾されたコンパートメント名

      "compartment" : "parent.childcompartment"

    • 値が未指定。デフォルトはルート・コンパートメントです。

      "compartment": ""

    • コンパートメントOCID

      "compartment" : "ocid1.tenancy.oc1...4ksd"

credentials

  • 用途: OCI資格証明を含むファイルへの絶対パス。

    指定しない場合は、デフォルトで$HOME/.oci/configに設定されます。

    資格証明ファイルの例は、構成例を参照してください。

  • データ型: 文字列
  • 必須(Y/N): N
  • 例:
    1. "credentials" : "/home/user/.oci/config"
    2. "credentials" : "/home/user/security/config"

credentialsProfile

  • 用途: Oracle NoSQL Database Cloud Serviceへの接続に使用される構成プロファイルの名前。

    この値を指定しない場合は、デフォルトでDEFAULTプロファイルに設定されます。

  • データ型: 文字列
  • 必須(Y/N): N
  • 例:
    1. "credentialsProfile" : "DEFAULT"
    2. "credentialsProfile": "ADMIN_USER"

readUnitsPercent

  • 用途: NoSQL表の移行中に使用される表読取りユニットの割合。

    デフォルト値は90です。有効範囲は1から100の任意の整数です。データの移行に必要な時間は、この属性に正比例することに注意してください。移行アクティビティの表の読取りスループットを向上させることをお薦めします。移行プロセスの完了後に読取りスループットを減らすことができます。

    スループット変更の日次制限の詳細は、Oracle NoSQL Database Cloud Serviceの使用クラウド制限を参照してください。

    デフォルト値は90です。有効範囲は1から100の任意の整数です。

    注意:

    データ移行に必要な時間は、writeUnitsPercent値に正比例します。

    この属性を使用してデータ移行速度を向上させる方法の詳細は、NoSQL Data Migratorのトラブルシューティングを参照してください。

  • データ型: 整数
  • 必須(Y/N): N
  • 例: "readUnitsPercent" : 90

requestTimeoutMs

  • 用途: シンク内の各読取り操作が完了するまで待機する時間を指定します。これはミリ秒単位で指定します。デフォルト値は5000です。値には任意の正の整数を指定できます。

  • データ型: 整数
  • 必須(Y/N): N
  • 例: "requestTimeoutMs" : 5000