跳到主要内容

createSchemaFromEntity()

function createSchemaFromEntity(metadata, options?): FieldMetadata[];

Defined in: packages/rxdb-model/dist/query-builder/utils/schema-factory.d.ts:38

从 EntityMetadata 创建字段元数据

这是一个便捷的工厂函数，封装了 SchemaParser 的创建和解析过程

Parameters​

ParameterTypeDescription
metadataEntityMetadataRxDB 实体元数据
options?SchemaParserOptions解析器选项

Returns​

FieldMetadata[]

字段元数据数组

Example​

// 基础用法
const fields = createSchemaFromEntity(userMetadata);

// 包含外键
const fieldsWithFK = createSchemaFromEntity(userMetadata, {
  includeForeignKeys: true
});

// 包含计算属性
const fieldsWithComputed = createSchemaFromEntity(userMetadata, {
  includeComputedProperties: true
});

// 自定义过滤器
const onlyStringFields = createSchemaFromEntity(userMetadata, {
  fieldFilter: (field) => field.type === 'string'
});