#Coleção

#Visão Geral

A coleção é usada para definir modelos de dados no sistema, como nomes de modelos, campos, índices, associações e outras informações. Geralmente, ela é chamada através do método collection de uma instância de Database como um ponto de entrada proxy.

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

// Cria uma instância de banco de dados
const db = new Database({...});

// Define um modelo de dados
db.collection({
  name: 'users',
  // Define os campos do modelo
  fields: [
    // Campo escalar
    {
      name: 'name',
      type: 'string',
    },

    // Campo de associação
    {
      name: 'profile',
      type: 'hasOne' // 'hasMany', 'belongsTo', 'belongsToMany'
    }
  ],
});

Para mais tipos de campos, consulte Campos.

#Construtor

Assinatura

• constructor(options: CollectionOptions, context: CollectionContext)

Parâmetros

Exemplo

Crie uma coleção de posts:

const posts = new Collection(
  {
    name: 'posts',
    fields: [
      {
        type: 'string',
        name: 'title',
      },
      {
        type: 'double',
        name: 'price',
      },
    ],
  },
  {
    // Instância de banco de dados existente
    database: db,
  },
);

#Membros da Instância

#options

Parâmetros de configuração inicial para a coleção. Idêntico ao parâmetro options do construtor.

#context

O contexto ao qual a coleção atual pertence, atualmente sendo principalmente a instância do banco de dados.

#name

Nome da coleção.

#db

A instância do banco de dados à qual pertence.

#filterTargetKey

O nome do campo usado como chave primária.

#isThrough

Se é uma coleção intermediária.

#model

Corresponde ao tipo de Model do Sequelize.

#repository

Instância do repositório.

#Métodos de Configuração de Campo

#getField()

Obtém o objeto de campo com o nome correspondente definido na coleção.

Assinatura

• getField(name: string): Field

Parâmetros

Exemplo

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

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

#setField()

Define um campo para a coleção.

Assinatura

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

Parâmetros

Exemplo

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

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

#setFields()

Define múltiplos campos para a coleção em lote.

Assinatura

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

Parâmetros

Exemplo

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

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

#removeField()

Remove o objeto de campo com o nome correspondente definido na coleção.

Assinatura

• removeField(name: string): void | Field

Parâmetros

Exemplo

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

posts.removeField('title');

#resetFields()

Redefine (limpa) os campos da coleção.

Assinatura

• resetFields(): void

Exemplo

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

posts.resetFields();

#hasField()

Verifica se um objeto de campo com o nome correspondente está definido na coleção.

Assinatura

• hasField(name: string): boolean

Parâmetros

Exemplo

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

posts.hasField('title'); // true

#findField()

Encontra um objeto de campo na coleção que atende aos critérios.

Assinatura

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

Parâmetros

Exemplo

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

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

#forEachField()

Itera sobre os objetos de campo na coleção.

Assinatura

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

Parâmetros

Exemplo

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

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

#Métodos de Configuração de Índice

#addIndex()

Adiciona um índice à coleção.

Assinatura

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

Parâmetros

Exemplo

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

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

#removeIndex()

Remove um índice da coleção.

Assinatura

• removeIndex(fields: string[])

Parâmetros

Exemplo

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

posts.removeIndex(['title']);

#Métodos de Configuração da Coleção

#remove()

Exclui a coleção.

Assinatura

• remove(): void

Exemplo

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

posts.remove();

#Métodos de Operação de Banco de Dados

#sync()

Sincroniza a definição da coleção com o banco de dados. Além da lógica padrão de Model.sync no Sequelize, ele também processa as coleções correspondentes aos campos de associação.

Assinatura

• sync(): Promise<void>

Exemplo

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

await posts.sync();

#existsInDb()

Verifica se a coleção existe no banco de dados.

Assinatura

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

Parâmetros

Exemplo

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

const existed = await posts.existsInDb();

console.log(existed); // false

#removeFromDb()

Assinatura

• removeFromDb(): Promise<void>

Exemplo

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

// Sincroniza a coleção de livros com o banco de dados
await db.sync();

// Remove a coleção de livros do banco de dados
await books.removeFromDb();