logologo
开始
手册
开发
插件
API
首页
English
简体中文
日本語
한국어
Español
Português
Deutsch
Français
Русский
Italiano
Türkçe
Українська
Tiếng Việt
Bahasa Indonesia
ไทย
Polski
Nederlands
Čeština
العربية
עברית
हिन्दी
Svenska
开始
手册
开发
插件
API
首页
logologo
API Overview

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cache

CacheManager
Cache

@nocobase/cli

NocoBase CLI
全局环境变量

@nocobase/client

Application
Plugin

@nocobase/database

Collection
Field

interfaces

BaseInterface
Filter Operators

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
Repository

shared

create-options
destroy-options
find-one
find-options
transaction
update-options

@nocobase/data-source-manager

DataSourceManager
DataSource (abstract)
ICollectionManager
ICollection
IField
IModel
IRepository

@nocobase/flow-engine

DataSourceManager
FlowContext
FlowEngine
FlowModel
FlowResource

@nocobase/logger

Logger

@nocobase/server

AppCommand
Application
AuditManager
Context
Migration
Plugin

@nocobase/sdk

Auth
Storage

@nocobase/telemetry

Metric
Telemetry
Trace
Previous PageDataSource (abstract)
Next PageICollection

#ICollectionManager

ICollectionManager 接口,用于管理数据源的 Collection 实例。

#API

#registerFieldTypes()

注册 Collection 中的字段类型。

#签名

  • registerFieldTypes(types: Record<string, any>): void

#registerFieldInterfaces()

注册 Collection 的 Interface 。

#签名

  • registerFieldInterfaces(interfaces: Record<string, any>): void

#registerCollectionTemplates()

注册 Collection Template。

#签名

  • registerCollectionTemplates(templates: Record<string, any>): void

#registerModels()

注册 Model。

#签名

  • registerModels(models: Record<string, any>): void

#registerRepositories()

注册 Repository。

#签名

  • registerRepositories(repositories: Record<string, any>): void

#getRegisteredRepository()

获取已注册的仓库实例。

#签名

  • getRegisteredRepository(key: string): IRepository

#defineCollection()

定义一个 Collection。

#签名

  • defineCollection(options: CollectionOptions): ICollection

#extendCollection()

修改一个已存在的 Collection 属性。

#签名

  • extendCollection(collectionOptions: CollectionOptions, mergeOptions?: MergeOptions): ICollection

#hasCollection()

判断 Collection 是否存在。

#签名

  • hasCollection(name: string): boolean

#getCollection()

获取 Collection 实例。

#签名

  • getCollection(name: string): ICollection

#getCollections()

获取所有的 Collection 实例。

#签名

  • getCollections(): Array<ICollection>

#getRepository()

获取 Repository 实例。

#签名

  • getRepository(name: string, sourceId?: string | number): IRepository

#sync()

同步数据源,逻辑由子类实现。

#签名

  • sync(): Promise<void>