Criação e execução de consultas

O módulo cds.ql fornece uma API do tipo SQL para a construção de tais consultas de banco de dados. As consultas necessárias para nosso cenário são mostradas na figura a seguir.

A API é disponibilizada por meio dos objetos globais SELECT, INSERT, UPSERT, UPDATE e DELETE.

12
const cds = require('@sap/cds');
const { SELECT, INSERT, UPSERT, UPDATE, DELETE } = cds.ql;

A API disponível por meio dos objetos CRUD listados é concebida como uma API fluente. Isso significa que os métodos disponíveis nesses objetos retornam objetos do mesmo tipo. As propriedades disponíveis - como a propriedade .one do objeto SELECT usado no exemplo mostrado - também têm objetos do mesmo tipo que seu valor. Isso permite o encadeamento, o que torna a codificação intuitiva e legível.

Para identificar a tabela de banco de dados a ser acessada, usamos a definição CSN da entidade Livros no exemplo mostrado. Esta é a abordagem recomendada.

Como uma alternativa às chamadas de método clássicas mostradas acima, a API fluente também pode ser usada com modelos marcados. A figura a seguir mostra como as consultas construídas acima usando chamadas de método clássicas podem ser criadas usando modelos marcados. O resultado é o mesmo em ambos os casos.

Na seção anterior, discutimos como os objetos query são criados. No entanto, as queries estruturadas não são executadas automaticamente. Eles ainda precisam ser enviados explicitamente para o banco de dados para execução. Agora vamos explorar como isso é alcançado.

A seguir, examinaremos como as consultas podem ser executadas no banco de dados. Neste contexto, não importa se os objetos query foram criados mediante chamadas de método clássicas ou mediante modelos marcados. Nos exemplos a seguir, usaremos chamadas de método clássicas para a construção de consultas.

As consultas são executadas no banco de dados transferindo-as para o método cds.db.run() (consulte a figura a seguir). Isso se aplica não só a consultas SELECT, como mostrado no exemplo, mas também à escrita de consultas ao banco de dados, como um UPDATE.

No exemplo, o operador await é utilizado para esperar pelo resultado da consulta SELECT.one. Este resultado é atribuído à constante b. No momento da execução, a constante é um objeto com uma característica chamada estoque. O valor desta propriedade é o estoque selecionado no banco de dados para o livro que foi especificado usando o método where() . Se não for possível encontrar um livro com o ID indicado na tabela de banco de dados, a constante b recebe o valor undefined.

Como alternativa à abordagem acima, você também pode simplesmente await uma consulta construída. Isso transfere a consulta para o método cds.db.run() por padrão. Isso significa que o exemplo seguinte e o anterior são equivalentes em relação à consulta SELECT:

O exemplo também mostra como a atualização é executada no banco de dados.

Após a atualização, um objeto é retornado ao chamador de acordo com o tipo de resposta da ação submitOrder. Este objeto tem um estoque de propriedade cujo valor é o estoque atualizado para o livro pedido.

Na parte do exercício desta lição, você encontrará a implementação completa para o método reduceStock(). Nesta implementação, é emitida uma mensagem de erro se o ID do livro transferido não existir no banco de dados (ou seja, se a constante b tiver o valor undefined). Uma mensagem de erro também é emitida se o estoque do registro for inferior à quantidade pedida.

Assista ao vídeo para ver como utilizar consultas na implementação de Serviços CAP.