指令

这是 GraphQL 库版本 7 的文档。对于长期支持 (LTS) 版本 5,请参考GraphQL 库版本 5 LTS

Neo4j GraphQL 库提供了以下指令,可在定义类型时使用

安全

指令 描述

@authentication

访问类型时需要进行身份验证检查。

@authorization

指定类型上查询和突变操作的授权规则。

@jwt

配置 JWT 认证和授权过滤器以包含额外的 JWT 声明。

@jwtClaim

@jwt 结合使用。配置 JWT 认证和授权过滤器以包含额外的 JWT 声明,该声明可以是嵌套的或使用 GraphQL 不支持的特殊字符。

@subscriptionsAuthorization

指定类型上订阅操作的授权规则。

数据库映射

指令 描述

@node

指定表示 Neo4j 节点的 GraphQL 对象类型的配置。

@relationship

配置对象类型之间的关系。另请参阅@relationship 字段配置

@relationshipProperties

用于区分用于关系属性的接口和其他接口。

@alias

将 GraphQL schema 字段映射到节点或关系上的 Neo4j 属性。

@declareRelationship

配置要在对象类型上实现的关系。

自动生成

指令 描述

@id

将字段标记为对象类型的唯一 ID,并允许自动生成 ID。

@timestamp

标记字段用于在 createupdate 事件中存储时间戳。

Schema 配置

指令 描述

@query

限制库中查询操作的可用性。

@mutation

限制库中突变操作的可用性。

@subscription

限制库中的订阅操作。

@default

允许在对象创建期间设置字段的默认值。

@plural

重新定义如何为生成的运算构成类型的复数。对于不能正确复数化或非英语单词的类型特别有用。

@selectable

设置查询和聚合中字段的可用性。

@settable

设置 createupdate 输入中字段的可用性。

@filterable

定义为字段生成的过滤器。

索引和约束

指令 描述

@fulltext

指示应为指定的节点及其属性在数据库中插入全文索引。

@vector

通过传入向量索引或搜索短语,在数据库上执行向量索引搜索。

自定义逻辑

指令 描述

@cypher

覆盖字段解析(包括查询和突变字段),而是使用指定的 Cypher 进行解析。

@coalesce

公开一种机制,用于查询节点上不存在的 null 值。

@limit

用于节点,将值注入 Cypher LIMIT 子句。

@customResolver

指定字段由自定义解析器解析,并允许指定作为参数传递给自定义解析器的任何必需字段。

@populatedBy

指定一个回调函数(在 GraphQL 查询解析期间执行),用于填充输入中未提供的字段。

Relay

指令 描述

@relayId

指定字段应作为 Relay 的全局节点标识符。

© . All rights reserved.