查询接口概述
数据实体和关系实体是工业数字模型驱动引擎-数据建模引擎（xDM Foundation，简称xDM-F）原子接口的承载体，支持多种具有查询功能的接口。其中：
- 数据实体支持调用find、get、batchget、query、count、list和select接口，可进行单字段排序或多字段排序。
- 仅支持单字段排序的接口有Get、Batchget和List接口。
- 支持多字段排序的接口有Find、Query、Count和Select接口。
- 关系实体支持queryRelatedObjects（查询源或目标实体的属性）、batchQueryRelatedObjects（批量查询源或目标实体的属性）、queryRelationship（查询关系实体的数据）、queryTarget（查询关系实例的数据）和deleteTarget（删除关系实例）接口。
功能对比
接口 |
适用场景 |
查询效率 |
多字段排序 |
|---|---|---|---|
Get |
适用于通过实体或实例的ID，获取某实体或实例所有信息的场景。 |
模型越复杂，参考对象和扩展属性越多，查询效率越慢。 |
不支持。 |
Batchget |
适用于通过实体或实例的ID，获取多个实体或实例所有信息的场景。 |
模型越复杂，参考对象和扩展属性越多，查询效率越慢。 |
不支持。 |
List |
适用于只查询数据模型自身信息的场景。 不支持参考模型属性作为查询条件。 |
查询效率较快。 |
可通过sorts字段进行多字段排序，通过filter字段进行数据过滤。 |
Find |
适用于通过指定查询条件，获取符合条件的所有数据模型的所有信息的场景。 |
模型越复杂，参考对象和扩展属性越多，查询效率越慢。 |
可通过sorts字段进行多字段排序，通过filter字段进行数据过滤。 |
Query |
适用于只查询数据模型所有的列表属性信息的场景。 只返回符合查询条件的对象及列表属性。 |
查询效率相较于find更快一些。 |
可通过sorts字段进行多字段排序，通过filter字段进行数据过滤。 |
Count |
适用于通过指定查询条件，获取符合条件的数据模型总数的场景。 只返回符合查询条件的对象的记录总数。 |
查询效率较快。 |
可通过sorts字段进行多字段排序，通过filter字段进行数据过滤。 |
Select |
适用于只查询数据模型指定属性数据的场景。 |
查询效率较快。 |
可通过sorts字段进行多字段排序，通过filter字段进行数据过滤。但数据过滤时，还需通过selectedField字段指定属性查询数据。 |
list、find、query和select接口的分页偏移量不能大于50000。
接口 |
描述 |
|---|---|
queryRelatedObjects |
用于查询源或目标实体的属性。 |
batchQueryRelatedObjects |
用于批量查询源或目标实体的属性。 |
queryRelationship |
用于查询关系实例的数据。 |
queryTarget |
用于查询目标实体的数据。 |
deleteTarget |
用于删除关系实例。 |
排序规则说明
数据实体、关系实体的接口，涉及排序的，根据数据库类型不同，字段首字母排序遵循如下规则：
- 如果是PostgreSQL数据库，在升降序排序时，先根据字母大小写，然后再根据英文字母顺序进行升降序排序显示。如升序排序时，字段首字母排序显示为B、X、Z、a、b、c。
- 如果是MySQL数据库，在升降序排序时，先根据英文字母顺序，然后再根据字母大小写进行升降序排序显示。如升序排序时，字段首字母排序显示为a、B、b、c、X、Z。
支持的运算符
查询接口支持如下运算符：
- =：支持设置文本、整型、长整型、浮点型、浮点型（自定义精度）、布尔值、枚举、人员、URL和日期类型的属性。
- like：支持设置文本、人员和URL类型的属性。
- startWith：支持设置文本、人员和URL类型的属性。
- endWith：支持设置文本、人员和URL类型的属性。
- in：支持设置文本、整型、长整型、浮点型、浮点型（自定义精度）、布尔值、日期、枚举、人员和URL类型的属性。
- <：支持设置整型、长整型、浮点型、浮点型（自定义精度）和日期类型的属性。
- >：支持设置整型、长整型、浮点型、浮点型（自定义精度）和日期类型的属性。
- <=：支持设置整型、长整型、浮点型、浮点型（自定义精度）和日期类型的属性。
- >=：支持设置整型、长整型、浮点型、浮点型（自定义精度）和日期类型的属性。
- <>：支持设置文本、整型、长整型、浮点型、浮点型（自定义精度）、布尔值、枚举、人员、URL和日期类型的属性。
- ISNULL：无需设置属性。
- NOTNULL：无需设置属性。
