База данных

Sumor Cloud Tool.
Дополнительная документация
Коннектор базы данных для MySQL и т. д. На основе сущности.

Установка

npm i @sumor/database --save

Предварительные требования

Версия Node.JS

Требуется Node.JS версии 18.x или выше.

Требуется ES-модуль Node.JS

Поскольку пакет написан на ES-модуле, пожалуйста, измените следующий код в вашем файле package.json:

{
  "type": "module"
}

Использование

Общее использование

import database from '@sumor/database'

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

await database.install(config, {
  entity: {
    Car: {
      property: {
        brand: {
          type: 'string',
          length: 100
        },
        model: {
          type: 'string',
          length: 100
        }
      }
    }
  },
  view: {}
})

// получить клиента с пулом соединений
const client = await database.client(config)

// получить соединение
const db = await client.connect()

// установить пользователя
db.setUser('tester')

// создать запись
const car1Id = await db.insert('Car', {
  brand: 'BMW',
  model: 'X5'
})
const car2Id = await db.insert('Car', {
  brand: 'BMW',
  model: 'X6'
})

// прочитать запись
const car = await db.single('Car', { id: carId })
// car = {id: car1Id, brand: 'BMW', model: 'X5'}

// запросить записи
const cars = await db.query('Car', {
  brand: 'BMW'
})
// cars = [{id: car1Id, brand: 'BMW', model: 'X5'}, {id: car2Id, brand: 'BMW', model: 'X6'}]

// подсчитать записи
const count = await db.count('Car', {
  brand: 'BMW'
})
// count = 2

// обновить запись
await db.update(
  'Car',
  { id: car1Id },
  {
    brand: 'BMW',
    model: 'X5M'
  }
)

// гарантировать запись
await db.ensure('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// не будет вставлять запись, если запись с брендом "BMW" уже существует

// изменить запись
await db.modify('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// обновит запись модели, если запись с брендом "BMW" уже существует

// удалить запись
await db.delete('Car', { id: car1Id })

// закрыть соединение
await db.commit()

// откат изменений
await db.rollback()

// закрыть соединение
await db.release()

// уничтожить клиента, когда сервер должен быть выключен
await client.destroy()

Опции запроса

// запросить записи с опциями
const cars = await db.select(
  'Car',
  {
    brand: 'BMW'
  },
  {
    term: 'X5',
    termRange: ['model'],
    top: 10,
    skip: 0
  }
)

Опции определения сущности

Индекс

Вы можете добавить массив индекса к определению сущности для создания индекса на таблице, по умолчанию создается индекс на поле id.

Join

Вы можете добавить объект соединения к определению сущности для создания соединения в таблице. В приведенном ниже примере будет создано поле userId в сущности Car.

import database from '@sumor/database'

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

await database.install(config, {
  entity: {
    Car: {
      property: {
        brand: {
          type: 'string',
          length: 100
        },
        model: {
          type: 'string',
          length: 100
        }
      },
      index: ['userId'],
      join: {
        user: 'User'
      }
    }
  },
  view: {}
})