realm-cli v1

CLI ユーザーの認証

MongoDB Atlas プログラム API キーで MongoDB Cloud ユーザーを認証するには、 realm-cli loginを使用します。

realm-cli login --api-key="<my api key>" --private-api-key="<my private api key>"

--api-key <api key>

ログインする MongoDB Cloud アカウントの有効な公開 MongoDB Atlasプログラム API キー。

--private-api-key <private api key>

ログインする MongoDB Cloud アカウントの有効なプライベート MongoDB Atlasプログラム API キー。

--username <MongoDB Cloud username>

（非推奨）個人 API キーを使用してログインする MongoDB Cloud アカウントのユーザー名。

現在の CLI ユーザーのログアウト

現在ログインしているユーザーをログアウトするには、 realm-cli logoutを使用します。

realm-cli logout

現在ログインしているユーザーの表示

現在 CLI にログインしているユーザーの詳細を表示するには、 realm-cli whoamiを使用します（該当する場合）。

realm-cli whoami

現在ログインしているユーザーが存在する場合、その情報は次の形式の次の行に表示されます。

<username> [API Key: ********-****-****-****-<last 12 digits of API key>]

ログインしているユーザーがいない場合、 realm-cliは次のメッセージを返します。

no user info available

アプリケーションのインポート

ローカル アプリケーション ディレクトリをホスト型アプリにインポートするには、 realm-cli importを使用します。 存在しないアプリケーションにディレクトリをインポートすると、 realm-cliはアプリケーションを作成できます。

realm-cli import \
  --app-id=myapp-abcde \
  --path=./path/to/app/dir \
  --strategy=merge \
  --include-hosting \
  --include-dependencies

--app-id <App Services Application ID>

Optional.

アプリのアプリケーションID。

指定しない場合、 realm-cliはconfig.jsonで定義されているapp_idの値を使用しようとします。 config.jsonにapp_id値がない場合、 realm-cliは新しいアプリケーションを作成するように要求します。

注意

新しいアプリケーション・アプリID

realm-cliを使用して新しいアプリケーションを作成すると、App Services は新しいアプリ ID を生成し、 --app-idフラグに指定した値を無視します。

--path <path>

Optional.

The path to the directory containing files you wish to import. ディレクトリには少なくとも有効なconfig.jsonファイルが含まれている必要があります。

path引数が省略されている場合、 realm-cliは現在のアプリケーション ディレクトリでconfig.jsonファイルを検索します。

--strategy ['merge|replace|replace-by-name']

Optional.

Default: Merge

インポートされたエンティティを調整するときにrealm-cliが使用する必要があるインポート戦略。

--project-id <MongoDB Cloud Project ID>

Optional.

新しく作成したアプリをホストするAtlas プロジェクトの Project ID 。 指定すると、 realm-cliでは新しいアプリの作成時にプロジェクトを選択するよう求められません。

注意

realm-cli は、新しいアプリケーションをインポートしない限り、 --project-idの値を無視します。

--include-hosting

Optional.

指定した場合、 は静的アセットをアプリの/hosting/filesディレクトリにアップロードして配置します。

--include-dependencies

Optional.

この場合、 は、アプリの/functionsディレクトリのnode_modulesアーカイブに含まれるすべての外部依存関係をアップロードして配置します。

アプリケーションのエクスポート

アプリ構成をローカル アプリケーション ディレクトリに保存するには、 realm-cli exportを使用します。

realm-cli export \
  --app-id=myRealmApp-abcde \
  --output=path/to/exported/app/dir \
  --include-hosting \
  --as-template

--app-id <App Services Application ID>

Optional.

アプリのアプリケーションID。

--output <path>

Optional.

App Services がアプリケーションをエクスポートするディレクトリのパス。

この場合、 realm-cliは指定されたパスにディレクトリを作成し、アプリケーション構成を新しいディレクトリにエクスポートします。 指定したパスにファイルまたはディレクトリがすでに存在する場合、エクスポートは失敗します。

注意

output引数が省略されている場合、 realm-cliは現在の作業ディレクトリ内の新しいディレクトリにアプリケーション構成をエクスポートします。

--include-hosting

Optional.

このオプションを指定すると、 はアプリのhosting/filesディレクトリでホストされているすべての静的アセットをエクスポートします。

--for-source-control

Optional.

有効にすると、realm-cli はGithubソース管理による配置と競合するフィールドを含まずにアプリケーション構成をエクスポートします。これには、config.json ファイル内の name、app_id、location、deployment_model などのフィールドと、アプリケーションにリンクされたAtlasデータソースの config.json の config.clusterName フィールド。

--as-template

Optional.

有効にすると、 realm-cliはアプリ ID を含むサービス ID 値なしでアプリケーション構成をエクスポートします。 これにより、エクスポートされた構成から新しいアプリケーションを作成することが簡素化されます。

保留中のアプリケーションの変更と差分

配置されたアプリケーションとローカル アプリケーション ディレクトリ間の構成ファイルの差を返すには、 realm-cli diffを使用します。

# Diff application config files
realm-cli diff
# Diff application config files and hosted files
realm-cli diff --include-hosting

差は次のようになります。

--- functions/oldFunctionName/config.json
+++ functions/oldFunctionName/config.json
@@ -1,6 +1 @@
-{
-    "id": "5d4c6a5cd28e555496a705da",
-    "name": "oldFunctionName",
-    "private": false
-}
--- functions/newFunctionName/config.json
+++ functions/newFunctionName/config.json
@@ -1 +1,6 @@
+{
+    "id": "5d4c6a5cd28e555496a705da",
+    "name": "newFunctionName",
+    "private": false
+}
Modified Files:
        * /index.html
        * /auth/confirmEmail.html
        * /auth/resetPassword.html

--include-hosting

Optional.

指定した場合、差分にはアプリのhosting/filesディレクトリ内のアプリのデプロイされたファイルとは異なるファイルのリストが含まれます。

すべてのシークレットを一覧表示する

アプリケーション内の各シークレットの名前と ID を含むリストを返すには、 realm-cli secrets listを使用します。

realm-cli secrets list

返されるシークレットのリストは次のようになります。

ID                       Name
5d5c25415e30c7ef857c6a10 test-secret-please-ignore
5d56dd453b467e2a48a6ec32 some-other-secret

シークレットを作成する

realm-cli secrets addを使用して、指定された名前と値を持つ新しいシークレットを作成します。

realm-cli secrets add --name=mySecret --value=SuperSecretValue!

--name <Secret Name>

新しいシークレットの一意の名前。 既存のシークレットに指定された名前がすでにある場合、この操作は失敗します。

--value <Secret Value>

新しい シークレット の値。

シークレットの値を更新

アプリケーション内の既存のシークレットの値を変更するには、 realm-cli secrets updateを使用します。

# Update a Secret by name
realm-cli secrets update --secret-name=mySecret --value=NewSecretValue
realm-cli secrets update --name=mySecret --value=NewSecretValue
# Update a Secret by name
realm-cli secrets update --secret-id=5ba9c5c2e707c02b38031412 --value=NewSecretValue
realm-cli secrets update --id=5ba9c5c2e707c02b38031412 --value=NewSecretValue

--secret-name <Secret Name>

--name <Secret Name>

更新するシークレットの名前。

--secret-id <Secret ID>

--id <Secret ID>

更新するシークレットの ID 値。

--value <Secret Value>

シークレットの新しい値。

シークレットを削除する

アプリケーションから既存のシークレットを削除するには、 realm-cli secrets removeを使用します。

# Remove a Secret by name
realm-cli secrets remove --secret-name=mySecret
realm-cli secrets remove --name=mySecret
# Remove a Secret by ID
realm-cli secrets remove --secret-id=5ba9c5c2e707c02b38031412
realm-cli secrets remove --id=5ba9c5c2e707c02b38031412

--secret-name <Secret Name>

--name <Secret Name>

アプリから削除するシークレットの名前。

--secret-id <Secret ID>

--id <Secret ID>

アプリから削除するシークレットの ID 値。

merge

realm-cli import --strategy=merge

merge戦略では、アプリケーション ディレクトリ内のエンティティは非破壊的にアプリケーションに追加されます。 アプリケーション内の既存のエンティティは、インポートされたアプリケーション ディレクトリに表現されていない場合は変更されません。

インポートされたエンティティのid値が既存のエンティティのidと一致する場合、既存のエンティティはインポートされたエンティティと一致するように更新されます。 App Services は、 id値がないエンティティに、新しいエンティティとしてインポートする前に、システムによって生成されたid値を割り当てます。

既存のエンティティと一致しないidを使用してエンティティをインポートすると、インポートは失敗します。 非 ObjectID id値を持つエンティティをインポートすると、エラーが発生します。

{ "id": <ObjectID 1>, "name": "FunctionA", ... }
{ "id": <ObjectID 2>, "name": "FunctionB", ... }
{ "id": <ObjectID 3>, "name": "FunctionC", ... }

{ "id": <ObjectID 1>, "name": "FunctionA_Updated!", ... }
{ "name": "FunctionD", ... }

{ "id": <ObjectID 1>, "name": "FunctionA_Updated!" }
{ "id": <ObjectID 2>, "name": "FunctionB", ... }
{ "id": <ObjectID 3>, "name": "FunctionC", ... }
{ "id": <ObjectID 4>, "name": "FunctionD", ... }

置換

realm-cli import --strategy=replace

replace戦略では、インポートされたエンティティのid値が既存のエンティティのidと一致する場合、App Services は既存のエンティティをインポートされたエンティティに置き換えます。 インポートされたエンティティのid値が既存のエンティティと一致しない場合、インポートは失敗します。 既存エンティティのidがインポートされたエンティティのidと一致しない場合、App Services はその既存のエンティティを削除します。

App Services は、 id値を持たないエンティティに対して、新しいエンティティとしてインポートする前にid値を生成します。 非 ObjectID id値を持つエンティティをインポートしても、エラーはスローされません。

{ "id": <ObjectID 1>, "name": "FunctionA", ... }
{ "id": <ObjectID 2>, "name": "FunctionB", ... }
{ "id": <ObjectID 3>, "name": "FunctionC", ... }

{ "id": <ObjectID 1>, "name": "FunctionA_Updated!", ... }
{ "name": "FunctionD", ... }
{ "id": "non-ObjectID-value", "name": "FunctionE", ... }

{ "id": <ObjectID 1>, "name": "FunctionA_Updated!" }
{ "id": <ObjectID 4>, "name": "FunctionD", ... }
{ "id": <ObjectID 5>, "name": "FunctionE", ... }

名前を使用して置換

realm-cli import --strategy=replace-by-name

replace-by-name戦略では、インポートされたエンティティのname値が既存のエンティティのnameと一致する場合、App Services は既存のエンティティをインポートされたエンティティに置き換えます。 インポートされたエンティティのname値が既存のエンティティと一致しない場合、そのエンティティは新しいエンティティになります。 既存エンティティのnameがインポートされたエンティティのnameと一致しない場合、App Services はその既存のエンティティを削除します。

インポートされたエンティティにname値がない場合、 realm-cliはエラーをスローします。

{ "id": <ObjectID 1>, "name": "FunctionA", ... }
{ "id": <ObjectID 2>, "name": "FunctionB", ... }
{ "id": <ObjectID 3>, "name": "FunctionC", ... }

{ "name": "FunctionZ", ... }
{ "name": "FunctionB", ... }
{ "name": "FunctionC", ... }

{ "id": <ObjectID 2>, "name": "FunctionB", ... }
{ "id": <ObjectID 3>, "name": "FunctionC", ... }
{ "id": <ObjectID 4>, "name": "FunctionZ", ... }