database

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 Node.JS

Requer a versão Node.JS 18.x ou superior

Requer módulo ES Node.JS

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

{
  "type": "module"
}

Uso

Instalando o banco de dados

Você pode usar o método de instalação para instalar entidade e visualização no banco de dados.

database.install(config, [caminho de recurso], [dados de recurso])

caso 1: instalar entidade e visualização a partir do caminho do recurso, ele carregará os dados/entidade e dados/visualização do caminho raiz do projeto.

import database from '@sumor/database'

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

await database.install(config.database, process.cwd() + '/data')

caso 2: instalar entidade e visualização a partir dos dados do recurso, ele carregará dados/entidade e dados/visualização do objeto de dados.

import database from '@sumor/database'

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

Uso Geral

import database from '@sumor/database'

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

// obter cliente com pool de conexão
const cliente = await database.cliente(config)

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

// definir usuário operante
db.setarUsuário('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: idCarro })
// carro = {id: idCarro1, marca: 'BMW', modelo: 'X5'}

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

// contar registros
const contagem = await db.count('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 irá inserir registro se a marca 'BMW' já existir

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

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

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

// reverter
await db.reverter()

// 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',
    intervaloTermo: ['modelo'],
    top: 10,
    pular: 0
  }
)

Opções de Definição de Entidade

Índice

Você pode adicionar um array de índices à definição de entidade para criar um í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 de entidade para criar uma junção na tabela. como no exemplo abaixo, ele 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.install(config, {
  entity: {
    Carro: {
      propriedade: {
        marca: {
          tipo: 'string',
          comprimento: 100
        },
        modelo: {
          tipo: 'string',
          comprimento: 100
        }
      },
      índice: ['userId'],
      junção: {
        usuário: 'Usuário'
      }
    }
  },
  visualização: {}
})