persagy/persagy-dmp-server-doc @ develop

通用查询说明

1.数据结构

{
    "page": 1,
    "size": 20,
    "onlyCount": false,
    "criteria": {
        "age": {
            "$gt": 21
        }
    },
    "orders": [
        {
            "column": "name",
            "asc": false
        }
    ],
    "withColumns": [ "roles" ]
}

返回格式

1.data为数组格式

{
    "result": "success",
    "data": [
        {
            "id": "dev_1",
            "groupCode": "PG",
            "type": "major",
            "name": "专业",
            "description": "Testing",
            "valid": 1,
            "creationTime": 1602434380000,
            "creator": "wdl",
            "modifiedTime": 1602705427000,
            "modifier": "wdl",
            "remark": "Testing"
        }
    ],
    "count": 1
}

2.data为对象格式

{
    "result": "success",
    "data":{
            "id": "dev_1",
            "groupCode": "PG",
            "type": "major",
            "name": "专业",
            "description": "Testing",
            "status": 1,
            "creationTime": 1602434380000,
            "creator": "wdl",
            "modifiedTime": 1602705427000,
            "modifier": "wdl",
            "remark": "Testing"
    }
}

3.错误返回格式

{
    "result": "fail/其他错误码",
    "message":"***"
}

参数说明

字段		说明
page		分页页码,从 1 开始
size		分页大小
onlyCount		是否只统计数量,默认 false
criteria		查询条件
orders	object[]	排序参数,支持多个字段排序
	column	排序字段
	asc	是否升序,默认 true
withColumns		额外返回的扩展字段清单
count		当分页时,该数表示数据总条数
result		详情见错误码列表

2.criteria 说明

符号说明

符号	说明
\$ne	不等于
\$gt, \$gte, \$lt, \$lte	大于, 大于等于, 小于, 小于等于
\$in	范围查询
\$like, \$notLike	模糊匹配不匹配
\$null	是否为空
relationFrom	查询id作为obj_from的对象
relationTo	查询id作为obj_to的对象
$andOr	类似AND (local_id LIKE "%temp%" OR local_name LIKE "%temp%")
$likeLeft	类似local_id LIKE "%temp"
$likeRight	类似local_id LIKE "temp%"

以下实例针对的实体类型 user 如下

字段	类型
id	int
name	string
age	int

相等

查询 name 为 zhangsan 的数据

{
    "criteria": {
        "name": "zhangsan"
    }
}

不等于

查询 name 不等于张三的数据

{
    "criteria": {
        "name": {
            "$ne": "zhangsan"
        }
    }
}

是否为空

查询 name 不为空的数据

{
    "criteria": {
        "name": {
            "$null": false
        }
    }
}

比较大小

查询 age 大于 25 小于 35 的数据

{
    "criteria": {
        "age": {
            "$gt": 25,
            "$lt": 35
        }
    }
}

in 查询

查询 name 为 zhangsan、lisi 的数据

{
    "criteria": {
        "name": {
            "$in": [ "zhangsan", "lisi" ]
        }
    }
}

也可直接写成

{
    "criteria": {
        "name": [ "zhangsan", "lisi" ]
    }
}

模糊查询

// $like
// 查询 name 含有 zh 的数据
{
    "criteria": {
        "name": {
            "$like": "zh"
        }
    }
}
// $likeLeft
// 查询 name 以 zh 结尾的数据
{
    "criteria": {
        "name": {
            "$likeLeft": "zh"
        }
    }
}
//$likeRight
// 查询 name 以 zh 开头的数据
{
    "criteria": {
        "name": {
            "$likeRight": "zh"
        }
    }
}

relationFrom

仅支持/rwd/instance/object/query接口查询

查询 objTo 为Sp5001120003566c821e83b84a84bc17ecf7290d261b的数据

// 多个查询
{
    "criteria": {
        "relationFrom": {
            "graphCode": ["MechForArch"],
            "relCode": ["Eq2Sp"],
            "objTo":["Sp5001120003566c821e83b84a84bc17ecf7290d261b"]
        }
    }
}
// 单个查询
{
    "criteria": {
        "relationFrom": {
            "graphCode": "MechForArch",
            "relCode": "Eq2Sp",
            "objTo":"Sp5001120003566c821e83b84a84bc17ecf7290d261b"
        }
    }
}

relationTo

仅支持/rwd/instance/object/query接口查询

查询 objFrom 为Eq5001120003c1192002bf9646c4b64077a6b0f283ab的数据

// 多个查询
{
    "criteria": {
        "relationTo": {
            "graphCode": ["MechForArch"],
            "relCode": ["Eq2Sp"],
            "objFrom":["Eq5001120003c1192002bf9646c4b64077a6b0f283ab"]
        }
    }
}
// 单个查询
{
    "criteria": {
        "relationTo": {
            "graphCode": "MechForArch",
            "relCode": "Eq2Sp",
            "objFrom":"Eq5001120003c1192002bf9646c4b64077a6b0f283ab"
        }
    }
}

$andOr 查询

模糊查询本地名称或本地id为P2的对象

{
    "criteria": {
        "$andOr": {
            "localId": {"$like":"P2"},
            "localName": {"$like":"P2"}
        }
    }
}

3.withColumns 说明

通过 withColumns 可以控制返回的数据内容,可以一定程度上提供服务性能.

withColumns 粒度比较粗,一般由服务提供者决定哪些字段可以通过 withColumns 来控制.

假设数据如下

{
    "name": "zhangsan",
    "age": 22,
    "roles": [ "administrator", "manager" ]
}

将 roles 设计为可选字段,由 withColumns 来管理,如果查询参数中有 withColumns 并包含 roles,则返回 roles 字段

默认查询和返回的数据内容为

{
    "criteria": {
        "name": "zhangsan"
    }
}

{
    "name": "zhangsan",
    "age": 22
}

包含 withColumns 时的查询参数和返回的数据

{
    "criteria": {
        "name": "zhangsan"
    },
    "withColumns": [ "roles" ]
}

{
    "name": "zhangsan",
    "age": 22,
    "roles": [ "administrator", "manager" ]
}

4.物理世界对象信息点相关查询

\$search

特别说明:

1.业务含义不可靠,目前除"查询绑定了某个表号功能号的对象"这一个场景外暂时没有合理使用该查询的业务场景
2.性能差!性能差!性能差!

{
    "criteria": {
        "$search": "关键字"
    }
}

1.直接放在criteria下,只能对字符串字段进行查询
2.支持通配符%, 如"%abc%"将返回信息点的值中包含abc的对象
3.固定字段(id,localId,name,localName,classCode...等)无效
4.信息点的值可能是对象,若对象的属性符合条件则该对象也将被返回

数组查询 \$contains \$notcontains