操作示例
这是 GraphQL 库版本 7 的文档。对于长期支持 (LTS) 版本 5,请参考 GraphQL 库版本 5 LTS。 |
此页面展示了多个 GraphQL 查询,以及如何触发不同认证和授权规则的评估。
每条相关行都有一个注释,例如 CREATE ON OBJECT Movie
,这意味着会评估如下认证指令
type Movie @authentication(operations: [CREATE]) @node {
title: String!
actors: [Actor!]! @relationship(type: "ACTED_IN", direction: IN)
}
如果指令没有参数,此规则也适用,因为 |
以下示例适用于 @authentication
指令,以及 @authorization
指令内的任何规则。
查询
对于简单查询,操作中包含 READ
的规则将针对任何被读取的类型进行评估
query {
movies { # READ ON OBJECT Movie
title # READ ON FIELD_DEFINITION Movie.title
actors { # READ ON OBJECT Actor
name # READ ON FIELD_DEFINITION Actor.name
}
}
}
连接
对于连接查询,操作中包含 READ
的规则将针对任何被读取的类型进行评估
query {
moviesConnection {
edges {
node { # READ ON OBJECT Movie
title # READ ON FIELD_DEFINITION Movie.title
actorsConnection {
edges {
node { # READ ON OBJECT Actor
name # READ ON FIELD_DEFINITION Actor.name
}
}
}
}
}
}
}
聚合
对于聚合查询,操作中包含 AGGREGATE
的规则将针对任何被聚合的类型进行评估
query {
moviesConnection {
aggregate { # AGGREGATE ON OBJECT Movie
title { # AGGREGATE ON FIELD_DEFINITION Movie.title
longest
}
}
}
}
同样的逻辑也适用于嵌套节点的聚合
query {
movies {
actorsConnection {
aggregate { # AGGREGATE ON OBJECT Actor
node {
name { # AGGREGATE ON FIELD_DEFINITION Actor.name
longest
}
}
}
}
}
}
变更
创建
对于 create
变更,将评估对象上的 CREATE
规则以及字段定义规则,以针对每个创建的节点进行评估
mutation {
createMovies(input: [
{ # CREATE ON OBJECT Movie
title: "The Matrix" # CREATE ON FIELD_DEFINITION Movie.title
}
]) {
movies { # READ ON OBJECT Movie
title # READ ON FIELD_DEFINITION Movie.title
}
}
}
删除
对于单个 delete
变更,将评估对象上包含 DELETE
的规则
mutation {
deleteMovies(where: { title: { eq: "The Matrix" } }) { # DELETE ON OBJECT Movie
nodesDeleted
}
}
对于包含嵌套删除操作的 delete
变更,将评估操作中包含 DELETE
的规则
mutation {
deleteMovies( # DELETE ON OBJECT Movie
where: { title: { eq: "The Matrix" } }
delete: { actors: { where: { node: { name: { eq: "Keanu" } } } } } # DELETE ON OBJECT Actor
) {
nodesDeleted
}
}
更新
对于具有多种效果的复杂 update
变更,将评估各种规则,以及选择集对应的 READ
规则
mutation {
updateMovies(
where: { title: { eq: "The Matrix" } }
connect: { actors: { where: { node: { name: { eq: "Keanu" } } } } } # CONNECT ON OBJECT Actor and Movie
update: { # UPDATE ON OBJECT Movie
title: { set: "Speed" } # UPDATE ON FIELD_DEFINITION Movie.title
}
) {
movies { # READ ON OBJECT Movie
title # READ ON FIELD_DEFINITION Movie.title
actors { # READ ON OBJECT Actor
name # READ ON FIELD_DEFINITION Actor.name
}
}
}
}
订阅
对于简单的创建事件订阅,SUBSCRIBE
和 READ
操作都会触发规则
subscription {
movieCreated { # SUBSCRIBE ON OBJECT Movie
createdMovie { # READ ON OBJECT Movie
title # READ ON FIELD_DEFINITION Movie.title
}
}
}
对于更复杂的关系事件订阅,SUBSCRIBE
和 READ
都是针对所有相关类型的操作
subscription {
movieRelationshipCreated { # SUBSCRIBE ON OBJECT Movie
movie { # READ ON OBJECT Movie
title # READ ON FIELD_DEFINITION Movie.title
}
createdRelationship {
actors {
node { # READ ON OBJECT Actor
name # READ ON FIELD_DEFINITION Actor.name
}
}
}
}
}