Essa documentação diz respeito aos blocos de programação Remover (Fonte de dados) e Remover, apesar de terem nomes parecidos, funcionam de formas diferentes.

Remove o registro vinculado a posição corrente do cursor de uma tabela em um banco de dados.

Parâmetros de Entrada

Compatibilidade

Image Removed Servidor

Exemplo 1

A função em destaque abaixo remove do banco de dados o registro sinalizado pelo cursor.

Image Removed

Bloco Remover (Fonte de dados)

Remove o registro atual da lista. Essa lista por vir do retorno do bloco Abrir consulta.

Image Added

Figura 1 - Bloco Remover (Fonte de dados)

Compatibilidade

• Bloco servidor: cronapi.database.Operations.remove()

Retorno

O bloco não possui retorno.

Parâmetros

Fonte de dados

Lista contendo os registros no padrão do retorno do bloco Abrir consulta.

• Posição: 1
• Inglês: Datasource
• Tipo: Lista / List
• Exemplo: retorno do bloco Abrir consulta.

Exemplo

A função a seguir apresenta um exemplo de uso do bloco Remover (Fonte de dados). Neste exemplo, o bloco Abrir consulta foi configurado a partir da classe "Aluno" do Diagrama de dados. Em seguida, enquanto houver registros na consulta, os blocos de repetição e Existe registro verificarão, utilizando o bloco se faça, se o e-mail informado no bloco de texto é o mesmo encontrado no registro obtido pelo bloco Obter campo do. Se for o mesmo, o bloco Remover (Fonte de dados) irá excluir esse registro. A cada repetição o bloco Próximo registro permite avançar para o próximo registro disponível.

Image Added

Figura 2 - Exemplo de uso do bloco Remover (Fonte de dados)

As Figuras 2.1 e 2.2 apresentam os registros no banco de dados antes e depois da remoção, respectivamente. Observe que somente o registro que contém o e-mail informado (destaque 1 da Figura 2.1) foi removido.

Image Added

Figura 2.1 - Tabela "Aluno" antes da remoção do registro

Image Added

Figura 2.2 - Tabela "Aluno" depois da remoção do registro

Bloco Remover

Permite remover um ou mais registros vinculados ao Banco de dados ou gerar uma requisição DELETE a partir de uma Fonte de dados Cronapp.

Image Added

Figura 3 - Bloco Remover

Compatibilidade

• Bloco servidor: cronapi.database.Operations.remove()

Retorno

O bloco não possui retorno.

Características do bloco

Para configurar o bloco Remover, clique no ícone de engrenagem (seta da Figura 4). Após esta ação, a janela do Assistente será exibida permitindo a configuração dos campos de forma visual, não necessitando de uma interação direta com códigos na linguagem JPQL ou SQL. As consultas no Assistente podem ser configuradas a partir de uma Entidade, Fonte de dados ou SQL Nativo. Para mais detalhes da estrutura do Assistente de consulta do bloco (Figura 4), consulte a documentação Assistente de consulta.

Image Added

Figura 4 - Configuração do bloco Remover

Destaques da Figura 4:

1. Entidade: abre a janela de seleção de entidades.
2. Tipos: define como será removido os registros:
   • Campos: permite criar regras para remover um ou vários registros ao mesmo tempo.
   • Objeto: esta opção não permite definir regras, o bloco remove o registro com base no objeto informado. Veja o Exemplo 1 para mais detalhes de configuração.
3. Regras: Possui a mesma estrutura vista no tópico "Regras" da documentação do Assistente de consulta.
4. Botão Excluir: apaga as regras inseridas. 

Para informações das demais opções exibidas no Assistente do bloco Remover, consulte a documentação Assistente de consulta.

Parâmetros

Parâmetro "N"

Os parâmetros da função são exibidos de acordo com o objeto ou os campos adicionados na tela de configuração do bloco de programação no Assistente de consulta. Isso implica que a cada novo campo definido, cujo valor não seja estático, um parâmetro é apresentado no bloco da função. 

• Posição: 1 ou mais
• Tipo: Depende do tipo do dado do atributo.

Exemplo 1 - Remoção por objeto

A função a seguir apresenta um exemplo de uso do bloco Remover configurado com o Tipo "Objeto" (destaque 2 da Figura 4) a partir da classe "Aluno" do Diagrama de dados. Neste exemplo, o bloco Remover recebe o bloco na lista com o retorno do bloco Abrir consulta. Dessa forma, vamos excluir o primeiro registro da consulta que possui o e-mail informado.

Image Added

Figura 5 - Exemplo de uso do bloco Remover passando um objeto como parâmetro 

Exemplo 2 - Remoção por campos

A imagem abaixo apresenta um exemplo de uso do bloco Atualizar configurado com o Tipo "Campos" (destaque 2 da Figura 4). O bloco foi configurado conforme a Figura 4. Por meio dele, removeremos os registros que possui o mesmo e-mail informado no parâmetro.

Image Added

Figura 6 - Exemplo de uso do bloco Remover utilizando o tipo "Campos"

Ao clicar no botão "Editar como Texto" (Figura 4), poderemos observar que a consulta definida ficará da seguinte forma:

DELETE FROM Aluno WHERE email = :email

Exemplo 3 - Utilizando uma Fonte de dados

A função abaixo apresenta um exemplo de uso do bloco Remover configurado com o Tipo "Campos" (destaque 2 da Figura 4) a partir da Fonte de dados "query156543". É importante destacar que, diferente dos exemplos anteriores, no qual ao selecionar uma classe é possível utilizar tanto o Tipo "Campos" como "Objeto", ao utilizar uma Fonte de dados apenas o Tipo "Campos" é permitido.

O bloco da função abaixo foi configurado conforme a Figura 4. Após a execução da função o registro será removido do banco de dados.

Image Added

Figura 7 - Exemplo de uso do bloco Remover configurado com uma Fonte de dados

Ao clicar no botão "Editar como Texto" (Figura 4), poderemos observar que a consulta definida gera a requisição REST abaixo. Para mais detalhes, consulte o tópico REST da documentação Assistente de consulta.

DELETE app/query156543(email=:email)