Criar operações de API - Amazon DynamoDB

Criar operações de API

Para usar o NoSQL Workbench para criar APIs CRUD do DynamoDB, selecione Criador de operações à esquerda da interface de usuário do NoSQL Workbench.

Depois, selecione Abrir e escolha uma conexão.

Você pode executar as operações a seguir no criador de operações.

Excluir tabela

Para executar uma operação Delete Table, faça o seguinte:

  1. Encontre a tabela que você deseja excluir na seção Tabelas.

  2. Selecione Excluir tabela no menu de reticências horizontais.

  3. Confirme se você deseja excluir a tabela inserindo o Nome da tabela.

  4. Selecione Excluir.

Para obter mais informações essa operação, consulte Delete table (Excluir tabela) na Amazon DynamoDB API Reference (Referência da API do Amazon DynamoDB).

Excluir o GSI

Para executar uma operação Delete GSI, faça o seguinte:

  1. Encontre o GSI de uma tabela que você deseja excluir na seção Tabelas.

  2. Selecione Excluir GSI no menu de reticências horizontal.

  3. Confirme se você deseja excluir o GSI inserindo o Nome do GSI.

  4. Selecione Excluir.

Para obter mais informações essa operação, consulte Delete table (Excluir tabela) na Amazon DynamoDB API Reference (Referência da API do Amazon DynamoDB).

Create table

Para executar uma operação Create Table, faça o seguinte:

  1. Selecione o ícone + ao lado da seção Tabelas.

  2. Insira o nome da tabela desejado.

  3. Crie uma chave de partição.

  4. Opcional: crie uma chave de classificação.

  5. Para personalizar as configurações de capacidade, desmarque a caixa ao lado de Usar configurações de capacidade padrão.

    • Agora é possível selecionar Provisioned (Provisionada) ou On-demand capacity (Capacidade sob demanda).

      Com a opção Provisionada selecionada, você pode definir unidades de capacidade mínima e máxima de leitura e gravação. Você também pode habilitar ou desabilitar a escalabilidade automática.

    • Se, no momento, a tabela estiver definida como sob demanda, você não poderá especificar um throughput provisionado.

    • Se você mudar de sob demanda para throughput provisionado, o ajuste de escala automático será aplicado automaticamente a todos os GSIs com: mín.: 1, máx.: 10; meta: 70%.

  6. Selecione Ignorar GSIs e criar para criar essa tabela sem um GSI. Você também pode selecionar Próximo para criar um GSI com essa nova tabela.

Para obter mais informações sobre essa operação, consulte Create table (Criar tabela) na Amazon DynamoDB API Reference (Referência da API do Amazon DynamoDB).

Criar o GSI

Para executar uma operação Create GSI, faça o seguinte:

  1. Encontre uma tabela à qual você deseja adicionar um GSI.

  2. No menu de reticências horizontal, selecione Criar GSI.

  3. Nomeie o GSI em Nome do índice.

  4. Crie uma chave de partição.

  5. Opcional: crie uma chave de classificação.

  6. Selecione uma opção de tipo de projeção no menu suspenso.

  7. Selecione Criar GSI.

Para obter mais informações sobre essa operação, consulte Create table (Criar tabela) na Amazon DynamoDB API Reference (Referência da API do Amazon DynamoDB).

Atualizar tabela

Para atualizar as configurações de capacidade de uma tabela com uma operação Update Table, faça o seguinte:

  1. Encontre a tabela para a qual você deseja atualizar as configurações de capacidade.

  2. No menu de reticências horizontal, selecione Atualizar configurações de capacidade.

  3. Selecione Provisionada ou Capacidade sob demanda.

    Com a opção Provisionada selecionada, você pode definir unidades de capacidade mínima e máxima de leitura e gravação. Você também pode habilitar ou desabilitar a escalabilidade automática.

  4. Selecione Atualizar.

Para obter mais informações sobre essa operação, consulte Atualizar tabela na Amazon DynamoDB API Reference (Referência da API do Amazon DynamoDB).

Atualizar o GSI

Para atualizar as configurações de capacidade de um GSI com uma operação Update Table, faça o seguinte:

nota

Por padrão, os índices secundários globais herdam as configurações de capacidade da tabela de base. Os índices secundários globais podem ter um modo de capacidade diferente somente quando a tabela básica está no modo de capacidade provisionada. Ao criar um índice secundário global em uma tabela de modo provisionado, você deve especificar unidades de capacidade de leitura e gravação para a workload esperada no índice. Para ter mais informações, consulte Considerações sobre throughput provisionado para índices secundários globais.

  1. Encontre o GSI cujas configurações de capacidade você deseja atualizar.

  2. No menu de reticências horizontal, selecione Atualizar configurações de capacidade.

  3. Agora é possível selecionar Provisioned (Provisionada) ou On-demand capacity (Capacidade sob demanda).

    Com a opção Provisionada selecionada, você pode definir unidades de capacidade mínima e máxima de leitura e gravação. Você também pode habilitar ou desabilitar a escalabilidade automática.

  4. Selecione Atualizar.

Para obter mais informações sobre essa operação, consulte Atualizar tabela na Amazon DynamoDB API Reference (Referência da API do Amazon DynamoDB).

Colocar item

Você pode criar um item usando a operação Put Item. Para executar ou gerar código para uma operação Put Item, faça o seguinte:

  1. Encontre a tabela na qual você deseja criar um item.

  2. No menu suspenso Ações, selecione Criar item.

  3. Insira o valor da chave de partição.

  4. Insira o valor da chave de classificação, se houver.

  5. Se desejar adicionar atributos que não sejam de chave, faça o seguinte:

    1. Selecione + Adicionar outros atributos.

    2. Especifique o Attribute name (Nome do atributo), o Type (Tipo) e o Value (Valor).

  6. Se for necessário cumprir a expressão de condição para que a operação Put Item tenha êxito, faça o seguinte:

    1. Escolha Condition (Condição).

    2. Especifique o nome do atributo, o operador de comparação, o tipo de atributo e o valor do atributo.

    3. Se outras condições forem necessárias, escolha Condition (Condição) novamente.

    Para ter mais informações, consulte Exemplo de expressão de condição do DynamoDB na CLI.

  7. Se desejar gerar código, escolha Generate code (Gerar código).

    Selecione a linguagem desejada nas guias exibidas. Agora você pode copiar esse código e usá-lo na sua aplicação.

  8. Se desejar que a operação seja executada imediatamente, escolha Run (Executar).

  9. Se desejar salvar esta operação para uso posterior, escolha Save operation (Salvar operação). Em seguida, insira um nome para a operação e clique em Save (Salvar).

Para obter mais informações sobre essa operação, consulte PutItem na Referência da API do Amazon DynamoDB.

Atualizar item

Para executar ou gerar código para uma operação Update Item, faça o seguinte:

  1. Encontre a tabela na qual você deseja atualizar um item.

  2. Selecione o item.

  3. Insira o nome e o valor do atributo para a expressão selecionada.

  4. Se desejar adicionar mais expressões, escolha outra expressão na lista suspensa Atualizar expressão e selecione o ícone +.

  5. Se for necessário cumprir a expressão de condição para que a operação Update Item tenha êxito, faça o seguinte:

    1. Escolha Condition (Condição).

    2. Especifique o nome do atributo, o operador de comparação, o tipo de atributo e o valor do atributo.

    3. Se outras condições forem necessárias, escolha Condition (Condição) novamente.

    Para ter mais informações, consulte Exemplo de expressão de condição do DynamoDB na CLI.

  6. Se desejar gerar código, escolha Generate code (Gerar código).

    Escolha a guia da linguagem desejada. Agora você pode copiar esse código e usá-lo na sua aplicação.

  7. Se desejar que a operação seja executada imediatamente, escolha Run (Executar).

  8. Se desejar salvar esta operação para uso posterior, escolha Save operation (Salvar operação). Em seguida, insira um nome para a operação e clique em Save (Salvar).

Para obter mais informações sobre essa operação, consulte UpdateItem na Referência da API do Amazon DynamoDB.

Excluir item

Para executar uma operação Delete Item, faça o seguinte:

  1. Encontre a tabela na qual você deseja excluir um item.

  2. Selecione o item.

  3. No menu suspenso Ações, selecione Excluir item.

  4. Confirme se você deseja excluir o item selecionando Excluir.

Para obter mais informações sobre essa operação, consulte DeleteItem na Referência da API do Amazon DynamoDB.

Duplicar item

É possível duplicar um item criando um item com os mesmos atributos. Para duplicar um item, faça o seguinte:

  1. Encontre a tabela na qual você deseja duplicar um item.

  2. Selecione o item.

  3. No menu suspenso Ações, selecione Duplicar item.

  4. Especifique uma nova chave de partição.

  5. Especifique uma nova chave de classificação (se necessário).

  6. Selecione Executar.

Para obter mais informações sobre essa operação, consulte DeleteItem na Referência da API do Amazon DynamoDB.

Consulta

Para executar ou gerar código para uma operação Query, faça o seguinte:

  1. Selecione Consultar na parte superior da interface de usuário do NoSQL Workbench.

  2. Especifique o valor da chave de partição.

  3. Se uma chave de classificação for necessária para a operação Query:

    1. Selecione Sort key (Chave de classificação).

    2. Especifique o operador de comparação e o valor do atributo.

  4. Selecione Consultar para realizar essa operação de consulta. Se forem necessárias mais opções, marque a caixa de seleção Mais opções e continue com as etapas a seguir.

  5. Se nem todos os atributos precisarem ser retornados com o resultado da operação, selecione Projection expression (Expressão de projeção).

  6. Escolha o ícone +.

  7. Insira o atributo a ser retornado com o resultado da consulta.

  8. Se mais atributos forem necessários, escolha o +.

  9. Se for necessário cumprir a expressão de condição para que a operação Query tenha êxito, faça o seguinte:

    1. Escolha Condition (Condição).

    2. Especifique o nome do atributo, o operador de comparação, o tipo de atributo e o valor do atributo.

    3. Se outras condições forem necessárias, escolha Condition (Condição) novamente.

    Para ter mais informações, consulte Exemplo de expressão de condição do DynamoDB na CLI.

  10. Se desejar gerar código, escolha Generate code (Gerar código).

    Escolha a guia da linguagem desejada. Agora você pode copiar esse código e usá-lo na sua aplicação.

  11. Se desejar que a operação seja executada imediatamente, escolha Run (Executar).

  12. Se desejar salvar esta operação para uso posterior, escolha Save operation (Salvar operação). Em seguida, insira um nome para a operação e clique em Save (Salvar).

Para obter mais informações sobre essa operação, consulte Query na Referência da API do Amazon DynamoDB.

Verificar

Para executar ou gerar código para uma operação Scan, faça o seguinte:

  1. Selecione Verificar na parte superior da interface de usuário do NoSQL Workbench.

  2. Selecione o botão Verificar para realizar essa operação básica de verificação. Se forem necessárias mais opções, marque a caixa de seleção Mais opções e continue com as etapas a seguir.

  3. Especifique um nome de atributo para filtrar os resultados da verificação.

  4. Se nem todos os atributos precisarem ser retornados com o resultado da operação, selecione Projection expression (Expressão de projeção).

  5. Se a expressão de condição precisar ser satisfeita para a operação scan ser bem-sucedida, faça o seguinte:

    1. Escolha Condition (Condição).

    2. Especifique o nome do atributo, o operador de comparação, o tipo de atributo e o valor do atributo.

    3. Se outras condições forem necessárias, escolha Condition (Condição) novamente.

    Para ter mais informações, consulte Exemplo de expressão de condição do DynamoDB na CLI.

  6. Se desejar gerar código, escolha Generate code (Gerar código).

    Escolha a guia da linguagem desejada. Agora você pode copiar esse código e usá-lo na sua aplicação.

  7. Se desejar que a operação seja executada imediatamente, escolha Run (Executar).

  8. Se desejar salvar esta operação para uso posterior, escolha Save operation (Salvar operação). Em seguida, insira um nome para a operação e clique em Save (Salvar).

TransactGetItems

Para executar ou gerar código para uma operação TransactGetItems, faça o seguinte:

  1. No menu suspenso Mais operações na parte superior da interface de usuário do NoSQL Workbench, selecione TransactGetItems.

  2. Selecione o ícone + ao lado de TransactGetItem.

  3. Especifique uma chave de partição.

  4. Especifique uma chave de classificação (se necessário).

  5. Selecione Executar para realizar a operação, Salvar operação para salvá-la ou Gerar código para gerar código para ela.

Para obter mais informações, consulte Amazon DynamoDB Transactions.

TransactWriteItems

Para executar ou gerar código para uma operação TransactWriteItems, faça o seguinte:

  1. No menu suspenso Mais operações na parte superior da interface de usuário do NoSQL Workbench, selecione TransactWriteItems.

  2. Selecione uma operação no menu suspenso Ações.

  3. Selecione o ícone + ao lado de TransactWriteItem.

  4. Na lista suspensa Ações, selecione a operação desejada.

    • Para DeleteItem, siga as instruções para a operação Excluir item.

    • Para PutItem, siga as instruções para a operação Colocar item.

    • Para UpdateItem, siga as instruções para a operação Atualizar item.

    Para alterar a ordem das ações, escolha uma ação na lista à esquerda e selecione as setas para cima ou para baixo para movê-la para cima ou para baixo na lista.

    Para excluir uma ação, escolha a ação na lista e selecione o ícone Delete (Excluir) (lixeira).

  5. Selecione Executar para realizar a operação, Salvar operação para salvá-la ou Gerar código para gerar código para ela.

Para obter mais informações, consulte Amazon DynamoDB Transactions.