Skip to main content

SQL Server

O módulo SQL Server é responsável conectar em um SGBD SQL Server, realizar querys e manipular os resultados dentro do robô.

Métodos​

connection​

Método responsável por criar uma conexão com um banco de dados SQL server.

const connection =  await Database.SQLServer.connection["v1_0_0"]({
      connectionString: `Server=localhost;1433;Database=master;User Id=admin;password=123;TrustServerCertificate=True;`,
    })

Parâmetros obrigatórios​

  • connectionString: String - espera uma string com os parâmetros da conexão. O padrão deve ser seguido conforme o exemplo mostrado anteriormente.

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais.

Retorno​

Esta ação não possui retornos.

close​

Método responsável por fechar uma conexão aberta com um banco de dados SQL Server.

await Database.SQLServer.close["v1_0_0"]({
      connection: connection,
    })

Parâmetros obrigatórios​

  • connection: Retorno da ação de conexão - espera uma varíavel ou constante em que está armazenada a conexão obtida através da ação connection.

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais.

Retorno​

Esta ação não possui retornos.

transactionBegin​

Método responsável criar uma transação com o SGBD SQL Server.

const transaction = await Database.SQLServer.transactionBegin["v1_0_0"]({
      connection: connection,
    })

Parâmetros obrigatórios​

  • connection: Retorno da ação de conexão - espera uma varíavel ou constante em que está armazenada a conexão obtida através da ação connection.

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais.

Retorno​

Esta ação não possui retornos.

transactionCommit​

Método responsável por aplicar (commitar) uma transação que foi aberta pela a ação transactionBegin.

await Database.SQLServer.transactionCommit["v1_0_0"]({
      transaction: transaction,
    })

Parâmetros obrigatórios​

  • transaction: Retorno da ação de iniciar uma transação - espera uma varíavel ou constante em que está armazenada a transação obtida através da ação transactionBegin.

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais.

Retorno​

Esta ação não possui retornos.

transactionRollBack​

Método responsável por desfazer uma transação (rollback) que foi aberta pela a ação transactionBegin

await Database.SQLServer.transactionRollBack["v1_0_0"]({
      transaction: transaction,
    })

Parâmetros obrigatórios​

  • transaction: Retorno da ação de iniciar uma transação - espera uma varíavel ou constante em que está armazenada a transação obtida através da ação connection

Parâmetros opcionais​

Esta ação não possui parâmetros opcionais

Retorno​

Esta ação não possui retornos.

query​

Método responsável por realizar uma query diretamente no banco de dados selecionado através da conexão obtida pela a ação connection.

  const query = await Database.SQLServer.query["v1_0_0"]({
      query: `SELECT * FROM tabela;`
      connection: connection ,
      transaction: transaction
    })

Parâmetros obrigatórios​

  • connection: Retorno da ação de conexão - espera uma varíavel ou constante em que está armazenada conexão obtida através da ação connection;
  • query: String - espera uma string com a query a ser realizada;

Parâmetros opcionais​

  • transaction: Retornado da ação transactionBegin - espera uma varíavel ou constante em que está armazenada a transação obtida através da ação transactionBegin;

Retorno​

A constante ou variável criada, como a query do exemplo mostrado anteriormente, receberá o um valor do tipo Objeto que dará acesso as seguintes propriedades:

  • query.query: String - retorna uma string com a query que foi utilizada;
  • query.result: Array - retorna um array com todos os resultados obtidos com a query;
  • query.resultsCount: Number - retorna a quantidade de linhas que foi obtidas no resultado.

getSingleResult​

Método responsável por obter um único resultado de uma lista de resultados que foi retornada pela ação de query.

  const getSingleResult = await Database.SQLServer.getSingleResult["v1_0_0"]({
      query: query,
      resultIndex: 'string' ,
    })

Parâmetros obrigatórios​

  • query: Retorno da query - espera uma varíavel ou constante em que está armazenada conexão obtida através da ação query;
  • resultIndex: Number - espera um number posição do resultado.

Retorno​

A constante ou variável criada, como a getSingleResult do exemplo mostrado anteriormente, receberá o um valor do tipo Objeto que dará acesso as seguintes propriedades:

  • resultIndex: Number - retorna a posição do resultado obtido.
  • result: String - retorna o resultado.

getFieldFromResult​

Método responsável por obter um único resultado de uma lista de resultados que foi retornada pela ação de query.

  const getFieldFromResult = await Database.SQLServer.getFieldFromResult["v1_0_0"]({
      query: query,
      field: 'string' ,
      resultType: `multiple` | `single`.
    })

Parâmetros obrigatórios​

  • query: Retorno da query - espera uma varíavel ou constante em que está armazenada conexão obtida através da ação query;
  • field: String - espera uma string com o nome do campo.
  • resultType: Options - multiple | single.

Retorno​

A constante ou variável criada, como a getFieldFromResult do exemplo mostrado anteriormente, receberá o um valor do tipo Objeto que dará acesso a seguinte propriedade:

  • value: any - retorna o valor do campo.