#Collection

#Ikhtisar

Collection digunakan untuk mendefinisikan model data dalam sistem, seperti nama model, field, index, asosiasi, dll. Umumnya dipanggil melalui method collection dari instance Database sebagai entry point proxy.

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

// Membuat instance database
const db = new Database({...});

// Mendefinisikan model data
db.collection({
  name: 'users',
  // Mendefinisikan field model
  fields: [
    // Field skalar
    {
      name: 'name',
      type: 'string',
    },

    // Field asosiasi
    {
      name: 'profile',
      type: 'hasOne' // 'hasMany', 'belongsTo', 'belongsToMany'
    }
  ],
});

Untuk tipe field lainnya lihat Fields.

#Constructor

Signature

• constructor(options: CollectionOptions, context: CollectionContext)

Parameter

Contoh

Membuat tabel artikel:

const posts = new Collection(
  {
    name: 'posts',
    fields: [
      {
        type: 'string',
        name: 'title',
      },
      {
        type: 'double',
        name: 'price',
      },
    ],
  },
  {
    // Instance database yang sudah ada
    database: db,
  },
);

#Anggota Instance

#options

Parameter awal konfigurasi tabel data. Konsisten dengan parameter options dari constructor.

#context

Lingkungan konteks tempat tabel data saat ini berada, saat ini terutama instance database.

#name

Nama tabel data.

#db

Instance database yang dimiliki.

#filterTargetKey

Nama field yang berfungsi sebagai primary key.

#isThrough

Apakah merupakan tabel perantara.

#model

Tipe Model yang sesuai dengan Sequelize.

#repository

Instance data repository.

#Method Konfigurasi Field

#getField()

Mendapatkan objek field dengan nama yang sesuai yang sudah didefinisikan di tabel data.

Signature

• getField(name: string): Field

Parameter

Contoh

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

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

#setField()

Mengatur field pada tabel data.

Signature

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

Parameter

Contoh

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

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

#setFields()

Mengatur beberapa field sekaligus pada tabel data.

Signature

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

Parameter

Contoh

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

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

#removeField()

Menghapus objek field dengan nama yang sesuai yang sudah didefinisikan di tabel data.

Signature

• removeField(name: string): void | Field

Parameter

Contoh

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

posts.removeField('title');

#resetFields()

Mereset (mengosongkan) field tabel data.

Signature

• resetFields(): void

Contoh

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

posts.resetFields();

#hasField()

Memeriksa apakah objek field dengan nama yang sesuai sudah didefinisikan di tabel data.

Signature

• hasField(name: string): boolean

Parameter

Contoh

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

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

#findField()

Mencari objek field di tabel data yang memenuhi kondisi.

Signature

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

Parameter

Contoh

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

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

#forEachField()

Iterasi objek field di tabel data.

Signature

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

Parameter

Contoh

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

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

#Method Konfigurasi Index

#addIndex()

Menambahkan index tabel data.

Signature

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

Parameter

Contoh

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

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

#removeIndex()

Menghapus index tabel data.

Signature

• removeIndex(fields: string[])

Parameter

Contoh

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

posts.removeIndex(['title']);

#Method Konfigurasi Tabel

#remove()

Menghapus tabel data.

Signature

• remove(): void

Contoh

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

posts.remove();

#Method Operasi Database

#sync()

Menyinkronkan definisi tabel data ke database. Selain logika Model.sync default di Sequelize, juga akan menangani tabel data yang sesuai dengan field relasi.

Signature

• sync(): Promise<void>

Contoh

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

await posts.sync();

#existsInDb()

Memeriksa apakah tabel data ada di database.

Signature

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

Parameter

Contoh

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

const existed = await posts.existsInDb();

console.log(existed); // false

#removeFromDb()

Signature

• removeFromDb(): Promise<void>

Contoh

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

// Sinkronkan tabel buku ke database
await db.sync();

// Hapus tabel buku di database
await books.removeFromDb();