#Collection - Коллекция

#Обзор

Коллекция используется для определения моделей данных в системе, таких как имена моделей, поля, индексы, связи и другая информация. Обычно она вызывается через метод collection экземпляра Database в качестве прокси-записи.

const { Database } = require('@nocobase/database')

// Создать экземпляр базы данных
const db = new Database({...});

// Определить модель данных
db.collection({
  name: 'users',
  // Определить поля модели
  fields: [
    // Скалярное поле
    {
      name: 'name',
      type: 'string',
    },

    // Поле связи
    {
      name: 'profile',
      type: 'hasOne' // 'hasMany', 'belongsTo', 'belongsToMany'
    }
  ],
});

Дополнительные типы полей см. в разделе Поля.

#Конструктор

Сигнатура

• constructor(options: CollectionOptions, context: CollectionContext)

Параметры

Пример

Создайте коллекцию постов:

const posts = new Collection(
  {
    name: 'posts',
    fields: [
      {
        type: 'string',
        name: 'title',
      },
      {
        type: 'double',
        name: 'price',
      },
    ],
  },
  {
    // Существующий экземпляр базы данных
    database: db,
  },
);

#Члены экземпляра

#options

Параметры начальной конфигурации коллекции. То же, что параметр options конструктора.

#context

Контекст, к которому принадлежит текущая коллекция, в настоящее время в основном экземпляр базы данных.

#name

Название коллекции.

#db

Экземпляр базы данных, которому он принадлежит.

#filterTargetKey

Имя поля, используемое в качестве первичного ключа.

#isThrough

Является ли это промежуточной коллекцией.

#model

Соответствует типу модели Sequelize.

#repository

Экземпляр репозитория.

#Методы настройки полей

#getField()

Получает объект поля с соответствующим именем, определенным в коллекции.

Сигнатура

• getField(name: string): Field

Параметры

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

const field = posts.getField('title');

#setField()

Устанавливает поле для коллекции.

Сигнатура

• setField(name: string, options: FieldOptions): Field

Параметры

Пример

const posts = db.collection({ name: 'posts' });

posts.setField('title', { type: 'string' });

#setFields()

Пакетно устанавливает несколько полей для коллекции.

Сигнатура

• setFields(fields: FieldOptions[], resetFields = true): Field[]

Параметры

Пример

const posts = db.collection({ name: 'posts' });

posts.setFields([
  { type: 'string', name: 'title' },
  { type: 'double', name: 'price' },
]);

#removeField()

Удаляет объект поля с соответствующим именем, определенным в коллекции.

Сигнатура

• removeField(name: string): void | Field

Параметры

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

posts.removeField('title');

#resetFields()

Сбрасывает (очищает) поля коллекции.

Сигнатура

• resetFields(): void

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

posts.resetFields();

#hasField()

Проверяет, определен ли в коллекции объект поля с соответствующим именем.

Сигнатура

• hasField(name: string): boolean

Параметры

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

posts.hasField('title'); // истинный

#findField()

Находит объект поля в коллекции, соответствующий критериям.

Сигнатура

• findField(predicate: (field: Field) => boolean): Field | undefined

Параметры

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

posts.findField((field) => field.name === 'title');

#forEachField()

Перебирает объекты полей в коллекции.

Сигнатура

• forEachField(callback: (field: Field) => void): void

Параметры

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

posts.forEachField((field) => console.log(field.name));

#Методы настройки индекса

#addIndex()

Добавляет индекс в коллекцию.

Сигнатура

• addIndex(index: string | string[] | { fields: string[], unique?: boolean,[key: string]: any })

Параметры

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

posts.addIndex({
  fields: ['title'],
  unique: true,
});

#removeIndex()

Удаляет индекс из коллекции.

Сигнатура

• removeIndex(fields: string[])

Параметры

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
  indexes: [
    {
      fields: ['title'],
      unique: true,
    },
  ],
});

posts.removeIndex(['title']);

#Методы настройки коллекции

#remove()

Удаляет коллекцию.

Сигнатура

• remove(): void

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

posts.remove();

#Методы работы с базой данных

#sync()

Синхронизирует определение коллекции с базой данных. В дополнение к логике Model.sync по умолчанию в Sequelize он также обрабатывает коллекции, соответствующие полям связи.

Сигнатура

• sync(): Promise<void>

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

await posts.sync();

#existsInDb()

Проверяет, существует ли коллекция в базе данных.

Сигнатура

• existsInDb(options?: Transactionable): Promise<boolean>

Параметры

Пример

const posts = db.collection({
  name: 'posts',
  fields: [
    {
      type: 'string',
      name: 'title',
    },
  ],
});

const existed = await posts.existsInDb();

console.log(existed); // ЛОЖЬ

#removeFromDb()

Сигнатура

• removeFromDb(): Promise<void>

Пример

const books = db.collection({
  name: 'books',
});

// Синхронизировать коллекцию книг с базой данных
await db.sync();

// Удалить коллекцию книг из базы данных
await books.removeFromDb();