Conceitos básicos do Amazon DocumentDB

Há muitas formas de se conectar e começar a usar o Amazon DocumentDB. Criamos esse guia porque descobrimos que essa é a maneira mais rápida, simples e fácil para os usuários começarem a usar nosso poderoso banco de dados de documentos. Esse guia utiliza o AWS Cloud9, um terminal baseado na web para conectar e consultar seu cluster do Amazon DocumentDB usando o shell do mongo diretamente a partir do AWS Management Console. Os novos clientes qualificados para o nível gratuito da AWS podem usar o Amazon DocumentDB e o AWS Cloud9 gratuitamente. Se seu ambiente AWS Cloud9 ou cluster do Amazon DocumentDB fizer uso de recursos além do nível gratuito, você será cobrado de acordo com as taxas normais da AWS para esses recursos. Esse guia ajudará você a começar a usar o Amazon DocumentDB em menos de 15 minutos.

nota

As instruções fornecidas nesse guia são específicas para criar e se conectar a clusters baseados em instâncias do Amazon DocumentDB. Se você quiser criar e se conectar aos clusters elásticos do Amazon DocumentDB, consulte Como iniciar com clusters elásticos do Amazon DocumentDB.

Se você preferir se conectar ao Amazon DocumentDB a partir de sua máquina local criando uma conexão SSH com uma instância do Amazon EC2, consulte Instruções para conectar-se com o EC2

Pré-requisitos

Antes de criar o primeiro cluster do Amazon DocumentDB, você deve fazer o seguinte:

Criar uma conta (AWS) da Amazon Web Services

Antes de começar a usar o Amazon DocumentDB, você deve ter uma conta da Amazon Web Services (AWS). A conta da AWS é gratuita. Você paga apenas pelos serviços e recursos usados.

Se você ainda não tem uma Conta da AWS, siga as etapas a seguir para criar uma.

Para se cadastrar em uma Conta da AWS

1. Abra https://portal.aws.amazon.com/billing/signup.

2. Siga as instruções on-line.

   Parte do procedimento de aplicação envolve receber uma chamada telefônica e digitar um código de verificação no teclado do telefone.

   Quando você se cadastra em uma Conta da AWS, um Usuário raiz da conta da AWS é criado. O usuário raiz tem acesso a todos os Serviços da AWS e atributos na conta. Como prática recomendada de segurança, atribua acesso administrativo a um usuário administrativo e use somente o usuário raiz para realizar as tarefas que exigem acesso do usuário raiz.

Configure as permissões necessárias do AWS Identity and Access Management (IAM).

O acesso para gerenciar recursos do Amazon DocumentDB como clusters, instâncias e grupos de parâmetros de cluster exige credenciais que a AWS pode usar para autenticar as suas solicitações. Para ter mais informações, consulte Gerenciamento de identidade e Gerenciamento de acesso para o Amazon DocumentDB.

1. Na barra de pesquisa do AWS Management Console, digite IAM e selecione IAM no menu suspenso exibido.

2. Depois de chegar ao console do IAM, selecione Usuários no painel de navegação.

3. Selecione o seu nome de usuário.

4. Clique no botão Add permissions (Adicionar permissões).

5. Selecione Attach existing policies directly (Anexar políticas existentes diretamente).

6. Digite AmazonDocDBFullAccess na barra de pesquisa e selecione-a quando ela aparecer nos resultados da pesquisa.

7. Clique no botão azul na parte inferior em que se lê Avançar: revisão.

8. Clique no botão azul na parte inferior em que se lê Adicionar permissões.

Como criar uma Amazon Virtual Private Cloud (Amazon VPC)

Essa etapa somente será necessária se você ainda não tiver uma Amazon VPC padrão. Caso não tenha, conclua a etapa 1 dos Como iniciar com o Amazon VPC no Guia do usuário da Amazon VPC. Isso levará menos de cinco minutos.

Etapa 1: Criar um ambiente AWS Cloud9

O AWS Cloud9 fornece um terminal baseado na web que você pode usar para se conectar e consultar seu cluster do Amazon DocumentDB usando o shell do mongo.

1. A partir do AWS Management Console, navegue até o console do AWS Cloud9 e escolha Criar ambiente.

   

2. Na seção Detalhes da caixa de diálogo Criar ambiente, insira DocumentDBCloud9 no campo Nome.

   

3. Para as seções Nova instância do EC2, Configurações de rede e Tags, deixe a configuração padrão como está e clique em Criar na parte inferior da tela.

   

Seu novo ambiente do AWS Cloud9 aparece na tabela Ambientes:

nota

O provisionamento do ambiente do AWS Cloud9 pode levar até três minutos.

Etapa 2: criar um grupo de segurança

Esse grupo de segurança permitirá que você se conecte ao seu cluster do Amazon DocumentDB a partir do seu ambiente do AWS Cloud9.

1. No console de gerenciamento do Amazon EC2, em Rede e segurança, escolha Grupos de segurança.

   

2. Escolha Criar grupo de segurança.

   

3. Na seção Detalhes básicos:

   1. Em Nome do grupo de segurança, insira demoDocDB.

   2. Em Descrição, insira uma descrição.

   3. Para VPC, aceite o uso da sua VPC padrão.

   

4. Na seção Regras de entrada, escolha Adicionar regra.

   1. Para Tipo, selecione Regra TCP personalizada.

   2. Em Intervalo de portas, insira 27017.

   3. Em Source, escolha o grupo de segurança para o AWS Cloud9 ambiente que você acabou de criar. Para ver uma lista dos grupos de segurança disponíveis, insira cloud9 no campo de pesquisa no lado direito do campo Origem. Escolha o grupo de segurança com o nome aws-cloud9-<environment name>.

   4. Em Destino, escolha Personalizado. No campo ao lado, procure o grupo de segurança que você acabou de chamardemoEC2. Talvez seja necessário atualizar seu navegador para que o console do Amazon EC2 preencha automaticamente demoEC2 o nome da fonte.

   

   nota

   A porta 27017 é a porta padrão para o Amazon DocumentDB.

5. Aceite todos os outros padrões e escolha Criar grupo de segurança.

   

Etapa 3: criar um cluster do Amazon DocumentDB

Nesta etapa, você criará um cluster do Amazon DocumentDB usando o grupo de segurança que você criou na etapa anterior.

nota

As instruções fornecidas nesse guia são específicas para criar clusters baseados em instâncias do Amazon DocumentDB. Se você quiser criar clusters elásticos do Amazon DocumentDB, consulte Como iniciar com clusters elásticos do Amazon DocumentDB.

1. No console de gerenciamento do Amazon DocumentDB, em Clusters, escolha Criar.

   

2. Na página Criar cluster do Amazon DocumentDB, na seção Tipo de cluster, escolha Clusters baseados em instância (essa é a opção padrão).

   

3. Na seção Configuração, escolha 1 instância. Escolher uma instância ajuda a minimizar os custos. Se for um sistema de produção, recomendamos que você provisione três instâncias para alta disponibilidade. Você pode deixar as outras configurações na seção Configuração como padrão.

   

4. Em Conectividade, deixe a configuração padrão de Não se conectar a um recurso computacional do EC2.

   

5. Na seção Autenticação, insira as credenciais de login.

   

6. Ative Exibir configurações avançadas.

   

7. Na seção Configurações de rede, para grupos de segurança da VPC, escolha demoDocDB (VPC) se você estiver criando um cluster de teste ou demonstração. Se você estiver criando um cluster para um sistema de produção, escolha padrão (VPC) ou, se quiser criar um grupo de segurança específico da VPC, consulte Grupos de segurança no Guia do usuário da Amazon Virtual Private Cloud.

   

8. Selecione Criar cluster.

   

O Amazon DocumentDB agora está provisionando seu cluster, o que pode levar alguns minutos para ser concluído. Você pode se conectar ao seu cluster quando o status do cluster e da instância for exibido comoavailable.

nota

Para obter informações sobre os valores de status do cluster, consulte Valores de status do cluster no capítulo Monitoramento do Amazon DocumentDB.

Para obter informações sobre os valores de status da instância, consulte Valores de status de instâncias no capítulo Monitoramento do Amazon DocumentDB.

Etapa 4: instalar o shell do Mongo

Agora você instalará o shell do mongo no seu ambiente do AWS Cloud9 que criou na Etapa 1. O shell do Mongo é um utilitário de linha de comando que você usa para se conectar e consultar seu cluster do Amazon DocumentDB.

1. Se seu ambiente do AWS Cloud9 ainda estiver aberto na Etapa 1, volte para esse ambiente e vá para a instrução 3. Se você saiu do seu ambiente do AWS Cloud9, no console de gerenciamento do AWS Cloud9, em Ambientes, localize o ambiente chamado DocumentDBCloud9. Escolha Abrir na coluna Cloud9 IDE.

   

2. No prompt de comando, crie o arquivo do repositório com o seguinte comando:

   echo -e "[mongodb-org-4.0] \nname=MongoDB Repository\nbaseurl=https://repo.mongodb.org/yum/amazon/2013.03/mongodb-org/4.0/x86_64/\ngpgcheck=1 \nenabled=1 \ngpgkey=https://www.mongodb.org/static/pgp/server-4.0.asc" | sudo tee /etc/yum.repos.d/mongodb-org-4.0.repo

3. Quando estiver concluído, instale o shell do mongo com o seguinte comando:

   sudo yum install -y mongodb-org-shell

Etapa 5: conectar ao cluster do Amazon DocumentDB

Agora você se conectará ao seu cluster do Amazon DocumentDB usando o shell do mongo que instalou na Etapa 4.

1. No console de gerenciamento do Amazon DocumentDB, em Clusters, localize seu cluster. Escolha o cluster que você criou clicando no identificador do cluster.

   

2. E ncryption-in-transit está habilitado por padrão no Amazon DocumentDB. Você também pode desativar o TLS. Para baixar o certificado atual necessário para se autenticar em seu cluster, na guia Conectividade e segurança, na seção Conectar-se, em Baixar o certificado da autoridade de certificação (CA) do Amazon DocumentDB necessário para autenticação em seu cluster, copie a string de conexão fornecida. Volte ao seu ambiente do AWS Cloud9 e cole a string de conexão.

   

3. Retorne ao seu cluster no console do Amazon DocumentDB e, na guia Conectividade e segurança, na seção Conectar-se, em Conectar-se a este cluster com o shell do mongo, copie a string de conexão fornecida. Omita a cópia <insertYourPassword> para que a solicitação de senha seja feita através do shell do mongo quando você se conectar.

   

   Volte ao seu ambiente do AWS Cloud9 e cole a string de conexão.

Quando você insere sua senha e seu prompt se torna um prompt rs0:PRIMARY>, a conexão ao seu cluster do Amazon DocumentDB é bem-sucedida.

nota

Para obter mais informações sobre solução de problemas, consulte Solução de problemas do Amazon DocumentDB.

Etapa 6: inserir e consultar dados

Agora que você está conectado ao seu cluster, pode executar algumas consultas para se familiarizar com o uso de um banco de dados de documentos.

1. Para inserir um único documento, digite o seguinte:

   db.collection.insert({"hello":"DocumentDB"})

2. Você obterá a seguinte saída:

   WriteResult({ "nInserted" : 1 })

3. Você pode ler o documento que escreveu com o comando findOne() (porque ele retorna apenas um único documento). Insira o seguinte:

   db.collection.findOne()

4. Você obterá a seguinte saída:

   { "_id" : ObjectId("5e401fe56056fda7321fbd67"), "hello" : "DocumentDB"
                           }

5. Para realizar mais algumas consultas, considere um caso de uso de perfis de jogo. Primeiro, insira algumas entradas em uma coleção intitulada profiles. Insira o seguinte:

   db.profiles.insertMany([
                       { "_id" : 1, "name" : "Matt", "status": "active", "level": 12, "score":202},
                       { "_id" : 2, "name" : "Frank", "status": "inactive", "level": 2, "score":9},
                       { "_id" : 3, "name" : "Karen", "status": "active", "level": 7, "score":87},
                       { "_id" : 4, "name" : "Katie", "status": "active", "level": 3, "score":27}
                       ])

6. Você obterá a seguinte saída:

   { "acknowledged" : true, "insertedIds" : [ 1, 2, 3, 4 ] }

7. Use o comando find() para retornar todos os documentos na coleção de perfis. Insira o seguinte:

   db.profiles.find()

8. Você obterá um resultado que corresponderá aos dados digitados na Etapa 5.

9. Use uma consulta para um único documento por meio de um filtro. Insira o seguinte:

   db.profiles.find({name: "Katie"})

10. Você deve obter este resultado:

    { "_id" : 4, "name" : "Katie", "status": "active", "level": 3,
                            "score":27}

11. Agora vamos tentar encontrar um perfil e modificá-lo usando o comando findAndModify. Atribuiremos ao usuário Matt mais dez pontos com o seguinte código:

    db.profiles.findAndModify({
                    query: { name: "Matt", status: "active"},
                    update: { $inc: { score: 10 } }
                })

12. Você obtém o seguinte resultado (observe que a pontuação dele ainda não aumentou):

    {
            "_id" : 1,
            "name" : "Matt",
            "status" : "active",
            "level" : 12,
            "score" : 202
    }

13. Você pode verificar se a pontuação dele mudou com a seguinte consulta:

    db.profiles.find({name: "Matt"})

14. Você obterá a seguinte saída:

    { "_id" : 1, "name" : "Matt", "status" : "active", "level" : 12, "score"
                            : 212 }

Etapa 7: Explorar

Parabéns! Você concluiu com êxito o Guia de conceitos básicos do Amazon DocumentDB.

E depois? Saiba como aproveitar ao máximo esse banco de dados com alguns de seus atributos populares:

• Gerenciando o Amazon DocumentDB

• Escalabilidade

• Fazer backup e restaurar

nota

O cluster que você criou a partir desse exercício introdutório continuará gerando custos, a menos que seja excluído. Para obter instruções, consulte Exclusão de um cluster do Amazon DocumentDB.