# 配置实体

实体是数据库表的映射,提供给程序使用的一种形态。实体模型是实体的抽象,包括实体的属性、关系、索引等。我们在上个章节导入了合同实体,现在我们来配置它。

# 基本信息

基本信息是对实体的简单描述,包括实体名称、实体编码、数据源、数据库、数据表名等。一般情况下不需要去修改这里的配置。假如需要启用逻辑删除、扩展字段等功能,可以在这里进行配置。

# 字段

默认情况下,字段是根据数据库表自动生成的。我们可以在这里对字段进行配置,包括字段名称、字段类型、长度、精度、是否主键、是否自增、是否可空等。点击 "编辑" 开始调整。调整完成后需要保存后才能生效。

  • 可过滤:接口查询实体信息的时候,支持根据 eq, like 等表达式过滤匹配;
  • 可排序:接口查询实体信息的时候,支持根据 orderby 关键字进行排序;
  • 可搜索:区别于可过滤,这里是配合查询接口里面的 search 参数使用,例如 search=keyword, 底层引擎会自动根据可搜索字段进行模糊匹配;
  • 字典:界面展示时候使用,例如某字段显示在页面上用了下拉框,那么这个下来框就会自动绑定这里选择的字典;
  • UI建议:界面展示时候使用,例如在表单里面,会根据这里设置的控件类型进行展示;
  • 默认值表达式:是指在数据创建的时候,自动填充的数据,例如:当前用户ID、用户名称、当前时间等,底层引擎根据接口请求上下文自动生成字段的值;

# 索引

默认情况下,生成实体的同时会根据主键生成一个唯一索引,同时也可以自定义其他索引,主要用于提高数据库检索性能。

选择字段,生成自定义索引,调整完成后需要保存后才能生效,底层引擎会自动创建到数据库。

# 关系

支持创建一对多,多对一,多对多的关系,主要是方便实体数据展开查询(expand),它是程序层面的虚拟关系。 不推荐使用 "生成外键" 生成物理外键,容易引发表结构冲突。

# 事件

元数据引擎为基于实体的 CRUD 操作,提供了一系列事件,可以在这里配置监听事件,例如:数据创建前、数据创建后、数据更新前、数据更新后、数据删除前、数据删除后等。这些事件的执行逻辑可以在函数编排中实现。并且可以控制是否需要事务。

顶部