パラメータ

NoSQL Database Migratorには、移行アクティビティを実行するためのすべてのパラメータを定義する構成ファイルが必要です。いくつかのパラメータは複数のソースとシンクに共通しています。このトピックでは、これらの共通パラメータのリストを示します。個々のソースまたはシンクに固有のその他のパラメータのリストについては、対応する構成テンプレートのセクションを参照してください。

共通の構成パラメータ

次に、共通の構成パラメータを示します。例については、個々の構成テンプレートのセクションを参照してください。

bucket

目的: ソース/シンク・オブジェクトを含むOCIオブジェクト・ストレージ・バケットの名前を指定します。

必要なバケットがOCIオブジェクト・ストレージ・インスタンスにすでに存在し、読取り/書込み権限があることを確認してください。
データ型: 文字列
必須(Y/N): Y

chunkSize

用途: シンクに格納される表データのchunkの最大サイズを指定します。値はMB単位です。移行中、表はchunkSizeのチャンクに分割され、各チャンクは別個のファイルとしてシンクに書き込まれます。移行するソース・データがchunkSize値を超えると、新しいファイルが作成されます。

指定しない場合、デフォルトは32MBです。有効な値は1から1024までの整数です。
データ型: 整数
必須(Y/N): N

credentials

用途: OCI資格証明を含むファイルへの絶対パスを指定します。NoSQL Database Migratorは、このファイルを使用して、Oracle NoSQL Database Cloud Service、OCIオブジェクト・ストレージなどのOCIサービスに接続します。

デフォルト値は$HOME/.oci/configです

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

ノート:
1つの認証オプションのみを選択できます。そのため、構成テンプレート内で、パラメータcredentials、useInstancePrincipal、useDelegationToken、useSessionTokenまたはuseOKEWorkloadIdentityのどれかのみを指定します。
データ型: 文字列
必須(Y/N): N

credentialsProfile

用途: Oracle NoSQL Database Cloud Service、OCIオブジェクト・ストレージなどのOCIサービスに接続するために使用する構成プロファイルの名前を指定します。ユーザー・アカウント資格証明は、プロファイルと呼ばれます。

この値を指定しない場合、NoSQL Database MigratorはDEFAULTプロファイルを使用します。

ノート:
このパラメータは、credentialsパラメータが指定されている場合のみ有効です。
データ型: 文字列
必須(Y/N): N

endpoint

用途: 次のいずれかを指定します:
- OCIオブジェクト・ストレージ・サービスのサービス・エンドポイントURLまたはリージョンID。
  OCIオブジェクト・ストレージ・サービス・エンドポイントのリストは、オブジェクト・ストレージ・エンドポイントを参照してください。
- Oracle NoSQL Database Cloud Serviceのサービス・エンドポイントURLまたはリージョンID。
  完全なURLまたはリージョンIDのみを指定できます。Oracle NoSQL Database Cloud Serviceでサポートされているデータ・リージョンのリストは、Oracle NoSQL Database Cloud Serviceドキュメントのデータ・リージョンおよび関連するサービスURLを参照してください。
データ型: 文字列
必須(Y/N): Y

format

用途: ソース/シンクの形式を指定します。
データ型: 文字列
必須(Y/N): Y

namespace

用途: OCIオブジェクト・ストレージ・サービスのネームスペースを指定します。これはオプション・パラメータです。このパラメータを指定しなかった場合、マイグレータ・ユーティリティでは、テナンシに割り当てられているネームスペースが使用されます。

たとえば、ネームスペース・パラメータは、ご使用のテナンシとは異なるテナンシからOCI OSを使用する必要がある場合に役立ちます。このような場合、OCI OSテナンシのネームスペースは、ご使用のテナンシのネームスペースとは異なります。特に指定されていなければ、移行中に、マイグレータ・ユーティリティによって、ご使用のテナンシのネームスペースがデフォルトに設定されます。そのため、OCI OSテナンシのネームスペースを選択するようにマイグレータ・ユーティリティに指示するには、ネームスペース・パラメータでOCI OSテナンシの名前を指定する必要があります。
データ型: 文字列
必須(Y/N): N

prefix

用途: 接頭辞は、OCIオブジェクト・ストレージ・バケットにデータを格納するための論理コンテナまたはディレクトリとして機能します。
- ソース構成テンプレート: prefixパラメータが指定されている場合、prefixパラメータで指定されたディレクトリのすべてのオブジェクトが移行されます。それ以外の場合は、バケットに存在するすべてのオブジェクトが移行されます。
- シンク構成テンプレート: prefixパラメータが指定されている場合、指定した接頭辞を持つディレクトリがバケットに作成され、オブジェクトがこのディレクトリに移行されます。それ以外の場合は、ソースの表名が接頭辞として使用されます。同じ名前のオブジェクトがバケットにすでに存在する場合、そのオブジェクトは上書きされます。
接頭辞の詳細は、接頭辞および階層を使用したオブジェクト・ネーミングに関する項を参照してください。
データ型: 文字列
必須(Y/N): N

requestTimeoutMs

用途: ストアからの各読取り操作およびストアへの各書込み操作が完了するまで待機する時間を指定します。これはミリ秒単位で指定します。デフォルト値は5000です。値には任意の正の整数を指定できます。
データ型: 整数
必須(Y/N): N

security

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

パスワード・ファイル・ベースの認証またはウォレット・ベースの認証のいずれかを使用できます。ただし、ウォレット・ベースの認証は、Oracle NoSQL DatabaseのEnterprise Edition (EE)でのみサポートされます。ウォレット・ベースの認証の詳細は、「ソースおよびシンク・セキュリティ」を参照してください。

Community Edition (CE)エディションでは、パスワード・ファイル・ベースの認証のみがサポートされます。
データ型: 文字列
必須(Y/N): Y, (セキュアなストアの場合)

type

用途: ソース/シンク・タイプを識別します。
データ型: 文字列
必須(Y/N): Y

useDelegationToken

用途: NoSQL Database Migratorツールが委任トークン認証を使用してOCIサービスに接続するかどうかを指定します。クラウド・シェルから移行ユーティリティを実行するには、委任トークン認証を使用する必要があります。委任トークンは、クラウド・シェルの起動時にユーザーに対して自動的に作成されます。

デフォルト値は、falseです。
データ型: ブール

必須(Y/N): N

ノート:

委任トークンを使用した認証は、NoSQL Database Migratorツールがクラウド・シェルから実行されている場合にのみサポートされます。
1つの認証オプションのみを選択できます。そのため、構成テンプレート内で、パラメータcredentials、useInstancePrincipal、useDelegationToken、useSessionTokenまたはuseOKEWorkloadIdentityのどれかのみを指定します。

クラウド・シェルでは、次のソースとシンク間の移行のみがサポートされます。

タイプ	有効なソース	有効なシンク
Oracle NoSQL Database Cloud Service (`nosqldb_cloud`)	Y	Y
ファイル(ホーム・ディレクトリのJSONファイル)	Y	Y
OCIオブジェクト・ストレージ(JSONファイル) (`object_storage_oci`)	Y	Y
OCIオブジェクト・ストレージ(Parquetファイル) (`object_storage_oci`)	N	Y

useInstancePrincipal

用途: NoSQL Database Migratorツールでインスタンス・プリンシパル認証を使用して、Oracle NoSQL Database Cloud Service、OCI Object StorageなどのOCIサービスに接続するかどうかを指定します。インスタンス・プリンシパル認証方法の詳細は、「ソースおよびシンク・セキュリティ」を参照してください。

デフォルト値は、falseです。
ノート:
- インスタンス・プリンシパルでの認証は、OCIでホストされているVMで実行されているNoSQL Database Migratorツールなど、OCIコンピュート・インスタンス内でNoSQL Database Migratorツールが実行されている場合のみサポートされます。
- 1つの認証オプションのみを選択できます。そのため、構成テンプレート内で、パラメータcredentials、useInstancePrincipal、useDelegationToken、useSessionTokenまたはuseOKEWorkloadIdentityのどれかのみを指定します。
データ型: ブール
必須(Y/N): N

useOKEWorkloadIdentity

用途: NoSQL Database Migratorツールでワークロード・アイデンティティ認証(WIA)を使用してOracle Kubernetes Engine (OKE)ポッドからOCIオブジェクト・ストレージおよびOracle NoSQL Database Cloud Serviceにアクセスするかどうかを指定します。
デフォルト値は、falseです。
データ型: ブール
必須(Y/N): N

サンプル・ユースケースについては、OKE認証の使用によるOCIオブジェクト・ストレージからOracle NoSQL Database Cloud Serviceへの移行を参照してください。

ノート:

1つの認証オプションのみを選択できます。そのため、構成テンプレート内で、パラメータcredentials、useInstancePrincipal、useDelegationToken、useSessionTokenおよびuseOKEWorkloadIdentityのどれかのみを指定します。

useSessionToken

用途: NoSQL Database Migratorツールでセッション・トークン認証を使用してOCIオブジェクト・ストレージ(OCI OS)やOracle NoSQL Database Cloud ServiceなどのOCIサービスに接続するかどうかを指定します。デフォルト値は、falseです。
データ型: ブール
必須(Y/N): N

セッション・トークンベースの認証を使用するには、OCIコマンドライン・インタフェース(CLI)のコマンドを使用してセッション・トークンを生成する必要があります。サンプル・ユースケースについては、「セッション・トークン認証の使用によるOracle NoSQL DatabaseからOCIオブジェクト・ストレージへの移行」を参照してください。

ノート:

セッション・トークン認証の使用中は、credentialsパラメータでOCI構成ファイルへのパスを指定し、credentialsProfileパラメータで、セッション・トークンの生成中に使用されるプロファイルを指定する必要があります。構成テンプレート内でcredentialsパラメータを設定しなかった場合、マイグレータ・ユーティリティでは、パス$HOME/.ociにある資格証明ファイルが検索されます。構成テンプレート内でcredentialsProfileパラメータを指定しなかった場合、マイグレータ・ユーティリティでは、OCI構成ファイルにあるデフォルト・プロファイル名(DEFAULT)が使用されます。

マイグレータ・ユーティリティで資格証明ファイルが見つからなかった場合は、移行に失敗し、OCI資格証明ファイルが存在しないことを示すエラー・メッセージが表示されます。
1つの認証オプションのみを選択できます。そのため、構成テンプレート内で、パラメータcredentials、useInstancePrincipal、useDelegationToken、useSessionTokenまたはuseOKEWorkloadIdentityのどれかのみを指定します。