Registros e configuração do registro
Aviso
Recurso experimental
Esse recurso é experimental. O MongoDB não é compatível com snippets. Este recurso pode ser alterado ou removido a qualquer momento sem aviso prévio.
Bugs não são esperados, no entanto, se você encontrar um, abra um problema no Github repositório do para este projeto.
Esta página discute diferentes registros e como configurar seu sistema para usá-los.
Tipos de configuração de Registro
A funcionalidade de snippets usa o gerenciador de pacote npm para instalar trechos de um registro pré-especificado. Você pode configurar seu mongosh local para usar um ou mais registros:
O registro da comunidade mantido pelo MongoDB
Um registro privado mantido por você
Vários registros usados juntos
Usando o Registro do MongoDB
Este é um registro público da comunidade mantido pelo MongoDB.
O registro da comunidade é o registro padrão. Ele fornece vários trechos úteis que podem ajudá-lo a começar. Os trechos no registro da comunidade também são bons exemplos para usar quando estiver pronto para criar seus próprios trechos.
Os usuários do MongoDB são encorajados a contribuir para este registro público. Para saber como compartilhar seu código com outros usuários do MongoDB, consulte Contribuir com um pacote de trecho para a comunidade MongoDB.
Usando registros de trechos privados
Você pode compartilhar código internamente usando um registro privado.
Se seus trechos revelarem informações exclusivas ou confidenciais, você poderá armazená-los em um registro local privado em vez de no registro público.
Para criar um registro privado, consulte Definir um novo registro.
Usando vários registros
Um registro privado também pode ser usado em conjunto com o registro comunitário e outros registros privados. O uso de vários registros permite que você se beneficia de trechos mantidos pelo MongoDB ou de terceiros, ao mesmo tempo em que mantém o controle sobre o código que não deseja compartilhar externamente.
Para configurar vários registros, consulte Conectar-se a registros.
Como configurar um registro
Para usar um registro privado ou vários registros:
Crie um arquivo de índice de registro.
Atualize
snippetIndexSourceURLspara conter um link para o arquivo de índice do registro.Atualize
snippetRegistryURLpara ponto para o host de registro (opcional).
Definir um novo registro
O registro público npm hospeda o registro da comunidade de trechos do MongoDB . Você também pode usar o npm para hospedar seu próprio registro público ou privado.
Crie um repositório no Github.
Você enviará pacotes de trecho do seu repositório GitHub para o seu registro npm.
Siga a Github documentação do para criar um repositório.
Crie um registro npm.
Siga a documentação do registro npm para criar um registro.
Update snippetIndexSourceURLs.
Para disponibilizar o novo registro para sua instalação local do mongosh , atualize as definições de configuração do snippetIndexSourceURLs .
config.set('snippetIndexSourceURLs', 'https://github.com/YOUR_COMPANY/PATH_TO_YOUR_REPOSITORY/index.bson.br;' + config.get('snippetIndexSourceURLs') )
Conexão com registros
Você pode usar um registro privado além do, ou em vez do registro MongoDB da comunidade.
snippetIndexSourceURLs é uma lista de URLs. Cada URL define um caminho para um arquivo de índice que contém metadados para os trechos nesse registro.
Configure um registro adicional adicionando uma URL a snippetIndexSourceURLs.
config.set('snippetIndexSourceURLs', 'https://github.com/YOUR_COMPANY/PATH_TO_YOUR_REPOSITORY/index.bson.br;' + config.get('snippetIndexSourceURLs') )
Reinicie o mongosh para que a atualização entre em vigor.
Importante
Se dois trechos com o mesmo nome aparecerem em vários registros, as atualizações do sistema local serão baseadas na entrada no primeiro registro na lista snippetIndexSourceURLs .
Não reutilize nomes de trechos para evitar possíveis conflitos.