#Collectie

#Overzicht

Collectie wordt gebruikt om datamodellen in het systeem te definiëren, zoals modelnamen, velden, indexen, associaties en andere informatie. U roept deze doorgaans aan via de collection-methode van een Database-instantie als een proxy-ingang.

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

// Maak een database-instantie aan
const db = new Database({...});

// Definieer een datamodel
db.collection({
  name: 'users',
  // Definieer modelvelden
  fields: [
    // Scalair veld
    {
      name: 'name',
      type: 'string',
    },

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

Voor meer veldtypes, zie Velden.

#Constructor

Signature

• constructor(options: CollectionOptions, context: CollectionContext)

Parameters

Voorbeeld

Maak een collectie voor berichten aan:

const posts = new Collection(
  {
    name: 'posts',
    fields: [
      {
        type: 'string',
        name: 'title',
      },
      {
        type: 'double',
        name: 'price',
      },
    ],
  },
  {
    // Bestaande database-instantie
    database: db,
  },
);

#Instantieleden

#options

Initiële configuratieparameters voor de collectie. Gelijk aan de options-parameter van de constructor.

#context

De context waartoe de huidige collectie behoort, momenteel voornamelijk de database-instantie.

#name

Naam van de collectie.

#db

De database-instantie waartoe het behoort.

#filterTargetKey

De veldnaam die als primaire sleutel wordt gebruikt.

#isThrough

Of het een tussencollectie is.

#model

Komt overeen met het Sequelize Model type.

#repository

Repository-instantie.

#Methoden voor veldconfiguratie

#getField()

Haalt het veldobject op met de corresponderende naam zoals gedefinieerd in de collectie.

Signature

• getField(name: string): Field

Parameters

Voorbeeld

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

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

#setField()

Stelt een veld in voor de collectie.

Signature

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

Parameters

Voorbeeld

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

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

#setFields()

Stelt meerdere velden tegelijk in voor de collectie.

Signature

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

Parameters

Voorbeeld

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

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

#removeField()

Verwijdert het veldobject met de corresponderende naam zoals gedefinieerd in de collectie.

Signature

• removeField(name: string): void | Field

Parameters

Voorbeeld

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

posts.removeField('title');

#resetFields()

Reset (leegt) de velden van de collectie.

Signature

• resetFields(): void

Voorbeeld

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

posts.resetFields();

#hasField()

Controleert of een veldobject met de corresponderende naam is gedefinieerd in de collectie.

Signature

• hasField(name: string): boolean

Parameters

Voorbeeld

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

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

#findField()

Zoekt een veldobject in de collectie dat voldoet aan de criteria.

Signature

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

Parameters

Voorbeeld

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

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

#forEachField()

Itereert over de veldobjecten in de collectie.

Signature

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

Parameters

Voorbeeld

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

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

#Methoden voor indexconfiguratie

#addIndex()

Voegt een index toe aan de collectie.

Signature

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

Parameters

Voorbeeld

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

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

#removeIndex()

Verwijdert een index uit de collectie.

Signature

• removeIndex(fields: string[])

Parameters

Voorbeeld

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

posts.removeIndex(['title']);

#Methoden voor collectieconfiguratie

#remove()

Verwijdert de collectie.

Signature

• remove(): void

Voorbeeld

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

posts.remove();

#Methoden voor databasebewerkingen

#sync()

Synchroniseert de collectiedefinitie met de database. Naast de standaardlogica van Model.sync in Sequelize, verwerkt het ook collecties die overeenkomen met associatievelden.

Signature

• sync(): Promise<void>

Voorbeeld

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

await posts.sync();

#existsInDb()

Controleert of de collectie bestaat in de database.

Signature

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

Parameters

Voorbeeld

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>

Voorbeeld

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

// Synchroniseer de boeken collectie met de database
await db.sync();

// Verwijder de boeken collectie uit de database
await books.removeFromDb();