注册表和注册表配置

在此页面上

注册表配置类型

如何配置注册表

警告

实验功能

此功能是实验性的。MongoDB 不支持代码片段。此功能可随时更改或删除，恕不另行通知。

预计不会出现错误，但如果您遇到错误，请在Github 存储库中提出问题对于此项目。

本页讨论不同的注册表以及如何配置系统以使用它们。

注册表配置类型

代码片段功能使用 npm包管理器从预先指定的注册表安装代码片段。您可以将本地 mongosh配置为使用一个或多个注册表：

社区注册表由MongoDB维护
您维护的私有注册表
同时使用多个注册表

使用 MongoDB 注册表

这是一个由 MongoDB 维护的公共社区注册表。

社区注册表是默认注册表。它提供了几个有用的代码片段，可以帮助您入门。社区注册表中的代码片段也是很好的示例当您准备好创建自己的代码片段时使用。

我们鼓励 MongoDB 用户为这个公共注册表做出贡献。要了解如何与其他 MongoDB 用户共享代码，请参阅向 MongoDB Community 贡献代码片段Package。

使用私有代码片段注册表

您可以使用私有注册表在内部共享代码。

如果您的代码片段泄露了专有信息或敏感信息，您可以将其存储在私有的本地注册表中，而不是公共注册表中。

要创建私有注册表，请参阅定义新注册表。

使用多个注册表

私有注册表还可以与社区注册表和其他私有注册表结合使用。使用多个注册表可以让您受益于 MongoDB 或第三方维护的代码片段，同时保持对不想与外部共享的代码的控制。

要配置多个注册表，请参阅连接到注册表。

如何配置注册表

要使用私有注册表或多个注册表，请执行以下操作：

定义新注册表。
创建注册表索引文件。
更新snippetIndexSourceURLs以包含注册表索引文件的链接。
更新snippetRegistryURL以点向您的注册表主机（可选）。

定义新注册表

npm公共注册表托管MongoDB片段社区注册表。您也可以使用npm托管自己的公共或私有注册表。

创建 GitHub 存储库。

您可以将代码片段包从 GitHub 存储库推送到 npm 注册表。

遵循Github 文档以创建存储库。

创建 npm 注册表。

遵循 npm注册表文档以创建注册表。

Update `snippetIndexSourceURLs`.

要使新注册表可用于本地mongosh安装，请更新snippetIndexSourceURLs配置设置。

config.set('snippetIndexSourceURLs',
'https://github.com/YOUR_COMPANY/PATH_TO_YOUR_REPOSITORY/index.bson.br;'
+ config.get('snippetIndexSourceURLs') )

Update `snippetRegistryURL`.

如果您创建了在 npm 外部托管的注册表，请更新snippetRegistryURL以点新的注册表。

连接到注册表

除了社区 MongoDB 注册表之外，您还可以使用私有注册表，也可以使用私有注册表代替社区 MongoDB 注册表。

snippetIndexSourceURLs ia 是一个 URL 列表。每个 URL 都定义了一个索引文件的路径，该文件包含该注册表中代码片段的元数据。

通过将 URL 添加到snippetIndexSourceURLs来配置额外的注册表。

config.set('snippetIndexSourceURLs',
  'https://github.com/YOUR_COMPANY/PATH_TO_YOUR_REPOSITORY/index.bson.br;'
  + config.get('snippetIndexSourceURLs')
)

重新启动mongosh以使更新生效。

重要

如果两个同名的代码段出现在多个注册表中，则本地系统更新将基于snippetIndexSourceURLs列表中第一个注册表中的条目。

不要重复使用代码片段名称，以避免潜在冲突。

后退

创建和共享

来年

故障排除

警告