База данных

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

Установка

npm i @sumor/database --save

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

Версия Node.JS

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

Требование к модулю Node.JS ES

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

{
  "type": "module"
}

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

Установка базы данных

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

database.install(config, [путь к ресурсу], [данные ресурса])

случай 1: установить сущность и представление из указанного пути к ресурсу, загружает данные сущности и данных представления из корневого пути проекта.

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')

случай 2: установить сущность и представление из данных ресурса, загружает данные сущности и данных представления из объекта данных.

import database from '@sumor/database'

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

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

import database from '@sumor/database'

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

// получение клиента с пулом соединений
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'
})
// запись не будет вставлена, если записи с brand 'BMW' уже существуют

// модификация записи
await db.modify('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// обновит модель записи, если запись с brand '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

Вы можете добавить объект 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: {}
})