banco de dados

Uma ferramenta Sumor Cloud.
Documentação Adicional
Um conector de banco de dados para MySQL, etc. Baseado em entidade.

Instalação

npm i @sumor/database --save

Pré-requisitos

Versão do Node.JS

Necessário Node.JS na versão 18.x ou superior

Requer módulo ES do Node.JS

Como este pacote é escrito em módulo ES, por favor altere o código a seguir em seu arquivo package.json:

{
  "type": "module"
}

Utilização

Utilização Geral

import database from '@sumor/database'

const config = {
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'database',
  port: 3306
}

await database.install(config, {
  entity: {
    Carro: {
      propriedade: {
        marca: {
          tipo: 'string',
          tamanho: 100
        },
        modelo: {
          tipo: 'string',
          tamanho: 100
        }
      }
    }
  },
  visualização: {}
})

// obter cliente com pool de conexões
const cliente = await database.cliente(config)

// obter conexão
const db = await cliente.conectar()

// definir usuário operador
db.setarUsuario('testador')

// criar registro
const idCarro1 = await db.inserir('Carro', {
  marca: 'BMW',
  modelo: 'X5'
})
const idCarro2 = await db.inserir('Carro', {
  marca: 'BMW',
  modelo: 'X6'
})

// ler registro
const carro = await db.único('Carro', { id: idCarro1 })
// carro = {id: idCarro1, marca: 'BMW', modelo: 'X5'}

// consultar registros
const carros = await db.consulta('Carro', {
  marca: 'BMW'
})
// carros = [{id: idCarro1, marca: 'BMW', modelo: 'X5'}, {id: idCarro2, marca: 'BMW', modelo: 'X6'}]

// contar registros
const contagem = await db.contagem('Carro', {
  marca: 'BMW'
})
// contagem = 2

// atualizar registro
await db.atualizar(
  'Carro',
  { id: idCarro1 },
  {
    marca: 'BMW',
    modelo: 'X5M'
  }
)

// garantir registro
await db.garantir('Carro', ['marca'], {
  marca: 'BMW',
  modelo: 'X5C'
})
// não vai inserir o registro se a marca 'BMW' já existir

// modificar registro
await db.modificar('Carro', ['marca'], {
  marca: 'BMW',
  modelo: 'X5C'
})
// vai atualizar o modelo do registro se a marca 'BMW' já existir

// deletar registro
await db.deletar('Carro', { id: idCarro1 })

// fechar conexão
await db.confirmar()

// retorno
await db.rolarDeVolta()

// fechar conexão
await db.liberar()

// destruir cliente quando o servidor deve ser desligado
await cliente.destruir()

Opções de Consulta

// consultar registros com opções
const carros = await db.selecionar(
  'Carro',
  {
    marca: 'BMW'
  },
  {
    termo: 'X5',
    intervaloDeTermo: ['modelo'],
    superior: 10,
    pular: 0
  }
)

Opções de Definição de Entidade

Índice

Você pode adicionar um array de índice à definição da entidade para criar índice na tabela, por padrão, será criado um índice no campo id.

Junção

Você pode adicionar um objeto de junção à definição da entidade para criar junção na tabela. como no exemplo abaixo, criará o campo userId na entidade Carro.

import database from '@sumor/database'

const config = {
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'database',
  port: 3306
}

await database.instalar(config, {
  entidade: {
    Carro: {
      propriedade: {
        marca: {
          tipo: 'string',
          tamanho: 100
        },
        modelo: {
          tipo: 'string',
          tamanho: 100
        }
      },
      índice: ['userId'],
      junção: {
        usuário: 'Usuário'
      }
    }
  },
  visualização: {}
})