mongofiles

概述

该mongofiles 工具允许您通过命令行操作存储在 MongoDB 实例中的 GridFS 对象中的文件。它特别有用，因为它为存储在文件系统中的对象和 GridFS 之间提供了一个接口。

从系统命令行运行 mongofiles，而不是 mongo shell。

兼容性

安装

mongofiles 工具是 MongoDB 数据库工具 包的一部分

➤按照数据库工具安装指南 安装 mongofiles。

语法

mongofiles 命令具有以下形式

mongofiles <options> <connection-string> <command> <filename or _id>

从系统命令行运行 mongofiles，而不是 mongo shell。

mongofiles 命令的组件

1. 选项。您可以使用一个或多个这些选项来控制 mongofiles 的行为。

2. 连接字符串。与 mongod / mongos 连接的连接字符串。

3. 命令。使用这些命令之一来确定 mongofiles 的操作。

4. 一个标识符，可以是：您本地文件系统上的文件名，或 GridFS 对象。

所需访问权限

为了连接到启用了mongod授权选项的数据库，您必须使用--auth，并且需要使用--username和--password选项。连接的用户必须至少拥有

• 访问数据库的read角色，当使用list，search或get命令时，

• 访问数据库的readWrite角色，当使用put或delete命令时。

行为

选项

--help

返回有关mongofiles选项和使用的信息。

--verbose, -v

增加在标准输出或日志文件中返回的内部报告量。通过多次包含选项来增加详细程度（例如，-vvvvv）。

--quiet

在静默模式下运行 mongofiles，尝试限制输出量。

此选项抑制

• 以下数据库命令的输出：

• 复制活动

• 连接接受事件

• 连接关闭事件

--version

返回 mongofiles 版本号。

--config=<filename>

新版本100.3.0.

指定包含以下选项敏感值的 YAML 配置文件的完整路径： mongofiles

• --password

• --uri

• --sslPEMKeyPassword

这是除通过密码提示指定之外，指定密码给 mongofiles 的推荐方法。

配置文件具有以下形式

password: <password>
uri: mongodb://mongodb0.example.com:27017
sslPEMKeyPassword: <password>

在“password:”字段指定密码，并在“uri:”字段提供包含冲突密码的连接字符串，会导致错误。

请确保使用适当的文件系统权限来保护此文件。

注意

如果您使用--config指定配置文件，并使用--password、--uri或--sslPEMKeyPassword选项来运行mongofiles，则每个命令行选项将覆盖配置文件中对应的选项。

--uri=<connectionString>

指定MongoDB部署的可解析URI连接字符串，并用引号括起来

--uri="mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]"

从mongofiles的100.0版本开始，连接字符串也可以作为位置参数提供，而不使用--uri选项

mongofiles mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]

作为一个位置参数，连接字符串可以在命令行的任何位置指定，只要它以mongodb://或mongodb+srv://开头。例如

mongofiles --username joe --password secret1 mongodb://mongodb0.example.com:27017 --ssl

只能提供一个连接字符串。尝试使用--uri选项或作为位置参数提供多个连接字符串会导致错误。

有关连接字符串组件的信息，请参阅连接字符串URI格式文档。

注意

在连接字符串中的一些组件可以选择使用它们自己的显式命令行选项进行指定，例如--username和--password。当同时提供连接字符串并使用显式选项指定冲突信息时，将导致错误。

注意

如果在Ubuntu 18.04上使用mongofiles，使用带有--uri选项的SRV连接字符串（格式为mongodb+srv://）时，可能会遇到无法解析DNS错误信息。如果是这种情况，请改用以下选项之一

• 使用--uri选项和非SRV连接字符串（格式为mongodb://）

• 使用--host选项直接指定要连接的主机

警告

在某些系统上，通过--uri选项提供的密码可能会被系统状态程序（如ps）看到，这些程序可能被其他用户调用。考虑以下替代方案

• 在连接字符串中省略密码以接收交互式密码提示，或

• 使用--config选项指定包含密码的配置文件。

--host=<hostname><:port>

指定一个可解析的主机名，该主机名用于您的mongod GridFS系统。默认情况下，mongofiles尝试连接到本地主机端口27017上运行的MongoDB进程。

可选地，指定一个端口号以连接到运行在非27017端口的MongoDB实例。

或者，您也可以直接在URI连接字符串中指定主机名。当同时提供连接字符串并使用--host并指定冲突信息时，将导致错误。

--port=<端口号>

默认: 27017

指定MongoDB实例监听客户端连接的TCP端口。

或者，您也可以直接在URI连接字符串中指定端口。在提供连接字符串的同时使用--port并指定冲突信息将导致错误。

--ssl

启用与已启用TLS/SSL支持的mongod或mongos的连接。

或者，您也可以直接在URI连接字符串中配置TLS/SSL支持。在提供连接字符串的同时使用--ssl并指定冲突信息将导致错误。

有关TLS/SSL和MongoDB的更多信息，请参阅配置mongod和mongos以使用TLS/SSL和客户端的TLS/SSL配置。

--sslCAFile=<filename>

指定包含证书颁发机构根证书链的 .pem 文件。使用相对路径或绝对路径指定 .pem 文件的文件名。

或者，您也可以在 URI 连接字符串 中直接指定 .pem 文件。在同时使用 --sslCAFile 并指定冲突信息时，将导致错误。

有关TLS/SSL和MongoDB的更多信息，请参阅配置mongod和mongos以使用TLS/SSL和客户端的TLS/SSL配置。

--sslPEMKeyFile=<filename>

指定包含 TLS/SSL 证书和私钥的 .pem 文件。使用相对路径或绝对路径指定 .pem 文件的文件名。

当使用 --ssl 选项连接到已启用 mongod 或 mongos 的 CAFile 并未启用 allowConnectionsWithoutCertificates 时，此选项是必需的。

或者，您也可以在 URI 连接字符串 中直接指定 .pem 文件。在同时使用 --sslPEMKeyFile 并指定冲突信息时，将导致错误。

有关TLS/SSL和MongoDB的更多信息，请参阅配置mongod和mongos以使用TLS/SSL和客户端的TLS/SSL配置。

--sslPEMKeyPassword=<value>

指定解密证书密钥文件的密码（即 --sslPEMKeyFile）。只有在证书密钥文件被加密时才使用 --sslPEMKeyPassword 选项。在所有情况下，mongofiles 将从所有日志和报告输出中删除密码。

如果 PEM 文件中的私钥被加密且未指定 --sslPEMKeyPassword 选项，mongofiles 将提示输入密码短语。参见 TLS/SSL 证书密码短语。

或者，您还可以直接在 URI 连接字符串 中指定密码。在同时使用 --sslPEMKeyPassword 并指定冲突信息时，将导致错误。

有关TLS/SSL和MongoDB的更多信息，请参阅配置mongod和mongos以使用TLS/SSL和客户端的TLS/SSL配置。

警告

在某些系统上，使用 --sslPEMKeyPassword 选项直接提供的密码可能对系统状态程序（如 ps）可见，这些程序可能由其他用户调用。考虑使用 --config 选项来指定包含密码的配置文件。

--sslCRLFile=<filename>

指定包含证书吊销列表的 .pem 文件。使用相对或绝对路径指定 .pem 文件的文件名。

有关TLS/SSL和MongoDB的更多信息，请参阅配置mongod和mongos以使用TLS/SSL和客户端的TLS/SSL配置。

--sslAllowInvalidCertificates

绕过服务器证书的验证检查，允许使用无效证书。当使用 allowInvalidCertificates 设置时，MongoDB 将使用无效证书的情况记录为警告。

警告

虽然可用，但尽可能避免使用 --sslAllowInvalidCertificates 选项。如果必须使用 --sslAllowInvalidCertificates，则仅在入侵不可能的系统上使用该选项。

在不验证服务器证书的情况下连接到 mongod 或 mongos 实例是一种潜在的安全风险。如果您只需要禁用 TLS/SSL 证书中主机名的验证，请参阅 --sslAllowInvalidHostnames。

或者，您也可以直接在 URI 连接字符串 中禁用证书验证。当同时使用 --sslAllowInvalidCertificates 并指定冲突信息时，将导致错误。

有关TLS/SSL和MongoDB的更多信息，请参阅配置mongod和mongos以使用TLS/SSL和客户端的TLS/SSL配置。

--sslAllowInvalidHostnames

禁用TLS/SSL证书中对主机名的验证。允许 mongofiles 连接到MongoDB实例，即使它们的证书中的主机名与指定的主机名不匹配。

或者，您也可以直接在URI连接字符串中禁用主机名验证。在使用--sslAllowInvalidHostnames的同时提供连接字符串并指定冲突信息将导致错误。

有关TLS/SSL和MongoDB的更多信息，请参阅配置mongod和mongos以使用TLS/SSL和客户端的TLS/SSL配置。

--username=<username>, -u=<username>

指定一个用于验证连接到使用认证的MongoDB数据库的用户名。与--password和--authenticationDatabase选项一起使用。

或者，您也可以直接在URI连接字符串中指定用户名。在使用--username的同时提供连接字符串并指定冲突信息将导致错误。

如果您使用MONGODB-AWS 认证机制连接到MongoDB Atlas集群，您可以在以下字段中指定您的AWS访问密钥ID：

• 该字段，

• 连接字符串中，或

• AWS_ACCESS_KEY_ID环境变量中。

有关每个示例的详细信息，请参阅使用AWS IAM凭据连接到MongoDB Atlas集群。

--password=<密码>, -p=<密码>

指定用于验证连接到使用身份验证的MongoDB数据库的密码。与--username和--authenticationDatabase选项一起使用。

要提示用户输入密码，请使用不带--password的--username选项，或者将--password的值指定为空字符串，例如--password ""。

或者，您也可以直接在URI连接字符串中指定密码。同时提供连接字符串并使用--password并指定冲突信息将导致错误。

如果您使用MONGODB-AWS身份验证机制连接到MongoDB Atlas集群，可以在

• 该字段，

• 连接字符串中，或

• AWS_SECRET_ACCESS_KEY环境变量中指定您的AWS密钥访问密钥。

有关每个示例的详细信息，请参阅使用AWS IAM凭据连接到MongoDB Atlas集群。

警告

在某些系统上，直接使用--password选项提供的密码可能会被系统状态程序（如ps）看到，这些程序可能由其他用户调用。考虑不使用

• --password选项以接收交互式密码提示，或者

• 使用--config选项指定包含密码的配置文件。

--awsSessionToken=<AWS 会话令牌>

如果您正在使用 MongoDB Atlas 集群，并通过 MONGODB-AWS 认证机制 连接，并且除了您的 AWS 访问密钥 ID 和密钥之外还使用会话令牌，您可以在

• 该字段，

• AWS_SESSION_TOKEN 认证机制属性 参数中指定您的 AWS 会话令牌到 连接字符串，或者

• 在 AWS_SESSION_TOKEN 环境变量中。

有关每个示例的详细信息，请参阅使用AWS IAM凭据连接到MongoDB Atlas集群。

仅在使用 MONGODB-AWS 认证机制 时有效。

--authenticationDatabase=<dbname>

指定已创建指定 --username 的认证数据库。请参阅 认证数据库。

如果使用 GSSAPI（Kerberos）、PLAIN（LDAP SASL）或 MONGODB-AWS 认证机制，您必须将 --authenticationDatabase 设置为 $external。

或者，您还可以在 URI 连接字符串 中直接指定认证数据库。在同时使用 --authenticationDatabase 并指定冲突信息时，将会产生错误。

--authenticationMechanism=<name>

默认：SCRAM-SHA-1

指定 mongofiles 实例用于认证到 mongod 或 mongos 的认证机制。

变更版本100.1.0: 从版本 100.1.0 开始，mongofiles 在连接到 MongoDB Atlas 集群时添加了对 MONGODB-AWS 认证机制的支持。

值	描述
SCRAM-SHA-1	RFC 5802 使用 SHA-1 哈希函数的标准加盐挑战响应认证机制。
SCRAM-SHA-256	RFC 7677 标准的盐值挑战响应认证机制，使用SHA-256哈希函数。 需要将特征兼容性版本设置为 4.0。
MONGODB-X509	MongoDB TLS/SSL证书认证。
MONGODB-AWS	使用AWS IAM凭据进行外部认证，用于连接到MongoDB Atlas集群。请参阅使用AWS IAM凭据连接到MongoDB Atlas集群。 新版本100.1.0.
GSSAPI (Kerberos)	使用Kerberos进行外部认证。此机制仅在MongoDB Enterprise.
PLAIN (LDAP SASL)	使用LDAP进行外部认证。您还可以使用PLAIN对数据库用户进行认证。PLAIN以明文形式传输密码。此机制仅在MongoDB Enterprise.

或者，您还可以直接在URI连接字符串中指定认证机制。同时使用--authenticationMechanism并指定冲突信息将导致错误。

--gssapiServiceName=<serviceName>

使用GSSAPI/Kerberos指定服务名称。如果服务不使用默认名称mongodb，则此选项是必需的。

此选项仅在MongoDB Enterprise中可用。

--gssapiHostName=<hostname>

使用 GSSAPI/Kerberos 指定服务的主机名。仅在机器的主机名与 DNS 解析出的主机名不匹配时才需要。

此选项仅在MongoDB Enterprise中可用。

--db=<database>, -d=<database>

指定运行 mongofiles. 的数据库名称。

或者，您也可以直接在 URI 连接字符串 中指定数据库。在同时使用 --db 并指定冲突信息时，将导致错误。

--local=<filename>, -l=<filename>

指定用于获取和放置操作的本地文件系统文件名。

在 mongofiles put 和 mongofiles get 命令中，必需的 <filename> 修饰符指的是对象在 GridFS 中的名称。 mongofiles 假定这反映了本地文件系统的文件名。此设置会覆盖此默认值。

--type=<MIME>

提供指定 MIME 类型的能力，以描述插入到 GridFS 存储中的文件。 mongofiles 在默认操作中省略此选项。

仅与 mongofiles put 操作一起使用。

--replace, -r

修改 mongofiles put 的行为，以用指定的本地文件替换现有的 GridFS 对象，而不是添加一个具有相同名称的额外对象。

在默认操作中，文件不会被 mongofiles put 选项覆盖。

--prefix=<string>

默认值: fs

使用的 GridFS 前缀。

--writeConcern=<document>

默认值: majority

指定 mongofiles 执行的每个写操作的 写关注。

将写关注指定为包含 w 选项 的文档：

--writeConcern="{w:'majority'}"

如果写关注也包含在 --uri 连接字符串 中，命令行 --writeConcern 将覆盖 URI 字符串中指定的写关注。

--readPreference=<string|document>

默认值: primary

指定 读取偏好。 mongofiles 的 --readPreference 选项可以接受：

• 如果仅指定读取偏好模式，则可以是一个字符串。

  --readPreference=secondary

• 一个用引号括起来的文档，用于指定模式、可选的 读取偏好标签集 和可选的 maxStalenessSeconds:

  --readPreference='{mode: "secondary", tagSets: [ { "region": "east" } ], maxStalenessSeconds: 120}'

  如果指定了 maxStalenessSeconds，则其值必须大于或等于 90。

mongofiles 默认为 primary 读取偏好。

如果读取偏好也包含在 --uri 连接字符串 中，则命令行 --readPreference 会覆盖 URI 字符串中指定的读取偏好。

命令

list <prefix>

列出 GridFS 存储中的文件。在 list 后指定的字符（例如，<prefix>）可以可选地限制返回的项目列表，只包括以该字符串开头的文件。

search <string>

列出 GridFS 存储中名称与 <string> 的任何部分匹配的文件。

put <filename1[ filename2] ...>

将指定的文件或文件从本地文件系统复制到 GridFS 存储。可以指定多个文件，作为空格分隔的列表。

每个指定的文件名指的是对象在 GridFS 中的名称，并且 mongofiles 假设这反映了文件在本地文件系统中的名称。如果本地文件名不同，请使用 mongofiles --local 选项。

get <filename1[ filename2] ...>

将指定的文件或文件从GridFS存储复制到本地文件系统。

每个指定的文件名指的是对象在GridFS中的名称，并且当写入本地文件系统时，mongofiles将使用此文件名。

如果只指定一个filename到get命令，您可以使用--local选项来指定不同的本地文件名进行写入，如果需要的话。在指定多个 filename到get命令的情况下，不能使用--local选项。

注意

要复制匹配正则表达式的GridFS存储文件，请使用get_regex命令。

get_id "<_id>"

将指定<_id>的文件从GridFS存储复制到本地文件系统。<_id>指的是GridFS中对象的扩展JSON _id。get_id可以接受<_id>的ObjectId值或非ObjectId值。

mongofiles将文件写入本地文件系统，使用GridFS中的文件名。要选择本地文件系统上的不同位置，请使用--local选项。

get_regex <regex> --regexOptions <regex-options>

从GridFS存储复制匹配指定<regex>表达式的文件或文件到本地文件系统。get_regex命令使用与Perl兼容的正则表达式("PCRE")版本8.42，具有UTF-8支持。

您可以使用--regexOptions标志可选地指定一个或多个<regex-options>。这些可以是$regex运算符支持的任何选项，包括大小写不敏感等设置。多个选项应一起提供，不带分隔符，例如--regexOptions si。

mongofiles将文件或文件写入本地文件系统，使用每个文件在GridFS中匹配的文件名。您不能使用--local选项与get_regex命令一起使用。

delete <filename>

从GridFS存储删除指定的文件。

delete_id "<_id>"

从GridFS存储删除指定<_id>的文件。delete_id可以接受<_id>的ObjectId值或非ObjectId值。

示例

从系统命令行运行 mongofiles，而不是 mongo shell。

要返回“records”数据库中所有文件的列表，请在系统外壳中使用以下调用

mongofiles -d=records list

此mongofiles实例将连接到运行在本地主机27017接口上的mongod实例，以指定在端口或主机名不同的操作上执行相同的操作，并发出类似于以下命令的命令

mongofiles --port=37017 -d=records list
mongofiles --host=db1.example.net -d=records list
mongofiles --host=db1.example.net --port=37017 -d=records list

如果需要连接到不同端口或主机上的mongod实例，请根据需要修改以下任何命令。

要将名为32-corinth.lp的文件上传到“records”数据库中的GridFS集合，可以使用以下命令

mongofiles -d=records put 32-corinth.lp

要从“records”数据库中的此GridFS集合删除32-corinth.lp文件，可以使用以下命令

mongofiles -d=records delete 32-corinth.lp

要搜索在“records”数据库的GridFS集合中具有名称包含字符串corinth的文件，可以使用以下命令

mongofiles -d=records search corinth

要列出所有在“records”数据库的GridFS集合中名称以字符串32开头的文件，可以使用以下命令

mongofiles -d=records list 32

要从“records”数据库的GridFS集合中检索名为32-corinth.lp的文件，可以使用以下命令

mongofiles -d=records get 32-corinth.lp

要从“records”数据库的GridFS集合中检索所有以字符串32开头并以字符串.lp结尾的文件，可以使用以下命令

mongofiles -d=records get_regex 32*.lp

要从“records”数据库的GridFS集合中检索具有_id: ObjectId("56feac751f417d0357e7140f")的文件，可以使用以下命令

mongofiles -d=records get_id '{"$oid": "56feac751f417d0357e7140f"}'

必须在_id周围加上引号。

mongofiles 'mongodb+srv://<aws access key id>:<aws secret access key>@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB-AWS' <other options>

mongofiles 'mongodb+srv://<aws access key id>:<aws secret access key>@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB-AWS&authMechanismProperties=AWS_SESSION_TOKEN:<aws session token>' <other options>

: / ? # [ ] @

mongofiles 'mongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB-AWS' --username <aws access key id> --password <aws secret access key> --awsSessionToken <aws session token> <other options>

export AWS_ACCESS_KEY_ID='<aws access key id>'
export AWS_SECRET_ACCESS_KEY='<aws secret access key>'
export AWS_SESSION_TOKEN='<aws session token>'

env | grep AWS

mongofiles 'mongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB-AWS'  <other options>