快速开始_MonogDB 中文网

MongoDB 工具

MongoDB工具 >MongoDB命令行界面 > 快速开始

在本页面

先决条件

MongoDB CLI提供了一个命令行界面，用于管理您的 MongoDB Atlas，MongoDB Cloud Manager和MongoDB Ops Manager项目和集群。本教程演示如何：

下载，安装和配置MongoDB CLI
在Atlas，Cloud Manager或Ops Manager项目中创建集群
为Atlas集群创建白名单和MongoDB用户
检索有关新集群的详细信息

参考部分中提供了本教程中提到的CLI的参考页。

前提条件¶

本教程要求以下内容：

一个MongoDB帐户
一个阿特拉斯，云管理器，或行动经理组织项目

下载并安装MongoDB CLI¶

有两种安装MongoDB CLI的方法。您可以：

克隆MongoDB CLI git存储库
下载二进制文件

请参阅安装MongoDB的CLI上下载并安装MongoDB的CLI的信息。安装MongoDB CLI后，运行以下命令以验证安装：

复制

mongocli help

生成编程访问密钥¶

MongoDB CLI使用编程访问键来访问Atlas，Cloud Manager或Ops Manager项目。您的Programmatic API密钥必须具有该角色，并且必须将其列入IP地址或CIDR范围的白名单。要了解有关生成Programmatic API密钥的更多信息，请参见：project owner

注意

以下部分由MongoDB服务组织。选择您的MongoDB服务的选项卡以继续本教程。

阿特拉斯
云端经理
运营经理

配置MongoDB CLI

您可以使用和命令配置对MongoDB Atlas的MongoDB CLI访问。以下步骤中的命令将创建一个在文件中命名的自定义配置文件，并在该配置文件中设置您的编程API访问密钥和项目ID。您可以将此配置文件与本教程中的所有其他命令一起使用。mongocli configmongocli config setatlasProfile~/.config/mongocli.toml

1个

为Atlas项目创建一个自定义配置文件。¶

运行以下命令以创建配置文件。

复制

mongocli config --profile atlasProfile

要了解有关该命令的更多信息，请参阅 mongocli config或配置MongoDB CLI。mongocli config

在个人资料中设置您的凭据。¶

当命令提示您输入和时，输入您生成的编程API密钥。Public API KeyPrivate API Key

在您的个人资料中设置项目的ID。¶

当命令提示您时，输入您的项目ID。

注意

您可以使用以下命令检索项目列表，包括其ID 。mongocli iam project list

创建集群

您可以使用MongoDB CLI 集群创建命令在Atlas上创建集群。

以下命令使用以下设置创建示例集群：

集群名称： getStarted
服务提供者： AWS
提供者地区： US_EAST-1
实例大小： M10
磁盘大小：2GB
MongoDB版本： 4.2
副本集成员： 3

例

复制

mongocli atlas cluster create getStarted --provider AWS --region US_EAST_1 --instanceSize M10 --diskSizeGB 2 --mdbVersion 4.2 --members 3 --profile atlasProfile

将您的IP地址列入白名单

对于每个项目，您可以创建可信IP地址列表（称为白名单），并从可信IP地址连接到项目中的群集。运行以下命令以将IP地址添加到白名单。

用您的连接IP地址替换IP地址。

复制

mongocli atlas whitelist create <your-IP-address> --type ipAddress --profile atlasProfile

创建一个MongoDB用户

您必须使用dbuser create为Atlas集群创建MongoDB用户。MongoDB用户可以访问Atlas中托管的数据库。运行以下命令以添加MongoDB用户。该命令创建具有以下属性的MongoDB用户：

用户名： myMongoDbUser
密码： myMongoDbUserPwd

注意

本教程使用密码myMongoDbUserPwd。将此密码替换为强密码。
角色：Atlas管理员

复制

mongocli atlas dbuser create --username myMongoDbUser --password myMongoDbUserPwd --role atlasAdmin@admin --profile atlasProfile

检索集群

您可以使用MongoDB CLI通过检索集群详细信息来检查集群是否已成功创建。运行以下命令以检索集群。该命令使用：

指定的配置文件，用于确定包含集群的项目的ID。
配置文件中用于身份验证的程序化API访问密钥。

复制

mongocli atlas cluster describe getStarted --profile atlasProfile

您的命令输出应类似于以下内容：

{
      "autoScaling": {
            "diskGBEnabled": false
      },
      "backupEnabled": false,
      "biConnector": {
            "enabled": false,
            "readPreference": "secondary"
      },
      "clusterType": "REPLICASET",
      "diskSizeGB": 2,
      "encryptionAtRestProvider": "NONE",
      "id": "5e29cf4e7a3e5a3f46554bde",
      "groupId": "<project-ID>",
      "mongoDBVersion": "4.2.3",
      "mongoDBMajorVersion": "4.2",
      "mongoURI": "mongodb://getstarted-shard-00-00-7hgjn.mongodb.net:27017,getstarted-shard-00-01-7hgjn.mongodb.net:27017,getstarted-shard-00-02-7hgjn.mongodb.net:27017",
      "name": "getStarted",
      "numShards": 1,
      "paused": false,
      "providerBackupEnabled": false,
      "providerSettings": {
            "backingProviderName": "AWS",
            "instanceSizeName": "M10",
            "providerName": "TENANT",
            "regionName": "US_EAST_1"
      },
      "replicationFactor": 3,
      "replicationSpec": {
             "US_EAST_1": {
                   "analyticsNodes": 0,
                   "electableNodes": 3,
                   "priority": 7,
                   "readOnlyNodes": 0
             }
      },
      "replicationSpecs": [
            {
                   "id": "5e29cf3cf10fab4e2677c9f9",
                   "numShards": 1,
                   "zoneName": "Zone 1",
                   "regionsConfig": {
                         "US_EAST_1": {
                               "analyticsNodes": 0,
                               "electableNodes": 3,
                               "priority": 7,
                               "readOnlyNodes": 0
                         }
                 }
            }
      ],
      "srvAddress": "mongodb+srv://getstarted-7hgjn.mongodb.net",
      "stateName": "IDLE"
}

摘要

恭喜你！您已经在Atlas中成功创建了一个集群来托管数据。您可以通过登录Atlas UI来查看集群。您也可以使用来连接到群集mongoURI。例如，运行以下命令以使用连接mongoURI。更换mongoURI用的价值mongoURI在你的命令的输出。cluster describe

复制

mongo <mongoURI>

配置MongoDB CLI

您可以使用和命令配置对Cloud Manager的MongoDB CLI访问。以下步骤中的命令将创建一个在文件中命名的自定义配置文件，并在该配置文件中设置您的编程API 访问密钥和项目ID。您可以使用此配置文件来运行本教程中的所有其他命令。mongocli configmongocli config setcmProfile~/.config/mongocli.toml

1个

为Cloud Manager项目创建自定义配置文件。¶

运行以下命令以创建配置文件。当命令提示您输入和时，输入您生成的编程API密钥。Public API KeyPrivate API Key

复制

mongocli config --service cloud-manager --profile cmProfile

要了解有关该命令的更多信息，请参阅 mongocli config或配置MongoDB CLI。mongocli config

在个人资料中设置您的凭据。¶

当命令提示您输入和时，输入您生成的编程API密钥。Public API KeyPrivate API Key

在您的个人资料中设置项目的ID。¶

当命令提示您时，输入您的项目ID。

注意

您可以使用以下命令检索项目列表，包括其ID 。mongocli iam project list

创建集群

您可以使用MongoDB CLI在Cloud Manager上创建集群。

以下命令使用以下设置创建示例集群：

集群名称： getStarted
MongoDB服务器版本： 4.2.2
功能兼容版本： 4.2
副本集成员： 3
会员主机名：host1，host2，host3

注意

本教程使用的主机名host1，host2和host3。将这些主机名替换为有效的MongoDB服务器主机名。
数据目录中的每个mongod实例：/data/cluster/rs1， /data/cluster/rs2，/data/cluster/rs3
日志文件路径为每个mongod实例：/data/cluster/rs1/mongodb.log， /data/cluster/rs2/mongodb.log，/data/cluster/rs3/mongodb.log
端口每个mongod过程：29010，29020，29030
每个成员的投票优先级： 1
每个成员的票数： 1

1个

将以下群集范围和副本集配置属性复制并粘贴到名为的文件中`getStartedCluster.json`。¶

要了解有关配置文件属性的更多信息，请参阅集群配置文件。

复制

{
  "name": "getStarted",
  "version": "4.2.2",
  "featureCompatibilityVersion": "4.2",
  "processes": [
    {
      "hostname": "host1",
      "dbPath": "/data/cluster/rs1",
      "logPath": "/data/cluster/rs1/mongodb.log",
      "priority": 1,
      "votes": 1,
      "port": 29010
    },
    {
      "hostname": "host2",
      "dbPath": "/data/cluster/rs2",
      "logPath": "/data/cluster/rs2/mongodb.log",
      "priority": 1,
      "votes": 1,
      "port": 29020
    },
    {
      "hostname": "host3",
      "dbPath": "/data/cluster/rs3",
      "logPath": "/data/cluster/rs3/mongodb.log",
      "priority": 1,
      "votes": 1,
      "port": 29030
    }
  ]
}

运行以下命令以创建集群。¶

复制

mongocli cloud-manager cluster create --file getStartedCluster.json --profile cmProfile

检索集群

您可以使用MongoDB CLI通过检索集群详细信息来检查集群是否已创建。运行以下命令以检索集群。以下命令检索名为的群集的详细说明getStarted。该命令使用：

指定的配置文件，用于确定包含集群的项目的ID。
配置文件中的编程API访问密钥，以与Cloud Manager项目进行交互。

复制

mongocli cloud-manager cluster describe getStarted --profile cmProfile

您的命令输出应类似于以下内容：

{
       "mongoURI": "mongodb://host1:29010,host2:29020,host3:29030",
       "name": "getStarted",
       "processes": [
             {
                    "buildIndexes": true,
                    "db_path": "/data/cluster/rs1",
                    "featureCompatibilityVersion": "4.2",
                    "hostname": "host1",
                    "log_path": "/data/cluster/rs1/mongodb.log",
                    "name": "getStartedCluster",
                    "port": 29010,
                    "priority": 1,
                    "process_type": "mongod",
                    "slave_delay": 0,
                    "version": "4.2.2",
                    "votes": 1,
                    "arbiter_only": false,
                    "disabled": false,
                    "hidden": false
             },
             {
                    "buildIndexes": true,
                    "db_path": "/data/cluster/rs2",
                    "featureCompatibilityVersion": "4.2",
                    "hostname": "host2",
                    "log_path": "/data/cluster/rs2/mongodb.log",
                    "name": "getStartedCluster",
                    "port": 29020,
                    "priority": 1,
                    "process_type": "mongod",
                    "slave_delay": 0,
                    "version": "4.2.2",
                    "votes": 1,
                    "arbiter_only": false,
                    "disabled": false,
                    "hidden": false
             },
             {
                    "buildIndexes": true,
                    "db_path": "/data/cluster/rs3",
                    "featureCompatibilityVersion": "4.2",
                    "hostname": "host3",
                    "log_path": "/data/cluster/rs3/mongodb.log",
                    "name": "getStartedCluster",
                    "port": 29030,
                    "priority": 1,
                    "process_type": "mongod",
                    "slave_delay": 0,
                    "version": "4.2.2",
                    "votes": 1,
                    "arbiter_only": false,
                    "disabled": false,
                    "hidden": false
             }
      ]
}

摘要

恭喜你！您已经在Cloud Manager中成功创建了一个集群来托管数据。您可以通过登录Cloud Manager UI来查看集群。您也可以使用来连接到群集 mongoURI。例如，运行以下命令以使用连接 mongoURI。更换mongoURI用的价值mongoURI在你的命令的输出。cluster describe

复制

mongo <mongoURI>

配置MongoDB CLI

您可以使用和命令配置对Ops Manager的MongoDB CLI访问。以下步骤中的命令将创建一个在文件中命名的自定义配置文件，并在该配置文件中设置您的编程API 访问密钥和项目ID。您可以使用此配置文件来运行本教程中的所有其他命令。mongocli configmongocli config setomProfile~/.config/mongocli.toml

1个

为Ops Manager项目创建自定义配置文件。¶

运行以下命令以创建配置文件。当命令提示您输入和时，输入您生成的编程API密钥。Public API KeyPrivate API Key

复制

mongocli config --service ops-manager --profile omProfile

要了解有关该命令的更多信息，请参阅 mongocli config或配置MongoDB CLI。mongocli config

在个人资料中设置您的凭据。¶

当命令提示您输入和时，输入您生成的编程API密钥。Public API KeyPrivate API Key

在您的个人资料中设置项目的ID。¶

当命令提示您时，输入您的项目ID。

注意

您可以使用以下命令检索项目列表，包括其ID 。mongocli iam project list

创建集群

您可以使用MongoDB CLI 在Ops Manager上创建集群。

以下命令使用以下设置创建示例集群：

集群名称： getStarted
MongoDB服务器版本： 4.2.2
功能兼容版本： 4.2
副本集成员： 3
会员主机名：host1，host2，host3

注意

本教程使用的主机名host1，host2和host3。将这些主机名替换为有效的MongoDB服务器主机名。
数据目录中的每个mongod实例：/data/cluster/rs1， /data/cluster/rs2，/data/cluster/rs3
日志文件路径为每个mongod实例：/data/cluster/rs1/mongodb.log， /data/cluster/rs2/mongodb.log，/data/cluster/rs3/mongodb.log
端口每个mongod过程：29010，29020，29030
每个成员的投票优先级： 1
每个成员的票数： 1

1个

将以下群集范围和副本集配置属性复制并粘贴到名为的文件中`getStartedCluster.json`。¶

要了解有关配置文件属性的更多信息，请参阅集群配置文件。

复制

{
  "name": "getStarted",
  "version": "4.2.2",
  "featureCompatibilityVersion": "4.2",
  "processes": [
    {
      "hostname": "host1",
      "dbPath": "/data/cluster/rs1",
      "logPath": "/data/cluster/rs1/mongodb.log",
      "priority": 1,
      "votes": 1,
      "port": 29010
    },
    {
      "hostname": "host2",
      "dbPath": "/data/cluster/rs2",
      "logPath": "/data/cluster/rs2/mongodb.log",
      "priority": 1,
      "votes": 1,
      "port": 29020
    },
    {
      "hostname": "host3",
      "dbPath": "/data/cluster/rs3",
      "logPath": "/data/cluster/rs3/mongodb.log",
      "priority": 1,
      "votes": 1,
      "port": 29030
    }
  ]
}

运行以下命令以创建集群。¶

复制

mongocli ops-manager cluster create --file getStartedCluster.json --profile omProfile

检索集群

以下命令检索名为的群集的详细说明getStarted。该命令使用名为的配置文件omProfile：

确定包含集群的项目的ID。
对于编程API，访问键可访问Ops Manager项目。

复制

mongocli ops-manager cluster describe getStarted --profile omProfile

您的命令输出应类似于以下内容：

{
       "mongoURI": "mongodb://host1:29010,host2:29020,host3:29030",
       "name": "getStarted",
       "processes": [
             {
                    "buildIndexes": true,
                    "db_path": "/data/cluster/rs1",
                    "featureCompatibilityVersion": "4.2",
               "hostname": "host1",
                    "log_path": "/data/cluster/rs1/mongodb.log",
                    "name": "getStartedCluster",
                    "port": 29010,
                    "priority": 1,
                    "process_type": "mongod",
                    "slave_delay": 0,
                    "version": "4.2.2",
                    "votes": 1,
                    "arbiter_only": false,
                    "disabled": false,
                    "hidden": false
             },
             {
                    "buildIndexes": true,
                    "db_path": "/data/cluster/rs2",
                    "featureCompatibilityVersion": "4.2",
                    "hostname": "host2",
                    "log_path": "/data/cluster/rs2/mongodb.log",
                    "name": "getStartedCluster",
                    "port": 29020,
                    "priority": 1,
                    "process_type": "mongod",
                    "slave_delay": 0,
                    "version": "4.2.2",
                    "votes": 1,
                    "arbiter_only": false,
                    "disabled": false,
                    "hidden": false
             },
             {
                    "buildIndexes": true,
                    "db_path": "/data/cluster/rs3",
                    "featureCompatibilityVersion": "4.2",
                    "hostname": "host3",
                    "log_path": "/data/cluster/rs3/mongodb.log",
                    "name": "getStartedCluster",
                    "port": 29030,
                    "priority": 1,
                    "process_type": "mongod",
                    "slave_delay": 0,
                    "version": "4.2.2",
                    "votes": 1,
                    "arbiter_only": false,
                    "disabled": false,
                    "hidden": false
             }
       ]
}

摘要

恭喜你！您已经在Ops Manager中成功创建了一个群集来托管数据。您可以通过登录Ops Manager UI 来查看集群。您也可以使用来连接到群集mongoURI。例如，运行以下命令以使用连接mongoURI。更换mongoURI用的价值mongoURI在你的命令的输出。cluster describe

复制

mongo <mongoURI>

MongoDB 工具

快速开始

前提条件¶

下载并安装MongoDB CLI¶

生成编程访问密钥¶

配置MongoDB CLI

为Atlas项目创建一个自定义配置文件。¶

在个人资料中设置您的凭据。¶

在您的个人资料中设置项目的ID。¶

创建集群

将您的IP地址列入白名单

创建一个MongoDB用户

检索集群

摘要

配置MongoDB CLI

为Cloud Manager项目创建自定义配置文件。¶

在个人资料中设置您的凭据。¶

在您的个人资料中设置项目的ID。¶

创建集群

将以下群集范围和副本集配置属性复制并粘贴到名为的文件中getStartedCluster.json。¶

运行以下命令以创建集群。¶

检索集群

摘要

配置MongoDB CLI

为Ops Manager项目创建自定义配置文件。¶

在个人资料中设置您的凭据。¶

在您的个人资料中设置项目的ID。¶

创建集群

将以下群集范围和副本集配置属性复制并粘贴到名为的文件中getStartedCluster.json。¶

运行以下命令以创建集群。¶

检索集群

摘要

将以下群集范围和副本集配置属性复制并粘贴到名为的文件中`getStartedCluster.json`。¶

将以下群集范围和副本集配置属性复制并粘贴到名为的文件中`getStartedCluster.json`。¶