Menu Docs

Página inicial do DocsServiços Atlas App

Protocolo de fio

Nesta página

  • Visão geral
  • Clientes compatíveis
  • Cadeias de conexão
  • Credenciais
  • Região
  • Parâmetros
  • Habilitar conexões de protocolo de fio
  • Navegue até a tela de configuração da fonte de dados
  • Habilitar connection strings para o cluster
  • Selecione o método de autenticação
  • Obtenha a versão mais recente da sua aplicação
  • Habilitar protocolo de fio para o cluster
  • Implemente a Configuração da Fonte de Dados Atualizada
  • Conecte-se através do protocolo de fio
  • Conecte-se ao App Services com uma connection string
  • Ler e modificar dados
  • Chamar uma função
  • Chame uma ação de serviço [OUSOS]
  • Obtenha os dados do usuário conectado

O Atlas App Services implementa nativamente um subconjunto do protocolo de fio MongoDB, que permite que você se conecte a um aplicativo por meio de uma de suas fontes de dados vinculadas do MongoDB Atlas usando drivers e ferramentas padrão do MongoDB. Os clientes usam uma connection string especializada do App Services para conectar e enviar solicitações. O App Services oferece suporte à maioria das funcionalidades do cliente através do protocolo de fio, incluindo regras de acesso a dados baseadas em função, funções e ações de serviço .

Essa é uma boa opção para idiomas que não têm atualmente um Realm SDK. Os exemplos aqui são para Python, C++11 e Mongo Shell. Qualquer driver do MongoDB que ofereça suporte ao parâmetro de cadeia de conexão appName pode usar o protocolo de fio para se conectar ao App Services.

Observação

Você pode usar as seguintes ferramentas e drivers para se comunicar com o App Services usando uma connection string:

  • Versão 4.0+ da shell mongo.

  • Qualquer driver MongoDB que ofereça suporte ao parâmetro de connection string appName . Todos os drivers oficiais do MongoDB suportam este parâmetro em suas versões atuais.

Observação

As conexões com o App Services através do protocolo de fio têm acesso à funcionalidade completa do Serviço MongoDB. No entanto, o App Services não oferece suporte a todas as operações e recursos disponíveis em ferramentas e clientes padrão. Para obter detalhes, consulte Limitações do Serviço MongoDB.

Para se conectar ao App Services pelo protocolo de fio, você deve construir uma connection string do MongoDB que inclua credenciais de um usuário do aplicativo e um parâmetro de query appName específico do aplicativo.

Importante

Codificação de URL

Você deve codificar a URL connection strings antes de usá-las para se conectar ao App Services. As connection strings na UI do App Services são codificadas corretamente por padrão.

As connection strings do App Services têm o seguinte formato:

mongodb://<credentials>@<region>.services.cloud.mongodb.com:27020/?<parameters>

Todas as operações que você emite pelo protocolo de fio são executadas no contexto de um usuário de aplicativo específico que você especifica na connection string. O usuário deve ser registrado com um dos seguintes fornecedores de autenticação:

O conteúdo das credenciais da connection string depende do provedor de autenticação com o qual o usuário se registrou:

A connection string deve especificar a região de implantação e o fornecedor de nuvem no qual o aplicativo está hospedado.

Aplicativos globais usam a região global :

mongodb://<credentials>@global.services.cloud.mongodb.com:27020/?<parameters>

Os aplicativos locais especificam o provedor de nuvem e o nome da região usando o formato <region>.<cloud> . Por exemplo, um aplicativo implantado no aws-us-east-1 utilizaria a seguinte cadeia de conexão:

mongodb://<credentials>@us-east-1.aws.services.cloud.mongodb.com:27020/?<parameters>

O App Services requer opções específicas de connection string que identificam o aplicativo ao qual você deseja se conectar e o fornecedor de autenticação associado às credenciais fornecidas.

As connection strings do App Services têm os seguintes parâmetros de query:

Parâmetro
Descrição
authMechanism
Este parâmetro deve ser sempre configurado para PLAIN.
authSource
Este parâmetro deve ser sempre configurado para $external.
appName

Identifica exclusivamente o aplicativo, serviço MongoDB e fornecedor de autenticação ao qual você deseja se conectar.

O parâmetro appName tem o seguinte formato:

<app id>:<service>:<provider>
<app id>
O App ID do aplicativo.
<service>
O nome do serviço MongoDB ao qual você deseja se conectar. Esse valor sempre será mongodb-atlas.
<provider>

O fornecedor de autenticação para o qual você forneceu credenciais.

Valores válidos:

  • local-userpass

  • api-key

  • custom-token

Você deve habilitar conexões de protocolo de fio para clusters vinculados antes de poder se conectar a um aplicativo do App Services com uma connection string.

Para se conectar ao App Services através do protocolo de fio, passe um URL codificado App Services connection string ao criar um cliente, da mesma forma que faria com uma connection string comum.

Enquanto estiver conectado ao App Services através do protocolo de fio, você pode usar operações CRUD padrão do MongoDB. O App Services aplica regras de acesso a dados baseadas em função a todas as queries no contexto do usuário autenticado especificado nas credenciais da connection string.

Você pode chamar funções usando o comando callFunction banco de dados.

Comando
Descrição
Protótipo
callFunction
Chama a função especificada e retorna qualquer resultado.
{
callFunction: <function name>,
arguments: [<arg1>, <arg2>, ...]
}

Você pode chamar ações de serviço usando o comando de banco de dados callServiceFunction .

Comando
Descrição
Protótipo
callServiceFunction
Chama a ação de serviço especificada e retorna qualquer resultado.
{
callServiceFunction: <function name>,
service: <service name>,
arguments: [<arg1>, <arg2>, ...]
}

Você pode obter o objeto de usuário para o usuário autenticado usando o comando userProfile do banco de dados.

Comando
Descrição
Protótipo
userProfile
Retorna o objeto de usuário para o usuário autenticado.
{
userProfile: 1
}
← readPreference