Skip to main content

MySQL

O módulo MySQL é responsável por criar uma conexão e manipular dados de um banco de dados MySQL.

Métodos​

connection​

Ação responsável por criar uma conexão com o banco de dados MySQL.

  const connection = await Database.MySQL.connection.v1_0_0({
    host: '',
    port: number,
    user: '',
    password: '',
    localAddress?: '',
    socketPath?: '',
    timezone?: '',
    connectTimeout?: number,
    stringifyObjects?: boolean,
    insecureAuth??: boolean,
    typeCast?: boolean,
    supportBigNumbers?: boolean,
    bigNumberStrings?: boolean,
    dateStrings?: boolean,
    debug?: boolean,
    trace?: boolean,
    multipleStatements?: boolean,
    flags?: '',
    ssl?: '',
    database?: '',
  })

Parâmetros obrigatório​

  • host: String - Este campo espera ser preenchido com o nome do host do banco de dados ao qual você está se conectando.
  • port: String - Este campo espera ser preenchido com o número da porta à qual deseja se conectar.
  • user: String - Este campo espera ser preenchido com o usuário do MySQL.
  • password: String - Este campo espera ser preenchido com a senha do MySQL.

Parâmetros opcionais​

  • database: String - Este campo espera ser preenchido com o nome da base de dados.
  • localAddress: String - Este campo espera ser preenchido com o endereço IP de origem a ser usado para conexão TCP.
  • socketPath: String - Este campo espera ser preenchido com o caminho para um soquete de domínio unix ao qual deseja se conectar.
  • Charset: String - Este campo espera ser preenchido com o charset desejado para a conexão.
  • timezone: Number - Este campo deve ser preenchido com o fuso horário configurado no servidor MySQL.
  • connectTimeout: Number - Este campo deve ser preenchido com os milissegundos desejados para indicar o tempo limite de uma conexão com o servidor MySQL.
  • stringifyObjects: Boolean - Este campo é uma seleção de Sim ou Não. O usuário deverá selecionar Sim se deseja que os objetos sejam convertidos para string.
  • insecureAuth: Boolean - Este campo é uma seleção de Sim ou Não. O usuário deverá selecionar Sim se deseja permitir a conexão com instâncias do MySQL que solicitam o método de autenticação antigo (inseguro).
  • typeCast: Boolean - Este campo é uma seleção de Sim ou Não. O usuário deverá selecionar Sim se deseja que os valores da coluna devem ser convertidos em tipos JavaScript nativos.
  • supportBigNumbers: Boolean - Este campo é uma seleção de Sim ou Não. O usuário deverá selecionar Sim se deseja lidar com números grandes (colunas BIGINT e DECIMAL) no banco de dados.
  • bigNumberStrings: Boolean - Este campo é uma seleção de Sim ou Não. O usuário deverá selecionar Sim se deseja forçar números grandes (colunas BIGINT e DECIMAL) a serem sempre retornados como String.
  • dateStrings: Boolean - Este campo é uma seleção de Sim ou Não. O usuário deverá selecionar Sim se deseja forçar os tipos de data (TIMESTAMP, DATETIME, DATE) a serem retornados como strings.
  • debug: Boolean - Este campo é uma seleção de Sim ou Não. O usuário deverá selecionar Sim se deseja imprimir detalhes do protocolo em stdout.
  • trace: Boolean - Este campo é uma seleção de Sim ou Não. O usuário deverá selecionar Sim se deseja gerar rastreamentos de pilha de Erros.
  • multipleStatements : Boolean - Este campo é uma seleção de Sim ou Não. O usuário deverá selecionar Sim se deseja permitir várias instruções mysql por consulta.
  • flags: String - Este campo espera ser preenchido com as flags que devem ser inseridas ou removidas das consultas.
  • ssl: String - Este campo espera ser preenchido com um objeto com parâmetros SSL ou uma string contendo o nome do perfil SSL. Consulte as opções de SSL.

Retorno​

Esta ação não possui retorno.

getDataValue​

Ação responsável obter um determinado dado de uma posição de uma resposta de um comando SQL executado em um banco de dados MySQL.

  const getDataValue = await Database.MySQL.getDataValue.v1_0_0({
    column: '',
    row: 1,
    query: ''
  })

Parâmetros obrigatório​

  • column: String - Este campo espera ser preenchido com o nome da coluna do MySQL desejada.
  • row: Number - Este campo espera ser preenchido com a posição em que o dado desejado se encontra no retorno da query executada.

Parâmetros opcionais​

  • query: String - Este campo possui uma lista com os IDs das conexões de banco MySQL criadas anteriormente pela ação de Criar conexão MySQL, basta selecionar a conexão desejada.

Retorno​

A constante ou variável criada, como a getDataValue do exemplo mostrado anteriormente, receberá um valor do tipo Object. O objeto retornado terá a seguinte propriedade:

  • getDataValue.values: text - retorna o dado obtido de uma query MySQL.

getReply​

Ação responsável obter a resposta de um comando SQL executado em um banco de dados MySQL. Essa ação pode ser utilizada quando foi realizado um SELECT no banco de dados.

  const getReply = await Database.MySQL.getReply.v1_0_0({
    query: ''
  })

Parâmetros obrigatório​

Esta ação não possui parâmetros obrigatórios.

Parâmetros opcionais​

  • query: String - Este campo possui uma lista com os IDs das conexões de banco MySQL criadas anteriormente pela ação de Criar conexão MySQL, basta selecionar a conexão desejada.

Retorno​

A constante ou variável criada, como a getReply do exemplo mostrado anteriormente, receberá um valor do tipo Object. O objeto retornado terá a seguinte propriedade:

  • getReply.values: array - retorna os resultados de um SELECT executado em uma query MySQL.

query​

Ação responsável executar um comando SQL em um banco de dados MySQL. Por exemplo: Um comando para inserir, selecionar, deletar ou atualizar certo tipo de dado ou tabela do banco de dados MySQL.

  const query = await Database.MySQL.query.v1_0_0({
    connection: connection
    query: '',
    timeout: 1
  })

Parâmetros obrigatório​

  • connection: Este campo possui uma lista com os IDs das conexões de banco MySQL criadas anteriormente pela ação de Criar conexão MySQL, basta selecionar a conexão desejada.
  • query: String - Este campo espera ser preenchido com a query que deverá ser executada pelo MySQL. Exemplo: SELECT * FROM teste.teste.
  • timeout: Nuber - Este campo espera um número, referente ao tempo de espera para que a ação de clicar comece a ser executada. O valor é sempre dado em segundos e o seu valor padrão é 0.

Retorno​

A constante ou variável criada, como a query do exemplo mostrado anteriormente, receberá um valor do tipo Object. O objeto retornado terá as seguintes propriedades:

  • query.size: number - retorna a quantidade de dados retornados pela query.
  • query.query: text - retorna se a query foi executada.
  • query.response: array - retorna os resultados da query.
  • query.insertedId: number - retorna o Id do registro inserido.
  • query.affectedRows: number - retorna a quantidade de linhas afetadas.
  • query.changedRows: number - retorna a quantidade de linhas alteradas.