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 Node.JS versão 18.x ou superior

requer Node.JS módulo ES

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

{
  "type": "module"
}

Uso

Instalação do 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 do recurso], [dados do recurso])

caso 1: instalar entidade e visualização a partir do caminho do recurso, ele carregará dados/entidade e dados/visualização a partir do caminho da 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.client(config)

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

// definir usuário operativo
db.setUser('testador')

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

// ler registro
const carro = await db.single('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 count = await db.count('Carro', {
  marca: 'BMW'
})
// count = 2

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

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

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

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

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

// reverter
await db.rollback()

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

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

Opções de Consulta

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

Opções de Definição de Entidade

Índice

você pode adicionar uma matriz de índice à definição de entidade para criar um índice na tabela, por padrão, criará um índice no campo id.

Junção

Você pode adicionar um objeto de junção à definição de 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.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: {}
})