nocobase/docs/reference/collection.md

toc
menu

Collection 待完善

collection.addField()

添加字段，如果字段 name 已存在，直接替换。

Definition

interface addField {
  (name: string, options: FieldOptions): Field;
}

Examples

const field = collection.addField('name1', {
  type: 'string',
});
await field.sync();

collection.findField()

Definition

interface findField {
  (fn: (field: Field) => boolean): Field;
}

Examples

const field = collection.findField((field) => {
  return field.name === 'name1';
});

collection.forEachField()

Definition

interface forEachField {
  (fn: (field: Field) => void): void;
}

Examples

collection.forEachField((field) => {

});

collection.getField()

获取字段

Definition

interface getField {
  (name: string): Field;
}

Examples

const field = collection.getField('name');

collection.hasField()

是否存在某字段

Definition

interface hasField {
  (name: string): boolean;
}

Examples

collection.hasField('name');

collection.removeField()

移除字段

Definition

interface removeField {
  (name: string): Field;
}

Examples

collection.removeField('name');

collection.setFields()

设置 fields，会清空之前配置的 fields。

Definition

interface setFields {
  (fields: FieldOptions[]): void;
}

Examples

const collection = db.collection({
  name: 'tests',
});
collection.setFields([
  { type: 'string', name: 'name1' },
  { type: 'string', name: 'name2' },
]);

collection.sync()

Definition

interface sync {
  (options?: SyncOptions): Promise<void>;
}

Examples

如果关联表不存在，不处理

const Post = db.collection({
  name: 'posts',
  fields: [
    { type: 'string', name: 'name' },
    // tags 跳过
    { type: 'belongsToMany', name: 'tags' },
  ],
});
await Post.sync();

如果关系表存在，一起处理

const Post = db.collection({
  name: 'posts',
  fields: [
    { type: 'string', name: 'name' },
    { type: 'belongsToMany', name: 'tags' },
  ],
});
const Tag = db.collection({
  name: 'tags',
  fields: [{ type: 'string', name: 'name' }],
});
await Post.sync();
// 等同于
await db.sequelize.models.posts.sync();
await db.sequelize.models.tags.sync();
await db.sequelize.models.posts_tags.sync();

collection.updateField()

更新字段配置

Definition

interface updateField {
  (name: string, options: FieldOptions): Field;
}

Examples

更改 name

const field = collection.updateField('name1', {
  name: 'name2',
});
await field.sync();

collection.updateOptions()

更改当前 collection 的 options

Definition

interface updateOptions {
  (options: CollectionOptions): void;
}

Examples

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

collection.updateOptions({
  createdAt: true,
  updatedAt: true,
  sortable: true,
  fields: [],
});